Prosody high level FILE play/record: API: sm_record_file_progress_ostatus

Prototype Definition

int sm_record_file_progress_ostatus(SM_FILE_RECORD_PARMS *file_parms, SM_RECORD_STATUS_PARMS *status_parms)

Parameters

file_parms

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

status_parms

A pointer to a structure as passed into sm_record_status().

Description

This is the same as sm_record_file_progress_istatus() except it first determines the status of the recording and reports this to the user.

When this function returns without an error, the fields in the status_parms structure are valid. On completion of a recording, the termination status will be reported in the status_parms structure.

If the current record status for the channel is known, then the sm_record_file_progress_istatus() variant of the call should be used with initial_status set to this status.

Returns

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:

• ERR_SM_PENDING - no error but record has not yet finished

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