Gets live playback media info for an item.

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "itemId": {
      "type": "string",
      "format": "uuid",
      "description": "The item id."
    },
    "userId": {
      "type": "string",
      "format": "uuid",
      "description": "The user id."
    }
  },
  "required": [
    "itemId",
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Class PlaybackInfoResponse.",
  "properties": {
    "ErrorCode": {
      "type": "string",
      "enum": [
        "NotAllowed",
        "NoCompatibleStream",
        "RateLimitExceeded"
      ]
    },
    "MediaSources": {
      "type": "array",
      "description": "Gets or sets the media sources.",
      "items": {
        "type": "object",
        "properties": {
          "AnalyzeDurationMs": {
            "type": "integer",
            "format": "int32"
          },
          "Bitrate": {
            "type": "integer",
            "format": "int32"
          },
          "BufferMs": {
            "type": "integer",
            "format": "int32"
          },
          "Container": {
            "type": "string"
          },
          "DefaultAudioStreamIndex": {
            "type": "integer",
            "format": "int32"
          },
          "DefaultSubtitleStreamIndex": {
            "type": "integer",
            "format": "int32"
          },
          "ETag": {
            "type": "string"
          },
          "EncoderPath": {
            "type": "string"
          },
          "EncoderProtocol": {
            "type": "string",
            "enum": [
              "File",
              "Http",
              "Rtmp",
              "Rtsp",
              "Udp",
              "Rtp",
              "Ftp"
            ]
          },
          "Formats": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "GenPtsInput": {
            "type": "boolean"
          },
          "Id": {
            "type": "string"
          },
          "IgnoreDts": {
            "type": "boolean"
          },
          "IgnoreIndex": {
            "type": "boolean"
          },
          "IsInfiniteStream": {
            "type": "boolean"
          },
          "IsRemote": {
            "type": "boolean",
            "description": "Differentiate internet url vs local network."
          },
          "IsoType": {
            "type": "string",
            "description": "Enum IsoType.",
            "enum": [
              "Dvd",
              "BluRay"
            ]
          },
          "LiveStreamId": {
            "type": "string"
          },
          "MediaAttachments": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Class MediaAttachment.",
              "properties": {
                "Codec": {
                  "type": "string",
                  "description": "Gets or sets the codec."
                },
                "CodecTag": {
                  "type": "string",
                  "description": "Gets or sets the codec tag."
                },
                "Comment": {
                  "type": "string",
                  "description": "Gets or sets the comment."
                },
                "DeliveryUrl": {
                  "type": "string",
                  "description": "Gets or sets the delivery URL."
                },
                "FileName": {
                  "type": "string",
                  "description": "Gets or sets the filename."
                },
                "Index": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the index."
                },
                "MimeType": {
                  "type": "string",
                  "description": "Gets or sets the MIME type."
                }
              },
              "additionalProperties": false
            }
          },
          "MediaStreams": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Class MediaStream.",
              "properties": {
                "AspectRatio": {
                  "type": "string",
                  "description": "Gets or sets the aspect ratio."
                },
                "AverageFrameRate": {
                  "type": "number",
                  "format": "float",
                  "description": "Gets or sets the average frame rate."
                },
                "BitDepth": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the bit depth."
                },
                "BitRate": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the bit rate."
                },
                "ChannelLayout": {
                  "type": "string",
                  "description": "Gets or sets the channel layout."
                },
                "Channels": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the channels."
                },
                "Codec": {
                  "type": "string",
                  "description": "Gets or sets the codec."
                },
                "CodecTag": {
                  "type": "string",
                  "description": "Gets or sets the codec tag."
                },
                "CodecTimeBase": {
                  "type": "string",
                  "description": "Gets or sets the codec time base."
                },
                "ColorPrimaries": {
                  "type": "string",
                  "description": "Gets or sets the color primaries."
                },
                "ColorRange": {
                  "type": "string",
                  "description": "Gets or sets the color range."
                },
                "ColorSpace": {
                  "type": "string",
                  "description": "Gets or sets the color space."
                },
                "ColorTransfer": {
                  "type": "string",
                  "description": "Gets or sets the color transfer."
                },
                "Comment": {
                  "type": "string",
                  "description": "Gets or sets the comment."
                },
                "DeliveryMethod": {
                  "type": "string",
                  "enum": [
                    "Encode",
                    "Embed",
                    "External",
                    "Hls"
                  ]
                },
                "DeliveryUrl": {
                  "type": "string",
                  "description": "Gets or sets the delivery URL."
                },
                "DisplayTitle": {
                  "type": "string"
                },
                "Height": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the height."
                },
                "Index": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the index."
                },
                "IsAVC": {
                  "type": "boolean"
                },
                "IsAnamorphic": {
                  "type": "boolean",
                  "description": "Gets a value indicating whether this instance is anamorphic."
                },
                "IsDefault": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether this instance is default."
                },
                "IsExternal": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether this instance is external."
                },
                "IsExternalUrl": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether this instance is external URL."
                },
                "IsForced": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether this instance is forced."
                },
                "IsInterlaced": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether this instance is interlaced."
                },
                "IsTextSubtitleStream": {
                  "type": "boolean"
                },
                "Language": {
                  "type": "string",
                  "description": "Gets or sets the language."
                },
                "Level": {
                  "type": "number",
                  "format": "double",
                  "description": "Gets or sets the level."
                },
                "NalLengthSize": {
                  "type": "string"
                },
                "PacketLength": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the length of the packet."
                },
                "Path": {
                  "type": "string",
                  "description": "Gets or sets the filename."
                },
                "PixelFormat": {
                  "type": "string",
                  "description": "Gets or sets the pixel format."
                },
                "Profile": {
                  "type": "string",
                  "description": "Gets or sets the profile."
                },
                "RealFrameRate": {
                  "type": "number",
                  "format": "float",
                  "description": "Gets or sets the real frame rate."
                },
                "RefFrames": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the reference frames."
                },
                "SampleRate": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the sample rate."
                },
                "Score": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the score."
                },
                "SupportsExternalStream": {
                  "type": "boolean",
                  "description": "Gets or sets a value indicating whether [supports external stream]."
                },
                "TimeBase": {
                  "type": "string",
                  "description": "Gets or sets the time base."
                },
                "Title": {
                  "type": "string",
                  "description": "Gets or sets the title."
                },
                "Type": {
                  "type": "string",
                  "description": "Enum MediaStreamType.",
                  "enum": [
                    "Audio",
                    "Video",
                    "Subtitle",
                    "EmbeddedImage"
                  ]
                },
                "VideoRange": {
                  "type": "string",
                  "description": "Gets or sets the video range."
                },
                "Width": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Gets or sets the width."
                },
                "localizedDefault": {
                  "type": "string"
                },
                "localizedForced": {
                  "type": "string"
                },
                "localizedUndefined": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "Name": {
            "type": "string"
          },
          "OpenToken": {
            "type": "string"
          },
          "Path": {
            "type": "string"
          },
          "Protocol": {
            "type": "string",
            "enum": [
              "File",
              "Http",
              "Rtmp",
              "Rtsp",
              "Udp",
              "Rtp",
              "Ftp"
            ]
          },
          "ReadAtNativeFramerate": {
            "type": "boolean"
          },
          "RequiredHttpHeaders": {
            "type": "object"
          },
          "RequiresClosing": {
            "type": "boolean"
          },
          "RequiresLooping": {
            "type": "boolean"
          },
          "RequiresOpening": {
            "type": "boolean"
          },
          "RunTimeTicks": {
            "type": "integer",
            "format": "int64"
          },
          "Size": {
            "type": "integer",
            "format": "int64"
          },
          "SupportsDirectPlay": {
            "type": "boolean"
          },
          "SupportsDirectStream": {
            "type": "boolean"
          },
          "SupportsProbing": {
            "type": "boolean"
          },
          "SupportsTranscoding": {
            "type": "boolean"
          },
          "Timestamp": {
            "type": "string",
            "enum": [
              "None",
              "Zero",
              "Valid"
            ]
          },
          "TranscodingContainer": {
            "type": "string"
          },
          "TranscodingSubProtocol": {
            "type": "string"
          },
          "TranscodingUrl": {
            "type": "string"
          },
          "Type": {
            "type": "string",
            "enum": [
              "Default",
              "Grouping",
              "Placeholder"
            ]
          },
          "Video3DFormat": {
            "type": "string",
            "enum": [
              "HalfSideBySide",
              "FullSideBySide",
              "FullTopAndBottom",
              "HalfTopAndBottom",
              "MVC"
            ]
          },
          "VideoType": {
            "type": "string",
            "description": "Enum VideoType.",
            "enum": [
              "VideoFile",
              "Iso",
              "Dvd",
              "BluRay"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "PlaySessionId": {
      "type": "string",
      "description": "Gets or sets the play session identifier."
    }
  },
  "additionalProperties": false
}