jellyfin-api/org.jellyfin.sdk.api.operations/DynamicHlsApi/getLiveHlsStreamUrl

getLiveHlsStreamUrl

fun getLiveHlsStreamUrl(itemId: <Error class: unknown class>, container: String? = null, static: Boolean? = null, params: String? = null, tag: String? = null, playSessionId: String? = null, segmentContainer: String? = null, segmentLength: Int? = null, minSegments: Int? = null, mediaSourceId: String? = null, deviceId: String? = null, audioCodec: String? = null, enableAutoStreamCopy: Boolean? = null, allowVideoStreamCopy: Boolean? = null, allowAudioStreamCopy: Boolean? = null, breakOnNonKeyFrames: Boolean? = null, audioSampleRate: Int? = null, maxAudioBitDepth: Int? = null, audioBitRate: Int? = null, audioChannels: Int? = null, maxAudioChannels: Int? = null, profile: String? = null, level: String? = null, framerate: Float? = null, maxFramerate: Float? = null, copyTimestamps: Boolean? = null, startTimeTicks: Long? = null, width: Int? = null, height: Int? = null, videoBitRate: Int? = null, subtitleStreamIndex: Int? = null, subtitleMethod: <Error class: unknown class>? = null, maxRefFrames: Int? = null, maxVideoBitDepth: Int? = null, requireAvc: Boolean? = null, deInterlace: Boolean? = null, requireNonAnamorphic: Boolean? = null, transcodingMaxAudioChannels: Int? = null, cpuCoreLimit: Int? = null, liveStreamId: String? = null, enableMpegtsM2TsMode: Boolean? = null, videoCodec: String? = null, subtitleCodec: String? = null, transcodeReasons: String? = null, audioStreamIndex: Int? = null, videoStreamIndex: Int? = null, context: <Error class: unknown class>? = null, streamOptions: Map<String, String?>? = emptyMap(), maxWidth: Int? = null, maxHeight: Int? = null, enableSubtitlesInManifest: Boolean? = null, enableAudioVbrEncoding: Boolean? = true, alwaysBurnInSubtitleWhenTranscoding: Boolean? = false): String

Gets a hls live stream.

Parameters

itemId

The item id.

container

The audio container.

static

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.

params

The streaming parameters.

tag

The tag.

playSessionId

The play session id.

segmentContainer

The segment container.

segmentLength

The segment length.

minSegments

The minimum number of segments.

mediaSourceId

The media version id, if playing an alternate version.

deviceId

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

audioCodec

Optional. Specify an audio codec to encode to, e.g. mp3.

enableAutoStreamCopy

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

allowVideoStreamCopy

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

allowAudioStreamCopy

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

breakOnNonKeyFrames

Optional. Whether to break on non key frames.

audioSampleRate

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

maxAudioBitDepth

Optional. The maximum audio bit depth.

audioBitRate

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

audioChannels

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

maxAudioChannels

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

profile

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

level

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

framerate

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

maxFramerate

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

copyTimestamps

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

startTimeTicks

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

width

Optional. The fixed horizontal resolution of the encoded video.

height

Optional. The fixed vertical resolution of the encoded video.

videoBitRate

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

subtitleStreamIndex

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

subtitleMethod

Optional. Specify the subtitle delivery method.

maxRefFrames

Optional.

maxVideoBitDepth

Optional. The maximum video bit depth.

requireAvc

Optional. Whether to require avc.

deInterlace

Optional. Whether to deinterlace the video.

requireNonAnamorphic

Optional. Whether to require a non anamorphic stream.

transcodingMaxAudioChannels

Optional. The maximum number of audio channels to transcode.

cpuCoreLimit

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

liveStreamId

The live stream id.

enableMpegtsM2TsMode

Optional. Whether to enable the MpegtsM2Ts mode.

videoCodec

Optional. Specify a video codec to encode to, e.g. h264.

subtitleCodec

Optional. Specify a subtitle codec to encode to.

transcodeReasons

Optional. The transcoding reason.

audioStreamIndex

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

videoStreamIndex

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

context

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

streamOptions

Optional. The streaming options.

maxWidth

Optional. The max width.

maxHeight

Optional. The max height.

enableSubtitlesInManifest

Optional. Whether to enable subtitles in the manifest.

enableAudioVbrEncoding

Optional. Whether to enable Audio Encoding.

alwaysBurnInSubtitleWhenTranscoding

Whether to always burn in subtitles when transcoding.