Prosody RTP processing: API: sm_rtcphand_config_sdes

Prototype Definition

int sm_rtcphand_config_sdes(struct sm_rtcphand_config_sdes_parms *rvp)

Parameters

*rvp
a structure of the following type: 
typedef struct sm_rtcphand_config_sdes_parms {
	tSMRTCPHandId rtcphand;					/* in */
	tSM_INT itemnum;					/* in */
	tSM_INT stringlen;					/* in */
	char *stringval;					/* in */
} SM_RTCPHAND_CONFIG_SDES_PARMS;

Description

Configures one string to be used by RTCP. The strings are used to specify the source description (SDES) items. Since Canonical End-Point Identifier SDES Item (CNAME) is mandatory in RTCP packets, it should be configured before the RTCP handler needs to transmit RTCP packets.

When a string which has already been configured is configured again, the new value replaces the old one.

Fields

rtcphand
The RTCP handler to configure
itemnum
Which SDES item to configure. This is the SDES type (for example, as defined in section 12.2 of IETF RFC 3550).
stringlen
The length of the string in octets.
stringval
The string contents.

Returns

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

This function is part of the Prosody RTP processing API.