Prosody FMP processing: API: sm_fmptx_config

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 FMP[tx] to send T.38 data to a device with the specified IPv4 address.

Fields

fmptx

The FMP[tx] to configure

destination

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

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

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

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:

• ERR_SM_DEVERR - device error

This function is part of the Prosody FMP processing API.