Collapse All Expand All

IltmfPlay::get_Balance

#include "ltmf.h"

C Syntax	HRESULT IltmfPlay_get_Balance(pPlay, pVal)
C++ Syntax	HRESULT get_Balance(pVal)

 

IltmfPlay *pPlay;	/* pointer to an interface */
long *pVal;	/* balance value */

Retrieves the balance for the audio signal.

Parameter	Description
pPlay	Pointer to an IltmfPlay interface.
pVal	Pointer to a variable receives the balance value.

Returns

S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the MediaFoundation documentation.

Comments

The balance is a value between 10,000 and 10,000.

A value of 10,000 indicates that the right speaker has been disabled and only the left speaker is receiving an audio signal.

A value of 0 indicates that both speakers are receiving equivalent audio signals.

A value of 10,000 indicates that the left speaker has been disabled and only the right speaker is receiving an audio signal.

Units correspond to .01 decibels (multiplied by 1 when pVal is a positive value). For example, a value of 1000 indicates 10 dB on the right channel and 90 dB on the left channel.

Required DLLs and Libraries

LTMF 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:	IltmfPlay::put_Balance
Topics:	Media Foundation Function Group

Example

For a C++ example, refer to the Simple Media Player for C++.