ToiAudioOutputConfiguration

Method Summary

getFormatMapping ( connectionId , inputFormat ) → formatMapping	Returns the audio format mapping for the specified output connection and input format.
getFormatMappingList ( connectionId ) → Array.<ToiAudioOutputConfiguration.ToiAudioFormatMapping>	Returns all audio format mappings for the specified output connection.

Type Definitions

ToiAudioFormat (Type: enum)
Input and output audio formats.
AUDIO_FORMAT_AAC_HE AUDIO_FORMAT_AAC_LC AUDIO_FORMAT_AC3 AUDIO_FORMAT_AC3_PLUS AUDIO_FORMAT_DTS AUDIO_FORMAT_DTS_HD AUDIO_FORMAT_MP3 AUDIO_FORMAT_MPEG_1 AUDIO_FORMAT_MPEG_2 AUDIO_FORMAT_NULL AUDIO_FORMAT_PCM_2CH AUDIO_FORMAT_PCM_MULTI

Methods

getFormatMapping ( connectionId , inputFormat ) → formatMapping

Returns the audio format mapping for the specified output connection and input format.

Parameters:

Name	Type	Description
`connectionId`	ToiAudioOutputService.ToiAudioConnectionId	The identifier of the output connection.
`inputFormat`	ToiAudioOutputConfiguration.ToiAudioFormat	The input format.

Throws:

ToiInvalidArgumentException

Raised if the output connection or the input format is invalid.

Returns:

The requested format mapping.

Type: ToiAudioOutputConfiguration.ToiAudioFormatMapping

getFormatMappingList ( connectionId ) → Array.<ToiAudioOutputConfiguration.ToiAudioFormatMapping>

Returns all audio format mappings for the specified output connection.

Parameters:

Name	Type	Description
`connectionId`	ToiAudioOutputService.ToiAudioConnectionId	The identifier of the output connection.

Throws:

ToiInvalidArgumentException

Raised if the output connection is invalid.

Returns:

The list of audio format mappings.

Type: Array.<ToiAudioOutputConfiguration.ToiAudioFormatMapping>

Members

AUDIO_FORMAT_AAC_HE (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 5) (static, constant)

AAC HE audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_AAC_HE.

AUDIO_FORMAT_AAC_LC (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 6) (static, constant)

AAC LC audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_AAC_LC.

AUDIO_FORMAT_AC3 (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 3) (static, constant)

AC3 audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_AC3.

AUDIO_FORMAT_AC3_PLUS (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 4) (static, constant)

Enhanced AC3 audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_AC3_PLUS.

AUDIO_FORMAT_DTS (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 7) (static, constant)

DTS audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_DTS.

AUDIO_FORMAT_DTS_HD (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 8) (static, constant)

DTS HD audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_DTS_HD.

AUDIO_FORMAT_MP3 (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 11) (static, constant)

MP3 audio

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_MP3.

AUDIO_FORMAT_MPEG_1 (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 1) (static, constant)

MPEG1 audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_MPEG_1.

AUDIO_FORMAT_MPEG_2 (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 2) (static, constant)

MPEG2 audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_MPEG_2.

AUDIO_FORMAT_NULL (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 0) (static, constant)

No value.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_NULL.

AUDIO_FORMAT_PCM_2CH (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 9) (static, constant)

PCM stereo audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_PCM_2CH.

AUDIO_FORMAT_PCM_MULTI (Type: ToiAudioOutputConfiguration.ToiAudioFormat) (value = 10) (static, constant)

PCM multi audio.

This constant can also be accessed from toi.consts.ToiAudioOutputConfiguration.AUDIO_FORMAT_PCM_MULTI.

ToiAudioFormatMapping (Type: struct) (static)

Specifies input and out audio format mapping

Struct fields

Name	Description
activeMixFlag	If true, the available input connections are mixed for this input format. Type: boolean
activeOutputFormat	The active output format for the input format. Type: ToiAudioOutputConfiguration.ToiAudioFormat
inputFormat	The input format. Type: ToiAudioOutputConfiguration.ToiAudioFormat
outputFormatOptionList	A list of output formats available for the input format. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiAudioOutputConfiguration.ToiAudioFormatOption> (Or a single ToiAudioOutputConfiguration.ToiAudioFormatOption.)

ToiAudioFormatOption (Type: struct) (static)

Specifies the audio format and the mix option.

Struct fields

Name	Description
format	The audio format. Type: ToiAudioOutputConfiguration.ToiAudioFormat
mixFlag	If true, the input connections are mixed. Type: boolean