cisco telepresence codec 3000/6000 mxp api reference guide

Download Cisco TelePresence Codec 3000/6000 MXP API Reference Guide

If you can't read please download the document

Post on 10-Jan-2017

232 views

Category:

Documents

5 download

Embed Size (px)

TRANSCRIPT

  • 1

    MXP Series Codecs API reference guide

    D14789.01 MXP Series Codec API Reference Guide F9.0, May 2011.

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

    Software version F9 May 2011

    API Reference GuideCisco Telepresence System Codec 6000 MXP and Codec 3000 MXP

  • 2

    MXP Series Codecs API reference guide

    D14789.01 MXP Series Codec API Reference Guide F9.0, May 2011.

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

    TA - ToC - Hidden text anchor

    Table of Contents

    Introduction

    About this guide .................................................................. 9User documentation ........................................................ 9

    Whats new in this version ................................................ 10Software release notes ................................................. 10Software download ....................................................... 10User documentation ...................................................... 10Cisco Branding .............................................................. 10New document structure ............................................... 10

    System Integrator Reference Guide .......................... 10Administrator Guide ................................................... 10Installation guides ...................................................... 10Licence information ................................................... 10

    New and changed API commands ................................ 10

    About the API

    About the API .....................................................................12Basic Principles ..............................................................12The API-Engine ..............................................................12Structuring of Information ...............................................12The RS232/Telnet dataport interface .............................13Addressing Using XPath or SimplePath .........................14Feedback ........................................................................14

    Connecting to the codec .................................................. 15Accessing XACLI ........................................................... 15Connecting to XACLI using the dataport (RS-232) ....... 15Hardware & Cabling (RS-232) ....................................... 15Troubleshooting (RS-232) ............................................. 15

    Value types and formats ................................................... 16

    Root commands .................................................................17

    Main type of commands .................................................... 18Configuration type commands ...................................... 18Command type commands ........................................... 18Status type commands ................................................. 18Special commands ........................................................ 18

    Whats in this guide?

    Feedback type command .......................................... 18Preferences type command ...................................... 18GetXML type command ............................................. 18

    About xConfiguration ........................................................ 19

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

    About xCommand ............................................................. 21Required parameters ..................................................... 21

    xCommand operations ...................................................... 22Return result parameters ............................................... 22xCommand Help ............................................................ 22xCommand Write ........................................................... 22Issuing a xCommand ..................................................... 23Multiple instances of a parameter ................................. 23Sequence Notation ........................................................ 23Combination of Markup Notation and Sequence .......... 23

    About xStatus commands ................................................. 24xStatus type commands formatting .............................. 25Default XACLI formatting ............................................... 25Complete path formatting ............................................. 26XML formatting .............................................................. 27Addressing xStatus information .................................... 28The Exposure option ..................................................... 29

    About xHistory command.................................................. 30

    About xEvent command .................................................... 31

    About xFeedback .............................................................. 32

    About xPreferences .......................................................... 34xPreferences with CompletePath .................................. 36

    About xGetXML ................................................................. 37

    XML API service ................................................................ 38

    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

  • 3

    MXP Series Codecs API reference guide

    D14789.01 MXP Series Codec API Reference Guide F9.0, May 2011.

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

    Description of the xConfiguration commands

    Description of the xConfiguration commands .................. 40AdditionalCamera Type ................................................ 40AlertSpeaker Mode ...................................................... 40AlertTone Volume ......................................................... 40AlertTone VideoTelephony ............................................ 40AlertTone Telephony ..................................................... 40AllowLatency .................................................................41Audio Microphones Mode .............................................41Audio Microphone Mixer Mode .....................................41Audio AutoMute .............................................................41Audio AudioModule .......................................................41Audio Volume .................................................................41Audio AGC Microphones ................................................41Audio AGC AUX ............................................................ 42Audio AGC VCR ............................................................ 42Audio AGC Received ..................................................... 42Audio EchoControl [1..x]................................................. 42Audio Stereo .................................................................. 43Audio SteroSpeakers ..................................................... 43Audio VCRDucking ....................................................... 43Audio KeyTones ............................................................ 43Audio Inputs Microphone [1..x] Level ............................. 44Audio Inputs Microphone [1..x] Mode ............................ 44Audio Inputs Microphone [1..x] Mode ............................ 44Audio Inputs Line [1..x] Level ......................................... 44Audio Inputs Line [1..x] Mode......................................... 44Audio Outputs Line [1..x] Level ...................................... 45Audio Outputs Line [1..x] Mode...................................... 45Audio Outputs Line [1] Type ........................................... 45Audio LocalDetection Mode .......................................... 45Audio Feedback Mode .................................................. 45Audio Delay AUX ........................................................... 45Audio Delay VCR ........................................................... 46Audio HearingImpaired Mode ........................................ 46Audio HearingImpaired NoiseReduction ....................... 46Audio HearingImpaired EQ ............................................ 46AutoAnswer Mode ......................................................... 46AutoAnswer Delay ......................................................... 46AutoPIP Mode ................................................................ 47AutoPIP Timeout ............................................................ 47

    AutoLayout Mode .......................................................... 47AutoDisplaySnapshot .................................................... 47Bonding Timer ............................................................... 47Bonding Rebonding ....................................................... 47CallManager Address .................................................... 47CallVideoSource ............................................................ 48Camera [1..13] Brightness Mode ................................... 48Camera [1..13] Brightness Level ................................... 48Camera [1..13] Whitebalance Mode .............................. 48Camera [1..13] Whitebalance Level ............................... 48Camera [1..13] Whitebalance Gain Red ........................ 48Camera [1..13] Whitebalance Gain Blue ........

Recommended

View more >