commonMain.org.jellyfin.sdk.api.operations.UniversalAudioApi.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jellyfin-api-jvm Show documentation
Show all versions of jellyfin-api-jvm Show documentation
Official Kotlin/Java SDK for Jellyfin. org.jellyfin.sdk:jellyfin-api-jvm
// !! WARNING
// !! DO NOT EDIT THIS FILE
//
// This file is generated by the openapi-generator module and is not meant for manual changes.
// Please read the README.md file in the openapi-generator module for additional information.
package org.jellyfin.sdk.api.operations
import io.ktor.utils.io.ByteReadChannel
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.Long
import kotlin.String
import kotlin.collections.Collection
import kotlin.collections.buildMap
import kotlin.collections.emptyList
import kotlin.require
import kotlin.text.Regex
import org.jellyfin.sdk.api.client.ApiClient
import org.jellyfin.sdk.api.client.Response
import org.jellyfin.sdk.api.client.extensions.`get`
import org.jellyfin.sdk.model.UUID
import org.jellyfin.sdk.model.api.MediaStreamProtocol
import org.jellyfin.sdk.model.api.request.GetUniversalAudioStreamRequest
public class UniversalAudioApi(
private val api: ApiClient,
) : Api {
/**
* Gets an audio stream.
*
* @param itemId The item id.
* @param container Optional. The audio container.
* @param mediaSourceId The media version id, if playing an alternate version.
* @param deviceId The device id of the client requesting. Used to stop encoding processes when
* needed.
* @param userId Optional. The user id.
* @param audioCodec Optional. The audio codec to transcode to.
* @param maxAudioChannels Optional. The maximum number of audio channels.
* @param transcodingAudioChannels Optional. The number of how many audio channels to transcode to.
* @param maxStreamingBitrate Optional. The maximum streaming bitrate.
* @param audioBitRate Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted
* this will be left to encoder defaults.
* @param startTimeTicks Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
* @param transcodingContainer Optional. The container to transcode to.
* @param transcodingProtocol Optional. The transcoding protocol.
* @param maxAudioSampleRate Optional. The maximum audio sample rate.
* @param maxAudioBitDepth Optional. The maximum audio bit depth.
* @param enableRemoteMedia Optional. Whether to enable remote media.
* @param breakOnNonKeyFrames Optional. Whether to break on non key frames.
* @param enableRedirection Whether to enable redirection. Defaults to true.
*/
public suspend fun getUniversalAudioStream(
itemId: UUID,
container: Collection? = emptyList(),
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,
breakOnNonKeyFrames: Boolean? = false,
enableRedirection: Boolean? = true,
): Response {
val pathParameters = buildMap(1) {
put("itemId", itemId)
}
require(audioCodec == null || Regex("""^[a-zA-Z0-9\-\._,|]{0,40}$""").matches(audioCodec)) { """Parameter "audioCodec" must match ^[a-zA-Z0-9\-\._,|]{0,40}$.""" }
require(transcodingContainer == null || Regex("""^[a-zA-Z0-9\-\._,|]{0,40}$""").matches(transcodingContainer)) { """Parameter "transcodingContainer" must match ^[a-zA-Z0-9\-\._,|]{0,40}$.""" }
val queryParameters = buildMap(17) {
put("container", container)
put("mediaSourceId", mediaSourceId)
put("deviceId", deviceId)
put("userId", userId)
put("audioCodec", audioCodec)
put("maxAudioChannels", maxAudioChannels)
put("transcodingAudioChannels", transcodingAudioChannels)
put("maxStreamingBitrate", maxStreamingBitrate)
put("audioBitRate", audioBitRate)
put("startTimeTicks", startTimeTicks)
put("transcodingContainer", transcodingContainer)
put("transcodingProtocol", transcodingProtocol)
put("maxAudioSampleRate", maxAudioSampleRate)
put("maxAudioBitDepth", maxAudioBitDepth)
put("enableRemoteMedia", enableRemoteMedia)
put("breakOnNonKeyFrames", breakOnNonKeyFrames)
put("enableRedirection", enableRedirection)
}
val data = null
val response = api.`get`("/Audio/{itemId}/universal", pathParameters,
queryParameters, data)
return response
}
/**
* Gets an audio stream.
*
* @param request The request parameters
*/
public suspend fun getUniversalAudioStream(request: GetUniversalAudioStreamRequest):
Response = getUniversalAudioStream(
itemId = request.itemId,
container = request.container,
mediaSourceId = request.mediaSourceId,
deviceId = request.deviceId,
userId = request.userId,
audioCodec = request.audioCodec,
maxAudioChannels = request.maxAudioChannels,
transcodingAudioChannels = request.transcodingAudioChannels,
maxStreamingBitrate = request.maxStreamingBitrate,
audioBitRate = request.audioBitRate,
startTimeTicks = request.startTimeTicks,
transcodingContainer = request.transcodingContainer,
transcodingProtocol = request.transcodingProtocol,
maxAudioSampleRate = request.maxAudioSampleRate,
maxAudioBitDepth = request.maxAudioBitDepth,
enableRemoteMedia = request.enableRemoteMedia,
breakOnNonKeyFrames = request.breakOnNonKeyFrames,
enableRedirection = request.enableRedirection,
)
/**
* Gets an audio stream.
*
* @param itemId The item id.
* @param container Optional. The audio container.
* @param mediaSourceId The media version id, if playing an alternate version.
* @param deviceId The device id of the client requesting. Used to stop encoding processes when
* needed.
* @param userId Optional. The user id.
* @param audioCodec Optional. The audio codec to transcode to.
* @param maxAudioChannels Optional. The maximum number of audio channels.
* @param transcodingAudioChannels Optional. The number of how many audio channels to transcode to.
* @param maxStreamingBitrate Optional. The maximum streaming bitrate.
* @param audioBitRate Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted
* this will be left to encoder defaults.
* @param startTimeTicks Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
* @param transcodingContainer Optional. The container to transcode to.
* @param transcodingProtocol Optional. The transcoding protocol.
* @param maxAudioSampleRate Optional. The maximum audio sample rate.
* @param maxAudioBitDepth Optional. The maximum audio bit depth.
* @param enableRemoteMedia Optional. Whether to enable remote media.
* @param breakOnNonKeyFrames Optional. Whether to break on non key frames.
* @param enableRedirection Whether to enable redirection. Defaults to true.
*/
public fun getUniversalAudioStreamUrl(
itemId: UUID,
container: Collection? = emptyList(),
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,
breakOnNonKeyFrames: Boolean? = false,
enableRedirection: Boolean? = true,
): String {
val pathParameters = buildMap(1) {
put("itemId", itemId)
}
require(audioCodec == null || Regex("""^[a-zA-Z0-9\-\._,|]{0,40}$""").matches(audioCodec)) { """Parameter "audioCodec" must match ^[a-zA-Z0-9\-\._,|]{0,40}$.""" }
require(transcodingContainer == null || Regex("""^[a-zA-Z0-9\-\._,|]{0,40}$""").matches(transcodingContainer)) { """Parameter "transcodingContainer" must match ^[a-zA-Z0-9\-\._,|]{0,40}$.""" }
val queryParameters = buildMap(17) {
put("container", container)
put("mediaSourceId", mediaSourceId)
put("deviceId", deviceId)
put("userId", userId)
put("audioCodec", audioCodec)
put("maxAudioChannels", maxAudioChannels)
put("transcodingAudioChannels", transcodingAudioChannels)
put("maxStreamingBitrate", maxStreamingBitrate)
put("audioBitRate", audioBitRate)
put("startTimeTicks", startTimeTicks)
put("transcodingContainer", transcodingContainer)
put("transcodingProtocol", transcodingProtocol)
put("maxAudioSampleRate", maxAudioSampleRate)
put("maxAudioBitDepth", maxAudioBitDepth)
put("enableRemoteMedia", enableRemoteMedia)
put("breakOnNonKeyFrames", breakOnNonKeyFrames)
put("enableRedirection", enableRedirection)
}
return api.createUrl("/Audio/{itemId}/universal", pathParameters, queryParameters)
}
}