Skip to main content

Using Bitfocus Companion / Stream deck

LTN Global
Updated

About: For controlling LTN Schedule you can use a stream deck or alternatively the Bitfocus Companion app which emulates a stream deck interface including all its functionalities.

Not sure how to start?

→ Learn how to create an API user.

What you can do with it in Schedule

screen_shot_2022-12-23_at_09.53.10.png

Schedule provides an HTTP API to interact with the playout system. Additionally, you can use a stream deck app called Companion to also receive feedback from interactions and have access to them with a single touch of a button (or on a virtual surface).


This addition provides the ability to:

  • start playback/pushing
  • skip elements
  • start/stop breaking live
  • enable overlays
  • switch push targets
  • and more...

The easiest way to get started with our module is to browse the available presets, they contain all the available actions for Schedule in combination with the usual feedback that goes with them.

 

Screenshot_2022-12-23_at_17.13.56.png

Example: Using the stream deck to control schedule targets and getting live feedback on their status.

 

Before you start

Before you can start using the Companion / Stream deck you must create an API user in the Schedule user tab. You will need the credentials for the setup in the Companion.

 

How to set up the Companion

Companion-1.png

  1. Select LTN Schedule from the list of modules available by searching for "ltn".


    Companion-2.png
  2. Edit your new Connection and give it an appropriate label.
  3. Enter the URL of your instance (e.g.mySchedule01a.ltnschedule.com)
  4. Enter the credentials from the API user you created.
  5. Click Save and the connection should be established and show Connected & Authenticated

Companion-3.png

 

Available features:

Actions:

  • Toggle playback running, with optional start stamp (can be set to NOW)
  • Toggle publishing status
  • Toggle individual push targets status
  • Skip element
  • Trigger an ad break
  • A skipping strategy can be selected [schedule 9.0+, API version 1]
  • Start/stop breaking live [schedule 9.1+, API version 2]
  • Select a live stream for breaking live [schedule 9.2+, API version 3]
  • Ad breaks can be triggered for non-live stream elements [schedule 9.3+, API version 4]
  • Cancel an ad break [schedule 9.3+, API version 4]
  • Skip element on stopping breaking live [schedule 9.4+, API version 5]
  • Active breaking live can be replaced by another one while running [schedule 9.4+, API version 5]
  • Toggle PNG Overlay [schedule 9.4+, API version 5]
  • Toggle HTML5 Overlay [schedule 9.4+, API version 5]
  • Toggle hold of current playing element [schedule 9.4+, API version 5]
  • Insert a template [schedule 9.5+, API version 6]
  • Changing the destination / target URL and stream key [schedule 9.5+, API version 6]
  • Set the Output Volume [schedule 9.5+, API version 6]
  • Choose the trigger type (national/local) for Trigger an ad break [API version 6+]
  • Cancel bumper [schedule 9.9+, API version 7]
  • Resync system [schedule 9.9+, API version 7]
  • Jump to element [schedule 10+, API version 8]
  • Toggle output scaling [schedule 10+, API version 8]

Feedbacks:

  • Playback status
  • Publishing status
  • Individual targets status
  • Publish status
  • Skippable status (if a skip is possible or not)
  • Ad break status (can be triggered, can't, is running)
  • Breaking live status [schedule 9.1+, API version 2]
  • PNG Overlay status (on or off) [schedule 9.4+, API version 5]
  • HTML5 Overlay status (on or off) [schedule 9.4+, API version 5]
  • Hold status for current playing element [schedule 9.4+, API version 5]
  • Breaking live status for individual live streams. It allows to see if breaking live can switch to this live stream [schedule 9.4+, API version 5]
  • Template insertion status [schedule 9.5+, API version 6]
  • Next element status [schedule 9.5+, API version 6]
  • Receive thumbnails from the output. The system should create thumbnails (400x224) all 10 seconds locally and make them available for download via API [schedule 9.5+, API version 6]
  • Getting Playout Status of the current playing element (Type, Name, Description, Status, duration & remaining Time) [schedule 9.5+, API version 6]
  • Breaking live bumper status [schedule 9.9+, API version 7]
  • Redundant system status [schedule 9.9+, API version 7]
  • Element playing status (shows if an element is playing, by ID) [schedule 10+, API version 8]
  • Flexible playback status [schedule 10+, API version 8]
  • Output scaling status [schedule 10+, API version 8]

Presets:

  • Individual target toggle with background color for their status
  • Toggle playback with playback status
  • Toggle publish with current status
  • Trigger ad break
  • Breaking live toggle with status [schedule 9.1+, API version 2]
  • Cancel ad break [schedule 9.3+ (API version 4]
  • Toggle PNG Overlay with status [schedule 9.4+, API version 5]
  • Toggle HTML5 Overlay with status [schedule 9.4+, API version 5]
  • Toggle hold with status [schedule 9.4+, API version 5]
  • Individual breaking live preset for each live stream on the system [schedule 9.4+, API version 5]
  • Skip button shows the status of the upcoming element if it is a livestream/rerun [schedule 9.5+, API version 6]
  • A preset for current status timers [schedule 9.9+, API version 7]
  • Jumping to an element [schedule 10+, API version 8]
  • Output scaling [schedule 10+, API version 8]

Variables:

  • Current remaining time [schedule 9.9+, API version 7]
  • Total played time [schedule 9.9+, API version 7]
  • Total remaining time [schedule 9.9+, API version 7]
  • Total duration [schedule 9.9+, API version 7]
  • Ad remaining time [schedule 9.9+, API version 7]
  • ID of the current running element [schedule 10+, API version 8]
  • Index of the current running element [schedule 10+, API version 8]

How to continue?

→ Learn how to use the REST API

Related to

Related articles