Interface PlaylistReplaceAllAndPlaySuccess

Successful response from playlist.replaceAllAndPlay.

interface PlaylistReplaceAllAndPlaySuccess {
    addedCount: number;
    clearedCount: number;
    playIndex: number;
    playlist: number;
    playlistGuid: string;
    success: true;
    totalCount: number;
}

Properties

addedCount: number

Tracks added.

clearedCount: number

Number of tracks removed.

playIndex: number

Row that was played or focused.

playlist: number

Index of the playlist.

playlistGuid: string

Unique identifier of the playlist, formatted as {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. Pass as playlistGuid to reliably target this playlist.

success: true

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

totalCount: number

Number of tracks afterwards.