Sign in

v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
UniversalAudio

Gets an audio stream.

head/Audio/{itemId}/universal

Path parameters

itemIdstring uuid required

The item id.

The item id.

Query parameters

containerstring[] nullable

Optional. The audio container.

Optional. The audio container.

mediaSourceIdstring nullable

The media version id, if playing an alternate version.

The media version id, if playing an alternate version.

deviceIdstring nullable

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

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

userIdstring uuid nullable

Optional. The user id.

Optional. The user id.

audioCodecstring nullable

Optional. The audio codec to transcode to.

Optional. The audio codec to transcode to.

maxAudioChannelsinteger nullable

Optional. The maximum number of audio channels.

Optional. The maximum number of audio channels.

transcodingAudioChannelsinteger nullable

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

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

maxStreamingBitrateinteger nullable

Optional. The maximum streaming bitrate.

Optional. The maximum streaming bitrate.

audioBitRateinteger nullable

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

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

startTimeTicksinteger nullable

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

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

transcodingContainerstring nullable

Optional. The container to transcode to.

Optional. The container to transcode to.

transcodingProtocolstring nullable

Optional. The transcoding protocol.

Optional. The transcoding protocol.

maxAudioSampleRateinteger nullable

Optional. The maximum audio sample rate.

Optional. The maximum audio sample rate.

maxAudioBitDepthinteger nullable

Optional. The maximum audio bit depth.

Optional. The maximum audio bit depth.

enableRemoteMediaboolean nullable

Optional. Whether to enable remote media.

Optional. Whether to enable remote media.

breakOnNonKeyFramesboolean

Optional. Whether to break on non key frames.

Optional. Whether to break on non key frames.

enableRedirectionboolean

Whether to enable redirection. Defaults to true.

Whether to enable redirection. Defaults to true.

Response

Audio stream returned.