int sm_replay_bfile_progress_istatus(SM_BFILE_REPLAY_PARMS *file_parms, int initial_status)
Transfers file data to speech processing module for previously initiated replay unless the channel has insufficient buffering space to accept more data, or all data has been transferred, or an error occurs.
If the current replay status for the channel is not known, then the sm_replay_bfile_progress() variant of the call must be used.
The parameter
file_parms
must point to the same
sm_bfile_replay_parms structure as was previously
used to initiate the file replay.
On return if the status field is still set to a value of
ERR_SM_PENDING then further calls to this routine will be
required to complete the file replay. If status has a zero value
then replay has successfully completed. Otherwise replay has
been terminated on error, and status will be set to a
corresponding error code.
Note: this routine must be periodically invoked following a call to sm_replay_bfile_start(). This may either be done explicitly by the application, or alternatively through a call to sm_replay_bfile_complete() which will handle the scheduling of calls to sm_replay_bfile_progress() on behalf of the application.
The same value as stored in the status field of the structure
pointed to by
file_parms
which is 0 or ERR_SM_PENDING
if call completed successfully, otherwise a standard error such as:
This function is part of the Prosody high level BFILE play/record API.