IBDA_Encoder::EnumAudioCapability method (bdaiface.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

Gets one of the audio formats supported by the device.

Syntax

HRESULT EnumAudioCapability(
  [in]  DWORD FmtIndex,
  [out] DWORD *MethodID,
  [out] DWORD *AlgorithmType,
  [out] DWORD *SamplingRate,
  [out] DWORD *BitDepth,
  [out] DWORD *NumChannels
);

Parameters

[in] FmtIndex

The zero-based index of the audio format to retrieve. To get the number of audio formats, call IBDA_Encoder::QueryCapabilities.

[out] MethodID

Receives a value that uniquely identifies this audio method.

[out] AlgorithmType

Receives the type of encoding algorithm. The following values are defined.

Value Meaning
PBDA_Encoder_Audio_AlgorithmType_MPEG1LayerII
0x00000000
MPEG-1 Layer II.
PBDA_Encoder_Audio_AlgorithmType_AC3
0x00000001
Dolby AC3.

[out] SamplingRate

Receives the audio sampling rate, in Hz.

[out] BitDepth

Receives the number of bits per audio sample.

[out] NumChannels

Receives the number of audio channels.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows�7 [desktop apps only]
Minimum supported server Windows Server�2008�R2 [desktop apps only]
Target Platform Windows
Header bdaiface.h

See also

IBDA_Encoder