ToiAudioOutputConfigurationSession Interface Reference

---

Description

ToiAudioOutputConfigurationSession is used to change the format mappings of available audio input formats.

import "ToiAudioOutputConfigurationSession.idl";

Inheritance diagram for ToiAudioOutputConfigurationSession:

List of all members.

Public Member Functions
void	resetFormatMapping (in ToiAudioOutputConfiguration::TToiAudioFormat inputFormat)
void	setFormatMapping (in ToiAudioOutputService::TToiAudioConnectionId connectionId, in ToiAudioOutputConfiguration::TToiAudioFormat inputFormat, in ToiAudioOutputConfigurationAudioFormatOption outputFormatOption) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
void	apply ()
void	revert ()

---

Member Function Documentation

void ToiAudioOutputConfigurationSession::apply

(

)

Applies any changes made in this session. This method also releases the resources used by this object and removes all registered observers. Upon return this object will no longer be available and any subsequent method calls will result in a low-level run-time failure.

void ToiAudioOutputConfigurationSession::resetFormatMapping

(

in ToiAudioOutputConfiguration::TToiAudioFormat

inputFormat

)

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

Parameters:

inputFormat

The input format to reset.

void ToiAudioOutputConfigurationSession::revert

(

)

Reverts any changes made in this session. This method also releases the resources used by this object and removes all registered observers. Upon return this object will no longer be available and any subsequent method calls will result in a low-level run-time failure.

void ToiAudioOutputConfigurationSession::setFormatMapping	(	in ToiAudioOutputService::TToiAudioConnectionId	connectionId,
		in ToiAudioOutputConfiguration::TToiAudioFormat	inputFormat,
		in ToiAudioOutputConfigurationAudioFormatOption	outputFormatOption
	)		raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)

Sets the format mapping on the specified audio output connection.

Parameters:

connectionId	The identifier of the output connection.
inputFormat	The input format.
outputFormatOption	The output format option.

Exceptions:

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