NaturalConference Developer's Reference Manual (6749-13): Alphabetical Function Reference
(Page 5 of 23 in this chapter) Version
cnfGetActiveTalkersList
Description
- Returns the list of members actively talking in a conference.
Prototype
- DWORD cnfGetActiveTalkersList (
CNFRESOURCEHD cnfresourcehd,
DWORD confid,
unsigned maxmemberids,
DWORD *memberidlist,
unsigned *nummemberids)
- cnfresourcehd Handle returned by cnfOpenResource.
- confid Conference identifier returned by cnfCreateConference.
- maxmemberids Maximum number of entries in memberidlist array.
- memberidlist Pointer to an array of DWORD where the function returns the list of member identifiers. If NULL, this function just returns the number of members talking in a conference
- nummemberids Pointer to a returned number of member identifiers.
Return Values
Details
- This function is typically called after the application receives a CNFEVN_ACTIVE_TALKERS_CHANGE event. Using this function, the application can compare the actual count of members currently included in the conference with the list of the corresponding member identifiers. The number of members selected as active talkers can be changed by setting the corresponding attribute. See cnfGetConferenceAttribute and cnfSetConferenceAttribute for further details about conference related attributes.
- The successive active talkers lists are not queued in NaturalConference. The application receiving the corresponding event must retrieve the list in the appropriate time delay.
- For more information, refer to Section 4.10, NaturalConference Events.
See Also
- cnfCreateConference, cnfGetMemberList, cnfSetConferenceAttribute
Example
extern CNFRESOURCEHD cnfresourcehd;
unsigned getTalkerList(DWORD confid, DWORD *talkeridlist,
unsigned maxmemberids)
{
DWORD error;
unsigned numtalkerids = 0;
error = cnfGetActiveTalkersList(cnfresourcehd, confid,
maxmemberids, talkeridlist,
&numtalkerids);
if (error != SUCCESS)
{
printf("Error when retrieving active talker list :%d", error);
}
return (numtalkerids);
}
(Page 5 of 23 in this chapter) Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights
reserved.