Searching - Cisco Codec C20 Reference Manual

Cisco TelePresence System Codec C20
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:
xCommand dial number: "my number contains
Correct:
spaces"
xCommand dial number: 12345
Correct:
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
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
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 3 Type: AutoDetect
*c xConfiguration Video Input DVI 5 Type: AutoDetect
*c xConfiguration Video Output DVI 2 Resolution: 1366 _ 768 _ 60
*c xConfiguration Video Output DVI 2 OverscanLevel: None
*c xConfiguration Video Output DVI 2 MonitorRole: Second
*c xConfiguration Video Output DVI 4 Resolution: Auto
*c xConfiguration Video Output DVI 4 OverscanLevel: None
*c xConfiguration Video Output DVI 4 MonitorRole: Fourth
** 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: 1920
*s Video Input Source 2 Resolution Width: 0
*s Video Input Source 3 Resolution Width: 0
*s Video Input Source 4 Resolution Width: 0
*s Video Input Source 5 Resolution Width: 0
*s Video Output HDMI 1 Resolution Width: 1366
*s Video Output HDMI 3 Resolution Width: 1366
*s Video Output DVI 2 Resolution Width: 1366
*s Video Output DVI 4 Resolution Width: 1024
*s Video Output Legacy 5 Resolution Width: 720
** end
example 3: Value types and formats
xConfiguration ??
*? xConfiguration Audio Microphones Mute Enabled: <True/InCallOnly>
*? xConfiguration Audio Volume: <0..100>
.
.
.
*? xConfiguration SystemUnit Name: <S: 0, 50>
13
xCommand xStatus
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices