ToiAudioOutputConfiguration Interface Reference

---

Description

ToiAudioOutputConfiguration is used to get information about the format mappings of available audio outputs.

import "ToiAudioOutputConfiguration.idl";

Inheritance diagram for ToiAudioOutputConfiguration:

List of all members.

Public Member Functions
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
const TToiAudioFormat	AUDIO_FORMAT_MP3 = 11
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< octet >	TToiBinary
typedef sequence < ToiAudioOutputConfigurationAudioFormatOption >	TToiAudioFormatOptionSequence
typedef sequence < ToiAudioOutputConfigurationAudioFormatMapping >	TToiAudioFormatMappingSequence

---

Member Typedef Documentation

typedef long ToiAudioOutputConfiguration::TToiAudioFormat

Input and output audio formats.

typedef sequence< ToiAudioOutputConfigurationAudioFormatMapping > ToiAudioOutputConfiguration::TToiAudioFormatMappingSequence

List of audio format mappings.

typedef sequence< ToiAudioOutputConfigurationAudioFormatOption > ToiAudioOutputConfiguration::TToiAudioFormatOptionSequence

List of audio format options.

typedef sequence< TToiAudioFormat > ToiAudioOutputConfiguration::TToiAudioFormatSequence

List of audio formats.

typedef sequence< octet > ToiAudioOutputConfiguration::TToiBinary

Technical Preview:

This type is a TECHNICAL PREVIEW, it may change. Generic byte vector.

typedef long ToiAudioOutputConfiguration::TToiHdmiConnectionStatus

HDMI conntection status information.

---

Member Function Documentation

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

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)

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)

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.

---

Member Data Documentation

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AAC_HE = 5

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

AAC LC audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AC3 = 3

AC3 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_AC3_PLUS = 4

Enhanced AC3 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_DTS = 7

DTS audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_DTS_HD = 8

DTS HD audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_MP3 = 11

MP3 audio

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_MPEG_1 = 1

MPEG1 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_MPEG_2 = 2

MPEG2 audio.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_NULL = 0

No value.

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

const TToiAudioFormat ToiAudioOutputConfiguration::AUDIO_FORMAT_PCM_2CH = 9

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

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

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

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

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

HDMI connection status is unknown.

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