SetShapeFiltVolOutputGain

Sets the output gain.

Syntax

HRESULT SetShapeFiltVolOutputGain(
         SHAPE_FILTVOL_CONTEXT *context,
         float outputGain
)  

Parameters

context
Type: SHAPE_FILTVOL_CONTEXT *

[in, out] Pointer to a SHAPE_FILTVOL_CONTEXT structure.

outputGain
Type: float 

The output gain.

Return value

Type: HRESULT 

HRESULT success or error code.

Remarks

Gain, and gain target, are amplitude values in the range -2.0 to 2.0, with negative values inverting the signal.

Values Description
1.0 to 2.0 Amplification
1.0 Unity gain
0.0 to 1.0 Gain reduction
0.0 Silence
-1.0 to 0.0 Gain reduction (inverted signal)
-1.0 Unity gain (inverted signal)
-2.0 to -1.0 Amplification (inverted signal)

Requirements

Header: Declared in shapefiltvolcontext.h.

Library: Use acphal.lib.