Prosody speech processing: API: sm_conf_prim_leave

Prototype Definition

int sm_conf_prim_leave(struct sm_conf_prim_leave_parms *confp)

Parameters

*confp

a structure of the following type:

typedef struct sm_conf_prim_leave_parms {
	tSMChannelId channel;					/* in */
	tSM_INT id;						/* in */
} SM_CONF_PRIM_LEAVE_PARMS;

Description

Removes a conference participant (identified by id) from the set of input channels whose conferenced sum is currently being output on the output channel channel.

The parameter id should be the value assigned to this conference participant in an earlier call to sm_conf_prim_add().

Fields

channel

The channel on which the conference output has been started from which a participant is to be removed.

id

The identifier of the participant to be removed from the conference.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_BAD_PARAMETER - unknown participant id
• ERR_SM_WRONG_CHANNEL_STATE - if no conference started on channel

This function is part of the Prosody speech processing API.