Prosody RTP processing: API: sm_vidmprx_ice_stun_change_role

This function is deprecated.

Prototype Definition

int sm_vidmprx_ice_stun_change_role(struct sm_vidmprx_ice_stun_change_role_parms *rolep)

Parameters

*rolep
a structure of the following type: 
typedef struct sm_vidmprx_ice_stun_change_role_parms {
	tSMVidMPrxId vidmprx;					/* in */
	enum kSMICERole local_role;				/* in */
} SM_VIDMPRX_ICE_STUN_CHANGE_ROLE_PARMS;

Description

Changes the role of ICE compatible STUN on the VidMP[rx].

Note: the role can only be changed when in either the controlled or controlling role and it can only be changed to the controlling or controlled role.

This requires the module icestun to have been downloaded.

Fields

vidmprx (Deprecated)
A VidMP[rx] running ICE compatible STUN.
local_role (Deprecated)
The new role of the local ICE agent. Note: changing to kSMICERoleNone or kSMICERoleLite is not permitted.
One of these values:
kSMICERoleNone
The VidMP[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.

Returns

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

This function is part of the Prosody RTP processing API.