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

GetUniversalAudioStreamRequest

@Serializable

data class GetUniversalAudioStreamRequest(val itemId: UUID, val container: Collection<String>? = null, val mediaSourceId: String? = null, val deviceId: String? = null, val userId: UUID? = null, val audioCodec: String? = null, val maxAudioChannels: Int? = null, val transcodingAudioChannels: Int? = null, val maxStreamingBitrate: Int? = null, val audioBitRate: Int? = null, val startTimeTicks: Long? = null, val transcodingContainer: String? = null, val transcodingProtocol: MediaStreamProtocol? = null, val maxAudioSampleRate: Int? = null, val maxAudioBitDepth: Int? = null, val enableRemoteMedia: Boolean? = null, val enableAudioVbrEncoding: Boolean? = true, val breakOnNonKeyFrames: Boolean? = false, val enableRedirection: Boolean? = true)

An audio stream.

Constructors

GetUniversalAudioStreamRequest

constructor(itemId: UUID, container: Collection<String>? = null, mediaSourceId: String? = null, deviceId: String? = null, userId: UUID? = null, audioCodec: String? = null, maxAudioChannels: Int? = null, transcodingAudioChannels: Int? = null, maxStreamingBitrate: Int? = null, audioBitRate: Int? = null, startTimeTicks: Long? = null, transcodingContainer: String? = null, transcodingProtocol: MediaStreamProtocol? = null, maxAudioSampleRate: Int? = null, maxAudioBitDepth: Int? = null, enableRemoteMedia: Boolean? = null, enableAudioVbrEncoding: Boolean? = true, breakOnNonKeyFrames: Boolean? = false, enableRedirection: Boolean? = true)

Properties

@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.

@SerialName(value = "audioCodec")

val audioCodec: String?

Optional. The audio codec to transcode to.

breakOnNonKeyFrames

@SerialName(value = "breakOnNonKeyFrames")

val breakOnNonKeyFrames: Boolean?

Optional. Whether to break on non key frames.

@SerialName(value = "container")

val container: Collection<String>?

Optional. The audio container.

@SerialName(value = "deviceId")

val deviceId: String?

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

enableAudioVbrEncoding

@SerialName(value = "enableAudioVbrEncoding")

val enableAudioVbrEncoding: Boolean?

Optional. Whether to enable Audio Encoding.

enableRedirection

@SerialName(value = "enableRedirection")

val enableRedirection: Boolean?

Whether to enable redirection. Defaults to true.

enableRemoteMedia

@SerialName(value = "enableRemoteMedia")

val enableRemoteMedia: Boolean?

Optional. Whether to enable remote media.

@SerialName(value = "itemId")

val itemId: UUID

The item id.

maxAudioBitDepth

@SerialName(value = "maxAudioBitDepth")

val maxAudioBitDepth: Int?

Optional. The maximum audio bit depth.

maxAudioChannels

@SerialName(value = "maxAudioChannels")

val maxAudioChannels: Int?

Optional. The maximum number of audio channels.

maxAudioSampleRate

@SerialName(value = "maxAudioSampleRate")

val maxAudioSampleRate: Int?

Optional. The maximum audio sample rate.

maxStreamingBitrate

@SerialName(value = "maxStreamingBitrate")

val maxStreamingBitrate: Int?

Optional. The maximum streaming bitrate.

@SerialName(value = "mediaSourceId")

val mediaSourceId: String?

The media version id, if playing an alternate version.

@SerialName(value = "startTimeTicks")

val startTimeTicks: Long?

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

transcodingAudioChannels

@SerialName(value = "transcodingAudioChannels")

val transcodingAudioChannels: Int?

Optional. The number of how many audio channels to transcode to.

transcodingContainer

@SerialName(value = "transcodingContainer")

val transcodingContainer: String?

Optional. The container to transcode to.

transcodingProtocol

@SerialName(value = "transcodingProtocol")

val transcodingProtocol: MediaStreamProtocol?

Optional. The transcoding protocol.

@SerialName(value = "userId")

val userId: UUID?

Optional. The user id.