foo-webview-sdk
    Preparing search index...

    Interface PlaylistPlayTrackParams

    Parameters for playlist.playTrack. Play a row of a playlist, as double-clicking it does. A row past the last one fails with INVALID_INDEX. With deferred, expectedVersion is verified again before starting playback; if rows changed in between, playback is skipped.

    interface PlaylistPlayTrackParams {
        deferred?: boolean;
        expectedVersion?: string;
        index?: number;
        muted?: boolean;
        playlist?: number;
        playlistGuid?: string;
    }
    Index
    deferred? expectedVersion? index? muted? playlist? playlistGuid?
    deferred?: boolean

    Start the playback after the current message has been handled instead of before the call returns. The playlist is looked up again by its GUID when the playback starts: moved meanwhile, the same playlist plays; removed meanwhile, or shorter than index by then, nothing plays.

    false
    expectedVersion?: string

    Expected content version for optimistic concurrency control. When mismatched, mutations are aborted with STALE_TARGET (details.current carries current version). Omitted, no check is made.

    index?: number

    Row to play.

    0
    muted?: boolean

    Mute before starting, so a page that sets the volume right afterwards leaves no audible gap. The mute is not undone by this call.

    false
    playlist?: number

    Index of the playlist; omitted, the active playlist. An index past the last playlist fails with INVALID_INDEX; with this omitted and no active playlist the call fails with NO_ACTIVE_ITEM.

    playlistGuid?: string

    Persistent unique identifier of a playlist (bracketed GUID, case-insensitive), used in place of a mutable index. Mutually exclusive with playlist; passing both or an invalid format fails with INVALID_PARAMS. Fails with NOT_FOUND if the playlist does not exist, never falling back. Invalid-format and not-found failures return the given GUID in details.playlistGuid.

    Settings
    Member Visibility

    On This Page
    Properties