Prosody high level FILE play/record: API: sm_replay_file_complete

Prototype Definition

int sm_replay_file_complete(SM_FILE_REPLAY_PARMS *file_parms)

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.

Description

Transfers all remaining data from file to speech processing module for previously initiated replay. This call may block during execution while it waits for buffering capacity to become available on the speech processing module.

On completion the offset field will have been updated to indicate at which byte offset in the file replay was aborted at, thus allowing a simple method for playback to be resumed through a subsequent call to sm_replay_file_start().

Note that this function assigns an event to the channel and removes it again when the replay finishes. If the channel previously had an event assigned, that assignment may have been lost (this depends on the operating system as events work differently on different operating systems).

Returns

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


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