postItemsByIdPlaybackinfo

Gets live playback media info for an item

Requires authentication as user

Request
post /Items/{Id}/PlaybackInfo
Parameters
Name In Type Default Notes
*Id path
*body body PlaybackInfoRequest

PlaybackInfoRequest:
Responses
Status Code Type Description Samples
200 PlaybackInfoResponse

Operation successful. Returning a PlaybackInfoResponse object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

PlaybackInfoRequest

Name Type Notes
Id string
UserId string
MaxStreamingBitrate integer (int64)
StartTimeTicks integer (int64)
AudioStreamIndex integer (int32)
SubtitleStreamIndex integer (int32)
MaxAudioChannels integer (int32)
MediaSourceId string
LiveStreamId string
DeviceProfile DeviceProfile[]
EnableDirectPlay boolean
EnableDirectStream boolean
EnableTranscoding boolean
AllowInterlacedVideoStreamCopy boolean
AllowVideoStreamCopy boolean
AllowAudioStreamCopy boolean
IsPlayback boolean
AutoOpenLiveStream boolean
CurrentPlaySessionId string

DeviceProfile

Name Type Notes
Name string

The name.
Id string
SupportedMediaTypes string
MaxStreamingBitrate integer (int64)
MusicStreamingTranscodingBitrate integer (int32)
MaxStaticMusicBitrate integer (int32)
DirectPlayProfiles DirectPlayProfile[]

The direct play profiles.
TranscodingProfiles TranscodingProfile[]

The transcoding profiles.
ContainerProfiles ContainerProfile[]
CodecProfiles CodecProfile[]
ResponseProfiles ResponseProfile[]
SubtitleProfiles SubtitleProfile[]

DirectPlayProfile

Name Type Notes
Container string
AudioCodec string
VideoCodec string
Type DlnaProfileType

DlnaProfileType

Enum Values
  • Audio
  • Video
  • Photo

TranscodingProfile

Name Type Notes
Container string
Type DlnaProfileType
VideoCodec string
AudioCodec string
Protocol string
EstimateContentLength boolean
EnableMpegtsM2TsMode boolean
TranscodeSeekInfo TranscodeSeekInfo
CopyTimestamps boolean
Context EncodingContext
MaxAudioChannels string
MinSegments integer (int32)
SegmentLength integer (int32)
BreakOnNonKeyFrames boolean
AllowInterlacedVideoStreamCopy boolean
ManifestSubtitles string
MaxManifestSubtitles integer (int32)
MaxWidth integer (int32)
MaxHeight integer (int32)
FillEmptySubtitleSegments boolean

TranscodeSeekInfo

Enum Values
  • Auto
  • Bytes

EncodingContext

Enum Values
  • Streaming
  • Static

ContainerProfile

Name Type Notes
Type DlnaProfileType
Conditions ProfileCondition[]
Container string

ProfileCondition

Name Type Notes
Condition ProfileConditionType
Property ProfileConditionValue
Value string
IsRequired boolean

ProfileConditionType

Enum Values
  • Equals
  • NotEquals
  • LessThanEqual
  • GreaterThanEqual
  • EqualsAny

ProfileConditionValue

Enum Values
  • AudioChannels
  • AudioBitrate
  • AudioProfile
  • Width
  • Height
  • Has64BitOffsets
  • PacketLength
  • VideoBitDepth
  • VideoBitrate
  • VideoFramerate
  • VideoLevel
  • VideoProfile
  • VideoTimestamp
  • IsAnamorphic
  • RefFrames
  • NumAudioStreams
  • NumVideoStreams
  • IsSecondaryAudio
  • VideoCodecTag
  • IsAvc
  • IsInterlaced
  • AudioSampleRate
  • AudioBitDepth
  • VideoRange
  • VideoRotation

CodecProfile

Name Type Notes
Type CodecType
Conditions ProfileCondition[]
ApplyConditions ProfileCondition[]
Codec string
Container string

CodecType

Enum Values
  • Video
  • VideoAudio
  • Audio

ResponseProfile

Name Type Notes
Container string
AudioCodec string
VideoCodec string
Type DlnaProfileType
OrgPn string
MimeType string
Conditions ProfileCondition[]

SubtitleProfile

Name Type Notes
Format string
Method SubtitleDeliveryMethod
DidlMode string
Language string
Container string
Protocol string

SubtitleDeliveryMethod

Enum Values
  • Encode
  • Embed
  • External
  • Hls
  • VideoSideData

PlaybackInfoResponse

Name Type Notes
MediaSources MediaSourceInfo[]

The media sources.
PlaySessionId string

The play session identifier.
ErrorCode PlaybackErrorCode

MediaSourceInfo

