User manual BIAMP VOCIA TEXT PROTOCOL

[. . . ] 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. An MS-1 is needed in a Vocia system to accept VTP commands. [. . . ] This is set in the Vocia software application. 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 must be is in the range 0-24, and must be in sequential order. 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. pre = Y pre = N Page will be preceded by preamble Page will not be preceded by preamble prio = This parameter defines the priority of the page (used for resolution of access to zones) and is in the range 1 ­ 4 inclusive, with 1 being the lowest priority. id = nnn This is an id number provided by the client (valid range ­ 0 through 32767 inclusive) which the system will use to identify individual page requests when informing the client of progress of an individual page. Command XS Argument pre Argument prio Argument id 4. 2. 1 Example of a complete VTP triggered page sequence Example E 0 e /vociawavs/baggagebelt+0. 0db. wav E 1 e /vociawavs/pleaseleavenow. wav E2z Z12 X S Y 1 3456 This would play, at priority level 1, the standard preamble for priority level 1 (low) as defined in the Vocia software configuration, followed by the announcement Biamp Systems 9300 S. W. Gemini Drive Beaverton, Oregon 97008 U. S. A. 503. 641. 7287 www. biamp. com 15 "baggagebelt+0. 0db. wav" followed by "pleaseleavenow. wav" to zones (1, 2) with event id number 3456. See Section 4. 1 for Element definition. 5. 0 Creating a User Audio Input Event A User Audio Input is assigned to a Vocia Input 6 (VI-6) input channel in the Vocia software interface. [. . . ] PCPreambleOn is 0 for no preamble or 1 when a preamble is required. PCPriority defines the priority of the page code - 1 for Low, 2 for Medium, 3 for High and 4 for Urgent. PCType can be "PAGE_TYPE_LIVE" for a live page from a paging station microphone, "PAGE_TYPE_DELAYED" for a delayed page from a paging station microphone or "PAGE_TYPE_PLAYBACK" for initiation of a recorded announcement playback. PCZoneCount specifies the number of destination paging zones for the page code. [. . . ]