spSetBranchAction
Set up an SPAction to branch to the specified marker.
Synopsis
Err spSetBranchAction (SPAction *action, SPSound *toSound, const char *toMarkerName)
Description
Sets up the SPAction to cause a branch to the specified marker as the resulting action of a decision function.
Arguments
- action
- Pointer to an SPAction to fill out. This must be the pointer passed to your decision function.
- toSound
- Pointer to SPSound containing marker to branch to. This SPSound must belong to the same SPPlayer as the SPMarker for which the decision function was called.
- toMarkerName
- Name of marker to in toSound branch to. 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.
Outputs
On success, fills out SPAction to cause a branch to the specified marker. On failure, nothing is written to the SPAction.
Implementation
Library call implemented in music.lib V24.
Associated Files
soundplayer.h, music.lib
See Also
SPDecisionFunction, spSetStopAction(), spBranchAtMarker()