Prosody Audio Video Format (AVF): API: sm_avfplay_get_event

This function is deprecated.

Prototype Definition

int sm_avfplay_get_event(struct sm_avfplay_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_avfplay_event_parms {
	tSMAVFplayId avfplay;					/* in */
	tSMEventId event;					/* out */
} SM_AVFPLAY_EVENT_PARMS;

Description

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

Fields

avfplay (Deprecated)
The AVF player
event (Deprecated)
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.