Skip to main content

Using REST API

LTN Global
Updated

About: LTN Schedule offers a REST API that allows users to integrate the platform with other systems and applications, and automate tasks and processes. The REST API uses HTTP GET methods to perform operations on the various resources in LTN Schedule, such as playlist elements, video sequences, and destinations.

Not sure how to start?

→ Learn how to create an API user.

Using the REST API

To use the REST API in LTN Schedule, you must first create an API user in the Schedule user section. 

Once you have obtained your API user credentials, you can use them to access the LTN Schedule Swagger UI under the following URL: 

http://your-server-name.ltnschedule.com/api/v1

 

In the Swagger UI, you see an overview of the available APIs which provide detailed documentation upon clicking.

Swagger_UI.png

The REST API in LTN Schedule supports HTTP Basic Authentication.

By using the REST API in LTN Schedule, you can integrate the platform with other systems and applications and automate tasks and processes.

 

Available features:

Actions

  • Playback Control
    • Toggle playback with optional start timestamp
    • Hold current playing element [v9.4+, API version 5]
    • Skip element
    • Skip element on breaking live stop [v9.4+, API version 5]
    • Insert template [v9.5+, API version 6]
    • Jump to specific element [v10+, API version 8]
    • Cancel bumper [v9.9+, API version 7]
    • Resync system [v9.9+, API version 7]
  • Publishing Management
    • Toggle publishing status
    • Toggle individual push targets
    • Change destination/target URL and stream key [v9.5+, API version 6]
    • Toggle output scaling [v10+, API version 8]
    • Set output volume [v9.5+, API version 6]
  • Live Features
    • Start/stop breaking live [v9.1+, API version 2]
    • Select live stream for breaking live [v9.2+, API version 3]
    • Replace active breaking live while running [v9.4+, API version 5]
  • Ad Management
    • Trigger ad break (with trigger type option: national/local) [v9.5+, API version 6]
    • Select skipping strategy [v9.0+, API version 1]
    • Trigger ad breaks for non-live stream elements [v9.3+, API version 4]
    • Cancel ad break [v9.3+, API version 4]
  • Overlay Controls
    • Toggle PNG Overlay [v9.4+, API version 5]
    • Toggle HTML5 Overlay [v9.4+, API version 5]

Feedbacks

  • Stream Status
    • Playback status
    • Publishing status
    • Individual targets status
    • Publish status
    • Element playing status (by ID) [v10+, API version 8]
    • Flexible playback status [v10+, API version 8]
    • Redundant system status [v9.9+, API version 7]
    • Output scaling status [v10+, API version 8]
  • Content Information
    • Skippable status
    • Next element status [v9.5+, API version 6]
    • Current playout details (type, name, description, status, duration, remaining time) [v9.5+, API version 6]
    • Breaking live status [v9.1+, API version 2]
    • Breaking live status for individual streams [v9.4+, API version 5]
    • Breaking live bumper status [v9.9+, API version 7]
  • Overlay Status
    • PNG Overlay status [v9.4+, API version 5]
    • HTML5 Overlay status [v9.4+, API version 5]
    • Hold status for current element [v9.4+, API version 5]
  • Additional Information
    • Ad break status
    • Template insertion status [v9.5+, API version 6]
    • Output thumbnails (400x224) every 10 seconds [v9.5+, API version 6]

Presets

  • Stream Controls
    • Individual target toggle with status background color
    • Toggle playback with status
    • Toggle publish with status
    • Jump to element [v10+, API version 8]
    • Output scaling [v10+, API version 8]
  • Content Management
    • Trigger ad break
    • Cancel ad break [v9.3+, API version 4]
    • Breaking live toggle with status [v9.1+, API version 2]
    • Individual breaking live preset per stream [v9.4+, API version 5]
    • Skip button showing upcoming element status [v9.5+, API version 6]
    • Current status timers [v9.9+, API version 7]
  • Overlay Presets
    • Toggle PNG Overlay with status [v9.4+, API version 5]
    • Toggle HTML5 Overlay with status [v9.4+, API version 5]
    • Toggle hold with status [v9.4+, API version 5]

Variables

  • Current remaining time [v9.9+, API version 7]
  • Total played time [v9.9+, API version 7]
  • Total remaining time [v9.9+, API version 7]
  • Total duration [v9.9+, API version 7]
  • Ad remaining time [v9.9+, API version 7]
  • ID of current running element [v10+, API version 8]
  • Index of current running element [v10+, API version 8]

How to continue?

→ Learn how to use the Bitfocus Companion / Stream deck

Related to

Related articles