Represents the detailed status information of a download.
string GidGID of the download.
JSON key:
gid
StatusOptions StatusStatusOptions.Active for currently downloading/seeding downloads.StatusOptions.Waiting for downloads in the queue; download is not started.StatusOptions.Paused for paused downloads.StatusOptions.Error for downloads that were stopped because of error.StatusOptions.Complete for stopped and completed downloads.StatusOptions.Removed for the downloads removed by user.
JSON key:
status
long TotalLengthTotal length of the download in bytes.
JSON key:
totalLength
long CompletedLengthCompleted length of the download in bytes.
JSON key:
completedLength
long UploadLengthUploaded length of the download in bytes.
JSON key:
uploadLength
string BitfieldHexadecimal representation of the download progress. The highest bit corresponds to the piece at index 0. Any set bits indicate loaded pieces, while unset bits indicate not yet loaded and/or missing pieces. Any overflow bits at the end are set to zero. When the download was not started yet, this key will not be included in the response.
JSON key:
bitfield
long DownloadSpeedDownload speed of this download measured in bytes/sec.
JSON key:
downloadSpeed
long UploadSpeedUpload speed of this download measured in bytes/sec.
JSON key:
uploadSpeed
string InfoHashInfoHash. BitTorrent only.
JSON key:
infoHash
int NumSeedersThe number of seeders aria2 has connected to. BitTorrent only.
JSON key:
numSeeders
bool Seedertrue if the local endpoint is a seeder. Otherwise false. BitTorrent only.
JSON key:
seeder
long PieceLengthPiece length in bytes.
JSON key:
pieceLength
int NumPiecesThe number of pieces.
JSON key:
numPieces
int ConnectionsThe number of peers/servers aria2 has connected to.
JSON key:
connections
Aria2ErrorCode ErrorCodeThe code of the last error for this item, if any. This value is only available for stopped/completed downloads.
JSON key:
errorCode
string ErrorMessageThe (hopefully) human readable error message associated to ErrorCode.
JSON key:
errorMessage
System.Collections.Generic.IReadOnlyList<string>? FollowedByList of GIDs which are generated as the result of this download. For example, when aria2 downloads a Metalink file, it generates downloads described in the Metalink (see the Aria2DownloadOptions.FollowMetalink option). This value is useful to track auto-generated downloads. If there are no such downloads, this will be null.
JSON key:
followedBy
string FollowingThe reverse link for FollowedBy. A download included in FollowedBy has this object’s GID in its following value.
JSON key:
following
string BelongsToGID of a parent download. Some downloads are a part of another download. For example, if a file in a Metalink has BitTorrent resources, the downloads of “.torrent” files are parts of that parent. If this download has no parent, this key will not be included in the response.
JSON key:
belongsTo
string DirDirectory to save files.
JSON key:
dir
System.Collections.Generic.IReadOnlyList<Aria2.JsonRpcClient.Models.Aria2File>? FilesReturns the list of files.
JSON key:
files
Aria2Bittorrent BittorrentContains information retrieved from the .torrent (file). BitTorrent only.
JSON key:
bittorrent
long VerifiedLengthThe number of verified number of bytes while the files are being hash checked. This will be null unless this download is being hash checked.
JSON key:
verifiedLength
bool VerifyIntegrityPendingtrue if this download is waiting for the hash check in a queue. This will be null unless this download is in the queue.
JSON key:
verifyIntegrityPending