ToiAudioOutputConfigurationSession Interface Reference

Description

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

import "ToiAudioOutputConfigurationSession.idl";

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 ()
ToiAudioOutputConfigurationAudioFormatMapping getFormatMapping (in ToiAudioOutputService::TToiAudioConnectionId connectionId, in TToiAudioFormat inputFormat) raises (TToiInvalidArgumentException)
TToiAudioFormatMappingSequence getFormatMappingList (in ToiAudioOutputService::TToiAudioConnectionId connectionId) raises (TToiInvalidArgumentException)
ToiAudioOutputConfigurationHdmiSinkInfo getHdmiSinkInfo (in ToiAudioOutputService::TToiAudioConnectionId connectionId) raises (TToiInvalidArgumentException)

Public Attributes

TToiAudioFormat

const TToiAudioFormat AUDIO_FORMAT_NULL = 0
const TToiAudioFormat AUDIO_FORMAT_MPEG_1 = 1
const TToiAudioFormat AUDIO_FORMAT_MPEG_2 = 2
const TToiAudioFormat AUDIO_FORMAT_AC3 = 3
const TToiAudioFormat AUDIO_FORMAT_AC3_PLUS = 4
const TToiAudioFormat AUDIO_FORMAT_AAC_HE = 5
const TToiAudioFormat AUDIO_FORMAT_AAC_LC = 6
const TToiAudioFormat AUDIO_FORMAT_DTS = 7
const TToiAudioFormat AUDIO_FORMAT_DTS_HD = 8
const TToiAudioFormat AUDIO_FORMAT_PCM_2CH = 9
const TToiAudioFormat AUDIO_FORMAT_PCM_MULTI = 10
TToiHdmiConnectionStatus

const TToiHdmiConnectionStatus HDMI_CONNECTION_STATUS_UNKNOWN = 0
const TToiHdmiConnectionStatus HDMI_CONNECTION_STATUS_CONNECTED = 1
const TToiHdmiConnectionStatus HDMI_CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN = 2
const TToiHdmiConnectionStatus HDMI_CONNECTION_STATUS_DISCONNECTED = 3

Public Types

typedef long TToiAudioFormat
typedef long TToiHdmiConnectionStatus
typedef sequence< TToiAudioFormat > TToiAudioFormatSequence
typedef sequence
< ToiAudioOutputConfigurationAudioFormatOption > 		TToiAudioFormatOptionSequence
typedef sequence
< ToiAudioOutputConfigurationAudioFormatMapping > 		TToiAudioFormatMappingSequence

Member Typedef Documentation

typedef long ToiAudioOutputConfiguration::TToiAudioFormat [inherited]

Input and output audio formats.

typedef sequence< ToiAudioOutputConfigurationAudioFormatMapping > ToiAudioOutputConfiguration::TToiAudioFormatMappingSequence [inherited]

List of audio format mappings.

typedef sequence< ToiAudioOutputConfigurationAudioFormatOption > ToiAudioOutputConfiguration::TToiAudioFormatOptionSequence [inherited]

List of audio format options.

typedef sequence< TToiAudioFormat > ToiAudioOutputConfiguration::TToiAudioFormatSequence [inherited]

List of audio formats.

typedef long ToiAudioOutputConfiguration::TToiHdmiConnectionStatus [inherited]

HDMI conntection status information.

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.

ToiAudioOutputConfigurationAudioFormatMapping ToiAudioOutputConfiguration::getFormatMapping ( in ToiAudioOutputService::TToiAudioConnectionId  connectionId,
in TToiAudioFormat  inputFormat 
) raises (TToiInvalidArgumentException) [inherited]

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

Parameters:
connectionId The identifier of the output connection.
inputFormat The input format.
Return values:
formatMapping The requested format mapping.
Exceptions:
TToiInvalidArgumentException Raised if the output connection or the input format is invalid.
TToiAudioFormatMappingSequence ToiAudioOutputConfiguration::getFormatMappingList ( in ToiAudioOutputService::TToiAudioConnectionId  connectionId  )  raises (TToiInvalidArgumentException) [inherited]

Returns all audio format mappings for the specified output connection.

Parameters:
connectionId The identifier of the output connection.
Return values:
formatMappingList The list of audio format mappings.
Exceptions:
TToiInvalidArgumentException Raised if the output connection is invalid.
ToiAudioOutputConfigurationHdmiSinkInfo ToiAudioOutputConfiguration::getHdmiSinkInfo ( in ToiAudioOutputService::TToiAudioConnectionId  connectionId  )  raises (TToiInvalidArgumentException) [inherited]

Returns the sink information for specified HDMI connection.

Parameters:
connectionId The identifier of the HDMI output connection.
Return values:
sinkInfo The sink information for the HDMI connection.
Exceptions:
TToiInvalidArgumentException Raised if the output connection is invalid.
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..

Member Data Documentation

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AAC_HE = 5 [inherited]

AAC HE audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AAC_LC = 6 [inherited]

AAC LC audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AC3 = 3 [inherited]

AC3 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AC3_PLUS = 4 [inherited]

Enhanced AC3 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_DTS = 7 [inherited]

DTS audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_DTS_HD = 8 [inherited]

DTS HD audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_MPEG_1 = 1 [inherited]

MPEG1 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_MPEG_2 = 2 [inherited]

MPEG2 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_NULL = 0 [inherited]

No value.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_PCM_2CH = 9 [inherited]

PCM stereo audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_PCM_MULTI = 10 [inherited]

PCM multi audio.

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

const TToiHdmiConnectionStatus ToiAudioOutputConfiguration::HDMI_CONNECTION_STATUS_CONNECTED = 1 [inherited]

HDMI sink is connected and capabilities are known.

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

const TToiHdmiConnectionStatus ToiAudioOutputConfiguration::HDMI_CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN = 2 [inherited]

HDMI sink is connected and capabilities are unknown/invalid.

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

const TToiHdmiConnectionStatus ToiAudioOutputConfiguration::HDMI_CONNECTION_STATUS_DISCONNECTED = 3 [inherited]

HDMI sink is not connected.

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

const TToiHdmiConnectionStatus ToiAudioOutputConfiguration::HDMI_CONNECTION_STATUS_UNKNOWN = 0 [inherited]

HDMI connection status is unknown.

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