Viz Ticker User Guide

Version 3.1 | Published May 27, 2020 ©

Overview

To access Viz Ticker functions, use standard REST HTTP calls to the Media Sequencer used by the Ticker System. The full Media Sequencer API documentation can be accessed by browsing:

http://YourMediaSequencerHostName:8580/doc

Note: 8580 is the default TCP port used by Media Sequencer.

It is advisable to read the Media Sequencer API documentation carefully in order to use the REST API effectively. Most programming and scripting languages have built in support for HTTP calls which makes it easy to interface Ticker via the REST API. It is beyond the scope of this document to explain REST (Representational State Transfer) in detail. There are many good internet resources for this. A good starting point for reading about REST would be http://en.wikipedia.org/wiki/Representational_state_transfer.

In the following examples we use the free curl utility to send REST calls and tidy to do a basic XML formatting, see The curl and tidy Utilities. Other tools can of course be used. For example Telerik’s Fiddler2 (http://www.telerik.com/fiddler) is quite popular.

The basic workflow:

  1. Send the REST API command you require to port 8580 on the Media Sequencer running the Ticker System.

  2. Media Sequencer sends the response as XML in UTF-8.

Example REST API Call

Send the REST verb GET with curl to the Media Sequencer running on localhost port 8580 to get a list of actions from the command line:

curl -X GET http://localhost:8580/actions

Receive a slightly more readable output (format the XML with tidy):

curl -X GET http://localhost:8580/actions/ | tidy -xml -i -w 0