Edit

Share via

ITBasicAudioTerminal::get_Balance method (tapi3if.h)

  • Article

The get_Balance method gets the balance. This method is not implemented for terminals shipped with TAPI 3.0 and higher.

Syntax

HRESULT get_Balance(
  [out] long *plBalance
);

Parameters

[out] plBalance

Pointer to balance.

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_OUTOFMEMORY
 Insufficient memory exists to perform the operation.
TAPI_E_NOTSUPPORTED
 Terminal does not support balance operations.
E_NOTIMPL
 Terminal's balance methods are not implemented.

Remarks

The balance property 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.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITBasicAudioTerminal

Terminal Object

put_Balance