AXSetDRCVSSurroundDepth

Syntax

#include <cafe/ax.h>

typedef enum
{
    AX_DRC_VS_OUTPUT_SPEAKER = 0,
    AX_DRC_VS_OUTPUT_HEADPHONE,
    AX_DRC_VS_OUTPUT_NUM
} AXDRCVSOutputMode;

AXPB_ERROR_CODE AXSetDRCVSSurroundDepth(AXDRCVSOutputMode output, f32 depth);

Parameters

output AX_DRC_VS_OUTPUT_SPEAKER → Speaker output setting
AX_DRC_VS_OUTPUT_HEADPHONE → Headphone output setting
depth Indicate how much VS processing is in effect.
Set between 0.0f ~ 1.0f. (1.0f is recommended.)
0.0f for no effect; 1.0f for the maximum surround effect
0.0f for down-mixed sound output
Both speakers/headphones are set to 1.0f by default.

Return Values

AXPB_ERROR_NONE if successful, an error of type AXPB_ERROR_CODE otherwise.

Description

Specify how much DRC VS processing should be in effect. It can be specified for each output mode (speakers or headphones) separately.

For more information, see DRC VS Overview.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

DRC VS Overview

Revision History

2013/05/08 Automated cleanup pass.
2012/06/04 Initial Version for SDK 2.06


CONFIDENTIAL