IltmmAudioFormat::get_SampleFrequency

#include "ltmm.h"

C Syntax

HRESULT IltmmAudioFormat_get_SampleFrequency(pAudioFormat, pVal)

C++ Syntax

HRESULT get_SampleFrequency(pVal)

 

IltmmAudioFormat *pAudioFormat;

/* pointer to an interface */

long *pVal;

/* pointer to a variable */

Retrieves the audio format's sample frequency, in HZ. This is the number of audio samples in one second.

Parameter

Description

pAudioFormat

Pointer to an IltmmAudioFormat Interface.

pVal

Pointer to a variable to be updated with the audio format's sample frequency.

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.

Comments

Call IltmmAudioFormat::get_Channels to get the number of channels for the audio format and call IltmmAudioFormat::get_BitsPerSample to get the number of bits per sample for the audio format.

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:

IltmmAudioFormat Interface, IltmmAudioFormat::get_BitsPerSample, IltmmAudioFormat::get_Channels

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++.