Name Type Notes
Chapters ChapterInfo[]
Protocol MediaProtocol
Id string
Path string
EncoderPath string
EncoderProtocol MediaProtocol
Type MediaSourceType
ProbePath string
ProbeProtocol MediaProtocol
Container string
Size integer (int64)
Name string
SortName string
IsRemote boolean

Differentiate internet url vs local network
HasMixedProtocols boolean
RunTimeTicks integer (int64)
ContainerStartTimeTicks integer (int64)
SupportsTranscoding boolean
TrancodeLiveStartIndex integer (int32)
WallClockStart string (date-time)
SupportsDirectStream boolean
SupportsDirectPlay boolean
IsInfiniteStream boolean
RequiresOpening boolean
OpenToken string
RequiresClosing boolean
LiveStreamId string
BufferMs integer (int32)
RequiresLooping boolean
SupportsProbing boolean
Video3DFormat Video3DFormat
MediaStreams MediaStream[]
Formats array
Bitrate integer (int32)
Timestamp TransportStreamTimestamp
RequiredHttpHeaders object
DirectStreamUrl string
AddApiKeyToDirectStreamUrl boolean
TranscodingUrl string
TranscodingSubProtocol string
TranscodingContainer string
AnalyzeDurationMs integer (int32)
ReadAtNativeFramerate boolean
DefaultAudioStreamIndex integer (int32)
DefaultSubtitleStreamIndex integer (int32)
ItemId string

Used only by our Windows app. Not used by Emby Server. The id of the item that this mediasource belongs to, if there is one Also used by Emby for Kodi
ServerId string

Used only by our Windows app. Not used by Emby Server.

ChapterInfo

Name Type Notes
StartPositionTicks integer (int64)

The start position ticks.
Name string

The name.
ImageTag string
MarkerType MarkerType
ChapterIndex integer (int32)

MarkerType

Enum Values
  • Chapter
  • IntroStart
  • IntroEnd
  • CreditsStart

MediaProtocol

Enum Values
  • File
  • Http
  • Rtmp
  • Rtsp
  • Udp
  • Rtp
  • Ftp
  • Mms

MediaSourceType

Enum Values
  • Default
  • Grouping
  • Placeholder

Video3DFormat

Enum Values
  • HalfSideBySide
  • FullSideBySide
  • FullTopAndBottom
  • HalfTopAndBottom
  • MVC

MediaStream

Name Type Notes
Codec string

The codec.

Probe Field: codec_name
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle
Related Enums: T:Emby.Media.Model.Enums.VideoMediaTypes, Emby.Media.Model.Enums.AudioMediaTypes, Emby.Media.Model.Enums.SubtitleMediaTypes.
CodecTag string

The codec tag.

Probe Field: codec_tag
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
Language string

The language.

Probe Field: tags["language"]
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
ColorTransfer string

The color transfer characteristics.

Probe Field: color_transfer
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
Related Enum: Emby.Media.Model.Enums.ColorTransfers.
ColorPrimaries string

The chromaticity coordinates of the source primaries.

Probe Field: color_primaries
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
Related Enum: Emby.Media.Model.Enums.ColorPrimaries.
ColorSpace string

The YUV colorspace type.

Probe Field: color_space
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
Related Enum: Emby.Media.Model.Enums.ColorSpaces.
Comment string

The comment.

Probe Field: tags["comment"]
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
StreamStartTimeTicks integer (int64)

The start time of the stream.

Probe Field: start_time
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
Actual type: System.TimeSpan.
TimeBase string

The time-base.

Probe Field: time_base
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
Actual type: Emby.Media.Model.Types.Rational.
Title string

The title.

Probe Field: tags["title"]
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
Extradata string

The extradata.

Probe Field: extradata
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.

Currently, this value is only parsed for subtitle streams with codec Emby.Media.Model.Enums.SubtitleMediaTypes.dvb_teletext.
VideoRange string
DisplayTitle string

The display title.

Custom property set by the application.
DisplayLanguage string

The display language.

Custom property set by the application.
NalLengthSize string

The nal length size.

Probe Field: nal_length_size
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video of type Emby.Media.Model.Enums.VideoMediaTypes.h264.
Actual type: System.Int32.
IsInterlaced boolean

A value indicating whether this instance is interlaced.

Probe Field: field_order != progressive
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
IsAVC boolean
ChannelLayout string

The channel layout.

Probe Field: channel_layout
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio
Related Enum: MediaBrowser.Model.Entities.MediaStream.ChannelLayout.
BitRate integer (int32)

The bit rate.

Probe Field: bit_rate
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio.

THIS VALUE IS PROCESSED BY CUSTOM LOGIC AND DOES NOT NECESSARILY MATCH FFPROBE RESULTS!
BitDepth integer (int32)

The bit depth.

Probe Field: bits_per_sample or bits_per_raw_sample
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio.
RefFrames integer (int32)

The reference frames.

