Controlling The BR Encoder Using Commands In Myriad Playout

Introduction

The BR Encoder allows you to use a HTTP GET method to start and stop streams as well as update Now Playing information. This also means you can use the Commands feature in Myriad 5 Playout to directly start and stop your Encoder streams and because Commands (in Myriad) can be a type of Media Item, that means you can start and stop your streams from the Media Wall, the Log or even from clicking on a Favourite!

Start / Stop / Update Now Playing Using HTTP Get Method

You can use the HTTP Get method to:

• Start an Encoder
• Stop an Encoder
• Update the Now Playing information for an Encoder

The HTTP Get method is available in a wide range of applications as well from standard web browsers so you can control your BR Encoder from a number of 3^rd party applications or devices.

The base URL for methods is:

http://localhost:6999/BrEncoder/v1/api/Encoder/{ExternalReference}/

Where {ExternalReference} is the string that is set in the Encoder settings window. This reference can be shared across multiple encoders in which case calls will apply to all encoders that share the same External Reference. The ‘localhost:6999’ can be replaced with ‘IPaddress:6999’ where the BR Encoder Service is on a different PC to the one executing the HTTP Get. The port is fixed at 6999 and cannot be altered.

Available GET Methods:

Starting the encoder:

http://localhost:6999/BrEncoder/v1/api/Encoder/{ExternalReference}/Start

Stopping the encoder:

http://localhost:6999/BrEncoder/v1/api/Encoder/{ExternalReference}/Stop

Updating the Now Playing information:

http://localhost:6999/BrEncoder/v1/api/Encoder/{ExternalReference}/UpdateNowPlaying?artist={artistName}&title={itemtitle} 

In the example we have been using, the External Reference for the ‘Hot FM’ Encoder is ‘hot’ so the HTTP GET call to start that Encoder streaming would be:

• http://localhost:6999/BrEncoder/v1/api/Encoder/hot/Start

Stop would be:

• http://localhost:6999/BrEncoder/v1/api/Encoder/hot/Stop

And update Now Playing info would be:

• http://localhost:6999/BrEncoder/v1/api/Encoder/hot/UpdateNowPlaying?artist=Kylie+Mibogue&title=Spinning+Around

You can copy these strings directly into a web browser to control your BR Encoder. Give it a try!

Starting & stopping encoders using commands in Myriad Playout v5

You can also use HTTP GET calls from within Commands on the Myriad Playout Media Wall. This means you can create Commands in Myriad to start and stop your Encoder streams or even update Now Playing Information.

To create a Command in Myriad Playout to start an Encoder stream, follow these steps:

1. Highlight the Media Item you want to use for your Command.
2. Click on the Edit button to open the Edit Window.
3. Give it a suitable Title
4. In the Editor Tab, click on the Command button to set the Media Item Type to Command.

5. Carefully type in the following command into the Command Script area: 

Remote.HttpGet("http://localhost:6999/BrEncoder/v1/api/Encoder/hot/Start")

Where ‘hot’ is replaced with the External Reference you are using for your Encoder.

6. Save the Media Item and it is now ready for use.

 To create a Media Item that Stops the Encoder stream, follow the same steps but use the Command Script:

Remote.HttpGet("http://localhost:6999/BrEncoder/v1/api/Encoder/hot/Stop")

And finally, to create a Command Media Item that updates ‘Now Playing Info us the Command Script:

Remote.HttpGet("http://localhost:6999/BrEncoder/v1/api/Encoder/hot/UpdateNowPlaying?artist=Liam+Burke&title=All+Hits+Breakfast")

Remember to replace the ‘hot’ with the External Reference you are using on your Encoder.

Please note that this extract was taken from the BR Encoder Quick Guide which you can view in full here - https://irp-cdn.multiscreensite.com/3bcc3595/files/uploaded/Broadcast%20Radio%20Encoder%20Quick%20Guide%20v1.1.pdf

Attachments (3)

mceclip0.png
22.9 KB

mceclip2.png
8.98 KB

mceclip3.png
19.6 KB