IltmmPlay::get_SourceAudioFormat

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay_get_SourceAudioFormat(pPlay, pVal)

C++ Syntax

HRESULT get_SourceAudioFormat(pVal)

 

IltmmPlay *pPlay;

/* pointer to an interface */

long *pVal;

/* pointer to a variable */

Retrieves the format id of the source audio.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

pVal

Pointer to a variable to be updated with a value that represents the format of the source audio. For a list of audio format values, refer to the Microsoft documentation.

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

If the source audio format is not a standard format, then the variable pointed to by pVal is updated with 0.

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:

IltmmPlay::get_SourceVideoType, IltmmPlay::get_SourceAudioType, IltmmPlay::get_SourceVideoFOURCC

Topics:

Multimedia Function Group

Example

For a C example, refer to the IltmmPlay::get_SourceAudioFormat Example for C.

For a C++ example, refer to the IltmmPlay::get_SourceAudioFormat Example for C++.