Prosody Audio Video Format (AVF): API: sm_avfrec_stop

This function is deprecated.

Prototype Definition

int sm_avfrec_stop(struct sm_avfrec_stop_parms *avfsp)

Parameters

*avfsp

a structure of the following type:

typedef struct sm_avfrec_stop_parms {
	tSMAVFrecId avfrec;					/* in */
	tSM_INT immediate;					/* in */
} SM_AVFREC_STOP_PARMS;

Description

Stop the AVF recorder task.

Fields

avfrec (Deprecated)

A tSMAVFrecId that has been prevously created by a call to sm_avfrec_create().

immediate (Deprecated)

The type of stop to perform. Set to a non zero value to stop immediately, discarding any data which has been recorded but not yet collected. Otherwise, the record will stop once all data recorded has been collected.

Returns

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

• ERR_SM_DEVERR - device error

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