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

GetVariantHlsAudioPlaylistDeprecatedRequest

@Serializable

data class GetVariantHlsAudioPlaylistDeprecatedRequest(val itemId: UUID, val static: Boolean? = null, val params: String? = null, val tag: String? = null, val deviceProfileId: 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 maxStreamingBitrate: 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 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)

An audio stream using HTTP live streaming.

Constructors

constructor(itemId: UUID, static: Boolean? = null, params: String? = null, tag: String? = null, deviceProfileId: 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, maxStreamingBitrate: 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: 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)

Properties

allowAudioStreamCopy

@SerialName(value = "allowAudioStreamCopy")

val allowAudioStreamCopy: Boolean?

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

allowVideoStreamCopy

@SerialName(value = "allowVideoStreamCopy")

val allowVideoStreamCopy: Boolean?

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

audioBitRate

@SerialName(value = "audioBitRate")

val audioBitRate: Int?

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

audioChannels

@SerialName(value = "audioChannels")

val audioChannels: Int?

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

audioCodec

@SerialName(value = "audioCodec")

val audioCodec: String?

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

audioSampleRate

@SerialName(value = "audioSampleRate")

val audioSampleRate: Int?

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

audioStreamIndex

@SerialName(value = "audioStreamIndex")

val audioStreamIndex: Int?

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

breakOnNonKeyFrames

@SerialName(value = "breakOnNonKeyFrames")

val breakOnNonKeyFrames: Boolean?

Optional. Whether to break on non key frames.

context

@SerialName(value = "context")

val context: EncodingContext?

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

copyTimestamps

@SerialName(value = "copyTimestamps")

val copyTimestamps: Boolean?

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

cpuCoreLimit

@SerialName(value = "cpuCoreLimit")

val cpuCoreLimit: Int?

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

deInterlace

@SerialName(value = "deInterlace")

val deInterlace: Boolean?

Optional. Whether to deinterlace the video.

deviceId

@SerialName(value = "deviceId")

val deviceId: String?

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

deviceProfileId

@SerialName(value = "deviceProfileId")

val ~~deviceProfileId~~: String?

Optional. The dlna device profile id to utilize.

enableAudioVbrEncoding

@SerialName(value = "enableAudioVbrEncoding")

val enableAudioVbrEncoding: Boolean?

Optional. Whether to enable Audio Encoding.

enableAutoStreamCopy

@SerialName(value = "enableAutoStreamCopy")

val enableAutoStreamCopy: Boolean?

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

enableMpegtsM2TsMode

@SerialName(value = "enableMpegtsM2TsMode")

val enableMpegtsM2TsMode: Boolean?

Optional. Whether to enable the MpegtsM2Ts mode.

framerate

@SerialName(value = "framerate")

val framerate: Float?

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

height

@SerialName(value = "height")

val height: Int?

Optional. The fixed vertical resolution of the encoded video.

itemId

@SerialName(value = "itemId")

val itemId: UUID

The item id.

level

@SerialName(value = "level")

val level: String?

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

liveStreamId

@SerialName(value = "liveStreamId")

val liveStreamId: String?

The live stream id.

maxAudioBitDepth

@SerialName(value = "maxAudioBitDepth")

val maxAudioBitDepth: Int?

Optional. The maximum audio bit depth.

maxAudioChannels

@SerialName(value = "maxAudioChannels")

val maxAudioChannels: Int?

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

maxFramerate

@SerialName(value = "maxFramerate")

val maxFramerate: Float?

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

maxRefFrames

@SerialName(value = "maxRefFrames")

val maxRefFrames: Int?

Optional.

maxStreamingBitrate

@SerialName(value = "maxStreamingBitrate")

val maxStreamingBitrate: Int?

Optional. The maximum streaming bitrate.

maxVideoBitDepth

@SerialName(value = "maxVideoBitDepth")

val maxVideoBitDepth: Int?

Optional. The maximum video bit depth.

mediaSourceId

@SerialName(value = "mediaSourceId")

val mediaSourceId: String?

The media version id, if playing an alternate version.

minSegments

@SerialName(value = "minSegments")

val minSegments: Int?

The minimum number of segments.

params

@SerialName(value = "params")

val params: String?

The streaming parameters.

playSessionId

@SerialName(value = "playSessionId")

val playSessionId: String?

The play session id.

profile

@SerialName(value = "profile")

val profile: String?

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

requireAvc

@SerialName(value = "requireAvc")

val requireAvc: Boolean?

Optional. Whether to require avc.

requireNonAnamorphic

@SerialName(value = "requireNonAnamorphic")

val requireNonAnamorphic: Boolean?

Optional. Whether to require a non anamorphic stream.

segmentContainer

@SerialName(value = "segmentContainer")

val segmentContainer: String?

The segment container.

segmentLength

@SerialName(value = "segmentLength")

val segmentLength: Int?

The segment length.

startTimeTicks

@SerialName(value = "startTimeTicks")

val startTimeTicks: Long?

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

static

@SerialName(value = "static")

val static: Boolean?

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