UnloadSoundFile

Unloads a sound file.

Synopsis

int32 UnloadSoundFile( SoundFilePlayer *sfp )

Description

This function unloads a sound file that has been played. This process closes the AIFF file, deletes the IOReq item used to read the file, detaches the buffers from the sampled sound instrument, and frees the sampled sound instrument. The task must delete the SoundFilePlayer data structure and the sound buffers on its own.

Arguments

sfp
A pointer to the SoundFilePlayer data structure.

Return Value

This function returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Library call implemented in music.lib V20.

Associated Files

soundfile.h, music.lib

See Also

OpenSoundFile(), CloseSoundFile(), DeleteSoundFilePlayer(), LoadSoundFile(), ReadSoundFile(), RewindSoundFile(), ServiceSoundFile(), StartSoundFile(), StopSoundFile(), CreateSoundFilePlayer()