Prosody high level conferencing: API: sm_conference_info

Prototype Definition

int sm_conference_info(struct sm_conference_info_parms *parms)

Parameters

*parms
a structure of the following type: 
typedef struct sm_conference_info_parms {
	tSMConference conf;					/* in */
	int activeChannelCount;					/* out */
	tSMChannelId *activeChannelList;			/* in */
} SM_CONFERENCE_INFO_PARMS;

Description

Return list of input channel identifiers corresponding to those input channels belonging to participants in the conference that are currently active (i.e currently speaking).

The parameter activeChannelList must point to an area of memory large enough to contain an array of N values of type tSMChannelId where N is the maximum possible no. of participants in the conference.

On return, activeChannelCount will be set to the no. of input channel identifiers written by the call to activeChannelList, each identifier in this list being the input channel id of an active participant in the conference. If a conference has only one member it will never report that member as being active.

Fields

conf
A conference created with sm_conference_create().
activeChannelCount
The number of channels currently active in this conference.
activeChannelList
A pointer to where to store the list of channels currently active on this conference.

Returns

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

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