Prosody speech processing: API: sm_conf_prim_attach

Prototype Definition

int sm_conf_prim_attach(struct sm_conf_prim_attach_parms *confp)

Parameters

*confp
a structure of the following type: 
typedef struct sm_conf_prim_attach_parms {
	tSMChannelId channel;					/* in */
	enum kSMConfType conf_type;				/* in */
} SM_CONF_PRIM_ATTACH_PARMS;

Description

Sets up an input channel channel ready to be added as a participant of one or more conferences through calls to sm_conf_prim_add().

The channel input is kept continuously ready for conferencing until sm_conf_prim_detach() is used on it.

Standard conferencing can implicitly attach a channel input for conferencing when sm_conf_prim_add() adds it to the first conference, and the channel is then also implicitly detached when sm_conf_prim_leave() removes it from the last conference. This implicit attaching and detaching does not apply to conferences with individual volume control.

When a channel input is detached (whether explicitly or implicitly), all of the input conference settings are lost (such as the input ID and volume) and all resources used by that input for conferencing are freed. This means that it is usually more convenient to attach explicitly as this allows the input to be set up before it is a participant in any conference and it retains the settings during any period when it is temporarily not a participant in any conference.

Fields

channel
The channel to be used for conference input.
conf_type
The type of conferencing that will be used. One of these values:
kSMConfTypeStandard
Standard conferencing.
kSMConfTypeIndividualVolume
Deprecated: Obsolete mode that permited individual adjustment of the volume of each participant's contribution to each output.

Returns

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

This function is part of the Prosody speech processing API.