IltmmAudioFormats::Find

#include "ltmm.h"

C Syntax

HRESULT IltmmAudioFormats__Find(pAudioFormats, Freq, Bits, Channels, Index)

C++ Syntax

HRESULT Find(pAudioFormats, Freq, Bits, Channels, Index)

 

IltmmAudioFormats *pAudioFormats;

/* pointer to an interface */

long Freq;

/* frequency*/

long Bits;

/* bits per sample */

long Channels;

/* number of channels */

long *Index;

/* pointer to a variable */

Retrieves the index of the audio format that matches the specified criteria (frequency, bits per sample and number of channels).

Parameter

Description

pAudioFormats

Pointer to an IltmmAudioFormats Interface.

SubType

Value that represents the frequency, in Hertz, of the audio format to be found. Common values include: 8000, 11025, 16000, 22050, 32000, and 44100 Hz..

Bits

Value the represents the number of bits per sample of the audio format to be found. Common values include 8, and 16 bits per sample.

Channels

Value that represents the number of channels of the audio format to be found. Common values include 1 (mono) and 2 (stereo).

Index

Pointer to a variable that receives the zero based index of the audio format matching the specified criteria. A value of –1 indicates that no match was found.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:

IltmmAudioFormats::get_Count, IltmmAudioFormats::Item, IltmmAudioFormats::get_Selection, IltmmAudioFormats::put_Selection

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmAudioFormats::get_Count Example for C.

For a C++ example, refer to IltmmAudioFormats::get_Count Example for C++.