Prosody data communications: API

The following functions are provided by the Prosody data communications API:

API call W Description
smdc_channel_config()   Configure a channel (or half a channel) for data communications
smdc_rx_config_v34() P Configure a channel's input for V.34 data communications
smdc_tx_config_v34() P Configure a channel's output for V.34 data communications
smdc_rx_config_t38() P Configure a channel's input for T.38 data communications
smdc_tx_config_t38() P Configure a channel's output for T.38 data communications
smdc_rx_encoding()   Configure the receive encoding used by a channel for data communications
smdc_tx_encoding()   Configure the transmit encoding used by a channel for data communications
smdc_line_control()   Perform a general control operation on a data communications channel
smdc_line_control_v34() P Perform a general control operation on a V.34 data communications channel
smdc_line_status() P Check general status on a data communications channel
smdc_line_status_v34() P Check general status on a V.34 data communications channel
smdc_tx_status()   Check the status of the output half of a data communication channel.
smdc_tx_control()   Perform a control operation on the output half of a data communications channel
smdc_tx_data()   Write data to a channel configured for data communications
smdc_tx_tone_indicator_t38() P Sends a T.38 tone indicator on the output half of a T.38 data communication channel
smdc_rx_status()   Check the status of the input half of a data communication channel.
smdc_rx_status_t38() P Check the status of the input half of a T.38 data communication channel.
smdc_rx_control()   Perform a control operation on the input half of a data communications channel
smdc_rx_data()   Read data from a channel configured for data communications
smdc_stop()   Stop data communications protocols on a channel.
smdc_rx_stop()   Stop the receive data communications protocol on a channel.
smdc_tx_stop()   Stop the transmit data communications protocol on a channel.

Key to W column:

P Preliminary documentation - this functionality is under development. It could be changed or withdrawn, and may not be implemented in this release

This document is also available as a single file.