Prosody RTP processing: API: sm_vidmprx_get_ports

This function is deprecated.

Prototype Definition

int sm_vidmprx_get_ports(struct sm_vidmprx_port_parms *portp)

Parameters

*portp
a structure of the following type: 
typedef struct sm_vidmprx_port_parms {
	tSMVidMPrxId vidmprx;					/* in */
	int RTP_port;						/* out */
	int RTCP_port;						/* out */
	struct in_addr address;					/* out */
	struct in6_addr ipv6_address;				/* out */
	tSM_UT32 nowait;					/* in */
} SM_VIDMPRX_PORT_PARMS;

Description

Retrieves the RTP and RTCP port numbers which have been allocated by this VidMP[rx] and on which it is listening.

If the call completes successfully, RTP_port will contain the port number where RTP packets should be directed for this VidMP[rx]. Similarly, RTCP_port will contain the port number where RTCP packets should be directed.

Fields

vidmprx (Deprecated)
The VidMP[rx] to be interrogated
RTP_port (Deprecated)
The UDP port number on which this VidMP[rx] is listening for RTP
RTCP_port (Deprecated)
The UDP port number on which this VidMP[rx] is listening for RTCP
address (Deprecated)
The address on which this VidMP[rx] is listening if this is a IPv4 VidMP[rx].
ipv6_address (Deprecated)
The address on which this VidMP[rx] is listening if this is a IPv6 VidMP[rx].
nowait (Deprecated)
Selects blocking or non-blocking mode for this API call. In non-blocking mode the API call may return without the requested information. It is recommended that users wait for sm_vidmprx_status() to inform the application that the port and address information is available, rather than using this API call. If the nowait flag is clear, the API call will block until the desired information is available, otherwise the API call will return immediately.

Returns

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

This function is part of the Prosody RTP processing API.