spBranchAtMarker

Set up a static branch at a marker.

Synopsis

Err spBranchAtMarker (SPSound *fromSound, const char *fromMarkerName, SPSound *toSound, const char *toMarkerName)

Description

Sets up a static branch from one marker to another. Barring the result of a marker or default decision function, when the playback encounters the 'from' marker, the playback will skip to the 'to' marker seamlessly.

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

fromSound
Pointer to SPSound containing marker to branch from.
fromMarkerName
Name of marker in fromSound to branch from. All markers except markers at the beginning of sounds are considered valid "from" markers.
toSound
Pointer to SPSound containing marker to branch to.
toMarkerName
Name of marker to branch to in toSound. All markers except markers at the end of sounds are considered valid "to" markers.

Return Value

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

Notes

Both SPSounds must belong to the same SPPlayer.

Good sounding results require good placement of markers in the sounds.

Implementation

Library call implemented in music.lib V24.

Associated Files

soundplayer.h, music.lib

See Also

spStopAtMarker(), spContinueAtMarker(), spSetMarkerDecisionFunction(), spSetDefaultDecisionFunction()