Prosody RTP processing: API: sm_rtcphand_request_statistics

Prototype Definition

int sm_rtcphand_request_statistics(struct sm_rtcphand_request_statistics_parms *rrsp)

Parameters

*rrsp

a structure of the following type:

typedef struct sm_rtcphand_request_statistics_parms {
	tSMRTCPHandId rtcphand;					/* in */
	tSM_INT statcode;					/* in */
} SM_RTCPHAND_REQUEST_STATISTICS_PARMS;

Description

Instructs RTCP handler to provide a statistics report as soon as possible for the specified category of statistics. The statistics report will appear in the data retrieved through sm_rtcphand_get_data() and may be in addition to statistics reports generated for other reasons. It may not be an additional report if the RTCP handler was about to produce a report of the requested type anyway, for example if the specified report type is currently enabled by sm_rtcphand_config_reports()

Fields

rtcphand

The RTCP handler which is to provide the statistics

statcode

Which statistics are to be provided. See sm_rtcphand_get_data() for the possible types of statistics and their codes.

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.