Prosody high level FILE play/record: API: sm_replay_file_stop

Prototype Definition

int sm_replay_file_stop(SM_FILE_REPLAY_PARMS *file_parms, int nowait)

Parameters

file_parms

A pointer to a structure passed into sm_replay_file_start() to start a replay that has not yet indicated that it has finished.

nowait

Whether to wait for a corresponding call to sm_replay_file_complete() to have complete the replay before returning

Description

Abort a previously initiated file replay. If nowait if non-zero, this function assumes the current file replay is being progressed by a separate thread of execution in which sm_replay_file_complete() has been invoked.

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_DEVERR - device error

This function is part of the Prosody high level FILE play/record API.