AXSetVoiceSrcRatio

Syntax

#include <cafe/ax.h>

s32 AXSetVoiceSrcRatio(AXVPB *p, f32 ratio);

Parameters

p Pointer to the 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 voice p. The pitch may be changed while the voice is active and running.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXPBSRC
AXSetVoiceSrc
AXSetVoiceSrcType

Revision History

2013/05/08 Automated cleanup pass.
2012/01/26 Update to Audio API v2.0.
2011/02/21 Initial Version


CONFIDENTIAL