GetShapeEqCompFilterTargetCoefficients

Gets the target coefficients of an equalizer filter.

Syntax

HRESULT GetShapeEqCompFilterTargetCoefficients(  
         const SHAPE_EQCOMP_CONTEXT* context,  
         SHAPE_EQCOMP_FILTER_INDEX filterIndex,  
         float* a1,  
         float* a2,  
         float* b0,  
         float* b1,  
         float* b2  
)  

Parameters

context   _In_
Type: SHAPE_EQCOMP_CONTEXT* Pointer to a SHAPE_EQCOMP_CONTEXT structure. filterIndex
Type: SHAPE_EQCOMP_FILTER_INDEX A member of the SHAPE_EQCOMP_FILTER_INDEX enumeration. a1   _Out_
Type: float* Target coefficient a1 of the specified equalizer filter. a2   _Out_
Type: float* Target coefficient a2 of the specified equalizer filter. b0   _Out_
Type: float* Target coefficient b0 of the specified equalizer filter. b1   _Out_
Type: float* Target coefficient b1 of the specified equalizer filter. b2   _Out_
Type: float* Target coefficient b2 of the specified equalizer filter.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

The coefficients of each biquad filter (b0, b1, b2, a1, and a2) are stored as 24-bit integers. This allows for a coefficient range of up to ±7.998, which is suitable for providing coefficients for the types of filters allowed: a frequency range of 20 Hz to 18 kHz, and a gain range of -18 dB to 18 dB. 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

GetShapeEqCompFilterTargetCoefficients

GetShapeEqCompFilterTargetCoefficients

Syntax

Parameters

Return value

Remarks

Requirements

See also

​GetShapeEqCompFilterTargetCoefficients

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

GetShapeEqCompFilterTargetCoefficients

Syntax

Parameters

Return value

Remarks

Requirements

See also