Prosody RTP processing: API: sm_vidmprx_create

This function is deprecated.

Prototype Definition

int sm_vidmprx_create(struct sm_vidmprx_create_parms *vidmprxp)

Parameters

*vidmprxp
a structure of the following type: 
typedef struct sm_vidmprx_create_parms {
	tSMVidMPrxId vidmprx;					/* out */
	tSMModuleId module;					/* in */
	enum kSMVidMPrxType {
		kSMVidMPrxTypeIPv4,
		kSMVidMPrxTypeIPv6,
	} type;							/* in */
	struct in_addr address;					/* in */
	struct in6_addr ipv6_address;				/* in */
} SM_VIDMPRX_CREATE_PARMS;

Description

Allocates, on a specific module, a new VidMP[rx] to receive incoming RTP data. If the call completes successfully, the parameter vidmprx will be set to the identifier for that vidmprx.

A VidMP[rx] is automatically allocated a port number for incoming RTP data, this information may be obtained by calling sm_vidmprx_get_ports() or by waiting for sm_vidmprx_status() to return the port information. Any RTP data arriving at the VidMP[rx] will be interpreted based on the codec configuration. The VidMP[rx] will discard any incoming packets that do not match it's current configuration settings.

This requires the module vmprx to have been downloaded.

Fields

vidmprx (Deprecated)
The newly created VidMP[rx].
module (Deprecated)
A value obtained from sm_open_module() which indicates the module where the VidMP[rx] is to be allocated.
type (Deprecated)
One of these values:
kSMVidMPrxTypeIPv4
The VidMP[rx] is to receive IPv4 packets
kSMVidMPrxTypeIPv6
The VidMP[rx] is to receive IPv6 packets
address (Deprecated)
The address on which this VidMP[rx] is to listen if type is kSMVidMPrxTypeIPv4.
ipv6_address (Deprecated)
The address on which this VidMP[rx] is to listen if type is kSMVidMPrxTypeIPv6.

Returns

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

This function is part of the Prosody RTP processing API.