Prosody data communications: API: smdc_tx_encoding

Prototype Definition

int smdc_tx_encoding(struct smdc_encoding_parms *encp)

Parameters

*encp

a structure of the following type:

typedef struct smdc_encoding_parms {
	tSMChannelId channel;					/* in */
	tSM_INT encoding;					/* in */
	tSM_INT encoding_config_length;				/* in */
	void *encoding_config_data;				/* in */
} SMDC_ENCODING_PARMS;

Description

Configures the transmit encoding for the output half of a channel which must have been already configured for data communications using smdc_channel_config().

For details of what encodings are available, and the format of their configuration data, see the document Prosody data communications Encodings.

Fields

channel

The channel to configure.

encoding

The desired encoding for data transmitted by the channel.

encoding_config_length

The length of the encoding-specific configuration data pointed to by encoding_config_data

encoding_config_data

Encoding-specific configuration data.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_BAD_PARAMETER - a parameter value is bad
• ERR_SM_WRONG_CHANNEL_STATE - channel has no transmit protocol configured

This function is part of the Prosody data communications API.