Articles in this section

StreamDeck ad marker insertion control - Bitfocus Companion Module

  • Updated
Follow

Disclaimers

  • Bitfocus Companion installation and setup is required prior to following the below instructions, users are responsible for doing so: https://user.bitfocus.io/product/companion 

  • The Companion Module and Sample Configuration are provided as is. No warranties or support are provided or implied.

  • Some features require additional licenses. For example, a data license is required for SCTE-35 commands. This code does not provide such licenses.

  • Please contact Videon Customer Service for license details.

Installation

Step 1: Import the Module

  • Download liveedge-max-v1.1.1.tgz to a local directory.

  • Log into the Companion GUI.

  • Go to Modules.

  • Click Import module package.

  • Navigate to the folder with liveedge-max-v1.1.1.tgz and load the module.

c613301c-b785-4944-9b65-02534c55f514.png
e128cd22-98aa-4ff3-bc49-bf417cf6e165.png
96e15841-f4d0-4e26-8142-fc5d560cb2a4.png

Step 2: Import Sample Configuration

  1. Copy liveedge-sample.companionconfig to a local folder.

  2. Go to Import / Export → Import → Select liveedge-sample.companionconfig → Open.

  3. Import:

    • Buttons

    • Triggers

    • Custom Variables

    • Expression Variables

    • Surfaces

  4. Click Import Selected Components or Full Reset & Import.

Configuration

Connection

  1. Go to Connections.

  2. Update the device details:

    • IP Address → Local address of the LiveEdge Device

    • Polling Rate → Default: 10 seconds

  3. Save. You should see a green check mark.

  4. You should also see an HTTP connection (used for the thumbnail image).

Buttons & Controls

  1. Go to Buttons. You should see something like the this:6f040bbc-8403-4c2e-95c4-9c597ee05c62.png

  2. Update SCTE Command Buttons:

    • Click an SCTE-35 Cue Out button.

    • Select the correct Input Channel ID.

    • Repeat for other SCTE buttons.

Note:

  • SCTE-35 commands require a Data Encoder to be created.

  • A TS output (Unicast, Multicast, Zixi, or SRT) must be enabled with the SCTE Data Encoder attached.

  • This module does not perform error checking.

Go to: Streamdeck Emulator: http://127.0.0.1:8000/emulator/p6A_EP_vWq2rWfcZH9Izq

Streamdeck Emulator

Access via: http://127.0.0.1:8000/emulator/p6A_EP_vWq2rWfcZH9Izq

6c72d23a-fd81-437c-aaab-e55b31047a0e.png

Button Functions

  • Input – SDI Button: Toggles input

    • Node: SDI → HDMI → SDI

    • Max Input 0: SDI → TPG → SDI

    • Max Input 1: SDI → HDMI → TPG → SDI

  • SCTE-35 Commands:

    • Cue Out → Inserts Opportunity Start

    • Cue In → Inserts Opportunity End

    • Cancel → Cancels all active SCTE commands

    • Splice 15, 30, 60 → Inserts splices of 15s, 30s, or 60s

  • Outputs:

    • Enable All Outputs → Turns on all outputs (may not succeed on all)

    • Disable All Outputs → Turns off all outputs

    • Toggle Button → Status updates on polling interval

    • All Outputs Off → Enables all outputs and updates state

    • Mixed State → Some outputs on/off (indicates error or mixed config)

    • All Outputs On → Turns all outputs off

Known Issues

  • Module Feedback: Image from Variable is not supported

  • Module Preset: Monitoring presets not functional

  • Module Actions: Toggle PNGA Graphics not functional


 

Related articles