cisco telepresence system codec c20 api reference guide ... 1 cisco telepresence system codec c20...

Download Cisco TelePresence System Codec C20 API Reference Guide ... 1 Cisco TelePresence System Codec C20 API

Post on 14-May-2020

6 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • 1

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Software version TC4.2 JULY 2011

    Application Programmer Interface (API) Reference Guide

    Cisco TelePresence System Codec C20

  • 2

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    TA - ToC - Hidden text anchor

    Table of Contents

    Introduction

    About this guide .................................................................. 5 User documentation ........................................................ 5

    What’s new in this version .................................................. 6 Software release notes ................................................... 6 Software download ......................................................... 6 NEW: API Reference Guide for Codec C20 .................... 6 New features and improvements .................................... 6

    New software release for PrecisionHD Camera .......... 6 New features accessible from Touch panel ................ 6 New features accessible from menu on screen .......... 6 New web interface ....................................................... 6 Support for Consumer Electronics Control (CEC) ....... 6 Support for always unmute when not in conference ... 6 Support for VCS clustering .......................................... 6

    About the API

    About the API ...................................................................... 8 Basic Principles ............................................................... 8 The API-Engine ............................................................... 8 Structuring of Information ................................................ 8 Addressing Using XPath or SimplePath .......................... 9 Feedback ......................................................................... 9

    Connecting to the codec .................................................. 10 Accessing XACLI ........................................................... 10

    Telnet/SSH login ........................................................ 10 Serial port login.......................................................... 10 Serial port configurations .......................................... 10 Reboot ....................................................................... 10

    Hardware & Cabling (RS-232) ....................................... 10 Troubleshooting (RS-232) ............................................. 10

    Value types and formats ....................................................11

    User commands .................................................................12

    Main type of commands .....................................................13 Configuration type commands .......................................13

    What’s in this guide?

    Command type commands ............................................13 Status type commands ..................................................13 Special commands .........................................................13

    Feedback type command ...........................................13 Preferences type command .......................................13

    About xConfiguration .........................................................14

    xConfiguration operations ................................................. 15 Return result parameters ............................................... 15 xConfiguration Help ....................................................... 15 xConfiguration Read ...................................................... 15 xConfiguration Write ...................................................... 15

    About xCommand ............................................................. 16

    xCommand operations .......................................................17 Return result parameters ................................................17 xCommand Help .............................................................17 xCommand Write ............................................................17

    About xStatus commands ................................................. 18 Quering status information ............................................ 19

    About xHistory ................................................................... 20

    About xEvent ..................................................................... 21

    About xFeedback .............................................................. 22

    About xPreferences .......................................................... 23 The xPreferences output modes ................................... 23

    The SystemTools commands ............................................ 24

    XML API service ................................................................ 26

    Description of the xConfiguration commands

    Description of the xConfiguration commands .................. 28

    Description of the xCommand commands

    Description of the xCommands commands ...................... 60

    The top menu bar and the entries in the Table of Contents are all hyperlinks, just click on them to go to the topic.

    We recommend you visit our web site regularly for updated versions of the user documentation. Go to: http://www.cisco.com/go/telepresence/ docs

    http://www.cisco.com/go/telepresence/docs http://www.cisco.com/go/telepresence/docs

  • 3

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Description of the xStatus commands

    Description of the xStatus commands .............................. 84

    Appendices

    Startup script ................................................................... 130 Adding a startup script ................................................ 130

    Cisco TelePresence Remote Control ...............................131

    Remote control key map ................................................. 132

    Overview of the xConfiguration commands.................... 133

    Overview of the xCommand commands ........................ 137

    Overview of the xStatus commands ............................... 140

  • 4

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    Chapter 1

    Introduction

  • 5

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    About this guide This guide will introduce you to the Application Programmer Interface (API) for the TC software in general, and serve as a reference guide for the command line commands for the Codec C Series listed below: • Cisco TelePresence System Codec C20

    User documentation The user documentation for the Cisco TelePresence systems, running the TC software, have several guides suitable to various user groups. • Video conference room primer • Video conference room acoustics guidelines • Installation guides for the TelePresence systems • Software release notes for the TC software • Getting started guide for the TelePresence systems • User guide for the TelePresence systems (Touch controller) • User guide for the TelePresence systems (Remote Control) • Quick reference guides for the TelePresence systems • Administrator guides for the TelePresence systems • Camera user guide for the PrecisionHD cameras • API reference guides for the Codec C Series • TC Console user guide for the Codec C Series • Physical interfaces guides for the Codec C Series • Regulatory compliance and safety information guides • Legal & license information for the TC software

    Download the user documentation Go to: http://www.cisco.com/go/telepresence/docs - in the right pane, select: • TelePresence Solutions Platform for the Codec C Series

    and Quick Set C20. • TelePresence Peripherals for the PrecisionHD cameras,

    microphones, Touch unit, and remote controls.

    http://www.cisco.com/go/telepresence/docs

  • 6

    Cisco TelePresence System Codec C20 API Reference Guide

    D14869.01 Codec C20 API Reference Guide TC4.2 July 2011.

    © 2010-2011 Cisco Systems, Inc. All rights reserved. www.cisco.com

    What’s new in this version This section provides an overview of the new and changed API commands and new features in the TC4.2 software version.

    Software release notes For a complete overview of the news and changes, we recommend reading the Software Release Notes (TC4). Go to: http://www.cisco.com/en/US/products/ps11422/ tsd_products_support_series_home.html

    Software download For software download go to: http://www.cisco.com/cisco/ software/navigator.html?a=a&i=rpm

    NEW: API Reference Guide for Codec C20 To meet several customers requests for an API guide for C20 we have made this API Reference Guide for Codec C20.

    New features and improvements

    New software release for PrecisionHD Camera

    With the TC4.2.0 release, the PrecisionHD 1080p camera will automatically be upgraded to camera softwar

Recommended

View more >