Prosody RTP processing: API: sm_vidmptx_get_event

This function is deprecated.

Prototype Definition

int sm_vidmptx_get_event(struct sm_vidmptx_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_vidmptx_event_parms {
	tSMVidMPtxId vidmptx;					/* in */
	tSMEventId event;					/* out */
} SM_VIDMPTX_EVENT_PARMS;

Description

If the call completes successfully event will hold the tSMEventId belonging to vidmptx. The tSMEventId is valid until the VidMP[tx] is destroyed using sm_vidmptx_destroy(). This event will be signalled when a status change occurs on the VidMP[tx]. When the event is signalled the user must call sm_vidmptx_status() to discover the nature of the status change.

Fields

vidmptx (Deprecated)
The VidMP[tx]
event (Deprecated)
The event identifier

Returns

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

This function is part of the Prosody RTP processing API.