Prosody RTP processing: API: sm_rtcphand_config_bandwidth

This function is only in Preliminary Documentation.

Prototype Definition

int sm_rtcphand_config_bandwidth(struct sm_rtcphand_config_bandwidth_parms *rvp)

Parameters

*rvp
a structure of the following type:
typedef struct sm_rtcphand_config_bandwidth_parms {
	tSMRTCPHandId rtcphand;					/* in */
	tSM_INT rtcp_bw;					/* in */
	tSM_INT rtcprx_bw;					/* in */
	tSM_INT rtcptx_bw;					/* in */
} SM_RTCPHAND_CONFIG_BANDWIDTH_PARMS;

Description

Configures the RTCP bandwidth.

Fields

rtcphand (Only in Preliminary Documentation)
The RTCP handler to configure
rtcp_bw (Only in Preliminary Documentation)
The bandwidth, in bits per second, allocated for use by RTCP in the session in which this RTCP handler is participating. This is the value rtcp_bw specified in IETF RFC 3550.
rtcprx_bw (Only in Preliminary Documentation)
The bandwith, in bits per second, allocated for use by RTCP reports from RTP receivers. This is the value spcified by "b=RR:<bandwith-value>" in SDP (IETF RFC 3556).
rtcptx_bw (Only in Preliminary Documentation)
The bandwith, in bits per second, allocated for use by RTCP reports from RTP senders. This is the value spcified by "b=RT:<bandwith-value>" in SDP (IETF RFC 3556).

Returns

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


This function is part of the Prosody RTP processing API.