AXSetDeviceCompressor

Syntax

#include <cafe/ax.h>

AXPB_ERROR_CODE AXSetDeviceCompressor(AXPBDeviceType device, u16 on_off);

Parameters

device Output device.
on_off
AX_COMPRESSOR_OFF No volume compression will be applied.
AX_COMPRESSOR_ON Interactive volume compression will be applied. If the threshold value of 0 dB is exceeded, a -4dB attenuation is applied to the output signal. This attenuation is in a 4 dB range, with an attack time of 3 milliseconds and a release time of 30 milliseconds. This is the default mode of AX.

Return Values

None.

Description

The AXSetCompressor function turns the AX compressor ON or OFF.

The compressor is off by default.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXSetDeviceCompressorTable
AXMakeCompressorTable

Revision History

2013-05-08 Automated cleanup pass.
2012-01-26 Update to Audio API v2.0.
2011-02-21 Initial Version


CONFIDENTIAL