AXSetVoiceInitialTimeDelay

Syntax

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

AXPB_ERROR_CODE AXSetVoiceInitialTimeDelay(AXVPB *p, u16 timeDelay);

Parameters

p Pointer to the voice.
timeDelay Delay, in samples.

Return Values

AXPB_ERROR_VOICE_IS_RUNNING is returned if the function has been called while the voice is running. AXPB_ERROR_INITIAL_TIME_DELAY_IS_TOO_BIG is returned if the delay number is > 96 (for 32K mode) or > 144 (for 48K mode).

Description

Applies the initial time delay for the specified voice. Decoding of the voice has been delayed by the user-specified amount at the beginning. The initial samples (delay amount) has been set to zero.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

Revision History

2015/05/26 Corrected func definition and params.
2014/04/10 Correct Availability field. This API is not available in Sound 1.0.
2013/02/22 Initial Version


CONFIDENTIAL