Previous Topic Index Next Topic
[API function]

FMUSIC_LoadSong

To load a module or bank with a given filename. FMUSIC Supports loading of
- .MOD (protracker/fasttracker modules)
- .S3M (screamtracker 3 modules)
- .XM (fasttracker 2 modules)
- .IT (impulse tracker modules)
- .MID (MIDI files)
- .RMI (MIDI files)
- .SGT (DirectMusic segment files)
- .FSB (FMOD Sample Bank files)

FMUSIC_MODULE * F_API FMUSIC_LoadSong(
const char *name
);

Parameters

name Filename of module to load.

Return Value

On success, a pointer to a FMUSIC_MODULE handle is returned.
On failure, NULL is returned.

Remarks

This function autodetects the format type, regardless of filename.
The MIDI loader does not support user file callbacks. For WAD type data structures with embedded MIDI files FMUSIC_LoadSongEx will have to be used with memory loading.
Various other functionality is not provided in MIDI. See relevant FMUSIC functions to see if a feature
is supported or not.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FMUSIC_FreeSong , FMUSIC_LoadSong , FMUSIC_LoadSongEx , FSOUND_File_SetCallbacks

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:26 2005 by SourceDoc v0.10, the automated source code documenter.