D14869.11
Codec C20 API Reference Guide TC7.0, JANUARY 2014.
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
28
Cisco TelePresence System Codec C20
API Reference Guide
Audio configuration
xConfiguration Audio Microphones Mute Enabled
Determine whether audio-mute is allowed or not. The default value is True.
Requires user role:
ADMIN
Value space:
<True/InCallOnly>
True:
Muting of audio is always available.
InCallOnly:
Muting of audio is only available when the device is in a call. When Idle it is not
possible to mute the microphone. This is useful when an external telephone service/audio system
is connected via the codec and is to be available when the codec is not in a call. When set to
InCallOnly this will prevent the audio-system from being muted by mistake.
Example:
xConfiguration Audio Microphones Mute Enabled: True
xConfiguration Audio SoundsAndAlerts KeyTones Mode
The system can be configured to make a keyboard click sound effect (key tone) when pressing a
key on the remote control, or when typing text or numbers on the touch screen control panel.
Requires user role:
USER
Value space:
<Off/On>
Off:
No key tones will be played when you type.
On:
You will hear a key tone when you press a key or type text.
Example:
xConfiguration Audio SoundsAndAlerts KeyTones Mode: Off
xConfiguration Audio SoundsAndAlerts RingVolume
Sets the ring volume for an incoming call.
Requires user role:
USER
Value space:
<0..100>
Range:
The value goes in steps of 5 from 0 to 100 (from -34.5 dB to 15 dB). Volume 0 = Off.
Example:
xConfiguration Audio SoundsAndAlerts RingVolume: 50
xConfiguration Audio Volume
Adjust the speaker volume.
Requires user role:
USER
Value space:
<0..100>
Range:
The value must be between 0 and 100. The values from 1 to 100 correspond to the range
from -34.5 dB to 15 dB (0.5 dB steps). The value 0 means that the audio is switched off.
Example:
xConfiguration Audio Volume: 70
xConfiguration Audio EcReferenceDelay Mode
Set the acoustic echo cancellation reference delay mode.
Requires user role:
ADMIN
Value space:
<Off/Fixed>
Off:
No extra latency will be added to reference signal used by the acoustic echo canceller.
Fixed:
The extra latency given by Audio EcReferenceDelay Delay will be used to compensate for
latency in the acoustic path, typically introduced by TV monitors.
Example:
xConfiguration Audio EcReferenceDelay Mode: Off
xConfiguration Audio EcReferenceDelay Delay
Adjust the time slot (in milliseconds) of the acoustic echo cancellation. Only applicable when Audio
EcReferenceDelay Mode is set to Fixed.
Requires user role:
ADMIN
Value space:
<0..250>
Range:
Value from 0 to 250 milliseconds.
Example:
xConfiguration Audio EcReferenceDelay Delay: 120
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
xConfiguration
