HOW TO: Control OnTheAir Video using the REST API

OnTheAir Video can be controlled using a REST API. Basic controls were provided in OnTheAir Video 3.8, and these were extended in OnTheAir Video 4.

About port numbers

OnTheAir Video uses port 8081 for the REST API.

If you are using a "multi" version of OnTheAir Video, the port numbers will change:

• 8081 is for OnTheAir Video 1
• 8082 is for OnTheAir Video 2
• 8083 is for OnTheAir Video 3
• etc...

Retrieve the API from the application

Then the best way to get the most up to date documentation for the OnTheAir Video REST API is to start the OnTheAir Video application on a Mac, and then simply type in a browser on that Mac:

http://localhost:8081/api.html

This will return a page with all the API documentation. 

About Websockets

We have websockets in OnTheAir Video so you can be notified when something changes.

You should be able to open a websocket for timecode update about playback with this URL: ws://localhost:8081/playback

It is also important that, when you connect, you provide the correct supported protocols as we will only send messages to clients who support our protocols.

Below is the list of the protocols we support BUT it is also important that you connect to a specific endpoint. For instance, if you want updates on a specific playlist, you will need to open a websocket at: ws://127.0.0.1:8081/playlists/<playlist unique ID>

• "playback_update_v1"                                    // playback status is changing 
• "playlist_update_v1"                                        // a specific playlist changes 
• "playlists_management_v1"                            // playlists are being open/closed
• "playlist_items_start_times_update_v1"       // item start times inside a playlist 
• "live_sources_update_v1"                               // live sources change

Attached is a sample page so you can get started.