Interface PlaystateApiOnPlaybackProgressRequest

Request parameters for onPlaybackProgress operation in PlaystateApi.

Export

PlaystateApiOnPlaybackProgressRequest

interface PlaystateApiOnPlaybackProgressRequest {
    audioStreamIndex?: number;
    isMuted?: boolean;
    isPaused?: boolean;
    itemId: string;
    liveStreamId?: string;
    mediaSourceId?: string;
    playMethod?: PlayMethod;
    playSessionId?: string;
    positionTicks?: number;
    repeatMode?: RepeatMode;
    subtitleStreamIndex?: number;
    volumeLevel?: number;
}

Properties

audioStreamIndex? isMuted? isPaused? itemId liveStreamId? mediaSourceId? playMethod? playSessionId? positionTicks? repeatMode? subtitleStreamIndex? volumeLevel?

Properties

Optional ReadonlyaudioStreamIndex

audioStreamIndex?: number

The audio stream index.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyisMuted

isMuted?: boolean

Indicates if the player is muted.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyisPaused

isPaused?: boolean

Indicates if the player is paused.

Memberof

PlaystateApiOnPlaybackProgress

ReadonlyitemId

itemId: string

Item id.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyliveStreamId

liveStreamId?: string

The live stream id.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlymediaSourceId

mediaSourceId?: string

The id of the MediaSource.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyplayMethod

playMethod?: PlayMethod

The play method.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyplaySessionId

playSessionId?: string

The play session id.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlypositionTicks

positionTicks?: number

Optional. The current position, in ticks. 1 tick = 10000 ms.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyrepeatMode

repeatMode?: RepeatMode

The repeat mode.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlysubtitleStreamIndex

subtitleStreamIndex?: number

The subtitle stream index.

Memberof

PlaystateApiOnPlaybackProgress

Optional ReadonlyvolumeLevel

volumeLevel?: number

Scale of 0-100.

Memberof

PlaystateApiOnPlaybackProgress

Settings

Member Visibility

On This Page

Properties