Interface UniversalAudioApiHeadUniversalAudioStreamRequest

Request parameters for headUniversalAudioStream operation in UniversalAudioApi.

Export

UniversalAudioApiHeadUniversalAudioStreamRequest

interface UniversalAudioApiHeadUniversalAudioStreamRequest {
    audioBitRate?: number;
    audioCodec?: string;
    breakOnNonKeyFrames?: boolean;
    container?: string[];
    deviceId?: string;
    enableAudioVbrEncoding?: boolean;
    enableRedirection?: boolean;
    enableRemoteMedia?: boolean;
    itemId: string;
    maxAudioBitDepth?: number;
    maxAudioChannels?: number;
    maxAudioSampleRate?: number;
    maxStreamingBitrate?: number;
    mediaSourceId?: string;
    startTimeTicks?: number;
    transcodingAudioChannels?: number;
    transcodingContainer?: string;
    transcodingProtocol?: MediaStreamProtocol;
    userId?: string;
}

Index

Properties

audioBitRate? audioCodec? breakOnNonKeyFrames? container? deviceId? enableAudioVbrEncoding? enableRedirection? enableRemoteMedia? itemId maxAudioBitDepth? maxAudioChannels? maxAudioSampleRate? maxStreamingBitrate? mediaSourceId? startTimeTicks? transcodingAudioChannels? transcodingContainer? transcodingProtocol? userId?

Properties

`Optional` `Readonly`audioBitRate

audioBitRate?: number

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

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`audioCodec

audioCodec?: string

Optional. The audio codec to transcode to.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`breakOnNonKeyFrames

breakOnNonKeyFrames?: boolean

Optional. Whether to break on non key frames.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`container

container?: string[]

Optional. The audio container.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`deviceId

deviceId?: string

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

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`enableAudioVbrEncoding

enableAudioVbrEncoding?: boolean

Optional. Whether to enable Audio Encoding.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`enableRedirection

enableRedirection?: boolean

Whether to enable redirection. Defaults to true.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`enableRemoteMedia

enableRemoteMedia?: boolean

Optional. Whether to enable remote media.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Readonly`itemId

itemId: string

The item id.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`maxAudioBitDepth

maxAudioBitDepth?: number

Optional. The maximum audio bit depth.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`maxAudioChannels

maxAudioChannels?: number

Optional. The maximum number of audio channels.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`maxAudioSampleRate

maxAudioSampleRate?: number

Optional. The maximum audio sample rate.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`maxStreamingBitrate

maxStreamingBitrate?: number

Optional. The maximum streaming bitrate.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`mediaSourceId

mediaSourceId?: string

The media version id, if playing an alternate version.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`startTimeTicks

startTimeTicks?: number

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

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`transcodingAudioChannels

transcodingAudioChannels?: number

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

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`transcodingContainer

transcodingContainer?: string

Optional. The container to transcode to.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`transcodingProtocol

transcodingProtocol?: MediaStreamProtocol

Optional. The transcoding protocol.

Memberof

UniversalAudioApiHeadUniversalAudioStream

`Optional` `Readonly`userId

userId?: string

Optional. The user id.

Memberof

UniversalAudioApiHeadUniversalAudioStream