Interface SessionArguments

interface SessionArguments {
    "alt-speed-down": number;
    "alt-speed-enabled": boolean;
    "alt-speed-time-begin": number;
    "alt-speed-time-day": number;
    "alt-speed-time-enabled": boolean;
    "alt-speed-time-end": number;
    "alt-speed-up": number;
    "blocklist-enabled": boolean;
    "blocklist-size": number;
    "blocklist-url": string;
    "cache-size-mb": number;
    "config-dir": string;
    "dht-enabled": boolean;
    "download-dir": string;
    "download-dir-free-space": number;
    "download-queue-enabled": boolean;
    "download-queue-size": number;
    encryption: string;
    "idle-seeding-limit": number;
    "idle-seeding-limit-enabled": boolean;
    "incomplete-dir": string;
    "incomplete-dir-enabled": boolean;
    "lpd-enabled": boolean;
    "peer-limit-global": number;
    "peer-limit-per-torrent": number;
    "peer-port": number;
    "peer-port-random-on-start": boolean;
    "pex-enabled": boolean;
    "port-forwarding-enabled": boolean;
    "queue-stalled-enabled": boolean;
    "queue-stalled-minutes": number;
    "rename-partial-files": boolean;
    "rpc-version": number;
    "rpc-version-minimum": number;
    "script-torrent-done-enabled": boolean;
    "script-torrent-done-filename": string;
    "seed-queue-enabled": boolean;
    "seed-queue-size": number;
    seedRatioLimit: number;
    seedRatioLimited: boolean;
    "speed-limit-down": number;
    "speed-limit-down-enabled": boolean;
    "speed-limit-up": number;
    "speed-limit-up-enabled": boolean;
    "start-added-torrents": boolean;
    "trash-original-torrent-files": boolean;
    units: Units;
    "utp-enabled": boolean;
    version: string;
}

Properties

"alt-speed-down": number

max global download speed (KBps)

"alt-speed-enabled": boolean

true means use the alt speeds

"alt-speed-time-begin": number

when to turn on alt speeds (units: minutes after midnight)

"alt-speed-time-day": number

what day(s) to turn on alt speeds (look at tr_sched_day)

"alt-speed-time-enabled": boolean

true means the scheduled on/off times are used

"alt-speed-time-end": number

when to turn off alt speeds (units: same)

"alt-speed-up": number

max global upload speed (KBps)

"blocklist-enabled": boolean

true means enabled

"blocklist-size": number

number of rules in the blocklist

"blocklist-url": string

location of the blocklist to use for "blocklist-update"

"cache-size-mb": number

maximum size of the disk cache (MB)

"config-dir": string

location of transmission's configuration directory

"dht-enabled": boolean

true means allow dht in public torrents

"download-dir": string

default path to download torrents

"download-dir-free-space": number
"download-queue-enabled": boolean

if true, limit how many torrents can be downloaded at once

"download-queue-size": number

max number of torrents to download at once (see download-queue-enabled)

encryption: string

"required", "preferred", "tolerated"

"idle-seeding-limit": number

torrents we're seeding will be stopped if they're idle for this long

"idle-seeding-limit-enabled": boolean

true if the seeding inactivity limit is honored by default

"incomplete-dir": string

path for incomplete torrents, when enabled

"incomplete-dir-enabled": boolean

true means keep torrents in incomplete-dir until done

"lpd-enabled": boolean

true means allow Local Peer Discovery in public torrents

"peer-limit-global": number

maximum global number of peers

"peer-limit-per-torrent": number

maximum global number of peers

"peer-port": number

port number

"peer-port-random-on-start": boolean

true means pick a random peer port on launch

"pex-enabled": boolean

true means allow pex in public torrents

"port-forwarding-enabled": boolean

true means enabled

"queue-stalled-enabled": boolean

whether or not to consider idle torrents as stalled

"queue-stalled-minutes": number

torrents that are idle for N minuets aren't counted toward seed-queue-size or download-queue-size

"rename-partial-files": boolean

true means append ".part" to incomplete files

"rpc-version": number

the current RPC API version

"rpc-version-minimum": number

the minimum RPC API version supported

"script-torrent-done-enabled": boolean

whether or not to call the "done" script

"script-torrent-done-filename": string

filename of the script to run

"seed-queue-enabled": boolean

if true, limit how many torrents can be uploaded at once

"seed-queue-size": number

max number of torrents to uploaded at once (see seed-queue-enabled)

seedRatioLimit: number

the default seed ratio for torrents to use

seedRatioLimited: boolean

true if seedRatioLimit is honored by default

"speed-limit-down": number

max global download speed (KBps)

"speed-limit-down-enabled": boolean

true means enabled

"speed-limit-up": number

max global upload speed (KBps)

"speed-limit-up-enabled": boolean

true means enabled

"start-added-torrents": boolean

true means added torrents will be started right away

"trash-original-torrent-files": boolean

true means the .torrent file of added torrents will be deleted

units: Units
"utp-enabled": boolean

true means allow utp

version: string

long version string "$version ($revision)"