Aria2.JsonRpcClient

Aria2.JsonRpcClient Documentation - Home | Client | Requests | Models | Examples

Aria2File Model


Overview

Represents a file within a download.


Properties

int Index

Index of the file, starting at 1, in the same order as files appear in the multi-file torrent.

JSON key: index

string Path

File path.

JSON key: path

long Length

File size in bytes.

JSON key: length

long CompletedLength

Completed length of this file in bytes. Please note that it is possible that sum of CompletedLength is less than the returned by the IAria2Client.GetFiles method. This is because completedLength in IAria2Client.GetFiles only includes completed pieces. On the other hand, completedLength in IAria2Client.TellStatus(string, string[], string?) also includes partially completed pieces.

JSON key: completedLength

bool Selected

true if this file is selected by Aria2DownloadOptions.SelectFile option. IfAria2DownloadOptions.SelectFile is not specified or this is single-file torrent or not a torrent download at all, this value is always true. Otherwise false.

JSON key: selected

System.Collections.Generic.IReadOnlyList<Aria2.JsonRpcClient.Models.Aria2Uri>? Uris

Returns a list of URIs for this file.

JSON key: uris


Top
© lantean-code - Generated on 2025-04-02