Sign in

v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Videos

Gets a video stream.

get/Videos/{itemId}/{stream}.{container}

Path parameters

itemIdstring uuid required

The item id.

The item id.

containerstring required

The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.

The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.

streamstring required

Query parameters

staticboolean nullable

Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.

Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.

paramsstring nullable

The streaming parameters.

The streaming parameters.

tagstring nullable

The tag.

The tag.

deviceProfileIdstring nullable

Optional. The dlna device profile id to utilize.

Optional. The dlna device profile id to utilize.

playSessionIdstring nullable

The play session id.

The play session id.

segmentContainerstring nullable

The segment container.

The segment container.

segmentLengthinteger nullable

The segment lenght.

The segment lenght.

minSegmentsinteger nullable

The minimum number of segments.

The minimum number of segments.

mediaSourceIdstring nullable

The media version id, if playing an alternate version.

The media version id, if playing an alternate version.

deviceIdstring nullable

The device id of the client requesting. Used to stop encoding processes when needed.

The device id of the client requesting. Used to stop encoding processes when needed.

audioCodecstring nullable

Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.

Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.

enableAutoStreamCopyboolean nullable

Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.

Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.

allowVideoStreamCopyboolean nullable

Whether or not to allow copying of the video stream url.

Whether or not to allow copying of the video stream url.

allowAudioStreamCopyboolean nullable

Whether or not to allow copying of the audio stream url.

Whether or not to allow copying of the audio stream url.

breakOnNonKeyFramesboolean nullable

Optional. Whether to break on non key frames.

Optional. Whether to break on non key frames.

audioSampleRateinteger nullable

Optional. Specify a specific audio sample rate, e.g. 44100.

Optional. Specify a specific audio sample rate, e.g. 44100.

maxAudioBitDepthinteger nullable

Optional. The maximum audio bit depth.

Optional. The maximum audio bit depth.

audioBitRateinteger nullable

Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.

Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.

audioChannelsinteger nullable

Optional. Specify a specific number of audio channels to encode to, e.g. 2.

Optional. Specify a specific number of audio channels to encode to, e.g. 2.

maxAudioChannelsinteger nullable

Optional. Specify a maximum number of audio channels to encode to, e.g. 2.

Optional. Specify a maximum number of audio channels to encode to, e.g. 2.

profilestring nullable

Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.

Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.

levelstring nullable

Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.

Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.

frameratenumber float nullable

Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

maxFrameratenumber float nullable

Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

copyTimestampsboolean nullable

Whether or not to copy timestamps when transcoding with an offset. Defaults to false.

Whether or not to copy timestamps when transcoding with an offset. Defaults to false.

startTimeTicksinteger nullable

Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.

Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.

widthinteger nullable

Optional. The fixed horizontal resolution of the encoded video.

Optional. The fixed horizontal resolution of the encoded video.

heightinteger nullable

Optional. The fixed vertical resolution of the encoded video.

Optional. The fixed vertical resolution of the encoded video.

videoBitRateinteger nullable

Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.

Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.

subtitleStreamIndexinteger nullable

Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.

Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.

subtitleMethod'Encode' | 'Embed' | 'External' | 'Hls'

Optional. Specify the subtitle delivery method.

maxRefFramesinteger nullable

Optional.

Optional.

maxVideoBitDepthinteger nullable

Optional. The maximum video bit depth.

Optional. The maximum video bit depth.

requireAvcboolean nullable

Optional. Whether to require avc.

Optional. Whether to require avc.

deInterlaceboolean nullable

Optional. Whether to deinterlace the video.

Optional. Whether to deinterlace the video.

requireNonAnamorphicboolean nullable

Optional. Whether to require a non anamporphic stream.

Optional. Whether to require a non anamporphic stream.

transcodingMaxAudioChannelsinteger nullable

Optional. The maximum number of audio channels to transcode.

Optional. The maximum number of audio channels to transcode.

cpuCoreLimitinteger nullable

Optional. The limit of how many cpu cores to use.

Optional. The limit of how many cpu cores to use.

liveStreamIdstring nullable

The live stream id.

The live stream id.

enableMpegtsM2TsModeboolean nullable

Optional. Whether to enable the MpegtsM2Ts mode.

Optional. Whether to enable the MpegtsM2Ts mode.

videoCodecstring nullable

Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv.

Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv.

subtitleCodecstring nullable

Optional. Specify a subtitle codec to encode to.

Optional. Specify a subtitle codec to encode to.

transcodeReasonsstring nullable

Optional. The transcoding reason.

Optional. The transcoding reason.

audioStreamIndexinteger nullable

Optional. The index of the audio stream to use. If omitted the first audio stream will be used.

Optional. The index of the audio stream to use. If omitted the first audio stream will be used.

videoStreamIndexinteger nullable

Optional. The index of the video stream to use. If omitted the first video stream will be used.

Optional. The index of the video stream to use. If omitted the first video stream will be used.

context'Streaming' | 'Static'

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

streamOptionsobject nullable

Optional. The streaming options.

Optional. The streaming options.

Response

Video stream returned.