Table of Contents Index NMS Glossary Previous Page Next Page (Page 6 of 23 in this chapter) Version


cnfGetConferenceAttribute

Description

Returns the current value of a conference attribute.

Prototype

DWORD cnfGetConferenceAttribute (
CNFRESOURCEHD cnfresourcehd,
DWORD confid,
DWORD attribute,
INT32 *value)

cnfresourcehd Handle returned by cnfOpenResource.

confid Conference identifier returned by cnfCreateConference.

attribute Specifies the attribute to be retrieved. See the Details section for a list and description of conference attributes.

value Pointer to the returned attribute value.

Return Values

Details

The following table describes the valid conference attributes:
Keyword

Allowed Values

Description

CONF_ATTR_NUM_LOUDEST_
SPEAKERS

1..n

The number of loudest speakers used for generating the conference output signal. In the interest of quality, the number of mixed member voices is minimized for output signal generation. The Loudest Speakers attribute allows an application to adjust this number according to its needs.

CONF_ATTR_EVENT_MASK

0 to disable all the events

or

CNF_EVNMSK_ACTIVE_
TALKERS_CHANGE

or

CNF_EVNMSK_TONE_
DONE

The bitmask describing the event the application is to receive for the conference.

CONF_ATTR_ACTIVE_TALKERS

1..n

The number of talking members factored in while generating the CNFEVN_ACTIVE_TALKERS_CHANGE event. This attribute allows an application to tune the way the CNFEVN_ACTIVE_TALKERS_CHANGE event is generated. For instance, when set to one (1), NaturalConference generates an event only when the main talker is changing. If set to 6, NaturalConference generates an event when one of the 6 main talkers has changed. This has nothing to do with the selection of the loudest speaker except that, if both attributes are set with the same value, the application considers the active talkers member list as the current member user for generating the conference's output signal.

CONF_ATTR_ACTIVE_TALKERS_TIMER

100 to 60000

The minimum time (in multiples of 20ms) between the generation of two CNFEVN_ACTIVE_
TALKERS_CHANGE
events.

See Appendix B for further details about attribute default values.

See Section 4.7 for more information on conference attributes.

See Also

cnfCreateConference, cnfGetConferenceInfo, cnfSetConferenceAttribute

Example

extern CNFRESOURCEHD cnfresourcehd;

INT32 getActiveTalkersTimer(DWORD confid)
{
INT32 timer; DWORD error; error = cnfGetConferenceAttribute(cnfresourcehd, confid,
CONF_ATTR_ACTIVE_TALKERS_TIMER,
&timer);
return(timer); }


Table of Contents Index NMS Glossary Previous Page Next Page (Page 6 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.