DeckLink

An input type that allows consuming streams from Blackmagic DeckLink cards.

To use DeckLink input you must register it first. You can do it by sending a request like this:

Example request

POST: /api/input/:input_id/register
Content-Type: application/json

{
  "type": "decklink",
  "display_name": "DeckLink Quad HDMI Recorder (3)"
}

See HTTP Routes documentation to learn more about managing inputs.

type DeckLink = {
  subdevice_index?: u32;
  display_name?: string;
  persistent_id?: string;
  enable_audio?: bool;
  required?: bool;
}

Capture streams from devices connected to Blackmagic DeckLink card.

subdevice_index - Single DeckLink device can consist of multiple sub-devices. This field defines index of sub-device that should be used.

The input device is selected based on fields subdevice_index, persistent_id AND display_name. All of them need to match the device if they are specified. If nothing is matched, the error response will list available devices.
display_name - Select sub-device to use based on the display name. This is the value you see in e.g. Blackmagic Media Express app. like "DeckLink Quad HDMI Recorder (3)"

The input device is selected based on fields subdevice_index, persistent_id AND display_name. All of them need to match the device if they are specified. If nothing is matched, the error response will list available devices.
persistent_id - Persistent ID of a device represented by 32-bit hex number. Each DeckLink sub-device has a separate id.

The input device is selected based on fields subdevice_index, persistent_id AND display_name. All of them need to match the device if they are specified. If nothing is matched, the error response will list available devices.
enable_audio - (default=true) Enable audio support.
required - (default=false) If input is required and frames are not processed on time, then LiveCompositor will delay producing output frames.

DeckLink​