Prosody speech processing: API: sm_conf_prim_stop

Prototype Definition

int sm_conf_prim_stop(struct sm_conf_prim_stop_parms *stopp)

Parameters

*stopp

a structure of the following type:

typedef struct sm_conf_prim_stop_parms {
	tSMChannelId channel;					/* in */
	tSM_UT32 no_wait;					/* in */
} SM_CONF_PRIM_STOP_PARMS;

Description

Stops the conference on a specified channel which will revert to outputting silence.

Fields

channel

The channel on which the conference output has been started which is to be stopped.

no_wait

Indicates if the function should return without waiting for the conference to stop. In this case the function sm_conf_prim_status() must be used to determine when the conference has stopped.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_WRONG_CHANNEL_STATE - if no conference started on channel

This function is part of the Prosody speech processing API.