NNS_SndArcLoadSeq*

C Specification

#include <nnsys/snd.h>

#define NNS_SND_ARC_LOAD_SEQ  ( 1 << 0 )
#define NNS_SND_ARC_LOAD_BANK ( 1 << 1 )
#define NNS_SND_ARC_LOAD_WAVE ( 1 << 2 )
BOOL NNS_SndArcLoadSeq( int seqNo, NNSSndHeapHandle heap );
BOOL NNS_SndArcLoadSeqEx( int seqNo, u32 loadFlag, NNSSndHeapHandle heap );

Arguments

seqNo Sequence number
heap The sound heap handle
loadFlag The flag that designates which data to load

Return Values

Returns a value to indicate whether or not the load was successful.

Description

Loads the sequence data to the heap.

The NNS_SndArcLoadSeq function loads the bank data and the waveform archive needed for playback of sequence data at the same time. The NNS_SndArcLoadSeqEx function designates with loadFlag which of the three types of data to load. Put the logical ORs of the following macros into loadFlag.

TABLE: Load Flags

Macros Constant Description
NNS_SND_ARC_LOAD_SEQ 1 << 0 The sequence data
NNS_SND_ARC_LOAD_BANK 1 << 1 The bank data
NNS_SND_ARC_LOAD_WAVE 1 << 2 The waveform archive

The memory necessary for loading is automatically allocated from the sound heap heap with the NNS_SndHeapAlloc function. If memory allocation fails, the process is interrupted and a FALSE is returned.

Sound data that is already resident in memory is not loaded. Execution of the function NNS_SndArcGetFileAddress will determine whether or not the sound data is resident in memory. Also, the NNS_SndArcSetFileAddress function sets the address of the successfully loaded data.

Note

Use this function only for the sound archive initialized with the NNS_SndArcInit function. This function cannot be used with the sound archive initialized with the NNS_SndArcInitOnMemory function.

See Also

NNS_SndHeapAlloc, NNS_SndArcGetFileAddress, NNS_SndArcSetFileAddress, NNS_SndArcInit, NNS_SndArcInitOnMemory

Revision History

06/01/2004 Initial version.


CONFIDENTIAL