tandberg api guide - cisco d14642.01—march 2010 2 tandberg codec c60 and codec c40 api guide...

Download TANDBERG API Guide - Cisco D14642.01—MARCH 2010 2 TANDBERG Codec C60 and Codec C40 API Guide TA -

Post on 01-Mar-2020

3 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • D14642.01—MARCH 2010 1

    TANDBERG Codec C60 and Codec C40 API Guide

    Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us

    www.tandberg.com

    Software version TC3.0 MARCH 2010

    TANDBERG API Guide TANDBERG Codec C60 and Codec C40

    Contact usAbout the API xConfiguration xCommand xStatus AppendicesContents Introduction

  • D14642.01—MARCH 2010 2

    TANDBERG Codec C60 and Codec C40 API Guide

    TA - ToC - Hidden text anchor

    Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us

    www.tandberg.com

    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 the TANDBERG web site regularly for updated versions of this guide. Go to: http://www.tandberg.com/docs

    Table of Contents

    Introduction

    Introduction ............................................................................ 5 The purpose of this document ............................................ 5 Disclaimers and Notices ..................................................... 5 Products covered in this guide ........................................... 5 Other documents you might find useful .............................. 5

    TANDBERG Codec C40 ......................................................... 6

    What’s new in this version ...................................................... 7 Software release notes ....................................................... 7 User documentation ........................................................... 7 New commands ................................................................. 7

    xConfiguration ................................................................. 7 xCommand ..................................................................... 8 xStatus ............................................................................ 8

    Commands that have been changed .................................. 8 xConfiguration ................................................................. 8 xCommand ..................................................................... 8

    Commands that are removed ............................................. 8 xConfiguration ................................................................. 8 xCommand ..................................................................... 8

    About the TANDBERG API

    TANDBERG API .................................................................... 10 Basic Principles ................................................................ 10 The TANDBERG API-Engine ............................................. 10 Structuring of Information ................................................. 10 Addressing Using XPath or TANDBERG SimplePath ........ 11 Feedback .......................................................................... 11

    Connecting to the codec ...................................................... 12 Accessing XACLI .............................................................. 12

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

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

    What’s in this guide?

    Value types and formats ....................................................... 13

    Root commands ................................................................... 14

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

    Feedback type command ............................................. 15 Preferences type command .......................................... 15

    About xConfiguration ............................................................ 16

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

    About xCommand ................................................................ 18

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

    About xStatus commands .................................................... 20 Query status information ................................................... 21

    About xHistory command ..................................................... 22

    About xFeedback ................................................................. 23

    About xPreferences .............................................................. 24 The xPreferences output modes ....................................... 24

    TANDBERG XML API service................................................ 25

    Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact usContents

    http://www.tandberg.com/docs

  • D14642.01—MARCH 2010 3

    TANDBERG Codec C60 and Codec C40 API Guide

    Contents Introduction About the API xConfiguration xCommand xStatus Appendices Contact us

    www.tandberg.com

    Description of the xConfiguration commands

    Description of the xConfiguration commands ....................... 27 The Audio settings ............................................................ 27 The Camera settings ........................................................ 31 The Conference settings ................................................... 33 The GPIO settings............................................................. 35 The H323 settings ............................................................ 35 The Network settings ........................................................ 37 The NetworkServices settings .......................................... 40 The Phonebook settings ................................................... 41 The Provisioning settings .................................................. 42 The SerialPort settings...................................................... 42 The SIP settings ................................................................ 43 The Standby settings ........................................................ 44 The SystemUnit settings ................................................... 45 The Time settings ............................................................. 45 The Video settings ............................................................ 46 The Experimental menu .................................................... 52

    Description of the xCommand commands

    xCommands with parameters .............................................. 54 The Audio commands ...................................................... 54 The Boot command ..........................................................60 The Call commands .......................................................... 61 The Call Log commands ................................................... 62 The CamCtrlPiP command ............................................... 63 The Camera commands ................................................... 63 The Dial command............................................................ 64 The DTMF command ........................................................ 65 The Far End Control commands ....................................... 65 The GPIO commands ....................................................... 66 The HTTP Feedback commands ...................................... 67 The Key commands .......................................................... 67 The Message command ................................................... 68 The Phonebook commands ............................................. 69 The Presentation commands ............................................ 71 The Preset commands ..................................................... 72 The SString Send command ............................................ 72 The Standby command .................................................... 73 The SystemUnit command ............................................... 73

    The TStringSend commands ............................................ 76 The Video commands ....................................................... 76 The Experimental commands ........................................... 81

    Description of the xStatus commands

    xStatus commands .............................................................. 83 The Audio status ............................................................... 83 The Call status .................................................................. 87 The Camera status ........................................................... 89 The Conf

Recommended

View more >