IltmfCapture::get_Balance

#include "ltmf.h"

C Syntax

HRESULT IltmfCapture_get_Balance(pCapture, pBalance)

C++ Syntax

HRESULT get_Balance(pBalance)

IltmfCapture *pCapture;

pointer to an interface

long *pBalance;

pointer to a variable

Retrieves the balance for the audio stream .

Parameter

Description

pCapture

Pointer to an IltmfCapture interface.

pBalance

Pointer to a variable to be updated with the balance value. Possible values range from 10000 to 10000, where 10000 indicates that the right channel is receiving no signal, 10000 indicates that the left channel is receiving no signal, and 0 indicates that both channels are getting the same amount of the audio signal.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes.

Comments

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:

IltmfCapture::put_Balance, IltmfCapture::get_Volume, IltmfCapture::put_Volume, IltmfCapture::get_Mute, IltmfCapture::put_Mute

Topics:

Media Foundation Function Group

Example

For a C++ example, refer to Using Mute with ltmfCapture Example for C++.

Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Media Foundation C API Help