AXSetMultiVoicePriority

Syntax

#include <cafe/ax.h>

#define AX_PRIORITY_NODROP  31
#define AX_PRIORITY_LOWEST  1

void AXSetMultiVoicePriority (AXMVPB *mv, u32 priority);

Parameters

mv Pointer to the multi-voice.
priority New priority for the voice. Set from 1 (minimum) - 31 (maximum). 31 is the highest priority. AX_PRIORITY_NODROP is defined as 31. AX_PRIORITY_LOWEST is defined as 1. Priority 0 indicates that the voice will not be played.

Return Values

None.

Description

Changes the priority for the specified multi-voice. As an example, consider a synthesizer application that acquires a voice to produce a note in a score. After the keyoff event is encountered, the voice enters the release phase and the priority of the voice may then be lowered to facilitate voice reacquisition.

Voices having priority AX_PRIORITY_NODROP may still be dropped by AX if rendering resources are exceeded for an audio frame.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXAcquireMultiVoice

Revision History

2011/11/15 Initial Version


CONFIDENTIAL