Prosody Audio Video Format (AVF): API: sm_avfrec_status

This function is deprecated.

Prototype Definition

int sm_avfrec_status(struct sm_avfrec_status_parms *statusp)

Parameters

a structure of the following type:

typedef struct sm_avfrec_status_parms {
	tSMAVFrecId avfrec;					/* in */
	enum kSMAVFrecordStatus {
		kSMAVFrecordStatusRunning,
		kSMAVFrecordStatusOverrun,
		kSMAVFrecordStatusCompleting,
		kSMAVFrecordStatusComplete,
	} status;						/* out */
} SM_AVFREC_STATUS_PARMS;

Description

Returns the current status of the AVF recorder or an error to indicate that a problem occurred during start-up.

When the event, obtained from sm_avfrec_get_event(), is signalled the user must call this function to determine the nature of the status change. The change in status may indicate that an error occurred whilst processing a user request or it may be notifiying the user of a change to the previous state of the AVF recorder.

Fields

avfrec (Deprecated)

The AVF recorder to interrogate

status (Deprecated)

One of these values:

kSMAVFrecordStatusRunning: Indicates that there is nothing significant to report
kSMAVFrecordStatusOverrun: Indicates that the AVF recorder has lost some data because it did not have enough space to store it because data was not collected quickly enough.
kSMAVFrecordStatusCompleting: Indicates that the record job is still ongoing, all required data for record has been supplied, the record job will complete once all module buffered data has been collected
kSMAVFrecordStatusComplete: Indicates that the record job has completed, all module buffered data has been collected

Returns

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

ERR_SM_DEVERR - device error
ERR_SM_NO_RESOURCES - if insufficient resources existed to create the AVF recorder

This function is part of the Prosody Audio Video Format (AVF) API.