Prosody Audio Video Format (AVF): API: sm_avfrec_get_event

Prototype Definition

int sm_avfrec_get_event(struct sm_avfrec_event_parms *eventp)

Parameters

*eventp
a structure of the following type:
typedef struct sm_avfrec_event_parms {
	tSMAVFrecId avfrec;					/* in */
	tSMEventId event;					/* out */
} SM_AVFREC_EVENT_PARMS;

Description

If the call completes successfully event will hold the tSMEventId belonging to avfrec.. The tSMEventId is valid until the AVF recorder is destroyed using sm_avfrec_destroy(). This event will be signalled when a status change occurs on the AVF recorder. When the event is signalled the user must call sm_avfrec_status() to discover the nature of the status change.

Fields

avfrec
The AVF recorder
event
The event identifier

Returns

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


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