Cisco TelePresence SX20 Codec User Manual

D14949.13 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. 12
Cisco TelePresence SX20 Codec API Reference Guide
Using the command line
Help
To get a list of all supported root commands you can type ?
or help after connecting to the TelePresence System using
RS-232, Telnet or SSH.
Bye
Typing the bye command closes the command line interface.
?
- User Commands -
help xcommand xconfiguration xevent xfeedback
xgetxml xdocument xhistory xpreferences xstatus
bye echo log systemtools
OK
API commands
xConfiguration
Configurations are system settings, such as system name
and network settings. These are persistent across boots.
Refer to ”Configurations” on page 15.
xCommand
Commands instruct the codec to execute actions, such as to
dial a number or to search the phone book.
Refer to ”Commands” on page 14.
xStatus
A status contains the current state of the codec, such as
connected calls, the status of the gatekeeper registration,
connected inputs and output sources.
Refer to ”Status” on page 16.
xFeedback
The Feedback commands are used to specify what parts of
the configuration and status hierarchies to monitor. Feedback
is only issued on the Telnet or SSH session for which it is
specified. If you are connecting to the codec with multiple
sessions, you have to define feedback individually for each
session. Refer to ”Feedback mechanism” on page 19.
xPreferences
The xPreferences command is used to set preferences for
the RS-232, Telnet and SSH sessions.
Refer to ”API output” on page 11.
Echo <on/off>
If echo is set to On the key inputs are displayed when
entering text in a command line interface.
If echo is set to Off no user input is displayed when entering
text in a command line interface.
xEvent
the xEvent command returns information on which events are
available for feedback. Refer to ”Events” on page 17.
xHistory
The xHistory command returns the call log.
xGetxml
The xGetxml request returns an XML document based on the
location parameter attached to the request. The elements
(or a complete document) matching the expression will be
returned. Refer to ”Feedback mechanism” on page 19.
Other commands
Systemtools
The systemtools commands are used for administrative
control of the codec and are only available from the
command line interface. Systemtools are not a part of the
programming API.
Refer to ”The SystemTools commands” on page 215.
Log
The log command is used to enable advanced logs. It is only
used for debugging the system.
Command line shortcuts
If your client supports it, there are some timesaving shortcuts
you can use:
• Tab-completion to complete the commands and
arguments.
• Arrow up and arrow down keys to navigate your
command history.
• < C T R L- a > : Jump to the beginning of the line.
• < C T R L- e > : Jump to the end of the line.
• < C T R L- r > : Incremental command history search.
• < C T R L- w > : Erase the current line.
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
About the API

Cisco TelePresence SX20 Codec Specifications

General

Max Frame Rate	60 fps
Video Outputs	2 x HDMI
Dual Stream	Yes
Storage Temperature	-20°C to 60°C (-4°F to 140°F)
Video Standards	H.261, H.263, H.263+, H.264
Audio Standards	G.711, G.722, G.722.1, G.729
Max Video Resolution	1920 x 1080
Network Protocols	H.323, SIP
Power Supply	100-240V AC, 50/60Hz
Video Inputs	1 x HDMI, 1 x DVI-I
Network Interface	10/100/1000 Ethernet
Operating Temperature	0°C to 35°C (32°F to 95°F)
Relative Humidity	10% to 90% (non-condensing)

Summary

Introduction to Cisco TelePresence SX20 Codec API

About This Guide

Provides a general overview of the guide's purpose, content, and related user documentation.

User Documentation Overview

Lists various user guides available for Cisco TelePresence systems, covering different user groups and functionalities.

New Features and Improvements in TC7.3

Details new and changed system settings, features, and improvements introduced in the TC7.3 software version.

Understanding the API for Cisco TelePresence SX20

API Fundamentals and Structure

Introduces the API's core mechanisms, hierarchical organization, and usage of commands, configurations, and status.

Connecting to the Codec API

Explains various connection methods for accessing the codec API, including RS-232, Telnet, SSH, and HTTP/HTTPS.

API Output Modes

Describes the two output modes for API responses: Terminal (line-based) and XML (structured data).

xConfiguration Commands for Cisco SX20

Description of xConfiguration Commands

Provides a comprehensive list and descriptions of available xConfiguration commands for system settings.

Audio Configuration Settings

Details various settings related to audio input, output, microphones, and sound configurations.

Camera Configuration Settings

Covers settings for camera control, including backlight, brightness, focus, and flip modes.

Network Configuration Settings

Explains network settings such as IP addressing, subnet masks, gateways, and DNS configuration.

SIP Configuration Settings

Details configuration options for the Session Initiation Protocol (SIP), including proxy and registration settings.

Video Configuration Settings

Covers settings for video input sources, output connectors, layouts, and on-screen display.

xCommand Commands for Cisco SX20

Description of xCommand Commands

Provides a comprehensive list and descriptions of available xCommand commands for controlling system actions.

Call Management Commands

Details commands for initiating, answering, disconnecting, and managing calls.

Camera Control Commands

Covers commands for controlling camera movement, presets, and snapshots.

Conference Management Commands

Details commands for managing conference features like active speaker, Do Not Disturb, and call extensions.

xStatus Commands for Cisco SX20

Description of xStatus Commands

Provides a comprehensive list and descriptions of available xStatus queries for system information.

Audio Status Information

Retrieves status details for audio inputs, outputs, microphones, and call-related audio information.

Call Status Information

Provides current status details for active calls, including type, protocol, and connection state.

Camera Status Information

Retrieves status details for connected cameras, including model, software, and positional information.

Network Status Information

Shows current network configuration, connectivity status, and interface details.

SIP Status Information

Provides information on SIP registration status, proxy communication, and call forwarding settings.

Appendices for Cisco TelePresence SX20 API

Adding a Startup Script

Explains how to create and use startup scripts to execute API commands during codec boot-up.

Cisco TelePresence Remote Control Overview

Describes the functionality and key mapping of the physical remote control for system operation.

SystemTools Commands Reference

Lists and describes administrative commands for codec management and diagnostics.