AXSetDRCVSOutputGain

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 AXSetDRCVSOutputGain(AXDRCVSOutputMode output, f32 gain);

Parameters

output AX_DRC_VS_OUTPUT_SPEAKER → Speaker output setting
AX_DRC_VS_OUTPUT_HEADPHONE → Headphone output setting
gain Output gain for the VS component.
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

DRC VS processing is comprised of 2 components: "VS" and "Down-Mixing". This API sets the volume for the VS component.

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