ToiAudioOutputConfigurationSession

Method Summary

apply ( )	Applies the changes made in this configuration session.
releaseInstance ( )	This function releases the resources used by this instance and ends the configuration session. If ToiAudioOutputConfigurationSession#apply has not been called, the session configuration is lost.
resetFormatMapping ( inputFormat )	Resets output format to 'no output' for the specified input format on all available outputs.
revert ( )	Reverts any changes made in this configuration session.
setFormatMapping ( connectionId , inputFormat , outputFormatOption )	Sets the format mapping on the specified audio output connection.

Inherited Methods

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.

Methods

apply ( )

Applies the changes made in the configuration session and makes the changes permanent as well as notifying any observers of the changed configuration.

getFormatMapping ( connectionId , inputFormat ) → formatMapping

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

Inherited From:

ToiAudioOutputConfiguration#getFormatMapping

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.

Inherited From:

ToiAudioOutputConfiguration#getFormatMappingList

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>

releaseInstance ( )

This function releases the resources used by this instance and ends the configuration session. If ToiAudioOutputConfigurationSession#apply has not been called, the session configuration is lost.

resetFormatMapping ( inputFormat )

Resets output format to 'no output' for the specified input format on all available outputs.

Parameters:

Name	Type	Description
`inputFormat`	ToiAudioOutputConfiguration.ToiAudioFormat	The input format to reset.

revert ( )

Reverts a configuration session to the state it had when first being created, even if changes have been applied. The reverted configuration is not applied until ToiAudioOutputConfigurationSession#apply is called.

setFormatMapping ( connectionId , inputFormat , outputFormatOption )

Sets the format mapping on the specified audio output connection.

Parameters:

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

Throws:

ToiInvalidArgumentException	Raised if the output connection or the output format option is invalid.
ToiOperationNotSupportedException	Raised if the format mapping can not be set..