Gets live playback media info for an item.

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

请求参数

Authorization

在 header 添加参数

X-Emby-Token

示例：

X-Emby-Token: ********************

Path 参数

itemId

string <uuid>

必需

The item id.

Query 参数

userId

string <uuid>

可选

The user id.

maxStreamingBitrate

integer <int32>

可选

The maximum streaming bitrate.

startTimeTicks

integer <int64>

可选

The start time in ticks.

audioStreamIndex

integer <int32>

可选

The audio stream index.

subtitleStreamIndex

integer <int32>

可选

The subtitle stream index.

maxAudioChannels

integer <int32>

可选

The maximum number of audio channels.

mediaSourceId

string

可选

The media source id.

liveStreamId

string

可选

The livestream id.

autoOpenLiveStream

boolean

可选

Whether to auto open the livestream.

enableDirectPlay

boolean

可选

Whether to enable direct play. Default: true.

enableDirectStream

boolean

可选

Whether to enable direct stream. Default: true.

enableTranscoding

boolean

可选

Whether to enable transcoding. Default: true.

allowVideoStreamCopy

boolean

可选

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

allowAudioStreamCopy

boolean

可选

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

Body 参数application/json

Plabyback info dto.

UserId

string <uuid> | null

可选

Gets or sets the playback userId.

MaxStreamingBitrate

integer <int32> | null

可选

Gets or sets the max streaming bitrate.

StartTimeTicks

integer <int64> | null

可选

Gets or sets the start time in ticks.

AudioStreamIndex

integer <int32> | null

可选

Gets or sets the audio stream index.

SubtitleStreamIndex

integer <int32> | null

可选

Gets or sets the subtitle stream index.

MaxAudioChannels

integer <int32> | null

可选

Gets or sets the max audio channels.

MediaSourceId

string | null

可选

Gets or sets the media source id.

LiveStreamId

string | null

可选

Gets or sets the live stream id.

DeviceProfile

null | allOf {1}

可选

Gets or sets the device profile.

object (DeviceProfile)

可选

A MediaBrowser.Model.Dlna.DeviceProfile represents a set of metadata which determines which content a certain device is able to play.

Specifically, it defines the supported and
(video and/or audio, including codec profiles and levels)
the device is able to direct play (without transcoding or remuxing),
as well as which in case it isn't.

EnableDirectPlay

boolean | null

可选

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

EnableDirectStream

boolean | null

可选

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

EnableTranscoding

boolean | null

可选

Gets or sets a value indicating whether to enable transcoding.

AllowVideoStreamCopy

boolean | null

可选

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

AllowAudioStreamCopy

boolean | null

可选

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

AutoOpenLiveStream

boolean | null

可选

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

AlwaysBurnInSubtitleWhenTranscoding

boolean | null

可选

Gets or sets a value indicating whether always burn in subtitles when transcoding.

示例

