IBDA_Encoder::EnumAudioCapability Method

[This documentation is preliminary and is subject to change.]
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

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

  • MethodID [out]
    Receives a value that uniquely identifies this audio method.

  • AlgorithmType [out]
    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.

  • SamplingRate [out]
    Receives the audio sampling rate, in Hz.

  • BitDepth [out]
    Receives the number of bits per audio sample.

  • NumChannels [out]
    Receives the number of audio channels.

Return Value

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

Requirements

Client Requires Windows 7.
IDL Declared in Bdaiface.idl.

See Also

IBDA_Encoder

Send comments about this topic to Microsoft

Build date: 12/4/2008