Miles Sound System SDK 7.2a

AIL_DLS_load_file

The function AIL_DLS_load_file loads an uncompressed DLS file into the specified DLS device.

HDLSFILEID AIL_DLS_load_file(
  HDLSDEVICE dls,
  char const * filename,
  U32 flags
);

In Parameters

dls
indicates the DLS device to load the DLS data into.
filename
is the name of the DLS file to use.
flags
should currently be zero.

Returns

A handle to a DLS file ID that can be used to unload the DLS data with the AIL_DLS_unload function, or NULL if the load was unsuccessful.

Discussion

This function only accepts uncompressed DLS files. If you have a compressed MLS file to load, use the AIL_extract_DLS function to get a DLS memory image and then load it with the AIL_DLS_load_memory function. You can use the AIL_file_type function to see what type of DLS file you have.

To load a DLS file that has been embedded in an XMI file, you can use the AIL_find_DLS function for uncompressed embedded DLS data, or the AIL_extract_DLS function for compressed embedded DLS data. You can use the AIL_file_type function to see what type of XMI file you have.

The software synthesizer will continue to use sample memory from the DLS file until the DLS device is closed, or the file ID is unloaded with the AIL_DLS_unload function.

The AIL_DLS_load_file function will always replace the existing DLS data when two DLS files specify duplicate instrument and note parameters.


Group: DLS Services
Related Functions: AIL_DLS_compact, AIL_DLS_load_file, AIL_DLS_load_memory, AIL_DLS_unload, AIL_compress_DLS, AIL_extract_DLS, AIL_file_type, AIL_find_DLS
Related Basic Types: HDLSDEVICE, HDLSFILEID, U32, char const *

For technical support, e-mail Miles3@radgametools.com
© Copyright 1991-2007 RAD Game Tools, Inc. All Rights Reserved.