Prosody high level conferencing: API: sm_conference_add_party

Prototype Definition

int sm_conference_add_party(struct sm_conference_add_party_parms *parms)

Parameters

*parms

a structure of the following type:

typedef struct sm_conference_add_party_parms {
	tSMConference conf;					/* in */
	tSMChannelId channelIn;					/* in */
	tSMChannelId channelOut;				/* in */
	int out_volume;						/* in */
	int out_agc;						/* in */
	int in_volume;						/* in */
	int in_agc;						/* in */
} SM_CONFERENCE_ADD_PARTY_PARMS;

Description

Adds new party to a previously created conference.

Note this party must not be a member of another conference. Adding a party to a conference twice (without removing it first) will result in an error condition.

Fields

conf

A conference created with sm_conference_create().

channelIn

The new party's input channel.

channelOut

The new party's output channel.

out_volume

The volume adjustment for the new party's output channel.

out_agc

Whether or not the new party's output channel should perform automatic gain control. When enabled, AGC tries to make the signal average about 0dBm0 by adjusting its gain. Although this is far too loud for normal use, it means that the desired level can be specified directly in out_volume. For example, if you want the target to be -12 dBm0, you set the volume to -12 and it applies this to the 0dBm0 signal generated by the AGC, giving an overall signal average targetted at -12dBm0.

in_volume

The volume adjustment for the new party's input channel.

in_agc

Whether or not the new party's input channel should perform automatic gain control.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_SUCH_CHANNEL - if channel/participant was invalid or no longer allocated
• ERR_SM_BAD_PARAMETER - illegal agc value
• ERR_SM_WRONG_CHANNEL_STATE - if no conference started on output channel

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