Prosody RTP processing: API: sm_rtcphand_get_event

Prototype Definition

int sm_rtcphand_get_event(struct sm_rtcphand_event_parms *eventp)

Parameters

*eventp

a structure of the following type:

typedef struct sm_rtcphand_event_parms {
	tSMRTCPHandId rtcphand;					/* in */
	tSMEventId event;					/* out */
} SM_RTCPHAND_EVENT_PARMS;

Description

If the call completes successfully event will hold the tSMEventId belonging to rtcphand. The tSMEventId is valid until the RTCP handler is destroyed using sm_rtcphand_destroy(). This event will be signalled when there is data to be collected using sm_rtcphand_get_data() or when a status change occurs on the RTCP handler. When the event is signalled the user should call sm_rtcphand_get_data() to try collecting data. If there is no data, the user must call sm_rtcphand_status() to discover the nature of the status change.

Fields

rtcphand

The RTCP handler

event

The event identifier

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody RTP processing API.