foo-webview-sdk
    Preparing search index...

    Interface PlaylistAddCompletePayload

    Payload of the playlist:addComplete event. A playlist.addPathsAsync call finished adding its paths. Paths that need expanding (such as .cue or .m3u) are expanded first; when every path can be added directly, this follows the call at once. A call that was answered with an error sends nothing.

    interface PlaylistAddCompletePayload {
        addedCount: number;
        operationId: string;
        playlistGuid: string;
        reason?: "targetRemoved" | "locked";
        status: "failed" | "completed" | "cancelled" | "partial";
        success: boolean;
        totalCount: number;
    }
    Index
    addedCount operationId playlistGuid reason? status success totalCount
    addedCount: number

    Tracks added, after expanding playlists and cue sheets. Tracks dropped because the playlist was removed or locked before the expansion finished are not counted.

    operationId: string

    Id from the call's answer.

    playlistGuid: string

    GUID of the playlist the call added to, as the call resolved it; still that playlist when it was moved meanwhile, and no longer anyone's when it was removed.

    reason?: "targetRemoved" | "locked"

    Why tracks were dropped: the playlist was removed (targetRemoved) or locked (locked) before they could be added. Present with partial and failed.

    status: "failed" | "completed" | "cancelled" | "partial"

    completed when every track the paths resolved to was added. partial or failed when some or all of them were dropped, for the cause in reason; the dropped ones are normally the tracks expanded from playlist files and cue sheets, since plain files are added before the call returns. cancelled when the user cancelled the expansion; tracks added before that stay in the playlist.

    success: boolean

    Always true; status tells how the call ended.

    totalCount: number

    Paths the call accepted.

    Settings
    Member Visibility

    On This Page
    Properties