@jellyfin/sdk
    Preparing search index...

    Interface SessionApiPlayRequest

    Request parameters for play operation in SessionApi.

    SessionApiPlayRequest

    interface SessionApiPlayRequest {
        audioStreamIndex?: number;
        itemIds: string[];
        mediaSourceId?: string;
        playCommand: PlayCommand;
        sessionId: string;
        startIndex?: number;
        startPositionTicks?: number;
        subtitleStreamIndex?: number;
    }
    Index

    Properties

    audioStreamIndex? itemIds mediaSourceId? playCommand sessionId startIndex? startPositionTicks? subtitleStreamIndex?

    Properties

    audioStreamIndex?: number

    Optional. The index of the audio stream to play.

    SessionApiPlay

    itemIds: string[]

    The ids of the items to play, comma delimited.

    SessionApiPlay

    mediaSourceId?: string

    Optional. The media source id.

    SessionApiPlay

    playCommand: PlayCommand

    The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.

    SessionApiPlay

    sessionId: string

    The session id.

    SessionApiPlay

    startIndex?: number

    Optional. The start index.

    SessionApiPlay

    startPositionTicks?: number

    The starting position of the first item.

    SessionApiPlay

    subtitleStreamIndex?: number

    Optional. The index of the subtitle stream to play.

    SessionApiPlay

    Settings

    Member Visibility

    On This Page

    Properties