Prosody Audio Video Format (AVF): API: sm_avfrec_sync

This function is deprecated.

Prototype Definition

int sm_avfrec_sync(struct sm_avfrec_sync_parms *avfsp)

Parameters

*avfsp
a structure of the following type: 
typedef struct sm_avfrec_sync_parms {
	tSMAVFrecId avfrec;					/* in */
	tSMAVFrecId sync_avfrec;				/* in */
} SM_AVFREC_SYNC_PARMS;

Description

Ensures that all future records on avfrec are synchronised with those on sync_avfrec. To achieve synchronised records following a call to sm_avfrec_sync() , sm_avfrec_start() must be called on both, avfrec and sync_avfrec . The records can be started in any order. Once started, the records will not process any data until the first full AVF frame arrives at either. This allows their internal time references to start in step and, therefore, for synchronised playback of a recorded AVF stream pair to be achieved. Once the records begin processing data, they progress as usual.

When two records are synchronised and processing data, if one record is stopped then restarted it will not re-synchronise with the running record and an error will be returned. If both records are stopped then restarted, the two records will synchronise as described above.

Fields

avfrec (Deprecated)
A tSMAVFrecId that has been prevously created by a call to sm_avfrec_create().
sync_avfrec (Deprecated)
The tSMAVFrecId, that has been prevously created by a call to sm_avfrec_create(), of the recorder with which we wish to synchronise. Or, set to 0 to un-synchronise.

Returns

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

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