Miles Sound System SDK 7.2a

AIL_quick_fss_load

The function AIL_quick_fss_load loads a sound file from a Mac file spec, returning a handle that can be used with the other quick API functions.

HAUDIO AIL_quick_fss_load(
  FSSpec const * file_spec
);

In Parameters

file_spec: specifies the FSSpec structure of a .WAV, .MP3, .OGG, .VOC or .XMI file.

Returns

A new audio handle if the function was successful, NULL otherwise.

Discussion

This function is only used on the Mac with the Classic or Carbon CFM libraries - the Mach-O version of Miles just uses normal Unix style slash separated string filenames. This function can load Microsoft .WAV files (uncompressed, XMA, or IMA ADPCM compressed), MPEG Layer-3 files, Ogg Vorbis files, Creative Labs .VOC files, or XMIDI files.

You must call AIL_quick_unload on all handles returned by this function.

This function must not be invoked from an interrupt-based callback function.

Group: Quick Integration Services
Related Sections: Filenames on MacOS
Related Functions: AIL_quick_copy, AIL_quick_fss_load_and_play, AIL_quick_load, AIL_quick_load_and_play, AIL_quick_load_mem, AIL_quick_unload
Related Basic Types: FSSpec, HAUDIO