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. 21
Cisco TelePresence SX20 Codec API Reference Guide
Using HTTP
The codec supports sending commands and configurations over HTTP and HTTPS. It is also possible to retrieve configurations
and statuses this way. This interface exposes the same API as the command line, but in XML format.
URL cheat sheet
The following table contains the main URLs used when accessing the API over HTTP.
Method URL Description
GET http://<ip-address>/status.xml Complete status document
GET http://<ip-address>/configuration.xml Complete configuration document
GET http://<ip-address>/command.xml Complete command document
GET http://<ip-address>/valuespace.xml Complete valuespace document
GET http://<ip-address>/getxml?location=<path> Retrieve document based on a path
POST http://<ip-address>/putxml Configurations and commands in HTTP body
GET, POST http://<ip-address>/formputxml?xmldoc=<xml> Configurations and commands www-urlencoded
Getting status and configurations
Example 1: Get all status entries on the codec.
http://<ip-address>/getxml?location=/Status
Example 2: Get just the audio statuses of the codec.
http://<ip-address>/getxml?location=/Status/Audio
Example 3: Get all configurations of the codec.
http://<ip-address>/getxml?location=/Configuration
Example 4: Get all video configurations of the codec.
http://<ip-address>/getxml?location=/
Configuration/Video
Sending commands and configurations
Using HTTP GET
It is possible to use HTTP GET when sending commands
or configurations to the codec. This makes it easy to test
commands using your browser.
Example 1: Setting the camera position.
http://<ip-address>/formputxml?xmldoc=
<Command><Camera><PositionSet command=”True”>
<CameraId>1</CameraId><Pan>200</Pan>
<Tilt>200</Tilt></PositionSet></Camera></Command>
Example 2: Changing the system name.
http://<ip-address>/formputxml?xmldoc=
<Configuration><SystemUnit>
<Name>newName</Name></SystemUnit></Configuration>
Example 3: Changing multiple configurations in one go.
http://<ip-address>/formputxml?xmldoc=
<Configuration><Audio><Volume>80</Volume>
</Audio><Video><OSD><TodaysBookings>On
</TodaysBookings></OSD></video><Configuration>
Using HTTP POST
When sending configurations and commands to the codec,
it is important that the HTTP header Content-Type is set to
text/xml, i.e. Content-Type: text/xml. The body of the POST
should contain the XML content.
Example 1: Changing the system name.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
Connection: close
<Configuration>
<SystemUnit>
<Name>newName</Name>
</SystemUnit>
</Configuration>
Example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
Connection: close
<Command>
<Camera>
<PositionSet command=”True”>
<CameraId>1</CameraId>
<Pan>200</Pan>
<Tilt>200</Tilt>
</PositionSet>
</Camera>
</Command>
Response
HTTP/1.1 200 OK
Date: <date>
Server: WSGIServer/0.1 Python/2.5.4
Cache-Control: no-cache
Content-Type: text/xml
Content-Length: 91
Connection: close
<?xml version=”1.0”?>
<Command>
<CameraPositionSetResult item=”1” status=”OK”/>
</Command>
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.