DeckLinkInputSettings interface

Signature:

export interface DeckLinkInputSettings extends InputSettings<DeckLinkInputNode>, StreamStatisticsMixin

Extends: InputSettings<DeckLinkInputNode>, StreamStatisticsMixin

Properties

Property Type Description

Property	Type	Description
ancillary?	DeckLinkAncillaryKind	(Optional) Which ancillary format (if any) to extract from SDI VANC. Default: "none". * "scte104" — SCTE-104 splice commands (DID=0x41 SDID=0x07), surfaced as SCTE-35 sections on the ancillary output pin.
captureCea?	boolean	(Optional) Enable CEA-608/708 extraction from SDI VANC (SMPTE 334 CDP). Default: false.
captureScte104?	boolean	(Optional) Enable SCTE-104 splice command extraction from SDI VANC. Default: false.
captureTeletext?	boolean	(Optional) Enable OP47 teletext extraction from SDI VANC. Default: false.
captureTimecode?	boolean	(Optional) Enable RP 188 VITC timecode extraction from SDI VANC. Default: false. When enabled, timecodes are set as `sourceTime` on captured frames.
cardIndex	number	Which card to use
channelLayout	ChannelLayout	The audio channel layout for the input
cpuList?	number[]	(Optional)
displayModeId?	DeckLinkDisplayModeId	(Optional) Typically left undefined, but can be used to force capture for a specific DeckLinkDisplayModeId. If the source is not currently in this mode, then no capture will occur.
pixelFormat?	DeckLinkPixelFormat	(Optional)
profileId?	DeckLinkProfileId	(Optional) Hardware profile to activate on the card before starting capture. Only relevant for cards that support multiple profiles (e.g. DeckLink Duo 2, Quad 2). If the card is already in the requested profile, this is a no-op. If omitted, the card’s current profile is used as-is.
subtitles?	DeckLinkSubtitleKind	(Optional) Which subtitle format (if any) to extract from SDI VANC. Default: "none". * "teletext" — OP47 teletext (DID=0x43 SDID=0x02) * "cta708" — CEA-708 in SMPTE 334 CDP (DID=0x61 SDID=0x01) * "cta608" — CEA-608 in SMPTE 334 CDP (DID=0x61 SDID=0x01)
videoConnection	DeckLinkVideoConnection	SDI or HDMI capture

ancillary?

DeckLinkAncillaryKind

(Optional) Which ancillary format (if any) to extract from SDI VANC. Default: "none". * "scte104" — SCTE-104 splice commands (DID=0x41 SDID=0x07), surfaced as SCTE-35 sections on the ancillary output pin.

captureCea?

boolean

(Optional) Enable CEA-608/708 extraction from SDI VANC (SMPTE 334 CDP). Default: false.

captureScte104?

boolean

(Optional) Enable SCTE-104 splice command extraction from SDI VANC. Default: false.

captureTeletext?

boolean

(Optional) Enable OP47 teletext extraction from SDI VANC. Default: false.

captureTimecode?

boolean

(Optional) Enable RP 188 VITC timecode extraction from SDI VANC. Default: false. When enabled, timecodes are set as sourceTime on captured frames.

cardIndex

number

Which card to use

channelLayout

ChannelLayout

The audio channel layout for the input

cpuList?

number[]

(Optional)

displayModeId?

DeckLinkDisplayModeId

(Optional) Typically left undefined, but can be used to force capture for a specific DeckLinkDisplayModeId. If the source is not currently in this mode, then no capture will occur.

(Optional)

(Optional) Hardware profile to activate on the card before starting capture. Only relevant for cards that support multiple profiles (e.g. DeckLink Duo 2, Quad 2). If the card is already in the requested profile, this is a no-op. If omitted, the card’s current profile is used as-is.

subtitles?

DeckLinkSubtitleKind

(Optional) Which subtitle format (if any) to extract from SDI VANC. Default: "none". * "teletext" — OP47 teletext (DID=0x43 SDID=0x02) * "cta708" — CEA-708 in SMPTE 334 CDP (DID=0x61 SDID=0x01) * "cta608" — CEA-608 in SMPTE 334 CDP (DID=0x61 SDID=0x01)

videoConnection

DeckLinkVideoConnection

SDI or HDMI capture