spRemoveMarker

Manually remove an SPMarker from an SPSound.

Synopsis

Err spRemoveMarker (SPMarker *marker)

Description

Removes and frees the specified marker from the sound that it belongs to. All markers belonging to an SPSound are automatically disposed of when that sound is disposed of with spRemoveSound() or when the player that owns that sound is deleted with spDeletePlayer(). Use this function if you want to remove a marker manually.

This function cannot be used to remove a permanent marker (SP_MARKER_NAME_BEGIN or SP_MARKER_NAME_END) from a sound.

Arguments

marker: Pointer to an SPMarker to remove. Can be NULL. If this is one of the permanent markers (SP_MARKER_NAME_BEGIN or SP_MARKER_NAME_END) this function does nothing and returns ML_ERR_INVALID_MARKER.

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