ILMMixCapSrc::get_Volume

Summary

Retrieves the master volume.

Syntax

Parameters

ILMMixCapSrc * pMixCapSrc

Pointer to an ILMMixCapSrc interface.

DOUBLE *pVal

Pointer to a variable that receives the master volume.

Returns

Comments

Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation). For each stream, the attenuation level is the product of:

• The master volume level.
• The volume level of the stream obtained by ILMMixCapSrcStream::get_Volume.

For example, if the master volume is 0.8 and the stream volume is 0.5, the attenuation for that stream is 0.8 × 0.5 = 0.4. Volume levels can exceed 1.0 (positive gain), but the audio engine clips any audio samples that exceed zero decibels.

Use the following formula to convert the volume level to the decibel (dB) scale:

Attenuation (dB) = 20 * log10(Level)

For example, a volume level of 0.50 represents 6.02 dB of attenuation.

To specify the master volume, call ILMMixCapSrc::put_Volume.

Required DLLs and Libraries

• LMMixCapSrc
• DSKernel
• 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

Functions

• ILMMixCapSrcStream::get_Volume
• ILMMixCapSrc::put_Volume

Topics

• Mixing Capture Source Function References