Prosody RTP processing: API: sm_vmprx_ice_stun_config

Prototype Definition

int sm_vmprx_ice_stun_config(struct sm_vmprx_ice_stun_config_parms *configp)

Parameters

*configp
a structure of the following type: 
typedef struct sm_vmprx_ice_stun_config_parms {
	tSMVMPrxId vmprx;					/* in */
	enum kSMICERole {
		kSMICERoleNone,
		kSMICERoleLite,
		kSMICERoleControlled,
		kSMICERoleControlling,
	} local_role;						/* in */
	char *local_ice_ufrag;					/* in */
	tSM_UT32 local_ice_ufrag_length;			/* in */
	char *local_ice_pwd;					/* in */
	tSM_UT32 local_ice_pwd_length;				/* in */
	tSM_UT64 role_tiebreaker;				/* in */
} SM_VMPRX_ICE_STUN_CONFIG_PARMS;

Description

Enables or disables ICE compatible STUN on the VMP[rx]. See IETF RFC 5245 and IETF RFC 5389 for more details.

This requires the module icestun to have been downloaded.

Fields

vmprx
The VMP[rx] being configured.
local_role
The role of the local ICE agent. One of these values:
kSMICERoleNone
The VMP[rx] does not handle STUN packets.
kSMICERoleLite
The local ICE agent is an ice-lite agent.
kSMICERoleControlled
The local ICE agent is controlled.
kSMICERoleControlling
The local ICE agent is controlling.
local_ice_ufrag
The local ICE username fragment.
local_ice_ufrag_length
The length of the local ICE username fragment.
local_ice_pwd
The local ICE password.
local_ice_pwd_length
The length of the local ICE password.
role_tiebreaker
The ICE role tiebreaker value.

Returns

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

This function is part of the Prosody RTP processing API.