AXSetDeviceMode DEPRECATED

Syntax

#include <cafe/ax.h>

AXPB_ERROR_CODE AXSetDeviceMode(AXPBDeviceType device, u32 mode);

Parameters

device Output device.
mode
AX_MODE_STEREO This is the default mode of AX. Only left and right channels are output.
AX_MODE_SURROUND Not yet supported.
AX_MODE_6CH Sounds are sent to all 5.1 channels. Available only for TV device.

Return Values

AXPB_ERROR_NONE if successful, an error of type AXPB_ERROR_CODE otherwise.

Description

NOTE:
This function is deprecated. Calling this function will print:
AXSetDeviceMode deprecated: change device output mode via Cafe menu.
It will always return AXPB_ERROR_NONE.
For information on setting device modes, see Changing Device Mode.

Sets the output mode for the device specified by device. The output mode applies for all instances of the given output device.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

Deprecated Do not call this function in new code.

See Also

Cafe Audio System Overview
AX Data Structures and Definitions
AXGetDeviceMode

Revision History

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


CONFIDENTIAL