nn::snd::CTR::Voice::SetupBcwav Member Function

bool SetupBcwav(
     uptr addrBcwav,
     WaveBuffer * pWaveBuffer0,
     WaveBuffer * pWaveBuffer1,
     Bcwav::ChannelIndex channelIndex = Bcwav::CHANNEL_INDEX_L
);

	Name	Description
in	addrBcwav	Starting address of a BCWAV file.
in	pWaveBuffer0	Pointer to the nn::snd::WaveBuffer used for the initial playback.
in	pWaveBuffer1	Pointer to the nn::snd::WaveBuffer used for looping playback.
in	channelIndex	The channel to use.

Returns true if the operation succeeded, or false if it failed.

Parses a BCWAV file and prepares for playback.

Configures the Voice and WaveBuffer settings based on the header information in the Bcwav file. The user must prepare the WaveBuffer objects and pass those addresses in arguments pWaveBuffer0 and pWaveBuffer1.

Only pWaveBuffer0 is used when the loop flag in the Bcwav file is disabled. You may specify NULL for pWaveBuffer1 in such cases.

Both pWaveBuffer0 and pWaveBuffer1 are used when the loop flag in the Bcwav header is enabled, however. pWaveBuffer0 is for the initial playback, and pWaveBuffer1 is for loop playback.

If the Bcwav file audio is in stereo format, specify a value for the channelIndex argument to select either the left or right channel to assign to the Voice (you cannot use Voice with a stereo format). If the file is monaural, you must specify the left channel (nn::snd::CTR::Bcwav::CHANNEL_INDEX_L).

2010/10/22

Revised to match change in specification to not configure parameters not included in Bcwav header.

2010/07/22

Initial version.