IToiAudioOutputConfigurationSession Interface Reference


Description

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

import "IToiAudioOutputConfigurationSession.idl";

List of all members.

Public Member Functions

void ResetFormatMapping (in IToiAudioOutputConfiguration::TToiAudioFormat inputFormat)
void SetFormatMapping (in IToiAudioOutputService::TToiAudioConnectionId connectionId, in IToiAudioOutputConfiguration::TToiAudioFormat inputFormat, in IToiAudioOutputConfiguration::TToiAudioFormatOption outputFormatOption) raises (TToiInvalidArgumentException, TToiOperationNotSupportedException)
void Apply ()
void Revert ()
void GetFormatMapping (in IToiAudioOutputService::TToiAudioConnectionId connectionId, in TToiAudioFormat inputFormat, out TToiAudioFormatMapping formatMapping) raises (TToiInvalidArgumentException)
void GetFormatMappingList (in IToiAudioOutputService::TToiAudioConnectionId connectionId, out TToiAudioFormatMappingSequence formatMappingList) raises (TToiInvalidArgumentException)
void GetHdmiSinkInfo (in IToiAudioOutputService::TToiAudioConnectionId connectionId, out TToiHdmiSinkInfo sinkInfo) raises (TToiInvalidArgumentException)

Public Types

enum  TToiAudioFormat {
  AUDIO_FORMAT_NULL, AUDIO_FORMAT_MPEG_1, AUDIO_FORMAT_MPEG_2, AUDIO_FORMAT_AC3,
  AUDIO_FORMAT_AC3_PLUS, AUDIO_FORMAT_AAC_HE, AUDIO_FORMAT_AAC_LC, AUDIO_FORMAT_DTS,
  AUDIO_FORMAT_DTS_HD, AUDIO_FORMAT_PCM_2CH, AUDIO_FORMAT_PCM_MULTI
}
enum  TToiHdmiConnectionStatus { HDMI_CONNECTION_STATUS_UNKNOWN, HDMI_CONNECTION_STATUS_CONNECTED, HDMI_CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN, HDMI_CONNECTION_STATUS_DISCONNECTED }
typedef sequence< TToiAudioFormatTToiAudioFormatSequence
typedef sequence
< TToiAudioFormatOption
TToiAudioFormatOptionSequence
typedef sequence
< TToiAudioFormatMapping
TToiAudioFormatMappingSequence

Member Typedef Documentation

List of audio format mappings.

List of audio format options.

List of audio formats.


Member Enumeration Documentation

Input and output audio formats.

Enumerator:
AUDIO_FORMAT_NULL 

No value.

AUDIO_FORMAT_MPEG_1 

MPEG1 audio.

AUDIO_FORMAT_MPEG_2 

MPEG2 audio.

AUDIO_FORMAT_AC3 

AC3 audio.

AUDIO_FORMAT_AC3_PLUS 

Enhanced AC3 audio.

AUDIO_FORMAT_AAC_HE 

AAC HE audio.

AUDIO_FORMAT_AAC_LC 

AAC LC audio.

AUDIO_FORMAT_DTS 

DTS audio.

AUDIO_FORMAT_DTS_HD 

DTS HD audio.

AUDIO_FORMAT_PCM_2CH 

PCM stereo audio.

AUDIO_FORMAT_PCM_MULTI 

PCM multi audio.

HDMI conntection status information.

Enumerator:
HDMI_CONNECTION_STATUS_UNKNOWN 

HDMI connection status is unknown.

HDMI_CONNECTION_STATUS_CONNECTED 

HDMI sink is connected and capabilities are known.

HDMI_CONNECTION_STATUS_CONNECTED_CAPABILITIES_UNKNOWN 

HDMI sink is connected and capabilities are unknown/invalid.

HDMI_CONNECTION_STATUS_DISCONNECTED 

HDMI sink is not connected.


Member Function Documentation

void IToiAudioOutputConfigurationSession::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 IToiAudioOutputConfiguration::GetFormatMapping ( in IToiAudioOutputService::TToiAudioConnectionId  connectionId,
in TToiAudioFormat  inputFormat,
out TToiAudioFormatMapping  formatMapping 
) 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.
void IToiAudioOutputConfiguration::GetFormatMappingList ( in IToiAudioOutputService::TToiAudioConnectionId  connectionId,
out TToiAudioFormatMappingSequence  formatMappingList 
) 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.
void IToiAudioOutputConfiguration::GetHdmiSinkInfo ( in IToiAudioOutputService::TToiAudioConnectionId  connectionId,
out TToiHdmiSinkInfo  sinkInfo 
) 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 IToiAudioOutputConfigurationSession::ResetFormatMapping ( in IToiAudioOutputConfiguration::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 IToiAudioOutputConfigurationSession::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 IToiAudioOutputConfigurationSession::SetFormatMapping ( in IToiAudioOutputService::TToiAudioConnectionId  connectionId,
in IToiAudioOutputConfiguration::TToiAudioFormat  inputFormat,
in IToiAudioOutputConfiguration::TToiAudioFormatOption  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..