Prosody high level conferencing: API: sm_conference_remove_party

Prototype Definition

int sm_conference_remove_party(struct sm_conference_remove_party_parms *parms)

Parameters

*parms

a structure of the following type:

typedef struct sm_conference_remove_party_parms {
	tSMConference conf;					/* in */
	tSMChannelId channelIn;					/* in */
	tSMChannelId channelOut;				/* in */
} SM_CONFERENCE_REMOVE_PARTY_PARMS;

Description

Removes existing party from previously created conference. The channelIn and channelOut parameters must be the same as were used in the corresponding call to sm_conference_add_party().

Fields

conf

A conference created with sm_conference_create().

channelIn

The party's input channel.

channelOut

The party's output channel.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_SUCH_CHANNEL - if channel was invalid or no longer allocated.
• ERR_SM_BAD_PARAMETER - unknown participant, or channelOut is not paired with channelIn
• ERR_SM_WRONG_CHANNEL_STATE - if no conference started on channelOut

This function is part of the Prosody high level conferencing API.