AXUserEnd

Syntax

#include <cafe.h>
#include <cafe/ax.h>

s32 AXUserEnd(void);

Parameters

None.

Return Values

AXSYNC_ERROR_NOT_PROTECTED Protection state is not active.
AXSYNC_ERROR_IN_CALLBACK Attempted to call AXUserBegin from within a callback.
>= 0 Nesting level after the call. 0 indicates that protection is terminated.

Description

Terminates a user-level protection state. After being terminated, accumulated voice parameter changes will be synchronized to the DSP at the next audio frame.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AX Programming Model Overview
AXUserBegin
AXUserIsProtected
AXVoiceIsProtected

Revision History

2013/05/08 Automated cleanup pass.
2011/03/02 Initial version.


CONFIDENTIAL