IltmmPlay::get_Volume

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay__get_Volume(pPlay, pVal)

C++ Syntax

RESULT get_Volume(pVal)

 

IltmmPlay *pPlay;

/* pointer to an interface */

long *pVal;

/* pointer to a variable */

Retrieves the volume (amplitude) of the audio signal.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

pVal

Pointer to a variable that receives the volume value. Divide by 100 to get equivalent decibel value (for example –10,000 = –100 dB).

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

A rate of 1.0 indicates normal playback speed.

A rate of 0.5 indicates half speed.

A rate of –1.0 indicates normal speed in reverse.

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, Mobile

See Also

Elements:

IltmmPlay::get_Balance, IltmmPlay::get_Mute, IltmmPlay::put_Volume

Topics:

Multimedia Function Group

Example

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

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