{
    "UserId": "08ba1929-681e-4b24-929b-9245852f65c0",
    "MaxStreamingBitrate": 0,
    "StartTimeTicks": 0,
    "AudioStreamIndex": 0,
    "SubtitleStreamIndex": 0,
    "MaxAudioChannels": 0,
    "MediaSourceId": "string",
    "LiveStreamId": "string",
    "DeviceProfile": {
        "Name": "string",
        "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
        "MaxStreamingBitrate": 0,
        "MaxStaticBitrate": 0,
        "MusicStreamingTranscodingBitrate": 0,
        "MaxStaticMusicBitrate": 0,
        "DirectPlayProfiles": [
            {
                "Container": "string",
                "AudioCodec": "string",
                "VideoCodec": "string",
                "Type": "Audio"
            }
        ],
        "TranscodingProfiles": [
            {
                "Container": "string",
                "Type": "Audio",
                "VideoCodec": "string",
                "AudioCodec": "string",
                "Protocol": "http",
                "EstimateContentLength": false,
                "EnableMpegtsM2TsMode": false,
                "TranscodeSeekInfo": "Auto",
                "CopyTimestamps": false,
                "Context": "Streaming",
                "EnableSubtitlesInManifest": false,
                "MaxAudioChannels": "string",
                "MinSegments": 0,
                "SegmentLength": 0,
                "BreakOnNonKeyFrames": false,
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "EnableAudioVbrEncoding": true
            }
        ],
        "ContainerProfiles": [
            {
                "Type": "Audio",
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "Container": "string",
                "SubContainer": "string"
            }
        ],
        "CodecProfiles": [
            {
                "Type": "Video",
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "ApplyConditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "Codec": "string",
                "Container": "string",
                "SubContainer": "string"
            }
        ],
        "SubtitleProfiles": [
            {
                "Format": "string",
                "Method": "Encode",
                "DidlMode": "string",
                "Language": "string",
                "Container": "string"
            }
        ]
    },
    "EnableDirectPlay": true,
    "EnableDirectStream": true,
    "EnableTranscoding": true,
    "AllowVideoStreamCopy": true,
    "AllowAudioStreamCopy": true,
    "AutoOpenLiveStream": true,
    "AlwaysBurnInSubtitleWhenTranscoding": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/Items//PlaybackInfo' \
--header 'Content-Type: application/json' \
--header 'X-Emby-Token;' \
--data-raw '{
    "UserId": "08ba1929-681e-4b24-929b-9245852f65c0",
    "MaxStreamingBitrate": 0,
    "StartTimeTicks": 0,
    "AudioStreamIndex": 0,
    "SubtitleStreamIndex": 0,
    "MaxAudioChannels": 0,
    "MediaSourceId": "string",
    "LiveStreamId": "string",
    "DeviceProfile": {
        "Name": "string",
        "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
        "MaxStreamingBitrate": 0,
        "MaxStaticBitrate": 0,
        "MusicStreamingTranscodingBitrate": 0,
        "MaxStaticMusicBitrate": 0,
        "DirectPlayProfiles": [
            {
                "Container": "string",
                "AudioCodec": "string",
                "VideoCodec": "string",
                "Type": "Audio"
            }
        ],
        "TranscodingProfiles": [
            {
                "Container": "string",
                "Type": "Audio",
                "VideoCodec": "string",
                "AudioCodec": "string",
                "Protocol": "http",
                "EstimateContentLength": false,
                "EnableMpegtsM2TsMode": false,
                "TranscodeSeekInfo": "Auto",
                "CopyTimestamps": false,
                "Context": "Streaming",
                "EnableSubtitlesInManifest": false,
                "MaxAudioChannels": "string",
                "MinSegments": 0,
                "SegmentLength": 0,
                "BreakOnNonKeyFrames": false,
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "EnableAudioVbrEncoding": true
            }
        ],
        "ContainerProfiles": [
            {
                "Type": "Audio",
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "Container": "string",
                "SubContainer": "string"
            }
        ],
        "CodecProfiles": [
            {
                "Type": "Video",
                "Conditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "ApplyConditions": [
                    {
                        "Condition": "Equals",
                        "Property": "AudioChannels",
                        "Value": "string",
                        "IsRequired": true
                    }
                ],
                "Codec": "string",
                "Container": "string",
                "SubContainer": "string"
            }
        ],
        "SubtitleProfiles": [
            {
                "Format": "string",
                "Method": "Encode",
                "DidlMode": "string",
                "Language": "string",
                "Container": "string"
            }
        ]
    },
    "EnableDirectPlay": true,
    "EnableDirectStream": true,
    "EnableTranscoding": true,
    "AllowVideoStreamCopy": true,
    "AllowAudioStreamCopy": true,
    "AutoOpenLiveStream": true,
    "AlwaysBurnInSubtitleWhenTranscoding": true
}'

返回响应

🟢200成功

application/json

Playback info returned.

Body

Class PlaybackInfoResponse.

MediaSources

array[object (MediaSourceInfo) {45}]

可选

Gets or sets the media sources.

Protocol

enum<string>

可选

枚举值:

FileHttpRtmpRtspUdpRtpFtp

string | null

可选

Path

string | null

可选

EncoderPath

string | null

可选

EncoderProtocol

enum<null> | enum<allOf> {1}

可选

枚举值:

FileHttpRtmpRtspUdpRtpFtp

Type

enum<string>

可选

枚举值:

DefaultGroupingPlaceholder

Container

string | null

可选

Size

integer <int64> | null

可选

Name

string | null

可选

IsRemote

boolean

可选

Gets or sets a value indicating whether the media is remote.
Differentiate internet url vs local network.

ETag

string | null

可选

RunTimeTicks

integer <int64> | null

可选

ReadAtNativeFramerate

boolean

可选

IgnoreDts

boolean

可选

IgnoreIndex

boolean

可选

GenPtsInput

boolean

可选

SupportsTranscoding

boolean

可选

SupportsDirectStream

boolean

可选

SupportsDirectPlay

boolean

可选

IsInfiniteStream

boolean

可选

UseMostCompatibleTranscodingProfile

boolean

可选

默认值:

false

RequiresOpening

boolean

可选

OpenToken

string | null

可选

RequiresClosing

boolean

可选

LiveStreamId

string | null

可选

BufferMs

integer <int32> | null

可选

RequiresLooping

boolean

可选

SupportsProbing

boolean

可选

VideoType

enum<null> | enum<allOf> {1}

可选

枚举值:

VideoFileIsoDvdBluRay

IsoType

enum<null> | enum<allOf> {1}

可选

枚举值:

DvdBluRay

Video3DFormat

enum<null> | enum<allOf> {1}

可选

枚举值:

HalfSideBySideFullSideBySideFullTopAndBottomHalfTopAndBottomMVC

MediaStreams

array[object (MediaStream) {63}] | null

可选

MediaAttachments

array[object (MediaAttachment) {7}] | null

可选

Formats

array[string] | null

可选

Bitrate

integer <int32> | null

可选

FallbackMaxStreamingBitrate

integer <int32> | null

可选

Timestamp

enum<null> | enum<allOf> {1}

可选

枚举值:

NoneZeroValid

RequiredHttpHeaders

object | null

可选

TranscodingUrl

string | null

可选

TranscodingSubProtocol

