User manual BIAMP VOCIA TEXT PROTOCOL
DON'T FORGET : ALWAYS READ THE USER GUIDE BEFORE BUYING !!!
If this document matches the user guide, instructions manual or user manual, feature sets, schematics you are looking for, download it now. Diplodocs provides you a fast and easy access to the user manual BIAMP VOCIA TEXT PROTOCOL. We hope that this BIAMP VOCIA TEXT PROTOCOL user guide will be useful to you.
Manual abstract: user guide BIAMP VOCIA TEXT PROTOCOL
Detailed instructions for use are in the User's Guide.
[. . . ] Vocia Text Protocol Document 6/22/2010
Contents
1. 0 Connecting to the VTP Service 2. 0 VTP Commands 2. 1 Username and Password Information 2. 2 Zone Definition 2. 3 Interactive Mode 2. 4 Activity Logging 2. 5 Page progress 2. 6 Terminating a VTP session 2. 7 Background Source Change 2. 8 Control Handle Change 3. 0 Vocia Configuration Query Commands 4. 0 Page Execute Commands 5. 0 Creating a User Audio Input Event 6. 0 XML Responses 7. 0 Glossary of VTP Commands
Biamp Systems
9300 S. W. Gemini Drive
Beaverton, Oregon
97008
U. S. A.
503. 641. 7287
www. biamp. com
2
VTP Commands Document
Vocia Text Protocol (VTP) is a remote control protocol that provides an interface for third party control. A control system can connect to the IP address of a Vocia MS-1 at a specific port address (8020) and the MS-1 will accept VTP commands for the Vocia system. This document describes the Vocia Text Protocol and gives a list of valid commands to use with this process. [. . . ] The response includes a background source label, and the CobraNet bundle and bundle channel carrying the desired background audio. See section 6. 1. 2 for details of the response to this command.
Command QB Argument Zone number
3. 3 Q C
Query the current configuration ID for the MS-1 and its world. This command can be used to poll for changes to the configuration and to ensure the configuration used by the third party application is synchronized to the MS-1. See section 6. 1. 3 for details of the response to this command.
Command QC Argument Not needed
3. 4 Q H
Request a list of the current control handles available in the system. See section 6. 1. 4 for details of the response to this command.
Command QH Argument Not needed
3. 5 Q I
Request a list of available user audio inputs. In general user audio inputs are VI-6 inputs that are available for long term pages to a set of destination paging zones. Each item in the user audio input list will consist of a device type, device ID and a channel number. See section 6. 1. 5 for details of the response to this command.
Biamp Systems
9300 S. W. Please note that the WAV file that is to be triggered must also be associated to a Page Code in the current configuration that is running on the MS-1. In addition to the paging elements, a VTP triggered page must have a zone/s allocation, as well as preamble and priority level selection, and finally an ID number. The method for defining elements is shown below in section 4. 1, zone allocation is shown in section 1. 0 and page execute commands are shown in section 3. 2. An example of a full VTP page sequence is shown at section 4. 2. 1.
4. 1 E n Element definition
As a VTP triggered page consists of elements, we must define the order of the wav files using an element number. This by default means the maximum number of wav file elements that can be triggered as a single VTP paging event is 24. E n e filename After defining the element number n as shown above we need to define the wave file filename. This wave filename is presumed to exist already on the MS-1 file system; otherwise an error will occur when the page is executed. A list of available wav files can be queried using the Q A command (see Section 3. 1). The filename should not be put in quotation marks, even if it contains spaces. See the example below for a valid demonstration of this command.
Command Ene Argument Wav filename
Enz This element is the end-of-sequence marker. There is no need to send this command if all elements (0->24) have been defined, however it must be included if all 24 elements are not defined. Obviously in all but the rarest of cases an end of sequence marker will be required.
Command En Argument z
Biamp Systems
9300 S. W. Gemini Drive
Beaverton, Oregon
97008
U. S. A.
503. 641. 7287
www. biamp. com
14
Element Example
Example
E 0 e /vociawavs/baggagebelt+0. 0db. wav E1z
In this example, only the baggagebelt+0. 0db. wav file will be triggered by VTP after these elements are constructed into a full X S command. Following the definition of the elements, zone allocation and page settings must be entered as shown in the example found in Section 4. 2. 1
4. 2 X S pre prio id
The X S command is used to execute a sequence page with the currently defined elements as the sequence as shown in section 4. 1. [. . . ] InputDeviceType is a decimal representation of the host device for the input. InputDeviceID is the specific device's 8bit device ID set on the rotary switches. InputChannel specifies the device's input channel used for the user input.
6. 1. 6 Page code list query response (Q L)
The response to a page code list query command will be as follows: <?xml version="1. 0"?> <Query Command="L"><Pagecodes count="PagecodeCount"> <Pagecode id="PageCode"> PagecodeLabel </ Pagecode > . . . <Pagecode id="PageCode"> PagecodeLabel </ Pagecode > </ Pagecodes ></Query> Where PagecodeCount is the number of available page codes. [. . . ]
DISCLAIMER TO DOWNLOAD THE USER GUIDE BIAMP VOCIA TEXT PROTOCOL
Click on "Download the user Manual" at the end of this Contract if you accept its terms, the downloading of the manual BIAMP VOCIA TEXT PROTOCOL will begin.