Prosody data communications: API: smdc_tx_tone_indicator_t38

Prototype Definition

int smdc_tx_tone_indicator_t38(struct smdc_tx_tone_indicator_t38_parms *tonep)

Parameters

*tonep
a structure of the following type: 
typedef struct smdc_tx_tone_indicator_t38_parms {
	tSMChannelId channel;					/* in */
	enum kSMDCT38ToneType {
		kSMDCT38ToneTypeCNG,
		kSMDCT38ToneTypeCED,
		kSMDCT38ToneTypeANSAM,
	} tone_type;						/* in */
} SMDC_TX_TONE_INDICATOR_T38_PARMS;

Description

Sends a T.38 tone indicator on the output half of a T.38 data communication channel.

T.38 tone indicators must be sent before sending any T.38 data on a given channel.

Fields

channel
The T.38 data communications channel
tone_type
The type of tone indicator to send One of these values:
kSMDCT38ToneTypeCNG
A CNG tone
kSMDCT38ToneTypeCED
A CED tone
kSMDCT38ToneTypeANSAM
An ANSAM tone

Returns

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

This function is part of the Prosody data communications API.