AXSetVoiceRmtOn

Syntax

#include <cafe/ax.h>
    
#define AX_PB_REMOTE_OFF        0x0000
#define AX_PB_REMOTE_ON         0x0001

void AXSetVoiceRmtOn(AXVPB *p, u16 on);

Parameters

p Pointer to the specified voice.
on Enables or disables rendering for the Wii Remote audio output devices.

Return Values

None.

Description

Enables or disables audio rendering for the Wii Remote controller audio output devices for the voice p. This is disabled by default when a voice is acquired.

When audio rendering is enabled for a Wii Remote, AX generates audio data for it but does not transfer this data to the Wii Remote. To handle this step, the application must retrieve the rendered audio from AX, encode it with WENC, and then dispatch it with WPAD. For more information, see Controller Speaker Encoding (WENC) Library Overview and the Wii Remotes section of the AX Programming Model reference.

If Remote audio is not needed, it is recommended that you disable audio rendering to conserve processing cycles of the rendering pipe.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXRmtAdvancePtr
AXRmtGetSamples
AXRmtGetSamplesLeft

Revision History

2013-05-17 Edit description
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