Sign in

v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
MediaInfo

Gets live playback media info for an item.

For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.

post/Items/{itemId}/PlaybackInfo

Path parameters

itemIdstring uuid required

The item id.

The item id.

Query parameters

userIdstring uuid nullable

The user id.

The user id.

maxStreamingBitrateinteger nullable

The maximum streaming bitrate.

The maximum streaming bitrate.

startTimeTicksinteger nullable

The start time in ticks.

The start time in ticks.

audioStreamIndexinteger nullable

The audio stream index.

The audio stream index.

subtitleStreamIndexinteger nullable

The subtitle stream index.

The subtitle stream index.

maxAudioChannelsinteger nullable

The maximum number of audio channels.

The maximum number of audio channels.

mediaSourceIdstring nullable

The media source id.

The media source id.

liveStreamIdstring nullable

The livestream id.

The livestream id.

autoOpenLiveStreamboolean nullable

Whether to auto open the livestream.

Whether to auto open the livestream.

enableDirectPlayboolean nullable

Whether to enable direct play. Default: true.

Whether to enable direct play. Default: true.

enableDirectStreamboolean nullable

Whether to enable direct stream. Default: true.

Whether to enable direct stream. Default: true.

enableTranscodingboolean nullable

Whether to enable transcoding. Default: true.

Whether to enable transcoding. Default: true.

allowVideoStreamCopyboolean nullable

Whether to allow to copy the video stream. Default: true.

Whether to allow to copy the video stream. Default: true.

allowAudioStreamCopyboolean nullable

Whether to allow to copy the audio stream. Default: true.

Whether to allow to copy the audio stream. Default: true.

Request body

UserIdstring uuid nullable

Gets or sets the playback userId.

MaxStreamingBitrateinteger nullable

Gets or sets the max streaming bitrate.

StartTimeTicksinteger nullable

Gets or sets the start time in ticks.

AudioStreamIndexinteger nullable

Gets or sets the audio stream index.

SubtitleStreamIndexinteger nullable

Gets or sets the subtitle stream index.

MaxAudioChannelsinteger nullable

Gets or sets the max audio channels.

MediaSourceIdstring nullable

Gets or sets the media source id.

LiveStreamIdstring nullable

Gets or sets the live stream id.

EnableDirectPlayboolean nullable

Gets or sets a value indicating whether to enable direct play.

EnableDirectStreamboolean nullable

Gets or sets a value indicating whether to enable direct stream.

EnableTranscodingboolean nullable

Gets or sets a value indicating whether to enable transcoding.

AllowVideoStreamCopyboolean nullable

Gets or sets a value indicating whether to enable video stream copy.

AllowAudioStreamCopyboolean nullable

Gets or sets a value indicating whether to allow audio stream copy.

AutoOpenLiveStreamboolean nullable

Gets or sets a value indicating whether to auto open the live stream.

Response

Playback info returned.

PlaySessionIdstring nullable

Gets or sets the play session identifier.

ErrorCode'NotAllowed' | 'NoCompatibleStream' | 'RateLimitExceeded'