int sm_path_stop(struct sm_path_stop_parms *stopp)
typedef struct sm_path_stop_parms { tSMPathId path; /* in */ } SM_PATH_STOP_PARMS;
Requests that a path stops executing. The user will be notified that a path has terminated by a final status, kSMPAthStatusStopped, from sm_path_status(). Once the stopped status notification has been received the path can be destroyed using sm_path_destroy().
Once the path has stopped the event should no longer be used to wait for status notifications as it will be signalled permanently. The event is invalidated when sm_path_destroy() is called.
0 if call completed successfully, otherwise a standard error such as:
This function is part of the Prosody signal path processing API.