Prosody data communications: API: smdc_tx_config_t38

Prototype Definition

int smdc_tx_config_t38(struct smdc_tx_config_t38_parms *configp)

Parameters

*configp
a structure of the following type:
typedef struct smdc_tx_config_t38_parms {
	tSMChannelId channel;					/* in */
	tSM_INT PreCorrigendum;					/* in */
	tSM_INT Protocol;					/* in */
	tSM_UT32 max_packet_length;				/* in */
} SMDC_TX_CONFIG_T38_PARMS;

Description

Configures a channel's output for data communications using the T.38 protocol.

The output half of a channel is reserved for this data communications configuration until smdc_tx_status() returns the status kSMDCTxStatusFinished. No other activity can take place on the output half of the channel during this time.

While the output half of a channel is configured for data communications, a write event associated with this channel using sm_channel_set_event() will be set while the channel is ready to allow data to be written or there may be a status change to report. See smdc_tx_control() for details of how this works. When an application discovers that this event is set, it should attempt to write data using smdc_tx_data(). See its description to see how this interacts with status changes.

The max_packet_length field is used to restrict the size of the IFP packet data produced by the channel. A value of zero will cause the maximum size to be the maximum permitted by the firmware, as will any value above that maximum.

Requires the module ifptx to have been downloaded.

Fields

channel
The channel to configure.
PreCorrigendum
Selects the version of T.38 to use. Non-zero selects the pre-Corrigendum (1998) version, zero selects the updated version (2002).
Protocol
A value from Table 4/T.38 which is sent in packets indicating which kind of modulation is being described.
max_packet_length
The maximum number of octets in the output IFP packets

Returns

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


This function is part of the Prosody data communications API.