spDeletePlayer

Delete an SPPlayer.

Synopsis

Err spDeletePlayer (SPPlayer *player)

Description

Deletes an SPPlayer created by spCreatePlayer(). Automatically stops the SPPlayer and calls spRemoveSound() for all SPSounds belonging to the SPPlayer. If the spCreatePlayer() allocated buffers, those buffers are automatically freed. Custom allocated buffers passed in to spCreatePlayer() are not deleted.

Arguments

player: Pointer to an SPPlayer to delete. Can be NULL.

Return Value

Non-negative value on success; negative error code on failure.

Implementation

Library call implemented in music.lib V24.

Associated Files

soundplayer.h, music.lib