Cisco TelePresence SX20 Codec Reference Manual page 32

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Contents
Introduction
xConfiguration Audio Input Microphone [1..2] EchoControl Dereverberation
The system has built-in signal processing to reduce the effect of room reverberation. Requires the
Echo Control Mode to be enabled for the microphone.
Requires user role: ADMIN
Value space: <Off/On>
Off: Turn off the dereverberation.
On: Turn on the dereverberation.
Example: xConfiguration Audio Input Microphone 1 EchoControl Dereverberation: On
xConfiguration Audio Input Microphone [1..2] Level
Define the audio level of the Microphone input connector.
Requires user role: ADMIN
Value space: <0..24>
Range: Select a value between 0 and 24, in steps of 1 dB.
Example: xConfiguration Audio Input Microphone 1 Level: 14
xConfiguration Audio Input Microphone [1..2] Mode
Set the audio input microphone mode.
Requires user role: ADMIN
Value space: <Off/On>
Off: Disable the microphone connector.
On: Enable the microphone connector.
Example: xConfiguration Audio Input Microphone 1 Mode: On
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
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API
xConfiguration
xConfiguration
xConfiguration Audio SoundsAndAlerts KeyTones Mode
xConfiguration Audio SoundsAndAlerts RingTone
xConfiguration Audio SoundsAndAlerts RingVolume
32
xCommand
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 controller.
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
This setting defines which ringtone to use for incoming calls. You need to enter the exact name of
the ringtone. You can find the available ringtones the following ways.
Web interface: On the Configuration > Personalization page.
Touch controller: On the Ringtone & Sound panel of the Settings menu. This panel is either in the
open part of the Settings menu, or included in the password protected Administrator menu. The
UserInterface UserPreference setting defines which panels will be in the password protected area.
Remote control: Under Sounds and Alerts in the Settings menu on screen.
API: Run xCommand Audio SoundsAndAlerts Ringtone.
Requires user role: USER
Value space: <S: 1, 100>
Format: String with a maximum of 100 characters.
Example: xConfiguration Audio SoundsAndAlerts RingTone: "Sunrise"
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
API Reference Guide
xStatus
Appendices
Copyright © 2015 Cisco Systems, Inc. All rights reserved.

Hide quick links:

Advertisement

Table of Contents
loading

Table of Contents