spStopAtMarker
Stop when playback reaches marker.
Synopsis
Err spStopAtMarker (SPSound *sound, const char *markerName)
Description
Barring results of a marker or default decision function, causes playback to stop when the player reaches this marker.
Markers can have one of 3 static actions: continue, branch, or stop. This action can be changed at any time, including while the player is playing.
Arguments
- sound
- Pointer to SPSound containing marker to stop at.
- markerName
- Name of marker in sound to stop at. All markers except markers at the beginning of sounds are considered valid places to stop.
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
See Also
spBranchAtMarker(), spContinueAtMarker(), spSetMarkerDecisionFunction(), spSetDefaultDecisionFunction()