ILMMixCapSrcStream::get_Volume

Summary

Retrieves the stream's volume.

Syntax

#include "ilmmixcapsrc.h"
Platform Syntax
C HRESULT ILMMixCapSrcStream_get_Volume(pixCapSrcStream, pVal)
C++ HRESULT get_Volume(pVal)

Parameters

ILMMixCapSrcStream * pixCapSrcStream

Pointer to an ILMMixCapSrcStream interface.

DOUBLE *pVal

Pointer to a variable that receives the stream's volume.

Returns

Value Meaning
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

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:

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 stream's volume, call ILMMixCapSrcStream::put_Volume.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

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

LEADTOOLS Filters C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.