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


cnfGetMemberAttribute

Description

Returns the current value of a member attribute.

Prototype

DWORD cnfGetMemberAttribute (
CNFRESOURCEHD cnfresourcehd,
DWORD memberid,
DWORD attribute,
INT32 *value)

cnfresourcehd Handle returned by cnfOpenResource.

memberid Member identifier returned by cnfJoinConference.

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

value Pointer to the returned attribute value.

Return Values

Details

The following table describes the valid member attributes:
Keyword

Allowed Values

Description

MEMBER_ATTR_INPUT_AGC_ENABLE

FALSE or TRUE

Input AGC state (enabled/disabled).

MEMBER_ATTR _OUTPUT_AGC_ENABLE

FALSE or TRUE

Output AGC state (enabled/disabled).

MEMBER_ATTR_INPUT_GAIN

-12 to 12

The value of the input gain currently applied.

MEMBER_ATTR_OUTPUT_GAIN

-12 to 12

The value of the output gain currently applied.

MEMBER_ATTR_INPUT_AGC_TARGETAMPL

-45 to 0

The target amplitude for AGC.

MEMBER_ATTR_INPUT_AGC_SILENCEAMPL

-45 to 0

The noise threshold amplitude for AGC.

MEMBER_ATTR_OUTPUT_AGC_TARGETAMPL

-45 to 0

The target amplitude for output AGC.

MEMBER_ATTR_OUTPUT_AGC_SILENCEAMPL

-45 to 0

The noise threshold amplitude for output AGC.

MEMBER_ATTR_TALKER_ENABLE

FALSE or TRUE

Indicates if the member is a talker in a conference.

MEMBER_ATTR_LISTENER_ENABLE

FALSE or TRUE

Indicates if the member can hear the other in the conference. If the member is neither TALKER or LISTENER, he can be considered as (temporarily) out of the conference even if the corresponding conferencing resource is still allocated for this member.

MEMBER_ATTR_TALKER_PRIVILEGE

FALSE or TRUE

Indicates if the member is considered a privileged talker. A privileged talker is always an active talker even when not speaking.

MEMBER_ATTR_DTMF_CLAMPING_ENABLE

FALSE or TRUE

Indicates whether the DTMF clamping capability is currently activated for this member.

Note: If DTMF clamping is disabled at the resource or conference level, this attribute is not relevant.

MEMBER_ATTR_DTMF_CLAMPING_DELAYLINE

0 to 28 in ms

The delay line to bufferize the signal received by each member before removing the DTMF with the DTMF clamping module.

Note: If DTMF clamping is disabled, the delay line is not activated.

MEMBER_ATTR_TONE_CLAMPING_ENABLE

FALSE or TRUE

Indicates if the tone clamping capability is currently activated for this member.

Note: If tone clamping is disabled at the resource or conference level, this attribute is not relevant.

MEMBER_ATTR_EC_ENABLE

FALSE or TRUE

Indicates if the echo cancellation capability is currently activated for this member.

Note: If echo cancellation is disabled at the resource or conference level, this attribute is not relevant.

MEMBER_ATTR_EC_GAIN

-54.. +24 in db

Indicates the amplification applied to the output signal. Relevant only when echo cancellation is activated.

MEMBER_ATTR_EC_PREDELAY

0 to 9

The output delay. Relevant only when echo cancellation is activated.

MEMBER_ATTR_SELF_ECHO_ENABLE

FALSE or TRUE

Indicates if the voice received from this member on its input is mixed and returned to that member on its output. This attribute can be enabled when the output is not connected to the member, but is actually used for recording.

MEMBER_ATTR_INPUT_G711_LAW

CNF_G711_DEFAULT,CNF_G711_ALAW,
or
CNF_G711_MULAW

The current G. 711 law applied in the member's input.

MEMBER_ATTR_OUTPUT_G711_LAW

CNF_G711_DEFAULT,CNF_G711_ALAW,
or
CNF_G711_MULAW

The current G. 711 law applied in the member's output.

See Appendix B for further details about attribute default values.

See Section 4.8 for more information about member attributes.

See Also

cnfGetMemberAttributeList, cnfGetMemberInfo, cnfJoinConference, cnfSetMemberAttribute

Example

extern CNFRESOURCEHD cnfresourcehd;

INT32 getMemberTalkerStatus(DWORD memberid)
{
DWORD error; INT32 talkerActive; error = cnfGetMemberAttribute(cnfresourcehd, memberid, MEMBER_ATTR_TALKER_ENABLE,
&talkerActive);
return(talkerActive); }


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