SPPrepareSound

Syntax

#include <cafe/sp.h>

void SPPrepareSound(SPSoundEntry *sound, AXVPB *axvpb, u32 sampleRate);

Parameters

sound Pointer to an entry in an SP sound table. This function will ASSERT a failure if sound is NULL.
axvpb Pointer to an AX voice parameter block.
NOTE:
The application must acquire a voice from AX prior to calling this function. This function will ASSERT a failure if axvpb is NULL.
sampleRate An integer specifying the frequency, in Hz, at which the sound must be played. To play the sound with the default frequency, use soundsampleRate for this argument.

Return Values

None.

Description

The SPPrepareSound function prepares a voice for playback of the specified sound effect.

This function copies the parameters of the sound from the SPSoundEntry structure into the appropriate locations in the AX voice parameter block.

Do Not Call From

None.

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup Pass.
2011/02/21 Initial version.


CONFIDENTIAL