Prosody RTP processing: API: sm_vmptx_get_event

Prototype Definition

int sm_vmptx_get_event(struct sm_vmptx_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_vmptx_event_parms {
	tSMVMPtxId vmptx;					/* in */
	tSMEventId event;					/* out */
} SM_VMPTX_EVENT_PARMS;

Description

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

Fields

vmptx
The VMP[tx]
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.