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

GetUniversalAudioStreamRequest

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

val audioBitRate: Int? = null

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

val audioCodec: String? = null

Optional. The audio codec to transcode to.

breakOnNonKeyFrames

val breakOnNonKeyFrames: Boolean? = false

Optional. Whether to break on non key frames.

val container: Collection<String>? = null

Optional. The audio container.

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.

enableRedirection

val enableRedirection: Boolean? = true

Whether to enable redirection. Defaults to true.

enableRemoteMedia

val enableRemoteMedia: Boolean? = null

Optional. Whether to enable remote media.

val itemId: UUID

The item id.

maxAudioBitDepth

val maxAudioBitDepth: Int? = null

Optional. The maximum audio bit depth.

maxAudioChannels

val maxAudioChannels: Int? = null

Optional. The maximum number of audio channels.

maxAudioSampleRate

val maxAudioSampleRate: Int? = null

Optional. The maximum audio sample rate.

maxStreamingBitrate

val maxStreamingBitrate: Int? = null

Optional. The maximum streaming bitrate.

val mediaSourceId: String? = null

The media version id, if playing an alternate version.

val startTimeTicks: Long? = null

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

transcodingAudioChannels

val transcodingAudioChannels: Int? = null

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

transcodingContainer

val transcodingContainer: String? = null

Optional. The container to transcode to.

transcodingProtocol

val transcodingProtocol: MediaStreamProtocol? = null

Optional. The transcoding protocol.

val userId: UUID? = null

Optional. The user id.