enum<string>

可选

Media streaming protocol.
Lowercase for backwards compatibility.

枚举值:

httphls

TranscodingContainer

string | null

可选

AnalyzeDurationMs

integer <int32> | null

可选

DefaultAudioStreamIndex

integer <int32> | null

可选

DefaultSubtitleStreamIndex

integer <int32> | null

可选

HasSegments

boolean

可选

PlaySessionId

string | null

可选

Gets or sets the play session identifier.

ErrorCode

enum<null> | enum<allOf> {1}

可选

Gets or sets the error code.

枚举值:

NotAllowedNoCompatibleStreamRateLimitExceeded

enum<string>

可选

枚举值:

NotAllowedNoCompatibleStreamRateLimitExceeded

示例

{
    "MediaSources": [
        {
            "Protocol": "File",
            "Id": "string",
            "Path": "string",
            "EncoderPath": "string",
            "EncoderProtocol": "File",
            "Type": "Default",
            "Container": "string",
            "Size": 0,
            "Name": "string",
            "IsRemote": true,
            "ETag": "string",
            "RunTimeTicks": 0,
            "ReadAtNativeFramerate": true,
            "IgnoreDts": true,
            "IgnoreIndex": true,
            "GenPtsInput": true,
            "SupportsTranscoding": true,
            "SupportsDirectStream": true,
            "SupportsDirectPlay": true,
            "IsInfiniteStream": true,
            "UseMostCompatibleTranscodingProfile": false,
            "RequiresOpening": true,
            "OpenToken": "string",
            "RequiresClosing": true,
            "LiveStreamId": "string",
            "BufferMs": 0,
            "RequiresLooping": true,
            "SupportsProbing": true,
            "VideoType": "VideoFile",
            "IsoType": "Dvd",
            "Video3DFormat": "HalfSideBySide",
            "MediaStreams": [
                {
                    "Codec": "string",
                    "CodecTag": "string",
                    "Language": "string",
                    "ColorRange": "string",
                    "ColorSpace": "string",
                    "ColorTransfer": "string",
                    "ColorPrimaries": "string",
                    "DvVersionMajor": 0,
                    "DvVersionMinor": 0,
                    "DvProfile": 0,
                    "DvLevel": 0,
                    "RpuPresentFlag": 0,
                    "ElPresentFlag": 0,
                    "BlPresentFlag": 0,
                    "DvBlSignalCompatibilityId": 0,
                    "Rotation": 0,
                    "Comment": "string",
                    "TimeBase": "string",
                    "CodecTimeBase": "string",
                    "Title": "string",
                    "VideoRange": "Unknown",
                    "VideoRangeType": "Unknown",
                    "VideoDoViTitle": "string",
                    "AudioSpatialFormat": "None",
                    "LocalizedUndefined": "string",
                    "LocalizedDefault": "string",
                    "LocalizedForced": "string",
                    "LocalizedExternal": "string",
                    "LocalizedHearingImpaired": "string",
                    "DisplayTitle": "string",
                    "NalLengthSize": "string",
                    "IsInterlaced": true,
                    "IsAVC": true,
                    "ChannelLayout": "string",
                    "BitRate": 0,
                    "BitDepth": 0,
                    "RefFrames": 0,
                    "PacketLength": 0,
                    "Channels": 0,
                    "SampleRate": 0,
                    "IsDefault": true,
                    "IsForced": true,
                    "IsHearingImpaired": true,
                    "Height": 0,
                    "Width": 0,
                    "AverageFrameRate": 0,
                    "RealFrameRate": 0,
                    "ReferenceFrameRate": 0,
                    "Profile": "string",
                    "Type": "Audio",
                    "AspectRatio": "string",
                    "Index": 0,
                    "Score": 0,
                    "IsExternal": true,
                    "DeliveryMethod": "Encode",
                    "DeliveryUrl": "string",
                    "IsExternalUrl": true,
                    "IsTextSubtitleStream": true,
                    "SupportsExternalStream": true,
                    "Path": "string",
                    "PixelFormat": "string",
                    "Level": 0,
                    "IsAnamorphic": true
                }
            ],
            "MediaAttachments": [
                {
                    "Codec": "string",
                    "CodecTag": "string",
                    "Comment": "string",
                    "Index": 0,
                    "FileName": "string",
                    "MimeType": "string",
                    "DeliveryUrl": "string"
                }
            ],
            "Formats": [
                "string"
            ],
            "Bitrate": 0,
            "FallbackMaxStreamingBitrate": 0,
            "Timestamp": "None",
            "RequiredHttpHeaders": {
                "property1": "string",
                "property2": "string"
            },
            "TranscodingUrl": "string",
            "TranscodingSubProtocol": "http",
            "TranscodingContainer": "string",
            "AnalyzeDurationMs": 0,
            "DefaultAudioStreamIndex": 0,
            "DefaultSubtitleStreamIndex": 0,
            "HasSegments": true
        }
    ],
    "PlaySessionId": "string",
    "ErrorCode": "NotAllowed"
}

🟠401没有权限

🟠403禁止访问

🟠404记录不存在