Prosody RTP processing: API: sm_vidmprx_ice_stun_send_bind_request

This function is deprecated.

Prototype Definition

int sm_vidmprx_ice_stun_send_bind_request(struct sm_vidmprx_ice_stun_send_bind_request_parms *requestp)

Parameters

*requestp
a structure of the following type: 
typedef struct sm_vidmprx_ice_stun_send_bind_request_parms {
	tSMVidMPrxId vidmprx;					/* in */
	int use_RTCP_port;					/* in */
	char transaction_id[12];				/* in */
	union {
		SOCKADDR_IN ipv4;				/* in */
		SOCKADDR_IN6 ipv6;				/* in */
	} destination;						/* in */
	tSM_UT32 priority;					/* in */
	tSM_INT use_candidate;					/* in */
} SM_VIDMPRX_ICE_STUN_SEND_BIND_REQUEST_PARMS;

Description

Sends a STUN bind request.

This requires the module icestun to have been downloaded.

Fields

vidmprx (Deprecated)
A VidMP[rx] running ICE compatible STUN.
use_RTCP_port (Deprecated)
Which port to use as the source for the request. When non-zero, use the RTCP port. Otherwise, the RTP port is used
transaction_id (Deprecated)
The transaction ID to use, in the same byte order as the packet.
destination (Deprecated)
ipv4
The destination on the bind request when the VidMP[rx] is an IPv4 endpoint.
ipv6
The destination on the bind request when the VidMP[rx] is an IPv6 endpoint.
priority (Deprecated)
The priority to assign to a learned peer reflexive address.
use_candidate (Deprecated)
An indicator of whether to include the USE-CANDIDATE attribute.

Returns

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

This function is part of the Prosody RTP processing API.