Prosody RTP processing: API: sm_vidmprx_get_event

This function is deprecated.

Prototype Definition

int sm_vidmprx_get_event(struct sm_vidmprx_event_parms *eventp)

Parameters

*eventp
a structure of the following type:
typedef struct sm_vidmprx_event_parms {
	tSMVidMPrxId vidmprx;					/* in */
	tSMEventId event;					/* out */
} SM_VIDMPRX_EVENT_PARMS;

Description

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

Fields

vidmprx (Deprecated)
The VidMP[rx]
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.