Prosody speech processing: API: sm_conf_prim_adj_input

Prototype Definition

int sm_conf_prim_adj_input(struct sm_conf_prim_adj_input_parms *confp)

Parameters

a structure of the following type:

typedef struct sm_conf_prim_adj_input_parms {
	tSMChannelId channel;					/* in */
	tSM_INT volume;						/* in */
	tSM_INT agc;						/* in */
} SM_CONF_PRIM_ADJ_INPUT_PARMS;

Description

Enable or disable automatic-gain-control/noise-reduction for an input channel which is a conference participant in one or more conference summed output channels.

The volume parameter may be set to a the gain (in dB) or to the value kSMConfAdjInputVolumeMute which will cause the input to be completely muted. The range of gain supported is at least +8 to -22 dB,

The default input conference settings for a channel are 0 dB volume adjustment with AGC disabled.

Note: all input settings are lost when the channel is no longer a conference input unless the channel has been explicitly attached for conferencing by calling sm_conf_prim_attach().

Fields

channel: The input channel which is attached to conferencing and which is to be adjusted.
volume: The new value for the volume (in dB).
agc: The new value for the indicator of whether automatic gain control is to be enabled (non-zero) or disabled (zero).

Returns

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

ERR_SM_DEVERR - device error
ERR_SM_BAD_PARAMETER - unknown participant id or bad agc value
ERR_SM_WRONG_CHANNEL_STATE - if channel not in a conference

This function is part of the Prosody speech processing API.