|
@@ -3267,7 +3267,8 @@ GID
|
|
|
</dl></div>
|
|
|
<h3 id="_methods">Methods</h3><div style="clear:left"></div>
|
|
|
<div class="paragraph"><p>All code examples come from Python2.7 interpreter.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.addUri</strong> (<em>uris[, options[, position]]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_adduri_strong_em_uris_options_position_em"><strong>aria2.addUri</strong> (<em>uris[, options[, position]]</em>)</h4>
|
|
|
+<h5 id="_description_2">Description</h5>
|
|
|
<div class="paragraph"><p>This method adds new HTTP(S)/FTP/BitTorrent Magnet URI. <em>uris</em> is of
|
|
|
type array and its element is URI which is of type string. For
|
|
|
BitTorrent Magnet URI, <em>uris</em> must have only one element and it should
|
|
@@ -3300,7 +3301,8 @@ GID of registered download.</p></div>
|
|
|
<pre><tt>>>> s.aria2.addUri(['http://example.org/file'], {}, 0)
|
|
|
'3'</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.addTorrent</strong> (<em>torrent[, uris[, options[, position]]]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_addtorrent_strong_em_torrent_uris_options_position_em"><strong>aria2.addTorrent</strong> (<em>torrent[, uris[, options[, position]]]</em>)</h4>
|
|
|
+<h5 id="_description_3">Description</h5>
|
|
|
<div class="paragraph"><p>This method adds BitTorrent download by uploading .torrent file. If
|
|
|
you want to add BitTorrent Magnet URI, use <strong>aria2.addUri</strong> method
|
|
|
instead. <em>torrent</em> is of type base64 which contains Base64-encoded
|
|
@@ -3325,7 +3327,8 @@ Please note that the downloads added by this method are not saved by
|
|
|
>>> s.aria2.addTorrent(xmlrpclib.Binary(open('file.torrent').read()))
|
|
|
'6'</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.addMetalink</strong> (<em>metalink[, options[, position]]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_addmetalink_strong_em_metalink_options_position_em"><strong>aria2.addMetalink</strong> (<em>metalink[, options[, position]]</em>)</h4>
|
|
|
+<h5 id="_description_4">Description</h5>
|
|
|
<div class="paragraph"><p>This method adds Metalink download by uploading .metalink file.
|
|
|
<em>metalink</em> is of type base64 which contains Base64-encoded .metalink
|
|
|
file. <em>options</em> is of type struct and its members are a pair of
|
|
@@ -3344,7 +3347,8 @@ method are not saved by <strong><a href="#aria2_optref_save_session">--save-sess
|
|
|
>>> s.aria2.addMetalink(xmlrpclib.Binary(open('file.meta4').read()))
|
|
|
['8']</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.remove</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_remove_strong_em_gid_em"><strong>aria2.remove</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_5">Description</h5>
|
|
|
<div class="paragraph"><p>This method removes the download denoted by <em>gid</em>. <em>gid</em> is of type
|
|
|
string. If specified download is in progress, it is stopped at
|
|
|
first. The status of removed download becomes "removed". This method
|
|
@@ -3357,38 +3361,46 @@ returns GID of removed download.</p></div>
|
|
|
>>> s.aria2.remove('3')
|
|
|
'3'</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.forceRemove</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_forceremove_strong_em_gid_em"><strong>aria2.forceRemove</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_6">Description</h5>
|
|
|
<div class="paragraph"><p>This method removes the download denoted by <em>gid</em>. This method
|
|
|
behaves just like <strong>aria2.remove</strong> except that this method removes
|
|
|
download without any action which takes time such as contacting
|
|
|
BitTorrent tracker.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.pause</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_pause_strong_em_gid_em"><strong>aria2.pause</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_7">Description</h5>
|
|
|
<div class="paragraph"><p>This method pauses the download denoted by <em>gid</em>. <em>gid</em> is of type
|
|
|
string. The status of paused download becomes "paused". If the
|
|
|
download is active, the download is placed on the first position of
|
|
|
waiting queue. As long as the status is "paused", the download is not
|
|
|
started. To change status to "waiting", use <strong>aria2.unpause</strong> method.
|
|
|
This method returns GID of paused download.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.pauseAll</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_pauseall_strong"><strong>aria2.pauseAll</strong> ()</h4>
|
|
|
+<h5 id="_description_8">Description</h5>
|
|
|
<div class="paragraph"><p>This method is equal to calling <strong>aria2.pause</strong> for every active/waiting
|
|
|
download. This methods returns "OK" for success.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.forcePause</strong> (<em>pid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_forcepause_strong_em_pid_em"><strong>aria2.forcePause</strong> (<em>pid</em>)</h4>
|
|
|
+<h5 id="_description_9">Description</h5>
|
|
|
<div class="paragraph"><p>This method pauses the download denoted by <em>gid</em>. This method
|
|
|
behaves just like <strong>aria2.pause</strong> except that this method pauses
|
|
|
download without any action which takes time such as contacting
|
|
|
BitTorrent tracker.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.forcePauseAll</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_forcepauseall_strong"><strong>aria2.forcePauseAll</strong> ()</h4>
|
|
|
+<h5 id="_description_10">Description</h5>
|
|
|
<div class="paragraph"><p>This method is equal to calling <strong>aria2.forcePause</strong> for every
|
|
|
active/waiting download. This methods returns "OK" for success.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.unpause</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_unpause_strong_em_gid_em"><strong>aria2.unpause</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_11">Description</h5>
|
|
|
<div class="paragraph"><p>This method changes the status of the download denoted by <em>gid</em> from
|
|
|
"paused" to "waiting". This makes the download eligible to restart.
|
|
|
<em>gid</em> is of type string. This method returns GID of unpaused
|
|
|
download.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.unpauseAll</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_unpauseall_strong"><strong>aria2.unpauseAll</strong> ()</h4>
|
|
|
+<h5 id="_description_12">Description</h5>
|
|
|
<div class="paragraph"><p>This method is equal to calling <strong>aria2.unpause</strong> for every active/waiting
|
|
|
download. This methods returns "OK" for success.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.tellStatus</strong> (<em>gid[, keys]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_tellstatus_strong_em_gid_keys_em"><strong>aria2.tellStatus</strong> (<em>gid[, keys]</em>)</h4>
|
|
|
+<h5 id="_description_13">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns download progress of the download denoted by
|
|
|
<em>gid</em>. <em>gid</em> is of type string. <em>keys</em> is array of string. If it is
|
|
|
specified, the response contains only keys in <em>keys</em> array. If <em>keys</em>
|
|
@@ -3664,7 +3676,8 @@ name
|
|
|
>>> pprint(r)
|
|
|
{'completedLength': '34896138', 'gid': '1', 'totalLength': '34896138'}</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getUris</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_geturis_strong_em_gid_em"><strong>aria2.getUris</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_14">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns URIs used in the download denoted by <em>gid</em>. <em>gid</em>
|
|
|
is of type string. The response is of type array and its element is of
|
|
|
type struct and it contains following keys. The value type is string.</p></div>
|
|
@@ -3687,7 +3700,8 @@ status
|
|
|
</p>
|
|
|
</dd>
|
|
|
</dl></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getFiles</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_getfiles_strong_em_gid_em"><strong>aria2.getFiles</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_15">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns file list of the download denoted by <em>gid</em>. <em>gid</em>
|
|
|
is of type string. The response is of type array and its element is of
|
|
|
type struct and it contains following keys. The value type is string.</p></div>
|
|
@@ -3737,7 +3751,8 @@ uris
|
|
|
</p>
|
|
|
</dd>
|
|
|
</dl></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getPeers</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_getpeers_strong_em_gid_em"><strong>aria2.getPeers</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_16">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns peer list of the download denoted by <em>gid</em>. <em>gid</em>
|
|
|
is of type string. This method is for BitTorrent only. The response
|
|
|
is of type array and its element is of type struct and it contains
|
|
@@ -3819,7 +3834,8 @@ seeder
|
|
|
</p>
|
|
|
</dd>
|
|
|
</dl></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getServers</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_getservers_strong_em_gid_em"><strong>aria2.getServers</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_17">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns currently connected HTTP(S)/FTP servers of the download denoted by <em>gid</em>. <em>gid</em> is of type string. The response
|
|
|
is of type array and its element is of type struct and it contains
|
|
|
following keys. The value type is string.</p></div>
|
|
@@ -3869,12 +3885,14 @@ downloadSpeed
|
|
|
</dl></div>
|
|
|
</dd>
|
|
|
</dl></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.tellActive</strong> (<em>[keys]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_tellactive_strong_em_keys_em"><strong>aria2.tellActive</strong> (<em>[keys]</em>)</h4>
|
|
|
+<h5 id="_description_18">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns the list of active downloads. The response is of
|
|
|
type array and its element is the same struct returned by
|
|
|
<strong>aria2.tellStatus</strong> method. For <em>keys</em> parameter, please refer to
|
|
|
<strong>aria2.tellStatus</strong> method.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.tellWaiting</strong> (<em>offset, num, [keys]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_tellwaiting_strong_em_offset_num_keys_em"><strong>aria2.tellWaiting</strong> (<em>offset, num, [keys]</em>)</h4>
|
|
|
+<h5 id="_description_19">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns the list of waiting download, including paused
|
|
|
downloads. <em>offset</em> is of type integer and specifies the offset from
|
|
|
the download waiting at the front. <em>num</em> is of type integer and
|
|
@@ -3892,7 +3910,8 @@ in this order. aria2.tellWaiting(0, 1) returns
|
|
|
aria2.tellWaiting(-1, 2) returns ["C", "B"].</p></div>
|
|
|
<div class="paragraph"><p>The response is of type array and its element is the same struct
|
|
|
returned by <strong>aria2.tellStatus</strong> method.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.tellStopped</strong> (<em>offset, num, [keys]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_tellstopped_strong_em_offset_num_keys_em"><strong>aria2.tellStopped</strong> (<em>offset, num, [keys]</em>)</h4>
|
|
|
+<h5 id="_description_20">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns the list of stopped download. <em>offset</em> is of type
|
|
|
integer and specifies the offset from the oldest download. <em>num</em> is of
|
|
|
type integer and specifies the number of downloads to be returned.
|
|
@@ -3901,7 +3920,8 @@ For <em>keys</em> parameter, please refer to <strong>aria2.tellStatus</strong> m
|
|
|
method.</p></div>
|
|
|
<div class="paragraph"><p>The response is of type array and its element is the same struct
|
|
|
returned by <strong>aria2.tellStatus</strong> method.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.changePosition</strong> (<em>gid, pos, how</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_changeposition_strong_em_gid_pos_how_em"><strong>aria2.changePosition</strong> (<em>gid, pos, how</em>)</h4>
|
|
|
+<h5 id="_description_21">Description</h5>
|
|
|
<div class="paragraph"><p>This method changes the position of the download denoted by
|
|
|
<em>gid</em>. <em>pos</em> is of type integer. <em>how</em> is of type string. If <em>how</em> is
|
|
|
"POS_SET", it moves the download to a position relative to the
|
|
@@ -3916,7 +3936,8 @@ destination position.</p></div>
|
|
|
-1, POS_CUR) will change its position to 2. Additional
|
|
|
aria2.changePosition(1, 0, POS_SET) will change its position to 0(the
|
|
|
beginning of the queue).</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.changeUri</strong> (<em>gid, fileIndex, delUris, addUris[, position]</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_changeuri_strong_em_gid_fileindex_deluris_adduris_position_em"><strong>aria2.changeUri</strong> (<em>gid, fileIndex, delUris, addUris[, position]</em>)</h4>
|
|
|
+<h5 id="_description_22">Description</h5>
|
|
|
<div class="paragraph"><p>This method removes URIs in <em>delUris</em> from and appends URIs in
|
|
|
<em>addUris</em> to download denoted by <em>gid</em>. <em>delUris</em> and <em>addUris</em> are
|
|
|
list of string. A download can contain multiple files and URIs are
|
|
@@ -3934,23 +3955,27 @@ specify (at least) 3 "http://example.org/aria2" in <em>delUris</em>. This
|
|
|
method returns a list which contains 2 integers. The first integer is
|
|
|
the number of URIs deleted. The second integer is the number of URIs
|
|
|
added.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getOption</strong> (<em>gid</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_getoption_strong_em_gid_em"><strong>aria2.getOption</strong> (<em>gid</em>)</h4>
|
|
|
+<h5 id="_description_23">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns options of the download denoted by <em>gid</em>. The
|
|
|
response is of type struct. Its key is the name of option. The value type
|
|
|
is string.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.changeOption</strong> (<em>gid, options</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_changeoption_strong_em_gid_options_em"><strong>aria2.changeOption</strong> (<em>gid, options</em>)</h4>
|
|
|
+<h5 id="_description_24">Description</h5>
|
|
|
<div class="paragraph"><p>This method changes options of the download denoted by <em>gid</em>
|
|
|
dynamically. <em>gid</em> is of type string. <em>options</em> is of type struct
|
|
|
and the available options are: <strong>bt-max-peers</strong>,
|
|
|
<strong>bt-request-peer-speed-limit</strong>, <strong>max-download-limit</strong> and
|
|
|
<strong>max-upload-limit</strong>. This method returns "OK" for success.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getGlobalOption</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_getglobaloption_strong"><strong>aria2.getGlobalOption</strong> ()</h4>
|
|
|
+<h5 id="_description_25">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns global options. The response is of type
|
|
|
struct. Its key is the name of option. The value type is string.
|
|
|
Because global options are used as a template for the options of newly
|
|
|
added download, the response contains keys returned by
|
|
|
<strong>aria2.getOption</strong> method.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.changeGlobalOption</strong> (<em>options</em>)</p></div>
|
|
|
+<h4 id="_strong_aria2_changeglobaloption_strong_em_options_em"><strong>aria2.changeGlobalOption</strong> (<em>options</em>)</h4>
|
|
|
+<h5 id="_description_26">Description</h5>
|
|
|
<div class="paragraph"><p>This method changes global options dynamically. <em>options</em> is of type
|
|
|
struct and the available options are <strong>max-concurrent-downloads</strong>,
|
|
|
<strong>max-overall-download-limit</strong>, <strong>max-overall-upload-limit</strong>, <strong>log-level</strong>
|
|
@@ -3958,10 +3983,12 @@ and <strong>log</strong>. Using <strong>log</strong> option, you can dynamically
|
|
|
change log file. To stop logging, give empty string("") as a parameter
|
|
|
value. Note that log file is always opened in append mode. This method
|
|
|
returns "OK" for success.</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.purgeDownloadResult</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_purgedownloadresult_strong"><strong>aria2.purgeDownloadResult</strong> ()</h4>
|
|
|
+<h5 id="_description_27">Description</h5>
|
|
|
<div class="paragraph"><p>This method purges completed/error/removed downloads to free memory.
|
|
|
This method returns "OK".</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getVersion</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_getversion_strong"><strong>aria2.getVersion</strong> ()</h4>
|
|
|
+<h5 id="_description_28">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns version of the program and the list of enabled
|
|
|
features. The response is of type struct and contains following keys.</p></div>
|
|
|
<div class="dlist"><dl>
|
|
@@ -3999,7 +4026,8 @@ enabledFeatures
|
|
|
'XML-RPC'],
|
|
|
'version': '1.10.5'}</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.getSessionInfo</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_getsessioninfo_strong"><strong>aria2.getSessionInfo</strong> ()</h4>
|
|
|
+<h5 id="_description_29">Description</h5>
|
|
|
<div class="paragraph"><p>This method returns session information.
|
|
|
The response is of type struct and contains following key.</p></div>
|
|
|
<div class="dlist"><dl>
|
|
@@ -4019,13 +4047,16 @@ sessionId
|
|
|
>>> s.aria2.getSessionInfo()
|
|
|
{'sessionId': 'cd6a3bc6a1de28eb5bfa181e5f6b916d44af31a9'}</tt></pre>
|
|
|
</div></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.shutdown</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_shutdown_strong"><strong>aria2.shutdown</strong> ()</h4>
|
|
|
+<h5 id="_description_30">Description</h5>
|
|
|
<div class="paragraph"><p>This method shutdowns aria2. This method returns "OK".</p></div>
|
|
|
-<div class="paragraph"><p><strong>aria2.forceShutdown</strong> ()</p></div>
|
|
|
+<h4 id="_strong_aria2_forceshutdown_strong"><strong>aria2.forceShutdown</strong> ()</h4>
|
|
|
+<h5 id="_description_31">Description</h5>
|
|
|
<div class="paragraph"><p>This method shutdowns aria2. This method behaves like <strong>aria2.shutdown</strong>
|
|
|
except that any actions which takes time such as contacting BitTorrent
|
|
|
tracker are skipped. This method returns "OK".</p></div>
|
|
|
-<div class="paragraph"><p><strong>system.multicall</strong> (<em>methods</em>)</p></div>
|
|
|
+<h4 id="_strong_system_multicall_strong_em_methods_em"><strong>system.multicall</strong> (<em>methods</em>)</h4>
|
|
|
+<h5 id="_description_32">Description</h5>
|
|
|
<div class="paragraph"><p>This methods encapsulates multiple method calls in a single request.
|
|
|
<em>methods</em> is of type array and its element is struct. The struct
|
|
|
contains two keys: "methodName" and "params". "methodName" is the
|
|
@@ -4550,7 +4581,7 @@ files in the program, then also delete it here.</p></div>
|
|
|
<div id="footnotes"><hr /></div>
|
|
|
<div id="footer">
|
|
|
<div id="footer-text">
|
|
|
-Last updated 2010-10-30 18:35:50 JST
|
|
|
+Last updated 2010-10-30 18:54:38 JST
|
|
|
</div>
|
|
|
</div>
|
|
|
</body>
|