--- title: "Opens a media source." method: POST path: "/LiveStreams/Open" tags: ["MediaInfo"] --- # Opens a media source. `POST /LiveStreams/Open` ## Query parameters - `openToken` string, nullable — The open token. - `userId` string, uuid, nullable — The user id. - `playSessionId` string, nullable — The play session id. - `maxStreamingBitrate` integer, nullable — The maximum streaming bitrate. - `startTimeTicks` integer, nullable — The start time in ticks. - `audioStreamIndex` integer, nullable — The audio stream index. - `subtitleStreamIndex` integer, nullable — The subtitle stream index. - `maxAudioChannels` integer, nullable — The maximum number of audio channels. - `itemId` string, uuid, nullable — The item id. - `enableDirectPlay` boolean, nullable — Whether to enable direct play. Default: true. - `enableDirectStream` boolean, nullable — Whether to enable direct stream. Default: true. ## Request body - OpenLiveStreamDto — Open live stream dto. - `OpenToken` string, nullable — Gets or sets the open token. - `UserId` string, uuid, nullable — Gets or sets the user id. - `PlaySessionId` string, nullable — Gets or sets the play session id. - `MaxStreamingBitrate` integer, nullable — Gets or sets the max streaming bitrate. - `StartTimeTicks` integer, nullable — Gets or sets the start time in ticks. - `AudioStreamIndex` integer, nullable — Gets or sets the audio stream index. - `SubtitleStreamIndex` integer, nullable — Gets or sets the subtitle stream index. - `MaxAudioChannels` integer, nullable — Gets or sets the max audio channels. - `ItemId` string, uuid, nullable — Gets or sets the item id. - `EnableDirectPlay` boolean, nullable — Gets or sets a value indicating whether to enable direct play. - `EnableDirectStream` boolean, nullable — Gets or sets a value indicating whether to enale direct stream. - `DeviceProfile` DeviceProfile — Defines the MediaBrowser.Model.Dlna.DeviceProfile. - `Name` string, nullable — Gets or sets the Name. - `Id` string, nullable — Gets or sets the Id. - `Identification` DeviceIdentification - `FriendlyName` string, nullable — Gets or sets the name of the friendly. - `ModelNumber` string, nullable — Gets or sets the model number. - `SerialNumber` string, nullable — Gets or sets the serial number. - `ModelName` string, nullable — Gets or sets the name of the model. - `ModelDescription` string, nullable — Gets or sets the model description. - `ModelUrl` string, nullable — Gets or sets the model URL. - `Manufacturer` string, nullable — Gets or sets the manufacturer. - `ManufacturerUrl` string, nullable — Gets or sets the manufacturer URL. - `Headers` HttpHeaderInfo[], nullable — Gets or sets the headers. - `Name` string, nullable - `Value` string, nullable - `Match` 'Equals' | 'Regex' | 'Substring' - `FriendlyName` string, nullable — Gets or sets the FriendlyName. - `Manufacturer` string, nullable — Gets or sets the Manufacturer. - `ManufacturerUrl` string, nullable — Gets or sets the ManufacturerUrl. - `ModelName` string, nullable — Gets or sets the ModelName. - `ModelDescription` string, nullable — Gets or sets the ModelDescription. - `ModelNumber` string, nullable — Gets or sets the ModelNumber. - `ModelUrl` string, nullable — Gets or sets the ModelUrl. - `SerialNumber` string, nullable — Gets or sets the SerialNumber. - `EnableAlbumArtInDidl` boolean — Gets or sets a value indicating whether EnableAlbumArtInDidl. - `EnableSingleAlbumArtLimit` boolean — Gets or sets a value indicating whether EnableSingleAlbumArtLimit. - `EnableSingleSubtitleLimit` boolean — Gets or sets a value indicating whether EnableSingleSubtitleLimit. - `SupportedMediaTypes` string, nullable — Gets or sets the SupportedMediaTypes. - `UserId` string, nullable — Gets or sets the UserId. - `AlbumArtPn` string, nullable — Gets or sets the AlbumArtPn. - `MaxAlbumArtWidth` integer — Gets or sets the MaxAlbumArtWidth. - `MaxAlbumArtHeight` integer — Gets or sets the MaxAlbumArtHeight. - `MaxIconWidth` integer, nullable — Gets or sets the MaxIconWidth. - `MaxIconHeight` integer, nullable — Gets or sets the MaxIconHeight. - `MaxStreamingBitrate` integer, nullable — Gets or sets the MaxStreamingBitrate. - `MaxStaticBitrate` integer, nullable — Gets or sets the MaxStaticBitrate. - `MusicStreamingTranscodingBitrate` integer, nullable — Gets or sets the MusicStreamingTranscodingBitrate. - `MaxStaticMusicBitrate` integer, nullable — Gets or sets the MaxStaticMusicBitrate. - `SonyAggregationFlags` string, nullable — Gets or sets the content of the aggregationFlags element in the urn:schemas-sonycom:av namespace. - `ProtocolInfo` string, nullable — Gets or sets the ProtocolInfo. - `TimelineOffsetSeconds` integer — Gets or sets the TimelineOffsetSeconds. - `RequiresPlainVideoItems` boolean — Gets or sets a value indicating whether RequiresPlainVideoItems. - `RequiresPlainFolders` boolean — Gets or sets a value indicating whether RequiresPlainFolders. - `EnableMSMediaReceiverRegistrar` boolean — Gets or sets a value indicating whether EnableMSMediaReceiverRegistrar. - `IgnoreTranscodeByteRangeRequests` boolean — Gets or sets a value indicating whether IgnoreTranscodeByteRangeRequests. - `XmlRootAttributes` XmlAttribute[], nullable — Gets or sets the XmlRootAttributes. - `Name` string, nullable — Gets or sets the name of the attribute. - `Value` string, nullable — Gets or sets the value of the attribute. - `DirectPlayProfiles` DirectPlayProfile[], nullable — Gets or sets the direct play profiles. - `Container` string, nullable - `AudioCodec` string, nullable - `VideoCodec` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `TranscodingProfiles` TranscodingProfile[], nullable — Gets or sets the transcoding profiles. - `Container` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `VideoCodec` string, nullable - `AudioCodec` string, nullable - `Protocol` string, nullable - `EstimateContentLength` boolean - `EnableMpegtsM2TsMode` boolean - `TranscodeSeekInfo` 'Auto' | 'Bytes' - `CopyTimestamps` boolean - `Context` 'Streaming' | 'Static' - `EnableSubtitlesInManifest` boolean - `MaxAudioChannels` string, nullable - `MinSegments` integer - `SegmentLength` integer - `BreakOnNonKeyFrames` boolean - `ContainerProfiles` ContainerProfile[], nullable — Gets or sets the ContainerProfiles. - `Type` 'Audio' | 'Video' | 'Photo' - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `Container` string, nullable - `CodecProfiles` CodecProfile[], nullable — Gets or sets the CodecProfiles. - `Type` 'Video' | 'VideoAudio' | 'Audio' - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `ApplyConditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `Codec` string, nullable - `Container` string, nullable - `ResponseProfiles` ResponseProfile[], nullable — Gets or sets the ResponseProfiles. - `Container` string, nullable - `AudioCodec` string, nullable - `VideoCodec` string, nullable - `Type` 'Audio' | 'Video' | 'Photo' - `OrgPn` string, nullable - `MimeType` string, nullable - `Conditions` ProfileCondition[], nullable - `Condition` 'Equals' | 'NotEquals' | 'LessThanEqual' | 'GreaterThanEqual' | 'EqualsAny' - `Property` 'AudioChannels' | 'AudioBitrate' | 'AudioProfile' | 'Width' | 'Height' | 'Has64BitOffsets' | 'PacketLength' | 'VideoBitDepth' | 'VideoBitrate' | 'VideoFramerate' | 'VideoLevel' | 'VideoProfile' | 'VideoTimestamp' | 'IsAnamorphic' | 'RefFrames' | 'NumAudioStreams' | 'NumVideoStreams' | 'IsSecondaryAudio' | 'VideoCodecTag' | 'IsAvc' | 'IsInterlaced' | 'AudioSampleRate' | 'AudioBitDepth' - `Value` string, nullable - `IsRequired` boolean - `SubtitleProfiles` SubtitleProfile[], nullable — Gets or sets the SubtitleProfiles. - `Format` string, nullable - `Method` 'Encode' | 'Embed' | 'External' | 'Hls' - `DidlMode` string, nullable - `Language` string, nullable - `Container` string, nullable - `DirectPlayProtocols` MediaProtocol[], nullable — Gets or sets the device play protocols. ## Response `200` Media source opened. - LiveStreamResponse - `MediaSource` MediaSourceInfo - `Protocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Id` string, nullable - `Path` string, nullable - `EncoderPath` string, nullable - `EncoderProtocol` 'File' | 'Http' | 'Rtmp' | 'Rtsp' | 'Udp' | 'Rtp' | 'Ftp' - `Type` 'Default' | 'Grouping' | 'Placeholder' - `Container` string, nullable - `Size` integer, nullable - `Name` string, nullable - `IsRemote` boolean — Differentiate internet url vs local network. - `ETag` string, nullable - `RunTimeTicks` integer, nullable - `ReadAtNativeFramerate` boolean - `IgnoreDts` boolean - `IgnoreIndex` boolean - `GenPtsInput` boolean - `SupportsTranscoding` boolean - `SupportsDirectStream` boolean - `SupportsDirectPlay` boolean - `IsInfiniteStream` boolean - `RequiresOpening` boolean - `OpenToken` string, nullable - `RequiresClosing` boolean - `LiveStreamId` string, nullable - `BufferMs` integer, nullable - `RequiresLooping` boolean - `SupportsProbing` boolean - `VideoType` 'VideoFile' | 'Iso' | 'Dvd' | 'BluRay' — Enum VideoType. - `IsoType` 'Dvd' | 'BluRay' — Enum IsoType. - `Video3DFormat` 'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC' - `MediaStreams` MediaStream[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Language` string, nullable — Gets or sets the language. - `ColorRange` string, nullable — Gets or sets the color range. - `ColorSpace` string, nullable — Gets or sets the color space. - `ColorTransfer` string, nullable — Gets or sets the color transfer. - `ColorPrimaries` string, nullable — Gets or sets the color primaries. - `Comment` string, nullable — Gets or sets the comment. - `TimeBase` string, nullable — Gets or sets the time base. - `CodecTimeBase` string, nullable — Gets or sets the codec time base. - `Title` string, nullable — Gets or sets the title. - `VideoRange` string, nullable — Gets or sets the video range. - `localizedUndefined` string, nullable - `localizedDefault` string, nullable - `localizedForced` string, nullable - `DisplayTitle` string, nullable - `NalLengthSize` string, nullable - `IsInterlaced` boolean — Gets or sets a value indicating whether this instance is interlaced. - `IsAVC` boolean, nullable - `ChannelLayout` string, nullable — Gets or sets the channel layout. - `BitRate` integer, nullable — Gets or sets the bit rate. - `BitDepth` integer, nullable — Gets or sets the bit depth. - `RefFrames` integer, nullable — Gets or sets the reference frames. - `PacketLength` integer, nullable — Gets or sets the length of the packet. - `Channels` integer, nullable — Gets or sets the channels. - `SampleRate` integer, nullable — Gets or sets the sample rate. - `IsDefault` boolean — Gets or sets a value indicating whether this instance is default. - `IsForced` boolean — Gets or sets a value indicating whether this instance is forced. - `Height` integer, nullable — Gets or sets the height. - `Width` integer, nullable — Gets or sets the width. - `AverageFrameRate` number, float, nullable — Gets or sets the average frame rate. - `RealFrameRate` number, float, nullable — Gets or sets the real frame rate. - `Profile` string, nullable — Gets or sets the profile. - `Type` 'Audio' | 'Video' | 'Subtitle' | 'EmbeddedImage' — Enum MediaStreamType. - `AspectRatio` string, nullable — Gets or sets the aspect ratio. - `Index` integer — Gets or sets the index. - `Score` integer, nullable — Gets or sets the score. - `IsExternal` boolean — Gets or sets a value indicating whether this instance is external. - `DeliveryMethod` 'Encode' | 'Embed' | 'External' | 'Hls' - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `IsExternalUrl` boolean, nullable — Gets or sets a value indicating whether this instance is external URL. - `IsTextSubtitleStream` boolean - `SupportsExternalStream` boolean — Gets or sets a value indicating whether [supports external stream]. - `Path` string, nullable — Gets or sets the filename. - `PixelFormat` string, nullable — Gets or sets the pixel format. - `Level` number, double, nullable — Gets or sets the level. - `IsAnamorphic` boolean, nullable — Gets a value indicating whether this instance is anamorphic. - `MediaAttachments` MediaAttachment[], nullable - `Codec` string, nullable — Gets or sets the codec. - `CodecTag` string, nullable — Gets or sets the codec tag. - `Comment` string, nullable — Gets or sets the comment. - `Index` integer — Gets or sets the index. - `FileName` string, nullable — Gets or sets the filename. - `MimeType` string, nullable — Gets or sets the MIME type. - `DeliveryUrl` string, nullable — Gets or sets the delivery URL. - `Formats` string[], nullable - `Bitrate` integer, nullable - `Timestamp` 'None' | 'Zero' | 'Valid' - `RequiredHttpHeaders` object, nullable - `TranscodingUrl` string, nullable - `TranscodingSubProtocol` string, nullable - `TranscodingContainer` string, nullable - `AnalyzeDurationMs` integer, nullable - `DefaultAudioStreamIndex` integer, nullable - `DefaultSubtitleStreamIndex` integer, nullable ## Other responses - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/jellyfin/apis/jellyfin-api.md) · [All operations](https://skmtc.net/jellyfin/apis/jellyfin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jellyfin/jellyfin-api/versions/eb6f75af7066/schema)