AXVoiceEnd

Syntax

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

s32 AXVoiceEnd(AXVPB *p);

Parameters

p Pointer to the voice to be unprotected.

Return Values

AXSYNC_ERROR_NOT_PROTECTED Protection has not been asserted for this voice.
AXSYNC_ERROR_IN_USE Voice is already protected. Try again later.
AXSYNC_ERROR_IN_CALLBACK Attempted to call AXVoiceEnd from within a callback.
>= 0 Nesting level after the call. 0 indicates that protection is terminated.

Description

Terminates a voice-level protection state for the specified voice. It is the corresponding call to AXVoiceBegin.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AX Programming Model Overview
AXUserBegin
AXUserEnd
AXUserIsProtected
AXVoiceBegin
AXVoiceIsProtected

Revision History

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


CONFIDENTIAL