Interface LibraryGetRootsSuccess

Successful response from library.getRoots.

interface LibraryGetRootsSuccess {
    enabled: boolean;
    fromCache: boolean;
    indexedTracks: number;
    roots: LibraryRootInfo[];
    skippedTracks: number;
    success: true;
    total: number;
}

Properties

enabled: boolean

Whether the media library is enabled.

fromCache: boolean

true when the index already existed before this call.

indexedTracks: number

Tracks placed under a root.

The root folders.

skippedTracks: number

Tracks left out because they have no stable local path.

success: true

Always true here; a failed call resolves with ApiFailure instead.

total: number

Number of roots.