Prosody speech processing: API: sm_set_sidetone_channel

This function is deprecated.

Prototype Definition

int sm_set_sidetone_channel(struct sm_set_sidetone_channel_parms *sidetp)

Parameters

*sidetp
a structure of the following type: 
typedef struct sm_set_sidetone_channel_parms {
	tSMChannelId channel;					/* in */
	tSMChannelId output;					/* in */
} SM_SET_SIDETONE_CHANNEL_PARMS;

Description

When both an input channel and an output channel are switched through to an analogue telephone, the hybrid will cause a fraction of the output signal to appear as part of the input signal received from that telephone. This signal fraction is sometimes called sidetone. When a signal is fed into a conference with sm_conf_prim_add() the firmware can temporarily suspend this input from the conference during times when it appears to contain only an echo of the signal being sent to the corresponding output. Note that this does not remove the echo - it suppresses the whole signal - nor does it suppress recording or detection of the signal, which continues normally.

However, see sm_condition_input() for a more general way to remove this echo, at the expense of using more processing resources.

This API call nominates for an input channel channel, the output channel, output, whose sidetone will be assumed to form part of the input channel signal. It should only be enabled when output is a channel whose output signal is from a conferencing job.

If output is set to kSMNullChannelId, it will be assumed no sidetone is present in the input channel signal.

Only on Prosody S: Not supported by Prosody S.

Fields

channel (Deprecated)
The input channel which is attached to conferencing whose sidetone is to be configured.
output (Deprecated)
The output channel which is to be configured as a sidetone.

Returns

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

This function is part of the Prosody speech processing API.