Prosody RTP processing: API: sm_vmprx_get_event

Prototype Definition

int sm_vmprx_get_event(struct sm_vmprx_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_vmprx_event_parms {
	tSMVMPrxId vmprx;					/* in */
	tSMEventId event;					/* out */
} SM_VMPRX_EVENT_PARMS;

Description

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

Fields

vmprx
The VMP[rx]
event
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.