Probe Field: refs
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Rotation integer (int32)
Channels integer (int32)

The audio channel count.

Probe Field: channels
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio.
SampleRate integer (int32)

The sample rate.

Probe Field: sample_rate
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Audio
Related Enum: Emby.Media.Model.Enums.SampleRates.
IsDefault boolean

A value indicating whether this instance is default.

Probe Field: disposition["default"]
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
IsForced boolean

A value indicating whether this instance is forced.

Probe Field: disposition["forced"]
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
IsHearingImpaired boolean
Height integer (int32)

The height.

Probe Field: height
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Width integer (int32)

The width.

Probe Field: width
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
AverageFrameRate number (float)

The average frame rate..

Probe Field: avg_frame_rate
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Actual type: Emby.Media.Model.Types.Rational.
RealFrameRate number (float)

The real frame rate..

Probe Field: r_frame_rate
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Actual type: Emby.Media.Model.Types.Rational.
Profile string

The profile.

Probe Field: profile
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio
Related Enums: Emby.Media.Model.Enums.AacProfiles, Emby.Media.Model.Enums.AvcProfiles, Emby.Media.Model.Enums.H263Profiles, Emby.Media.Model.Enums.HevcProfiles, Emby.Media.Model.Enums.Mpeg2Profiles,Emby.Media.Model.Enums.Vc1Profiles, Emby.Media.Model.Enums.Mpeg4Profiles, Emby.Media.Model.Enums.Vp8Profiles, Emby.Media.Model.Enums.Vp9Profiles.
Type MediaStreamType

Enum MediaStreamType
AspectRatio string

The aspect ratio.

Probe Field: display_aspect_ratio
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Actual type: Emby.Media.Model.Types.Rational.
Index integer (int32)

The index of the stream inside its container.

Probe Field: index
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video, MediaBrowser.Model.Entities.MediaStreamType.Audio, MediaBrowser.Model.Entities.MediaStreamType.Subtitle.
IsExternal boolean

A value indicating whether this instance is external.

Custom property set by the application.
DeliveryMethod SubtitleDeliveryMethod
DeliveryUrl string

The delivery URL.

Custom property set by the application.
IsExternalUrl boolean

A value indicating whether this instance is external URL.

Custom property set by the application.
IsTextSubtitleStream boolean
SupportsExternalStream boolean

A value indicating whether [supports external stream].
Path string

The filename.
Protocol MediaProtocol
PixelFormat string

The pixel format.

Probe Field: pix_fmt
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video.
Actual type: MediaBrowser.Model.Entities.MediaStream.PixelFormat.
Level number (double)

The codec level.

Probe Field: level
Applies to: MediaBrowser.Model.Entities.MediaStreamType.Video
Related Enums: Emby.Media.Model.Enums.AvcLevels, Emby.Media.Model.Enums.H263Levels, Emby.Media.Model.Enums.HevcLevels, Emby.Media.Model.Enums.Mpeg2Levels,Emby.Media.Model.Enums.Vc1Levels, Emby.Media.Model.Enums.Mpeg4Levels, Emby.Media.Model.Enums.Vp8Levels, Emby.Media.Model.Enums.Vp9Levels.
IsAnamorphic boolean

A value indicating whether this instance is anamorphic.
ExtendedVideoType ExtendedVideoTypes
ExtendedVideoSubType ExtendedVideoSubTypes
ExtendedVideoSubTypeDescription string

The extended video sub-type description.
ItemId string

Used only by our Windows app. Not used by Emby Server.
ServerId string

Used only by our Windows app. Not used by Emby Server.
AttachmentSize integer (int32)

The size of the attachment.
MimeType string

The type of the MIME.
SubtitleLocationType SubtitleLocationType

MediaStreamType

Enum Values
  • Unknown
  • Audio
  • Video
  • Subtitle
  • EmbeddedImage
  • Attachment
  • Data

ExtendedVideoTypes

Enum Values
  • None
  • Hdr10
  • Hdr10Plus
  • HyperLogGamma
  • DolbyVision

ExtendedVideoSubTypes

Enum Values
  • None
  • Hdr10
  • HyperLogGamma
  • Hdr10Plus0
  • DoviProfile02
  • DoviProfile10
  • DoviProfile22
  • DoviProfile30
  • DoviProfile42
  • DoviProfile50
  • DoviProfile61
  • DoviProfile76
  • DoviProfile81
  • DoviProfile82
  • DoviProfile83
  • DoviProfile84
  • DoviProfile85
  • DoviProfile92

SubtitleLocationType

Enum Values
  • InternalStream
  • VideoSideData

TransportStreamTimestamp

Enum Values
  • None
  • Zero
  • Valid

PlaybackErrorCode

Enum Values
  • NotAllowed
  • NoCompatibleStream
  • RateLimitExceeded