窗口程序集名 | 保 留 | 保 留 | 备 注 |
Aria2, , 公开 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
绑定_RPC实时通知回调 | 绑定实时通知回调 | ||||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
回调函数 | 子程序指针 | 一个文本参数 [无返回值] 回调子程序 (消息数据 [文本型]) |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
保存会话_SaveSession | 文本型 | aria2.saveSession,此方法将当前会话保存到--save-session(位于常量 #选项设置_状态保存文件)选项指定的文件中,成功返回OK |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
初始化 | 整数型 | 初始化一个Aria2子进程,并返回子进程进程ID,aria2子进程默认会随父进程,父进程退出,aria2子进程会自动退出 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
RPC端口 | 整数型 | RPC密钥 | 文本型 | rpc-secret 选项得设置。该参数为空则默认不设置 | 命令行扩展配置 | Aria2_命令行 | 调试模式 | 逻辑型 | 为真则显示aria2控制台调试窗口 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
创建URL单任务 | 文本型 | 返回GID文本 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
URL | 文本型 | 文件重命名 | 文本型 | 重命名任务的文件名 | 选项设置 | zyJsonValue | 单独选项设置,如:选项设置.置属性 (, #选项设置_最大尝试次数, 选项设置.创建长整数 (0)) |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
创建URL多任务 | 多任务信息_GID | 返回多任务信息_GID | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
参数 | Aria2_多任务URL_列表 | Aria2_多任务URL_列表 | 选项设置 | zyJsonValue | 单独选项设置,如:选项设置.置属性 (, #选项设置_最大尝试次数, 选项设置.创建长整数 (0)) |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
恢复所有任务 | 文本型 | aria2.unpauseAll,成功返回OK,恢复所有被暂停得任务 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
恢复指定任务 | 文本型 | aria2.unpause,成功返回已恢复任务的GID。恢复被暂停得任务 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取版本信息 | zyJsonValue | aria2.getVersion,返回一个JSON结构结果,版本和启用的功能列表 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取错误信息 | 文本型 | ||||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
错误代码 | 整数型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取会话信息_SessionInfo | zyJsonValue | aria2.getSessionInfo,返回一个JSON结构结果,返回会话信息 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取全局_统计信息 | zyJsonValue | aria2.getGlobalStat,返回一个JSON结构结果,统计信息 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取全局_选项设置信息 | zyJsonValue | aria2.getGlobalOption,返回一个JSON结构结果,全局选项设置信息 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取全局任务进度_等待中 | zyJsonValue | aria2.tellWaiting,返回当前全局等待中的任务进度信息 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
起始偏移 | 整数型 | 从状态为等待中的任务进度队列中何处开始取。从0开始计算,表示正序第一个,如果要倒着取,则从-1开始,-1为倒数第一个,-2为倒数第二个 | 返回结果_最大值 | 整数型 | 返回结果的最大数,如等待中的任务有10个,最大值填5,则返回5条,若只有2个任务,最大值填5,则返回2条 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取全局任务进度_下载中 | zyJsonValue | aria2.tellActive,返回当前全局正在下载的任务进度信息 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取全局任务进度_已停止 | zyJsonValue | aria2.tellStopped,返回当前全局已停止的任务进度信息 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
起始偏移 | 整数型 | 从状态为已停止的任务进度队列中何处开始取。从0开始计算,表示正序第一个,如果要倒着取,则从-1开始,-1为倒数第一个,-2为倒数第二个 | 返回结果_最大值 | 整数型 | 返回结果的最大数,如已停止的任务有10个,最大值填5,则返回5条,若只有2个任务,最大值填5,则返回2条 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取系统_所有的RPC方法 | zyJsonValue | system.listMethods,返回一个JSON结构结果,返回所有可用的 RPC 方法 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
取系统_所有的RPC通知 | zyJsonValue | system.listMethods,返回一个JSON结构结果,返回所有可用的 RPC 通知 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_BT下载节点列表 | zyJsonValue | aria2.getPeers,返回一个JSON结构结果,此方法仅适用于 BitTorrent | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_URI列表 | zyJsonValue | aria2.getUris,返回一个JSON结构结果 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_当前连接的服务器信息 | zyJsonValue | aria2.getServers,返回一个JSON结构结果,获取当前连接的 HTTP(S)/FTP/SFTP 服务器 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_下载进度信息 | zyJsonValue | aria2.tellStatus,返回下载进度信息,更多参考常量:#说明_取指定任务下载进度 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 | 创建任务返回的GID信息 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_下载文件列表 | zyJsonValue | aria2.getFiles,返回一个JSON结构结果,一般用于获取BT文件列表 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
取指定任务_选项设置 | zyJsonValue | aria2.getOption,返回一个JSON结构结果,该任务的选项设置信息 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
删除指定任务 | 文本型 | 成功返回已删除任务的GID | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 | 强制模式 | 逻辑型 | 默认假,类似于aria2.remove ,如设置真,则类似于aria2.forceRemove |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
设置全局_选项设置 | 文本型 | aria2.changeGlobalOption,成功返回字符串OK | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
选项设置 | zyJsonValue | 单独选项设置,如:选项设置.置属性 (, #选项设置_最大尝试次数, 选项设置.创建长整数 (0)) |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
设置指定任务_队列位置 | 整数型 | aria2.changePosition,返回当前已变更得任务队列位置 | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 | 队列位置 | 整数型 | 队列位置以0开始计算。例如GID为A的任务当前队列位置在3,队列位置设为1,模式为:POS_SET,队列将变更为1。如果模式为:POS_CUR,队列设置-1,则队列变更为2 | 队列设置1,则队列变更为4。以此类推 | 操作模式 | 文本型 | 三种模式:POS_SET(相对于队列起始位置),POS_CUR(相对于队列当前位置),POS_END(相对于队列末尾位置) ,默认值:POS_SET |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
设置指定任务_选项设置 | 文本型 | aria2.changeOption,成功返回字符串OK | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 | 选项设置 | zyJsonValue | 单独选项设置,如:选项设置.置属性 (, #选项设置_最大尝试次数, 选项设置.创建长整数 (0)) |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
暂停所有任务 | 文本型 | aria2.pauseAll,暂停当前所有任务,成功返回OK |
子程序名 | 返回值类型 | 公开 | 备 注 | ||
暂停所有任务_强制 | 文本型 | aria2.forcePauseAll,强制暂停当前所有任务,成功返回OK |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
暂停指定任务 | 文本型 | aria2.pause/aria2.forcePause 成功返回已暂停任务的GID | |||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
GID | 文本型 | 强制模式 | 逻辑型 | 默认假,类似于aria2.pause ,如设置真,则类似于aria2.forcePause |
子程序名 | 返回值类型 | 公开 | 备 注 | ||||
置调试模式_请求日志 | |||||||
参数名 | 类 型 | 参考 | 可空 | 数组 | 备 注 | ||
是否显示调试日志 | 逻辑型 |
常量名称 | 常量值 | 公 开 | 备 注 | ||
文件分配方法_不分配 | “none” | √ | |||
文件分配方法_快速分配 | “falloc” | √ | |||
文件分配方法_快速预先分配零字节 | “trunc” | √ | |||
文件分配方法_预先分配 | “prealloc” | √ | |||
选项设置_BT_保存种子文件 | “bt-save-metadata” | √ | 74 //保存种子文件为 ".torrent" 文件. 此选项仅对磁链生效. 文件名为十六进制编码后的哈希值及 ".torrent"后缀. 保存的目录与下载文件的目录相同. 如果相同的文件已存在, 种子文件将不会保存. | ||
选项设置_BT_不检查已经下载的文件 | “bt-seed-unverified” | √ | 75 //不检查之前下载文件中每个分片的哈希值. | ||
选项设置_BT_分离仅做种任务 | “bt-detach-seed-only” | √ | 58 //统计当前活动下载任务(参见 -j 选项) 时排除仅做种的任务. 这意味着, 如果参数设置为 -j3, 此选项打开并且当前有 3 个正在活动的任务, 并且其中有 1 个进入做种模式, 那么其会从正在下载的数量中排除(即数量会变为 2), 在队列中等待的下一个任务将会开始执行. 但要知道, 在 RPC 方法中, 做种的任务仍然被认为是活动的下载任务. | ||
选项设置_BT_服务器超时时间 | “bt-tracker-timeout” | √ | 80 // | ||
选项设置_BT_服务器地址 | “bt-tracker” | √ | 77 //逗号分隔的 BT 服务器地址. 这些地址不受 --bt-exclude-tracker 选项的影响, 因为这些地址在 --bt-exclude-tracker 选项排除掉其他地址之后才会添加. | ||
选项设置_BT_服务器连接超时时间 | “bt-tracker-connect-timeout” | √ | 78 //设置 BT 服务器的连接超时时间 (秒). 当连接建立后, 此选项不再生效, 请使用 --bt-tracker-timeout 选项. | ||
选项设置_BT_服务器连接间隔时间 | “bt-tracker-interval” | √ | 79 //设置请求 BT 服务器的间隔时间 (秒). 此选项将完全覆盖服务器返回的最小间隔时间和间隔时间, aria2 仅使用此选项的值.如果设置为 0, aria2 将根据服务器的响应情况和下载进程决定时间间隔. | ||
选项设置_BT_加载已保存的元数据文件 | “bt-load-saved-metadata” | √ | 65 //当使用磁链下载时, 在从 DHT 获取种子元数据之前, 首先尝试加载使用 --bt-save-metadata 选项保存的文件. 如果文件加载成功, 则不会从 DHT 下载元数据. | ||
选项设置_BT_仅下载种子文件 | “bt-metadata-only” | √ | 68 //仅下载种子文件. 种子文件中描述的文件将不会下载. 此选项仅对磁链生效. | ||
选项设置_BT_排除服务器地址 | “bt-exclude-tracker” | √ | 61 //逗号分隔的 BT 排除服务器地址. 您可以使用 * 匹配所有地址, 因此将排除所有服务器地址. 当在 shell 命令行使用 * 时, 需要使用转义符或引号. | ||
选项设置_BT_期望下载速度 | “bt-request-peer-speed-limit” | √ | 73 //如果一个 BT 下载的整体下载速度低于此选项设置的值, aria2 会临时提高连接数以提高下载速度. 在某些情况下, 设置期望下载速度可以提高您的下载速度. 您可以增加数值的单位 K 或 M (1K = 1024, 1M = 1024K). | ||
选项设置_BT_启用本地节点发现__LPD | “bt-enable-lpd” | √ | 60 // | ||
选项设置_BT_启用哈希检查完成事件 | “bt-enable-hook-after-hash-check” | √ | 59 //允许 BT 下载哈希检查(参见 -V 选项) 完成后调用命令. 默认情况下, 当哈希检查成功后, 通过 --on-bt-download-complete 设置的命令将会被执行. 如果要禁用此行为, 请设置为"否". | ||
选项设置_BT_强制加密 | “bt-force-encryption” | √ | 63 //BT 消息中的内容需要使用 arc4 加密. 此选项是设置 --bt-require-crypto --bt-min-crypto-level=arc4 这两个选项的快捷方式. 此选项不会修改上述两个选项的内容. 如果设置为"是", 将拒绝以前的 BT 握手, 并仅使用模糊握手及加密消息. | ||
选项设置_BT_删除未选择的文件 | “bt-remove-unselected-file” | √ | 71 //当 BT 任务完成后删除未选择的文件. 要选择需要下载的文件, 请使用 --select-file 选项. 如果没有选择, 则所有文件都默认为需要下载. 此选项会从磁盘上直接删除文件, 请谨慎使用此选项. | ||
选项设置_BT_外部_IP_地址 | “bt-external-ip” | √ | 62 //指定用在 BitTorrent 下载和 DHT 中的外部 IP 地址. 它可能被发送到 BitTorrent 服务器. 对于 DHT, 此选项将会报告本地节点正在下载特定的种子. 这对于在私有网络中使用 DHT 非常关键. 虽然这个方法叫外部, 但其可以接受各种类型的 IP 地址. | ||
选项设置_BT_无速度时自动停止时间 | “bt-stop-timeout” | √ | 76 //当 BT 任务下载速度持续为 0, 达到此选项设置的时间后停止下载. 如果设置为 0, 此功能将禁用. | ||
选项设置_BT_需要加密 | “bt-require-crypto” | √ | 72 //如果设置为"是", aria 将不会接受以前的 BitTorrent 握手协议(\19BitTorrent 协议)并建立连接. 因此 aria2 总是模糊握手. | ||
选项设置_BT_优先下载 | “bt-prioritize-piece” | √ | 70 //尝试先下载每个文件开头或结尾的分片. 此选项有助于预览文件. 参数可以包括两个关键词: head 和 tail. 如果包含两个关键词, 需要使用逗号分隔. 每个关键词可以包含一个参数, SIZE. 例如, 如果指定 head=SIZE, 每个文件的最前 SIZE 数据将会获得更高的优先级. tail=SIZE 表示每个文件的最后 SIZE 数据. SIZE 可以包含 K 或 M (1K = 1024, 1M = 1024K). | ||
选项设置_BT_最大连接节点数 | “bt-max-peers” | √ | 67 //设置每个 BT 下载的最大连接节点数. 0 表示不限制. | ||
选项设置_BT_最低加密级别 | “bt-min-crypto-level” | √ | 69 //设置加密方法的最小级别. 如果节点提供多种加密方法, aria2 将选择满足给定级别的最低级别. | ||
选项设置_BT_最多打开文件数 | “bt-max-open-files” | √ | 66 //设置 BT/Metalink 下载全局打开的最大文件数. | ||
选项设置_BT_做种前检查文件哈希 | “bt-hash-check-seed” | √ | 64 //如果设置为"是", 当使用 --check-integrity 选项完成哈希检查及文件完成后才继续做种. 如果您希望仅当文件损坏或未完成时检查文件, 请设置为"否". 此选项仅对 BT 下载有效 | ||
选项设置_Cookies_保存路径 | “save-cookies” | √ | 46 //以 Mozilla/Firefox(1.x/2.x)/Netscape 格式将 Cookies 保存到文件中. 如果文件已经存在, 将被覆盖. 会话过期的 Cookies 也将会保存, 其过期时间将会设置为 0. | ||
选项设置_DHT_IPv4_文件 | “dht-file-path” | √ | 81 //修改 IPv4 DHT 路由表文件路径. | ||
选项设置_DHT_IPv6_文件 | “dht-file-path6” | √ | 82 //修改 IPv6 DHT 路由表文件路径. | ||
选项设置_DHT_监听端口 | “dht-listen-port” | √ | 83 //设置 DHT (IPv4, IPv6) 和 UDP 服务器使用的 UCP 端口. 多个端口可以使用逗号 "," 分隔, 例如: 6881,6885. 您还可以使用短横线 "-" 表示范围: 6881-6999, 或可以一起使用: 6881-6889, 6999. | ||
选项设置_DHT_消息超时时间 | “dht-message-timeout” | √ | 84 // | ||
选项设置_DSCP | “dscp” | √ | 127 //为 QoS 设置 BT 上行 IP 包的 DSCP 值. 此参数仅设置 IP 包中 TOS 字段的 DSCP 位, 而不是整个字段. 如果您从 /usr/include/netinet/ip.h 得到的值, 需要除以 4 (否则值将不正确, 例如您的 CS1 类将会转为 CS4). 如果您从 RFC, 网络供应商的文档, 维基百科或其他来源采取常用的值, 可以直接使用. | ||
选项设置_FTP_被动模式 | “ftp-pasv” | √ | 51 //在 FTP 中使用被动模式. 如果设置为"否", 则使用主动模式. 此选项不适用于 SFTP 传输. | ||
选项设置_FTP_传输类型 | “ftp-type” | √ | 55 // | ||
选项设置_FTP_代理服务器 | “ftp-proxy” | √ | 52 // | ||
选项设置_FTP_代理服务器密码 | “ftp-proxy-passwd” | √ | 54 // | ||
选项设置_FTP_代理服务器用户名 | “ftp-proxy-user” | √ | 53 // | ||
选项设置_FTP_连接复用 | “ftp-reuse-connection” | √ | 56 // | ||
选项设置_FTP_默认密码 | “ftp-passwd” | √ | 50 //如果 URI 中包含用户名单不包含密码, aria2 首先会从 .netrc 文件中获取密码. 如果在 .netrc 文件中找到密码, 则使用该密码. 否则, 使用此选项设置的密码. | ||
选项设置_FTP_默认用户名 | “ftp-user” | √ | 49 // | ||
选项设置_HTTP_代理服务器 | “http-proxy” | √ | 36 // | ||
选项设置_HTTP_代理服务器密码 | “http-proxy-passwd” | √ | 38 // | ||
选项设置_HTTP_代理服务器用户名 | “http-proxy-user” | √ | 37 // | ||
选项设置_HTTP_禁用缓存 | “http-no-cache” | √ | 33 //发送的请求头中将包含 Cache-Control: no-cache 和 Pragma: no-cache header 以避免内容被缓存. 如果设置为"否", 上述请求头将不会发送, 同时您也可以使用 --header 选项将 Cache-Control 请求头添加进去. | ||
选项设置_HTTP_默认密码 | “http-passwd” | √ | 35 // | ||
选项设置_HTTP_默认用户名 | “http-user” | √ | 34 // | ||
选项设置_HTTP_认证质询 | “http-auth-challenge” | √ | 32 //仅当服务器需要时才发送 HTTP 认证请求头. 如果设置为"否", 每次都会发送认证请求头. 例外: 如果用户名和密码包含在 URI 中, 将忽略此选项并且每次都会发送认证请求头. | ||
选项设置_HTTP_支持_GZip | “http-accept-gzip” | √ | 31 //如果远程服务器的响应头中包含 Content-Encoding: gzip 或 Content-Encoding: deflate , 将发送包含 Accept: deflate, gzip 的请求头并解压缩响应. | ||
选项设置_HTTPS_代理服务器 | “https-proxy” | √ | 39 // | ||
选项设置_HTTPS_代理服务器密码 | “https-proxy-passwd” | √ | 41 // | ||
选项设置_HTTPS_代理服务器用户名 | “https-proxy-user” | √ | 40 // | ||
选项设置_Metalink_版本号 | “metalink-version” | √ | 101 //下载文件的版本号. | ||
选项设置_Metalink_操作系统 | “metalink-os” | √ | 100 //下载文件的操作系统. | ||
选项设置_Metalink_基础_URI | “metalink-base-uri” | √ | 97 //指定基础 URI 以便解析本地磁盘中存储的 Metalink 文件里 metalink:url 和 metalink:metaurl 中的相对 URI 地址. 如果 URI 表示的为目录, 最后需要以 / 结尾. | ||
选项设置_Metalink_仅使用唯一协议 | “metalink-enable-unique-protocol” | √ | 103 //如果一个 Metalink 文件可用多种协议, 并且此选项设置为"是", aria2 将只会使用其中一种. 使用 --metalink-preferred-protocol 参数指定首选的协议. | ||
选项设置_Metalink_首选服务器位置 | “metalink-location” | √ | 99 //首选服务器所在的位置. 可以使用逗号分隔的列表, 例如: jp,us. | ||
选项设置_Metalink_首选使用协议 | “metalink-preferred-protocol” | √ | 102 //指定首选使用的协议. 可以设置为 http, https, ftp 或"无". 设置为"无"时禁用此选项. | ||
选项设置_Metalink_语言 | “metalink-language” | √ | 98 // | ||
选项设置_MMap_最大限制 | “max-mmap-limit” | √ | 139 //设置启用 MMap (参见 --enable-mmap 选项) 最大的文件大小. 文件大小由一个下载任务中所有文件大小的和决定. 例如, 如果一个下载包含 5 个文件, 那么文件大小就是这些文件的总大小. 如果文件大小超过此选项设置的大小时, MMap 将会禁用. |