Prosody RTP processing: API: sm_vmptx_config_ipv6

Prototype Definition

int sm_vmptx_config_ipv6(struct sm_vmptx_config_ipv6_parms *configp)

Parameters

*configp

a structure of the following type:

typedef struct sm_vmptx_config_ipv6_parms {
	tSMVMPtxId vmptx;					/* in */
	SOCKADDR_IN6 destination_rtp;				/* in */
	SOCKADDR_IN6 source_rtp;				/* in */
	SOCKADDR_IN6 destination_rtcp;				/* in */
	SOCKADDR_IN6 source_rtcp;				/* in */
} SM_VMPTX_CONFIG_IPV6_PARMS;

Description

Configures a VMP[tx] to send RTP and RTCP data to a device with the specified IPv6 address and port numbers.

If the call completes successfully RTP data generated by the vmptx will be sent to the address and port as specified in destination_rtp. Any associated RTCP data will be delivered to the address and port specified by destination_rtcp. Specifying the source_rtp instructs the VMP[tx] to use the given IPv6 address and port for outgoing RTP data. Specifying the source_rtcp instructs the VMP[tx] to use the given IPv6 address and port for outgoing RTCP data.

This requires the module vmptx to have been downloaded.

Fields

vmptx

The VMP[tx] to configure

destination_rtp

The SOCKADDR_IN6 structure specifying the destination IP address and port for the RTP stream. A struct SOCKADDR_IN6 must be configured with an address family, an IPv6 address and a port. Note that most operating systems define this structure such that fields are in network byte order.

source_rtp

The SOCKADDR_IN6 structure allows you to specify the source IP address and port for the RTP stream. A struct SOCKADDR_IN6 must be configured with an address family. The IP address may be specified, or a value equivalent to in6addr_any may be used to indicate that any suitable address may be used. The port number may be specified, or the value zero may be used to indicate that a suitable port number is to be automatically allocated and used. Note that most operating systems define this structure such that fields are in network byte order.

destination_rtcp

The SOCKADDR_IN6 structure specifying the destination IP address and port for the RTCP stream. A struct SOCKADDR_IN6 must be configured with an address family, an IPv6 address and a port. Note that most operating systems define this structure such that fields are in network bytes order.

source_rtcp

The SOCKADDR_IN6 structure allows you to specify the source IP address and port for the RTCP stream. A struct SOCKADDR_IN6 must be configured with an address family. The IP address may be specified, or a value equivalent to in6addr_any may be used to indicate that any suitable address may be used. The port number may be specified, or the value zero may be used to indicate that a suitable port number is to be automatically allocated and used. Note that most operating systems define this structure such that fields are in network bytes order.

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody RTP processing API.