jellyfin-model/org.jellyfin.sdk.model.api.request/GetHlsVideoSegmentRequest

GetHlsVideoSegmentRequest

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

A video stream using HTTP live streaming.

Constructors

constructor(itemId: UUID, playlistId: String, segmentId: Int, container: String, runtimeTicks: Long, actualSegmentLengthTicks: Long, 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, maxWidth: Int? = null, maxHeight: Int? = null, videoBitRate: Int? = null, subtitleStreamIndex: Int? = null, subtitleMethod: SubtitleDeliveryMethod? = 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: EncodingContext? = null, streamOptions: Map<String, String?>? = null, enableAudioVbrEncoding: Boolean? = true, alwaysBurnInSubtitleWhenTranscoding: Boolean? = false)

Properties

actualSegmentLengthTicks

val actualSegmentLengthTicks: Long

The length of the requested segment in ticks.

allowAudioStreamCopy

val allowAudioStreamCopy: Boolean? = null

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

allowVideoStreamCopy

val allowVideoStreamCopy: Boolean? = null

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

alwaysBurnInSubtitleWhenTranscoding

val alwaysBurnInSubtitleWhenTranscoding: Boolean? = false

Whether to always burn in subtitles when transcoding.

audioBitRate

val audioBitRate: Int? = null

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

audioChannels

val audioChannels: Int? = null

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

audioCodec

val audioCodec: String? = null

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

audioSampleRate

val audioSampleRate: Int? = null

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

audioStreamIndex

val audioStreamIndex: Int? = null

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

breakOnNonKeyFrames

val breakOnNonKeyFrames: Boolean? = null

Optional. Whether to break on non key frames.

container

val container: String

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

context

val context: EncodingContext? = null

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

copyTimestamps

val copyTimestamps: Boolean? = null

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

cpuCoreLimit

val cpuCoreLimit: Int? = null

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

deInterlace

val deInterlace: Boolean? = null

Optional. Whether to deinterlace the video.

deviceId

val deviceId: String? = null

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

enableAudioVbrEncoding

val enableAudioVbrEncoding: Boolean? = true

Optional. Whether to enable Audio Encoding.

enableAutoStreamCopy

val enableAutoStreamCopy: Boolean? = null

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

enableMpegtsM2TsMode

val enableMpegtsM2TsMode: Boolean? = null

Optional. Whether to enable the MpegtsM2Ts mode.

framerate

val framerate: Float? = null

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

height

val height: Int? = null

Optional. The fixed vertical resolution of the encoded video.

itemId

val itemId: UUID

The item id.

level

val level: String? = null

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

liveStreamId

val liveStreamId: String? = null

The live stream id.

maxAudioBitDepth

val maxAudioBitDepth: Int? = null

Optional. The maximum audio bit depth.

maxAudioChannels

val maxAudioChannels: Int? = null

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

maxFramerate

val maxFramerate: Float? = null

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

maxHeight

val maxHeight: Int? = null

Optional. The maximum vertical resolution of the encoded video.

maxRefFrames

val maxRefFrames: Int? = null

Optional.

maxVideoBitDepth

val maxVideoBitDepth: Int? = null

Optional. The maximum video bit depth.

maxWidth

val maxWidth: Int? = null

Optional. The maximum horizontal resolution of the encoded video.

mediaSourceId

val mediaSourceId: String? = null

The media version id, if playing an alternate version.

minSegments

val minSegments: Int? = null

The minimum number of segments.

params

val params: String? = null

The streaming parameters.

playlistId

val playlistId: String

The playlist id.

playSessionId

val playSessionId: String? = null

The play session id.

profile

val profile: String? = null

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

requireAvc

val requireAvc: Boolean? = null

Optional. Whether to require avc.

requireNonAnamorphic

val requireNonAnamorphic: Boolean? = null

Optional. Whether to require a non anamorphic stream.

runtimeTicks

val runtimeTicks: Long

The position of the requested segment in ticks.

segmentContainer

val segmentContainer: String? = null

The segment container.

segmentId

val segmentId: Int

The segment id.

segmentLength

val segmentLength: Int? = null

The desired segment length.

startTimeTicks

val startTimeTicks: Long? = null

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

static

val static: Boolean? = null

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.

streamOptions