Interface SetTorrentOptions

interface SetTorrentOptions {
    bandwidthPriority: number;
    downloadLimit: number;
    downloadLimited: boolean;
    files-wanted: number[];
    files-unwanted: number[];
    honorsSessionLimits: boolean;
    ids: TorrentIds;
    labels: string[];
    location: string;
    peer-limit: number;
    priority-high: number[];
    priority-low: number[];
    priority-normal: number[];
    queuePosition: number;
    seedIdleLimit: number;
    seedIdleMode: number;
    seedRatioLimit: number;
    seedRatioMode: number;
    trackerAdd: string[];
    trackerRemove: number[];
    trackerReplace: any[];
    uploadLimit: number;
    uploadLimited: boolean;
}

Properties

bandwidthPriority: number

this torrent's bandwidth tr_priority_t

downloadLimit: number

maximum download speed (KBps)

downloadLimited: boolean

true if "downloadLimit" is honored

files-wanted: number[]

indices of file(s) to download

files-unwanted: number[]

indices of file(s) to not download

honorsSessionLimits: boolean

true if session upload limits are honored

torrent list, as described in 3.1

labels: string[]

array of string labels

location: string

new location of the torrent's content

peer-limit: number

maximum number of peers

priority-high: number[]

indices of high-priority file(s)

priority-low: number[]

indices of low-priority file(s)

priority-normal: number[]

indices of normal-priority file(s)

queuePosition: number

position of this torrent in its queue [0...n)

seedIdleLimit: number

torrent-level number of minutes of seeding inactivity

seedIdleMode: number

which seeding inactivity to use. See tr_idlelimit

seedRatioLimit: number

torrent-level seeding ratio

seedRatioMode: number

which ratio to use. See tr_ratiolimit

trackerAdd: string[]

strings of announce URLs to add

trackerRemove: number[]

ids of trackers to remove

trackerReplace: any[]

pairs of <trackerId/new announce URLs>

uploadLimit: number

maximum upload speed (KBps)

uploadLimited: boolean

true if "uploadLimit" is honored