Prosody FMP processing: API: sm_fmptx_config

This function is only in Preliminary Documentation.

Prototype Definition

int sm_fmptx_config(struct sm_fmptx_config_parms *configp)

Parameters

*configp
a structure of the following type: 
typedef struct sm_fmptx_config_parms {
	tSMFMPtxId fmptx;					/* in */
	SOCKADDR_IN destination;				/* in */
	SOCKADDR_IN source;					/* in */
	enum kSMFMPRecoveryType {
		kSMFMPRecoveryTypeRED,
		kSMFMPRecoveryTypeFEC,
		kSMFMPRecoveryTypeRTP,
	} Recovery;						/* in */
	tSM_UT32 RecoveryLevel;					/* in */
} SM_FMPTX_CONFIG_PARMS;

Description

Configures a VMP[tx] to send T.38 data to a device with the specified IP address.

Fields

fmptx (Only in Preliminary Documentation)
The fmp[tx] to configure
destination (Only in Preliminary Documentation)
The SOCKADDR_IN structure specifying the destination IP address and port for the T38 data. 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 (Only in Preliminary Documentation)
The SOCKADDR_IN structure allows you to specify the source IP address and port for the T.38 data. 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.
Recovery (Only in Preliminary Documentation)
The type of error protection to use
One of these values:
kSMFMPRecoveryTypeRED
Indicates that Redundancy is to be used
kSMFMPRecoveryTypeFEC
Indicates that Forward Error Correction is to be used, (not currently supported)
kSMFMPRecoveryTypeRTP
Indicates the Redundancy over RTP is to be used, (not currently supported)
RecoveryLevel (Only in Preliminary Documentation)
Indicates the level of Redundancy to apply to packets. This is the number of secondaries to include in each packet.

Returns

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

This function is part of the Prosody FMP processing API.