Interface SessionApiPlayRequest

Request parameters for play operation in SessionApi.

Export

SessionApiPlayRequest

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

Properties

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

Properties

Optional ReadonlyaudioStreamIndex

audioStreamIndex?: number

Optional. The index of the audio stream to play.

Memberof

SessionApiPlay

ReadonlyitemIds

itemIds: string[]

The ids of the items to play, comma delimited.

Memberof

SessionApiPlay

Optional ReadonlymediaSourceId

mediaSourceId?: string

Optional. The media source id.

Memberof

SessionApiPlay

ReadonlyplayCommand

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.

Memberof

SessionApiPlay

ReadonlysessionId

sessionId: string

The session id.

Memberof

SessionApiPlay

Optional ReadonlystartIndex

startIndex?: number

Optional. The start index.

Memberof

SessionApiPlay

Optional ReadonlystartPositionTicks

startPositionTicks?: number

The starting position of the first item.

Memberof

SessionApiPlay

Optional ReadonlysubtitleStreamIndex

subtitleStreamIndex?: number

Optional. The index of the subtitle stream to play.

Memberof

SessionApiPlay

Settings

Member Visibility

On This Page

Properties