Searching - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Introduction

Searching

You can use // to search for elements anywhere in the status or
configuration hierarchy (Example 1).
You can also combine multiple //'s (Example 2).
WARNING: The search shortcuts work well for inspecting the API, but
should not be used in applications. We recommend that you always use
the complete paths to avoid command ambiguity when upgrading to
newer firmware releases.
Value types and formats
The system supports the following value types (Example 3):
• Integer values: <x..y>
Defines the valid range for an integer input. x = min value, y = max
value.
• Literal values: <X/Y/../Z>
Defines the possible values for a given configuration.
• String values: <S: x, y>
Defines that the valid input for this configuration is a string with
minimum length of x and maximum length of y characters. Strings
can have rules that further specify their format and length.
Input values that contain spaces need to be quoted
Any values for configurations and commands containing spaces must
be enclosed in quotes. Quotes are not necessary for values without
spaces.
Examples:
Correct:
xCommand dial number: "my number contains spaces"
Correct:
xCommand dial number: 12345
Incorrect:
xCommand dial number: my number contains spaces
Case sensitivity
All commands are case-insensitive. All of the following commands will
work.
XCOMMAND DIAL NUMBER: foo@bar.org
xcommand dial number: foo@bar.org
xCommand Dial Number: foo@bar.org
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API About the API xConfiguration
Example 1: List all configurations that include a word that starts with DVI:
xConfiguration //dvi
*c xConfiguration Video Input DVI 2 RGBQuantizationRange: Full
*c xConfiguration Video Input DVI 2 Type: AutoDetect
** end
Example 2: Get the resolution width of all connected sources for both inputs and outputs:
xStatus //vid//res//wid
*s Video Input Source 1 Resolution Width: 1280
*s Video Input Source 2 Resolution Width: 0
*s Video Output HDMI 1 Resolution Width: 1280
*s Video Output HDMI 2 Resolution Width: 1680
** end
Example 3: List the value types and formats
xConfiguration ??
*? xConfiguration Audio DefaultVolume: <0..100>
*? xConfiguration Audio Input HDMI[1] Mode: <Off, On>
*? xConfiguration Audio Input Line[1] VideoAssociation MuteOnInactiveVideo: <Off, On>
*? xConfiguration Audio Input Line[1] VideoAssociation VideoInputSource: <1, 2>
*? xConfiguration Audio Input Microphone[1] EchoControl Dereverberation: <Off, On>
*? xConfiguration Audio Input Microphone[1] EchoControl Mode: <Off, On>
.
.
*? xConfiguration Video SelfviewDefault Mode: <Off/Current/On>
*? xConfiguration Video SelfviewDefault OnMonitorRole: <First/Second/Current>
*? xConfiguration Video SelfviewDefault PIPPosition: <Current/UpperLeft/UpperCenter/
UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight>
*? xConfiguration Video SelfviewPosition: <UpperLeft/UpperCenter/UpperRight/CenterLeft/
CenterRight/LowerLeft/LowerRight>
*? xConfiguration Video Wallpaper: <None/Custom/Growing/Summersky/Waves/Blue>
OK
13
xCommand xStatus
Copyright © 2015 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices