application programmer interface (api) reference guide cisco telepresence system codec c40/c60 api...

Download Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C40/C60 API Reference

Post on 28-Jun-2020

1 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 1

    Cisco TelePresence System Codec C40/C60 API Reference Guide

    Software version TC7.0 JANUARY 2014

    Application Programmer Interface (API) Reference Guide Cisco TelePresence System Codec C40/C60

  • D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 2

    Cisco TelePresence System Codec C40/C60 API Reference Guide

    TA - ToC - Hidden text anchor

    Table of Contents

    Introduction ..........................................................................3

    About this guide ......................................................................4 User documentation .............................................................4

    What’s new in this version ......................................................5 Software release notes ........................................................5 Software download ..............................................................5 New features and improvements .........................................5 System configuration changes .............................................6 System command changes..................................................6 System status changes ........................................................6

    About the API ........................................................................ 7

    API fundamentals ....................................................................8 Connecting to the API ..........................................................8 Password .............................................................................8 RS-232/serial connection ....................................................8 Telnet ....................................................................................8 SSH ......................................................................................8 HTTP/HTTPS ........................................................................8

    API output ...............................................................................9 The output modes ................................................................9

    Using the command line .......................................................10 API commands ...................................................................10 Other commands ...............................................................10 Command line shortcuts ....................................................10 Searching ........................................................................... 11 Value types and formats .................................................... 11

    Commands ........................................................................... 12

    Configurations ......................................................................13

    Status ....................................................................................14

    Events ...................................................................................15

    Call history ............................................................................16

    Feedback mechanism........................................................... 17 Feedback expressions ....................................................... 17 Terminal connections .........................................................18

    Using HTTP ...........................................................................19 Getting status and configurations ......................................19 Sending commands and configurations.............................19 Using HTTP POST ..............................................................19

    Feedback from codec over HTTP ........................................20 Registering for feedback ....................................................20 Translating from terminal mode to XML.............................. 21

    Dos and don’ts ......................................................................22

    xConfiguration commands ..................................................23

    Description of the xConfiguration commands ......................24

    xCommand commands .......................................................83

    Description of the xCommand commands ...........................84

    xStatus commands ...........................................................140

    Description of the xStatus commands ............................... 141

    Appendices....................................................................... 217

    About startup scripts ..........................................................218

    Cisco TelePresence Remote Control ..................................219

    Remote control key map .....................................................220

    The SystemTools commands .............................................. 221

    About disconnect cause types ...........................................223

    What’s in this guide? 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/cseries-docs

    http://www.cisco.com/go/cseries-docs

  • D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 3

    Cisco TelePresence System Codec C40/C60 API Reference Guide

    Chapter 1

    Introduction

  • D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 4

    Cisco TelePresence System Codec C40/C60 API Reference Guide

    About this guide This guide introduces 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 C60 • Cisco TelePresence System Codec C40

    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 TC software

    To download the user documentation go to:

    http://www.cisco.com/go/cseries-docs

    http://www.cisco.com/go/cseries-docs

  • D14642.15 Codec C40-C60 API Reference Guide TC7.0, JANUARY 2014. Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved. 5

    Cisco TelePresence System Codec C40/C60 API Reference Guide

    What’s new in this version This section provides an overview of the new and changed system settings and new features in the TC7.0 software version.

    Software release notes For a complete overview of new features and changes, we recommend reading the Software Release Notes (TC7). Go to:

     http://www.cisco.com/c/en/us/support/collaboration- endpoints/telepresence-integrator-c-series/products- release-notes-list.html

    Software download For software download go to:  http://www.cisco.com/cisco/software/navigator.html

    New features and improvements

    New GUI for Touch 8

    A new visual design for the Touch user interface is introduced.

    IPv6 and dual stack support

    IPv6 and dual stack operations are fully supported, also when using ActiveControl and ICE.

    Use the following settings if you want to enable dual stack operation with IPv6 as the preferred protocol:

    Network 1 IPStack: Dual (enables IPv4 and IPv6 network address (default))

    Conference 1 CallProtocolIPStack: Dual (enables dual stack operation for the call protocols)

    SIP PreferredIPMedia: IPv6 (selects which IP version to prefer for media if both versions are supported on both ends)

    SIP PreferredIPSignaling: IPv6 (selects which IP version to prefer for signaling if both versions are supported on both ends)

    Presentation will stop when the presentation source is disconnected

    If a presentation source is disconnected or goes into standby (e.g. a PC), the presentation will automatically be ended after 10 seconds. If the source is connected or comes out of standby within 10 seconds, the presentation will automatically be resumed.

    When presenting an input source that is not connected, an empty presentation will not be sent to the far end.

    Tap the upper left corner to activate/deactivate the Do not disturb feature, to activate/deactivate the Standby feature, and to access the Settings.

    Tap the icon to activate selfview, choose a preset camera position, and pan/tilt/zoom the camera.

    Password protection of the Touch Administrator menu

    You must sign

Recommended

View more >