AXSetMultiVoiceSrcRatio

Syntax

#include <cafe/ax.h>

s32 AXSetMultiVoiceSrcRatio(AXMVPB *mv, f32 ratio);

Parameters

mv Pointer to the multi-voice.
ratio New pitch (SRC ratio) to apply.

Return Values

AX_SRC_RATIO_OK Ratio is between the legal 0.0 - 8.0 limits.
AX_SRC_RATIO_TOO_SMALL Ratio is less than 0. It is clamped to 0.
AX_SRC_RATIO_TOO_LARGE Ratio is greater than 8.0. It is clamped to 8.0.

Description

Applies the given sample rate conversion ratio (pitch) to the multi-voice mv. The pitch may be changed while the multi-voice is active and running.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXPBSRC
AXSetMultiVoiceSrc
AXSetMultiVoiceSrcType

Revision History

2013/10/20 Initial Version


CONFIDENTIAL