Transfer¶
-
class
qbittorrentapi.
TransferAPIMixIn
(host='', port=None, username=None, password=None, **kwargs)¶ Implementation of all Transfer API methods
-
transfer_banPeers
(peers=None, **kwargs)¶ Ban one or more peers. (alias: transfer_banPeers)
Parameters: peers – one or more peers to ban. each peer should take the form ‘host:port’ Returns: None
-
transfer_ban_peers
(peers=None, **kwargs)¶ Ban one or more peers. (alias: transfer_banPeers)
Parameters: peers – one or more peers to ban. each peer should take the form ‘host:port’ Returns: None
-
transfer_downloadLimit
(**kwargs)¶ Retrieves download limit. 0 is unlimited. (alias: transfer_downloadLimit)
Returns: integer
-
transfer_download_limit
(**kwargs)¶ Retrieves download limit. 0 is unlimited. (alias: transfer_downloadLimit)
Returns: integer
-
transfer_info
(**kwargs)¶ Retrieves the global transfer info usually found in qBittorrent status bar.
Returns: dictionary of status items Properties: https://github.com/qbittorrent/qBittorrent/wiki/Web-API-Documentation#get-global-transfer-info
-
transfer_setDownloadLimit
(limit=None, **kwargs)¶ Set the global download limit in bytes/second. (alias: transfer_setDownloadLimit)
Parameters: limit – download limit in bytes/second (0 or -1 for no limit) Returns: None
-
transfer_setUploadLimit
(limit=None, **kwargs)¶ Set the global download limit in bytes/second. (alias: transfer_setUploadLimit)
Parameters: limit – upload limit in bytes/second (0 or -1 for no limit) Returns: None
-
transfer_set_download_limit
(limit=None, **kwargs)¶ Set the global download limit in bytes/second. (alias: transfer_setDownloadLimit)
Parameters: limit – download limit in bytes/second (0 or -1 for no limit) Returns: None
-
transfer_set_upload_limit
(limit=None, **kwargs)¶ Set the global download limit in bytes/second. (alias: transfer_setUploadLimit)
Parameters: limit – upload limit in bytes/second (0 or -1 for no limit) Returns: None
-
transfer_speedLimitsMode
(**kwargs)¶ Retrieves whether alternative speed limits are enabled. (alias: transfer_speedLimitMode)
Returns: ‘1’ if alternative speed limits are currently enabled, ‘0’ otherwise
-
transfer_speed_limits_mode
(**kwargs)¶ Retrieves whether alternative speed limits are enabled. (alias: transfer_speedLimitMode)
Returns: ‘1’ if alternative speed limits are currently enabled, ‘0’ otherwise
-
transfer_toggleSpeedLimitsMode
(intended_state=None, **kwargs)¶ Sets whether alternative speed limits are enabled. (alias: transfer_toggleSpeedLimitsMode)
Parameters: intended_state – True to enable alt speed and False to disable. Leaving None will toggle the current state. Returns: None
-
transfer_toggle_speed_limits_mode
(intended_state=None, **kwargs)¶ Sets whether alternative speed limits are enabled. (alias: transfer_toggleSpeedLimitsMode)
Parameters: intended_state – True to enable alt speed and False to disable. Leaving None will toggle the current state. Returns: None
-
transfer_uploadLimit
(**kwargs)¶ Retrieves upload limit. 0 is unlimited. (alias: transfer_uploadLimit)
Returns: integer
-
transfer_upload_limit
(**kwargs)¶ Retrieves upload limit. 0 is unlimited. (alias: transfer_uploadLimit)
Returns: integer
-
-
class
qbittorrentapi.
Transfer
(*args, **kwargs)¶ Alows interaction with the “Transfer” API endpoints.
- Usage:
>>> from qbittorrentapi import Client >>> client = Client(host='localhost:8080', username='admin', password='adminadmin') >>> # this are all the same attributes that are available as named in the >>> # endpoints or the more pythonic names in Client (with or without 'transfer_' prepended) >>> transfer_info = client.transfer.info >>> # access and set download/upload limits as attributes >>> dl_limit = client.transfer.download_limit >>> # this updates qBittorrent in real-time >>> client.transfer.download_limit = 1024000 >>> # update speed limits mode to alternate or not >>> client.transfer.speedLimitsMode = True
-
banPeers
(peers=None, **kwargs)¶
-
ban_peers
(peers=None, **kwargs)¶
-
downloadLimit
¶
-
download_limit
¶
-
info
¶
-
setDownloadLimit
(limit=None, **kwargs)¶
-
setUploadLimit
(limit=None, **kwargs)¶
-
set_download_limit
(limit=None, **kwargs)¶
-
set_upload_limit
(limit=None, **kwargs)¶
-
speedLimitsMode
¶
-
speed_limits_mode
¶
-
toggleSpeedLimitsMode
(intended_state=None, **kwargs)¶
-
toggle_speed_limits_mode
(intended_state=None, **kwargs)¶
-
uploadLimit
¶
-
upload_limit
¶