SetShapeEqCompRelease

Sets the compression release multiplier.

Syntax

HRESULT SetShapeEqCompRelease(  
         SHAPE_EQCOMP_CONTEXT* context,  
         float release  
)  

Parameters

context _Inout_
Type: SHAPE_EQCOMP_CONTEXT* Pointer to a SHAPE_EQCOMP_CONTEXT object. release
Type: float The release multiplier.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

Attack and release are specified in milliseconds, and correspond to how quickly the compressor should vary the output gain in response to the signal exceeding or falling below the threshold. These adjustments can be linear or log based. The desired output level is not achieved until the input has exceeded the threshold for the time specified by attack, and similarly returns to unity only after the input is under the threshold for the time specified by release. For more information, see Equalization and compression in Overview of SHAPE.

Requirements

Header: shapeeqcompcontext.h Supported platforms: XBOX One family consoles and XBOX Series consoles

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

SetShapeEqCompRelease

SetShapeEqCompRelease

Syntax

Parameters

Return value

Remarks

Requirements

See also

​SetShapeEqCompRelease

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

SetShapeEqCompRelease

Syntax

Parameters

Return value

Remarks

Requirements

See also