Prosody RTP processing: API: sm_vidmptx_config
Prototype Definition
int sm_vidmptx_config(struct sm_vidmptx_config_parms *configp)
Parameters
- *configp
-
a structure of the following type:
typedef struct sm_vidmptx_config_parms {
tSMVidMPtxId vidmptx; /* in */
SOCKADDR_IN destination_rtp; /* in */
SOCKADDR_IN source_rtp; /* in */
int TOS_RTP; /* in */
SOCKADDR_IN destination_rtcp; /* in */
SOCKADDR_IN source_rtcp; /* in */
int TOS_RTCP; /* in */
} SM_VIDMPTX_CONFIG_PARMS;
Description
Configures a VidMP[tx] to send RTP and RTCP data to a device with the
specified IP address and port numbers.
If the call completes successfully RTP data generated by the
vidmptx
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 VidMP[tx] to use the given IP address and port for
outgoing RTP data.
Specifying the
source_rtcp
instructs the VidMP[tx] to use the given IP address and port for
outgoing RTCP data.
This requires the module
vidmptx
to have been downloaded.
Fields
- vidmptx (Deprecated)
- The VidMP[tx] to configure
- destination_rtp (Deprecated)
- The SOCKADDR_IN structure specifying the destination IP address
and port for the RTP stream. A struct SOCKADDR_IN must be
configured with an address family, an IP address and a port.
Note that most operating systems define this structure such that
fields are in network byte order.
The structure must be correctly cast such that an IP V4
address is specified.
- source_rtp (Deprecated)
- The SOCKADDR_IN structure allows you to specify the source IP
address and port for the RTP stream. A struct SOCKADDR_IN must
be configured with an address family. The IP address may be
specified, or the value INADDR_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.
The structure must be correctly cast such that an IP V4
address is specified.
- TOS_RTP (Deprecated)
- The Type Of Service (TOS) indicator to be sent with RTP data
- destination_rtcp (Deprecated)
- The SOCKADDR_IN structure specifying the destination IP address
and port for the RTCP stream. A struct SOCKADDR_IN must be
configured with an address family, an IP address and a port.
Note that most operating systems define this structure such that
fields are in network bytes order.
The structure must be correctly cast such that an IP V4
address is specified.
- source_rtcp (Deprecated)
- The SOCKADDR_IN structure allows you to specify the source IP
address and port for the RTCP stream. A struct SOCKADDR_IN must
be configured with an address family. The IP address may be
specified, or the value INADDR_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.
The structure must be correctly cast such that an IP V4
address is specified.
- TOS_RTCP (Deprecated)
- The Type Of Service (TOS) indicator to be sent with RTCP data
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.