Prosody data communications: API: smdc_rx_config_t38

Prototype Definition

int smdc_rx_config_t38(struct smdc_rx_config_t38_parms *configp)

Parameters

*configp
a structure of the following type: 
typedef struct smdc_rx_config_t38_parms {
	tSMChannelId channel;					/* in */
	tSM_INT PreCorrigendum;					/* in */
	tSM_INT Protocol;					/* in */
} SMDC_RX_CONFIG_T38_PARMS;

Description

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

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

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

Requires the module ifprx 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 used in packets indicating which kind of modulation is being described. Incoming packets are discarded if they are incompatible with the value selected. The value kSMDCT38ProtocolAll may be used to allow all received data to be read. In this case, smdc_rx_status_t38() will report the protocol being received and all data read will be in the appropriate format until a new protocol is reported.

Returns

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

This function is part of the Prosody data communications API.