Sound Function - Sound Data Utility Function

sdBankDownload

Downloads a bank of sound data

FORMAT

SDE_ERR sdBankDownload( handle, bank_type, bank_num )
SDMEMBLK handle
SDE_DATA_TYPE bank_type
Sint32 bank_num

PARAMETER

 handle  Handle of the block information for the bank to download 
 bank_type  Bank type to download 
 bank_num  Bank number of download destination 

RETURN

 SDE_ERR_NO_INIT  The Sound Library has not been initialized 
 SDE_ERR_HANDLE_NULL  The handle was NULL 
 SDE_ERR_HANDLE_ILLEGAL_VALUE  An illegal address was specified for the handle 
 SDE_ERR_DATA_ILLEGAL_TYPE  Illegal data type 

DESCRIPTION

Downloads a bank of sound data from main memory to sound memory.

The argument bank_type which specifies the bank type to download can have the following specifications.


NOTE

 SDE_DATA_TYPE_SND_DRV  Sound driver 
 SDE_DATA_TYPE_MULTI_UNIT  Multi-unit 
 SDE_DATA_TYPE_MIDI_SEQ_DATAMIDI  Sequence data 
 SDE_DATA_TYPE_MIDI_SEQ_BANKMIDI  Sequence bank-MIDI sequence data grouping 
 SDE_DATA_TYPE_MIDI_PRG_BANKMIDI  Program bank-tone group as MIDI sound source 
 SDE_DATA_TYPE_SHOT_DATA  One-shot data 
 SDE_DATA_TYPE_SHOT_BANK  One-shot bank-one shot data grouping 
 SDE_DATA_TYPE_PSTM_DATAPCM  Stream data (future support intended) 
 SDE_DATA_TYPE_PSTM_RING_BUFPCM  Ring buffer for playing stream data. Doesn't actually exist as data, but is defined on management. 
 SDE_DATA_TYPE_FX_OUT_BANKFX  Out bank-FX Output in DSP final output parameter grouping 
 SDE_DATA_TYPE_FX_PRG_BANKFX  Program bank-FX Program grouping in DSP code 
 SDE_DATA_TYPE_FX_PRG_WRKFX  Program work-the same definition as SDE_PSTM_RING_BUF on management 
This function cannot be used until sdMultiUnitDownload has been called at least once to download a Multi-Unit file (which creates the memory mapping).

If error type is returned as SDE_ERR_DATA_ILLGAL_TYPE (data type is abnormal), it can be assumed that a Multi-Unit was not specified, or an attempt was made to download a Multi-Unit with a data ID not recognized by the library.


REFERENCE

sdMultiUnitDownload()

sdBankDownload
COPYRIGHT © SEGA ENTERPRISES, LTD., 1998,1999