TANDBERG 3.0 Reference Manual
  1. Manuals
  2. Brands
  3. TANDBERG Manuals
  4. Software
  5. Movi 3.0
  6. Reference manual
TANDBERG 3.0 Reference Manual

TANDBERG 3.0 Reference Manual

Tandberg monitor reference guide
Hide thumbs Also See for 3.0:
Table of Contents

Advertisement

Quick Links

Download this manual
Reference guide
Codian Remote
Management API
Document version 3.0
September 2008

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the 3.0 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for TANDBERG 3.0

Summary of Contents for TANDBERG 3.0

  • Page 1 Reference guide Codian Remote Management API Document version 3.0 September 2008...
  • Page 2 TANDBERG Philip Pedersens vei 20 1366 Lysaker Norway Telephone: +47 67 125 125 Telefax: +47 67 125 234 Video: +47 67 117 777 E-mail: tandberg@tandberg.com www.tandberg.com Copyright © TANDBERG 2008...

  • Page 3: Table Of Contents

    4.13 participant.connect...26 4.14 participant.disconnect...26 4.15 participant.move...26 4.16 participant.enumerate...27 4.17 participant.fecc...31 4.18 participant.message ...31 4.19 participant.diagnostics ...32 4.20 autoAttendant.enumerate ...32 4.21 autoAttendant.destroy ...33 IP VCR methods... 34 recording.callout...34 recording.configure ...34 recording.delete...35 recording.enumerate ...35 recording.stop...36 folder.enumerate ...36 Copyright © TANDBERG 2008...
  • Page 4 Example message 4 - setting the new "linked2" participant to use a full screen view layout ...58 Message responses ...59 Appendix C - Revision Numbers... 60 Discovering record removal...60 Dead records ...61 Appendix D - HTTP Keep-alives ... 62 Copyright © TANDBERG 2008...

  • Page 5: Introduction

    1 Introduction This document contains the specification of the TANDBERG Codian Remote Management API, by which it is possible to control several Codian products. This is accomplished via messages sent using the XML-RPC protocol. XML-RPC is a simple protocol for remote procedure calling using HTTP as the transport and XML as the encoding.

  • Page 6: Protocol Overview

    <methodName>conference.create</methodName> <params> <param> <value> <struct> <member> <name>authenticationUser</name> <value> <string>api_test</string> </value> </member> <member> <name>authenticationPassword</name> <value> <string>123456</string> </value> </member> <member> <name>conferenceName</name> <value> <string>Meeting 1</string> </value> </member> <member> <name>startTime</name> <value> <dateTime.iso8601>20050218T10:45:00</dateTime.iso8601> </value> </member> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...
  • Page 7 MCU returns: HTTP/1.1 200 OK Connection: close Content-Type: text/xml Content-Length: 411 <?xml version="1.0"?> <methodResponse> <fault> <value> <struct> <member> <name>faultCode</name> <value> <int>2</int> </value> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 8: Unicode Support

    The name is case sensitive. The corresponding user’s password. This parameter is ignored if the user has no password set - note that this differs from the web interface where a blank password must be blank. Reference Guide Version 3.0 rev 3.0 "Accept-Encoding:...

  • Page 9: Participant Identification Parameters

    API-generated conferences and all other ad hoc and scheduled MCU conferences. If the participant in question is connected to an auto attendant rather than a conference, this field contains a unique identifier for that auto attendant. Reference Guide Version 3.0 rev 3.0 by_address ad_hoc...

  • Page 10: Filtering

    << Bitwise left shift >> Bitwise right shift Addition Subtraction Multiplication Division Modulo There are also the following unary operators, all of which bind tighter than any binary operator. Copyright © TANDBERG 2008 ,expression2). Reference Guide Version 3.0 rev 3.0...
  • Page 11 Operator Description Unary minus Unary plus Logical negation Bitwise negation An example filter would be !(expression Copyright © TANDBERG 2008 && expression Reference Guide Version 3.0 rev 3.0...

  • Page 12: Messages Supported By Multiple Product Types

    Contains the configuration and status for port B. Comments true if the port is enabled, otherwise false. The host name of this port. true if configured by DHCP, otherwise false. a.b.c.d format. a.b.c.d format. a.b.c.d format. Reference Guide Version 3.0 rev 3.0...

  • Page 13: Device.health.query

    Loads for the media processors (total, and split between audio and video) as percentage values. These are not present on ISDN gateways. One of outOfSpec One of active shuttingDown Comments Contains the restart log in structures as described below. Reference Guide Version 3.0 rev 3.0 critical shutDown...

  • Page 14: Gatekeeper.query

    The currently configured SIP proxy address. This corresponds to the “SIP proxy address” on the Settings > SIP web page, and will be an empty string value if there is no Reference Guide Version 3.0 rev 3.0 unknown User User requested...

  • Page 15: Addressbookentry.enumerate

    Whether this endpoint is configured to use a sip registrar when being called. String The password for vnc endpoints. Integer The port number for vnc endpoints. struct See below for details. struct See below for details. Reference Guide Version 3.0 rev 3.0...

  • Page 16: Gateway.enumerate

    Integer 0 (no border), or 1, 2, or 3 for +1/+2/+3. Comments The value returned by the last enumeration call. If it is omitted, a new enumeration is started. Reference Guide Version 3.0 rev 3.0...
  • Page 17 If true, this endpoint will use box-wide default motion sharpness settings. Integer Only present if useDefaultMotionSharpness is false. Specifies the minimum frame rate for this endpoint. Integer Max media transmit bit rate. Integer Max media receive bit rate. Reference Guide Version 3.0 rev 3.0...

  • Page 18: Conference Related Methods

    “Visibility” setting on the web UI, which can have the value Private Integer These fields set the limit on the number of audio (audio only) and video (video + Integer audio) ports for the conference. The Integer Reference Guide Version 3.0 rev 3.0 Public...
  • Page 19 Boolean true if new participants use the custom layout, false otherwise. Only valid if customLayoutEnabled is true. Integer A layout index, as described in appendix Reference Guide Version 3.0 rev 3.0 daily weekly monthly monthly tuesday wednesday friday...

  • Page 20: Conference.modify

    These fields can only be used for conferences which are not of type String String ad_hoc Boolean Boolean dateTime.iso8601 Integer dateTime.iso8601 String Boolean Boolean Boolean Boolean Integer Integer Integer Integer String String String Reference Guide Version 3.0 rev 3.0 none - these values...

  • Page 21: Conference.destroy

    Name of the conference to be destroyed. Comments Name of the conference to be ended. Comments The value returned by the last enumeration call. If it is omitted, a new enumeration is started. A filter expression. Reference Guide Version 3.0 rev 3.0 conferences, however. ad_hoc...
  • Page 22 (and will be absent if no limits have been configured). Boolean True if a custom layout has been enabled for this conference. Integer The index (from appendix A) of the custom layout. This is only present if the custom Reference Guide Version 3.0 rev 3.0 ad_hoc...
  • Page 23 ID even if, for example, the conference is renamed while active, but each scheduled instance of this conference will have a different activeConferenceId. Reference Guide Version 3.0 rev 3.0 daily weekly monthly. . One of...

  • Page 24: Conference.streaming.query

    The bit rate of this stream in bits/second. This is only present for video streams with a defined codec. The maximum width and height of this stream. Reference Guide Version 3.0 rev 3.0 , or conferenceCustom , and describes the reason voiceActivated for undefined codecs.

  • Page 25: Conference.streaming.modify

    - the h239 content channel h239 - a participant as identified below. participant The index of this pane. Participant identification. Only present if this pane contains a specific participant. Reference Guide Version 3.0 rev 3.0 participant...

  • Page 26: Conference.paneplacement.modify

    Note that for is optional, but must be present otherwise. If present, must be h323, sip or vnc Reference Guide Version 3.0 rev 3.0 participants, this ad_hoc – these are...
  • Page 27 If true, the video sent to this participant will be in a Reference Guide Version 3.0 rev 3.0 . Note ad_hoc conference, this ad_hoc .

  • Page 28: Participant.remove

    Currently, must be one of: cascadeSlaveToMaster this is only taken note of if participantType is by_address). , whereas API participants are of type by_name Comments Participant identification as described above. Reference Guide Version 3.0 rev 3.0 . (Currently default...

  • Page 29: Participant.modify

    , change the stored configuredState configuration of a participant, or, if change the active participant state, resulting in real-time changes to that participant. Reference Guide Version 3.0 rev 3.0 . This configuredState activeState preferSharpness configuredState...

  • Page 30: Participant.connect

    Should only be present if focusType is participant. Comments Participant identification as described above. Comments Participant identification as described above. Comments Participant identification as described above. Reference Guide Version 3.0 rev 3.0 h239 participant...

  • Page 31: Participant.enumerate

    The value which should be used in the next call to get the next set of data. If this is not present, there is no further data available from the MCU. See below for contents. Comments Participant identification as described above. Reference Guide Version 3.0 rev 3.0 . If configuredState...
  • Page 32 Whether or not the participant should be automatically disconnected from the conference when all other participants disconnect. 0 (no border), or 1, 2, or 3 for +1/+2/+3. One of: cascadeSlaveToMaster Reference Guide Version 3.0 rev 3.0 preferSharpness automatic fixed default...
  • Page 33 String Integer Integer String Integer Integer Boolean String One of fixed Reference Guide Version 3.0 rev 3.0 (if set to the global default preferSharpness alerting connected . When dormant, the . It may or may not be connected disconnected none...
  • Page 34 Struct Only present if focusType is This structure contains participant identification members (i.e. conferenceName, participantName, participantType and participantProtocol). Reference Guide Version 3.0 rev 3.0 family<x> , or , and describes the . When the outgoing ’, the callDirection dormant...

  • Page 35: Participant.fecc

    Whether this endpoint is muted remotely. Comments Participant identification as described above. One of: down left focusIn focusOut Comments Participant identification as described above. The string to send to the participant. Reference Guide Version 3.0 rev 3.0 right zoomIn zoomOut...

  • Page 36: Participant.diagnostics

    Participant identification as described above. Comments One of: notLimited viewedSize aggregateBandwidth endpointLimitation One of: notLimited viewedSize aggregateBandwidth endpointLimitation Comments The value returned by the last enumeration call, if omitted, a new enumeration is started. Reference Guide Version 3.0 rev 3.0 quality flowControl quality flowControl...

  • Page 37: Autoattendant.destroy

    MCU’s configured menu structure. dateTime.iso8601 The time at which the auto attendant was created. Comments Identifier for the auto attendant to be destroyed. Reference Guide Version 3.0 rev 3.0...

  • Page 38: Ip Vcr Methods

    The PIN for this recording. Whether to register this recording with the sip registrar. Whether to register this recording with the h323 gatekeeper. Whether this recording has playback enabled. Reference Guide Version 3.0 rev 3.0 h323 . Defaults to false.

  • Page 39: Recording.delete

    True if the recording can be played back by users. True if the numeric ID is registered with the SIP registrar. True if the numeric ID is registered with the h323 gatekeeper. Reference Guide Version 3.0 rev 3.0 idle initialising deleting recording...

  • Page 40: Recording.stop

    Contains the PIN of this folder. String The numerical ids used to access these functions. String Note that these are not the same as other instances of similar names, e.g. recordingId. String These must be unique across the device. Reference Guide Version 3.0 rev 3.0...
  • Page 41 Field pointToPointIncomingPrefix pointToPointOutgoingPrefix Copyright © TANDBERG 2008 Type Comments String The folder’s configured point to point recording prefixes. String These values are only present with IP VCR software version 2.3 and later. Reference Guide Version 3.0 rev 3.0...

  • Page 42: Isdn Gateway Methods

    The number of ISDN channels in use. Only present for ISDN participants. The channels in use by this call. Only present for ISDN participants. Reference Guide Version 3.0 rev 3.0 (for ISDN). h320 proceeding alerting Only present for...

  • Page 43: Calls.active.enumerate

    Comments An enumerateID, as specified in section 2. Comments An enumerateID, as specified in section 2. See below for layout of the structures. Reference Guide Version 3.0 rev 3.0 , depending on the none , depending on the none if this...

  • Page 44: Isdn.ports.query

    The index of the low channel. The index of the high channel. True if the search order is high to low, false if Reference Guide Version 3.0 rev 3.0 , depending on the none , depending on the...
  • Page 45 True if this a voice call, false if a data call. Only present if active. True if this call is incoming, false if outgoing. Only present if active. Only present if active. Only present if active. Reference Guide Version 3.0 rev 3.0...

  • Page 46: Ip Gateway Methods

    Configures the path to the TMS address book. Parameter Type corpdirURI String Copyright © TANDBERG 2008 Comments The full path of the TMS address book. Comments The full path of the TMS address book. Reference Guide Version 3.0 rev 3.0...

  • Page 47: Deprecated Messages

    The time at which the conference started at or will start The time at which the conference will end. If the conference is permanent then this parameter is absent. The PIN. Comments The participant name supplied in the participant.add message. Reference Guide Version 3.0 rev 3.0...

  • Page 48: Conference.participant.modify

    The address used to connect to the remote endpoint in question. Only returned when the address is known, or if the participant is configured via the API (which requires the address to be specified when added). Reference Guide Version 3.0 rev 3.0...
  • Page 49 (in the event that it has disconnected). true if this participant is currently the active speaker in the conference. The configured layout behavior for this Reference Guide Version 3.0 rev 3.0 connected call state,...
  • Page 50 MCU is not currently transmitting video to the participant in question. The values for this are those described in appendix A. Either incoming Reference Guide Version 3.0 rev 3.0 outgoing...

  • Page 51: Related Information Sources

    (Not supported on the IP GW). maxVideoResolution The maximum video resolution for the MCU; either "cif" or "max" if larger video is enabled. (Not supported on the IP GW). Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 52: Required User Privileges

    “administrator” privilege. Any user with administrator privileges. Any user with administrator privileges. Any user with administrator privileges. Any user with privilege “conference detail” or higher. As above for “participant.modify”. As above for “participant.add”. Reference Guide Version 3.0 rev 3.0...

  • Page 53: Fault Codes

    Missing parameter. This is given when a required parameter is absent. The parameter in question is given in the fault string in the format "missing parameter - parameter_name". Invalid parameter. This is given when a parameter was successfully parsed, is of the Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...
  • Page 54 The parameter in question is given in the fault string in the format "malformed parameter - parameter_name". Operation failed. This is a generic fault for when an operation does not succeed as required. Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 55: Participant Disconnect Reasons

    Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 56: References

    13 References [1] XML-RPC, http://www.xmlrpc.com/ [2] RFC 2616, http://www.faqs.org/rfcs/rfc2616.html Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 57: Appendix A - Conference Layouts

    The “<index>” values for “layout<index>” correspond to the pane arrangements shown below. It is worth noting that these indices are also used for the currentLayout parameter from the participant.enumerate call. Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...
  • Page 58 Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0...

  • Page 59: Appendix B - Linking Conferences Across Mcus

    4 shows such a “participant.modify” call; in this case the participant name needed was "1_Codian MCU 4210". B.1 Example message 1 - creating conference "linked1" on "mcu1" <?xml version="1.0"?> <methodCall> <methodName>conference.create</methodName> <params> <param> <value> <struct> <member> <name>authenticationUser</name> <value> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 60: Example Message 2 - Creating Conference "Linked2" On "Mcu2

    <?xml version="1.0"?> <methodCall> <methodName>conference.create</methodName> <params> <param> <value> <struct> <member> <name>authenticationUser</name> <value> <string>admin</string> </value> </member> <member> <name>conferenceName</name> <value> <string>linked2</string> </value> </member> <member> <name>conferenceID</name> <value> <string>5678</string> </value> </member> </struct> </value> </param> </params> </methodCall> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 61: Example Message 3 - Calling Into "Linked2" From "Linked1

    </member> <member> <name>participantName</name> <value> <string>remote_mcu</string> </value> </member> <member> <name>address</name> <value> <string>5678</string> </value> </member> <member> <name>gatewayAddress</name> <value> <string>10.2.1.27</string> </value> </member> <member> <name>cpLayout</name> <value> <string>layout1</string> </value> </member> </struct> </value> </param> </params> </methodCall> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 62: Example Message 4 - Setting The New "Linked2" Participant To Use A Full Screen View Layout

    <name>conferenceName</name> <value> <string>linked2</string> </value> </member> <member> <name>participantName</name> <value> <string>1_Codian MCU 4210</string> </value> </member> <member> <name>operationScope</name> <value> <string>active</string> </value> </member> <member> <name>cpLayout</name> <value> <string>layout1</string> </value> </member> </struct> </value> </param> </params> </methodCall> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 63: B.5 Message Responses

    The response to each of the above method invocations should be the same normal success indication: <?xml version="1.0"?> <methodResponse> <params> <param> <value> <struct> <member> <name>status</name> <value> <string>operation successful</string> </value> </member> </struct> </value> </param> </params> </methodResponse> Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 64: Appendix C - Revision Numbers

    The problem with only returning records in responses when they have changed is that if a record is removed there is no way for the client to distinguish between it being removed and just not having changed. Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 65: C.2 Dead Records

    These dead records are only cached on the MCU for a few minutes; therefore a client should not rely on them unless it is doing very regular polling. When using less frequent polling using the listAll parameter described above is more appropriate. Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

  • Page 66: Copyright © Tandberg

    If requests from the client are likely to be this far apart then there is little to be gained by using HTTP keep-alives. Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0...

This manual is also suitable for:

Codian remote management api

Table of Contents