• Products
  • Resellers
  • Support
  • Developer
  • Company
  • Media
  • Splice
  • Forum
Blackmagic Design logo
  • Back to Developer Page

Quick Search

Table of Contents

  • 1 Desktop Video SDK
  • 2 DeckLink API
  • 3 Common Data Types
    • 3.1 Basic Types
    • 3.2 Time Representation
    • 3.3 Display Modes
    • 3.4 Pixel Formats
    • 3.5 Field Dominance
    • 3.6 Frame Flags
    • 3.7 Video Input Flags
    • 3.8 Video Output Flags
    • 3.9 Output Frame Completion Results Flags
    • 3.10 Frame Preview Format
    • 3.11 Video IO Support
    • 3.12 Video Connection Modes
    • 3.13 Link Configuration
    • 3.14 Audio Sample Rates
    • 3.15 Audio Sample Types
    • 3.16 DeckLink Information ID
    • 3.17 DeckLink Attribute ID
    • 3.18 DeckLink Configuration ID
    • 3.19 Audio Output Stream Type
    • 3.20 Analog Video Flags
    • 3.21 Audio Connection Modes
    • 3.22 Audio Output Selection switch
    • 3.23 Output Conversion Modes
    • 3.24 Input Conversion Modes
    • 3.25 Video Input Format Changed Events
    • 3.26 Detected Video Input Format Flags
    • 3.27 Capture Pass Through Mode
    • 3.28 Display Mode Characteristics
    • 3.29 Video 3D packing format
    • 3.30 Timecode Format
    • 3.31 Timecode Flags
    • 3.32 Timecode BCD
    • 3.33 Deck Control Mode
    • 3.34 Deck Control Event
    • 3.35 Deck Control VTR Control States
    • 3.36 Deck Control Status Flags
    • 3.37 Deck Control Export Mode Ops Flags
    • 3.38 Deck Control error
    • 3.39 Genlock Reference Status
    • 3.40 Idle Video Output Operation
    • 3.41 Device Busy State
    • 3.42 DeckLink Device Notification
    • 3.43 Streaming Device Mode
    • 3.44 Streaming Device Encoding Frame Rates
    • 3.45 Streaming Device Encoding Support
    • 3.46 Streaming Device Codecs
    • 3.47 Streaming Device H264 Profile
    • 3.48 Streaming Device H264 Level
    • 3.49 Streaming Device H264 Entropy Coding
    • 3.50 Streaming Device Audio Codec
    • 3.51 Streaming Device Encoding Mode Properties
    • 3.52 Audio Formats
    • 3.53 Deck Control Connection
    • 3.54 Video Encoder Frame Coding Mode
    • 3.55 DeckLink Encoder Configuration ID
    • 3.56 Device Interface
    • 3.57 Packet Type
    • 3.58 DeckLink Status ID
    • 3.59 Video Status Flags
    • 3.60 Duplex Mode
    • 3.61 Frame Metadata ID
    • 3.62 DNxHR Levels
    • 3.63 Panel Type
    • 3.64 Ancillary Packet Format
    • 3.65 Colorspace
    • 3.66 HDMI Input EDID ID
    • 3.67 Dynamic Range
    • 3.68 Supported Video Mode Flags
    • 3.69 Profile Identifier
    • 3.70 HDMI Timecode Packing
    • 3.71 Internal Keying Ancillary Data Source
    • 3.72 Ethernet Link State
    • 3.73 Mezzanine Type
    • 3.74 Video Format Flags
    • 3.75 Buffer Access Requirements
    • 3.76 IP Flow ID
    • 3.77 IP Flow Direction
    • 3.78 IP Flow Type
    • 3.79 IP Flow Attribute ID
    • 3.80 IP Flow Status ID
    • 3.81 IP Flow Setting ID
    • 3.82 Audio Output XLR Delay Types
    • 3.83 Languages
    • 3.84 Audio Meter Type
  • Docs »
  • 3 Common Data Types »
  • 3.17 DeckLink Attribute ID
  • ← 3.16 DeckLink Information ID
  • 3.18 DeckLink Configuration ID →

3.17 DeckLink Attribute ID¶

enum BMDDeckLinkAttributeID¶

BMDDeckLinkAttributeID enumerates a set of attributes of a DeckLink device which may be queried (see IDeckLinkProfileAttributes interface for details).

Key

Description

Flags

BMDDeckLinkSupportsInternalKeying

enumerator BMDDeckLinkSupportsInternalKeying¶

True if internal keying is supported on this device.

BMDDeckLinkSupportsExternalKeying

enumerator BMDDeckLinkSupportsExternalKeying¶

True if external keying is supported on this device.

BMDDeckLinkSupportsInputFormatDetection

enumerator BMDDeckLinkSupportsInputFormatDetection¶

True if input format detection is supported on this device.

BMDDeckLinkHasReferenceInput

enumerator BMDDeckLinkHasReferenceInput¶

True if the DeckLink device has a genlock reference source input connector.

BMDDeckLinkHasSerialPort

enumerator BMDDeckLinkHasSerialPort¶

True if device has a serial port.

BMDDeckLinkHasAnalogVideoOutputGain

enumerator BMDDeckLinkHasAnalogVideoOutputGain¶

True if analog video output gain adjustment is supported on this device.

BMDDeckLinkCanOnlyAdjustOverallVideoOutputGain

enumerator BMDDeckLinkCanOnlyAdjustOverallVideoOutputGain¶

True if only the overall video output gain can be adjusted. In this case, only the luma gain can be accessed with the IDeckLinkConfiguration interface, and it controls all three gains (luma, chroma blue and chroma red).

BMDDeckLinkHasVideoInputAntiAliasingFilter

enumerator BMDDeckLinkHasVideoInputAntiAliasingFilter¶

True if there is an antialising filter on the analog video input of this device.

BMDDeckLinkHasBypass

enumerator BMDDeckLinkHasBypass¶

True if this device has loop-through bypass function.

BMDDeckLinkSupportsClockTimingAdjustment

enumerator BMDDeckLinkSupportsClockTimingAdjustment¶

True if this device supports clock timing adjustment (see bmdDeckLinkConfigClockTimingAdjustment).

BMDDeckLinkSupportsFullFrameReferenceInputTimingOffset

enumerator BMDDeckLinkSupportsFullFrameReferenceInputTimingOffset¶

True if the DeckLink device supports genlock offset adjustment wider than +/-511 pixels (see bmdDeckLinkConfigReferenceInputTimingOffset for more information).

BMDDeckLinkSupportsSMPTELevelAOutput

enumerator BMDDeckLinkSupportsSMPTELevelAOutput¶

True if SMPTE Level A output is supported on this device.

BMDDeckLinkSupportsAutoSwitchingPPsFOnInput

enumerator BMDDeckLinkSupportsAutoSwitchingPPsFOnInput¶

True if the DeckLink device supports PsF mode detection on capture.

BMDDeckLinkSupportsDualLinkSDI

enumerator BMDDeckLinkSupportsDualLinkSDI¶

True if SDI dual-link is supported on this device.

BMDDeckLinkSupportsQuadLinkSDI

enumerator BMDDeckLinkSupportsQuadLinkSDI¶

True if SDI quad-link is supported on this device.

BMDDeckLinkSupportsIdleOutput

enumerator BMDDeckLinkSupportsIdleOutput¶

True if this device supports idle output configuration. (see BMDIdleVideoOutputOperation for idle output options).

BMDDeckLinkVANCRequires10BitYUVVideoFrames

enumerator BMDDeckLinkVANCRequires10BitYUVVideoFrames¶

True if the device supports VANC only when the active picture is also 10-bit YUV. See BMDAncillaryPacketFormat for more information.

BMDDeckLinkHasLTCTimecodeInput

enumerator BMDDeckLinkHasLTCTimecodeInput¶

True if this device has a dedicated LTC input.

BMDDeckLinkSupportsHDRMetadata

enumerator BMDDeckLinkSupportsHDRMetadata¶

True if the device supports transport of HDR metadata.

BMDDeckLinkSupportsColorspaceMetadata

enumerator BMDDeckLinkSupportsColorspaceMetadata¶

True if the device supports transport of Colorspace metadata. See bmdDeckLinkFrameMetadataColorspace and BMDColorspace for more information.

BMDDeckLinkSupportsHDMITimecode

enumerator BMDDeckLinkSupportsHDMITimecode¶

True if HDMI LTC timecode is supported by the device.

BMDDeckLinkSupportsHighFrameRateTimecode

enumerator BMDDeckLinkSupportsHighFrameRateTimecode¶

True if High Frame Rate Timecode (HFRTC) is supported by the device.

BMDDeckLinkSupportsSynchronizeToCaptureGroup

enumerator BMDDeckLinkSupportsSynchronizeToCaptureGroup¶

True if the device can be grouped with other input devices for synchronized capture.

BMDDeckLinkSupportsSynchronizeToPlaybackGroup

enumerator BMDDeckLinkSupportsSynchronizeToPlaybackGroup¶

True if the device can be grouped with other output devices for synchronized playback.

BMDDeckLinkHasMonitorOut

enumerator BMDDeckLinkHasMonitorOut¶

True if the device has Monitor Out capability.

BMDDeckLinkSupportsExtendedDesktop

enumerator BMDDeckLinkSupportsExtendedDesktop¶

True if the device supports extended desktop.

Integers

BMDDeckLinkMaximumAudioChannels

enumerator BMDDeckLinkMaximumAudioChannels¶

The maximum number of audio channels embedded on digital connections supported by this device.

BMDDeckLinkMaximumHDMIAudioChannels

enumerator BMDDeckLinkMaximumHDMIAudioChannels¶

The maximum number of audio channels embedded on HDMI supported by this device.

BMDDeckLinkMaximumAnalogAudioInputChannels

enumerator BMDDeckLinkMaximumAnalogAudioInputChannels¶

The maximum number of input analog audio channels supported by this device.

BMDDeckLinkMaximumAnalogAudioOutputChannels

enumerator BMDDeckLinkMaximumAnalogAudioOutputChannels¶

The maximum number of output analog audio channels supported by this device.

BMDDeckLinkNumberOfSubDevices

enumerator BMDDeckLinkNumberOfSubDevices¶

The number of sub-devices supported by the DeckLink hardware.

BMDDeckLinkSubDeviceIndex

enumerator BMDDeckLinkSubDeviceIndex¶

The index of the sub-device on a DeckLink hardware device, starting from zero.

BMDDeckLinkPersistentID

enumerator BMDDeckLinkPersistentID¶

A device specific 32 bit unique identifier. It is stable even when the device is plugged in a different connector, across reboots, and when plugged into different computers.

BMDDeckLinkDeviceGroupID

enumerator BMDDeckLinkDeviceGroupID¶

A 32 bit identifier used to group sub-devices belonging to the same DeckLink hardware device. Supported if the sub-device supports BMDDeckLinkPersistentID.

BMDDeckLinkTopologicalID

enumerator BMDDeckLinkTopologicalID¶

A 32-bit identifier based on how the OS enumerates the DeckLink device. It will remain stable only so long as no devices are added/removed from the system. It is not stable in other machines nor if the OS changes the order in which devices are enumerated.

BMDDeckLinkVideoOutputConnections

enumerator BMDDeckLinkVideoOutputConnections¶

The video output connections supported by the hardware (see BMDVideoConnection for more details).

BMDDeckLinkVideoInputConnections

enumerator BMDDeckLinkVideoInputConnections¶

The video input connections supported by the hardware (see BMDVideoConnection for more details).

BMDDeckLinkAudioOutputConnections

enumerator BMDDeckLinkAudioOutputConnections¶

The audio output connections supported by the hardware (see BMDAudioConnection for more details). Devices with one or more types of analog connection will have the bmdAudioConnectionAnalog flag set.

Devices with individually selectable XLR/RCA connectors will additionally have the bmdAudioConnectionAnalogXLR and bmdAudioConnectionAnalogRCA flags set.

BMDDeckLinkAudioInputConnections

enumerator BMDDeckLinkAudioInputConnections¶

The audio input connections supported by the hardware (see BMDAudioConnection for more details).

BMDDeckLinkVideoIOSupport

enumerator BMDDeckLinkVideoIOSupport¶

The capture and/or playback capability of the device. (See BMDVideoIOSupport for more information)

BMDDeckLinkDeckControlConnections

enumerator BMDDeckLinkDeckControlConnections¶

The deck control connections supported by the hardware (see BMDDeckControlConnection for more information).

BMDDeckLinkDeviceInterface

enumerator BMDDeckLinkDeviceInterface¶

The active device interface (see BMDDeviceInterface for more information)

BMDDeckLinkAudioInputRCAChannelCount

enumerator BMDDeckLinkAudioInputRCAChannelCount¶

Number of input audio RCA channels supported by this device.

BMDDeckLinkAudioInputXLRChannelCount

enumerator BMDDeckLinkAudioInputXLRChannelCount¶

Number of input audio XLR channels supported by this device.

BMDDeckLinkAudioOutputRCAChannelCount

enumerator BMDDeckLinkAudioOutputRCAChannelCount¶

Number of output audio RCA channels supported by this device.

BMDDeckLinkAudioOutputXLRChannelCount

enumerator BMDDeckLinkAudioOutputXLRChannelCount¶

Number of output audio XLR channels supported by this device.

BMDDeckLinkProfileID

enumerator BMDDeckLinkProfileID¶

The Profile ID for the currently active IDeckLinkProfile. See BMDProfileID for more information

BMDDeckLinkDuplex

enumerator BMDDeckLinkDuplex¶

The duplex mode for the corresponding profile. See BMDDuplexMode for more information

BMDDeckLinkMinimumPrerollFrames

enumerator BMDDeckLinkMinimumPrerollFrames¶

The minimum number of preroll video frames required by the device for scheduled playback

BMDDeckLinkSupportedDynamicRange

enumerator BMDDeckLinkSupportedDynamicRange¶

The high dynamic range transfer functions supported by this device. See BMDDynamicRange for more information.

BMDDeckLinkMezzanineType

enumerator BMDDeckLinkMezzanineType¶

The mezzanine board currently attached to this device. See BMDMezzanineType for more information.

BMDDeckLinkXLRDelayMsMaximum

enumerator BMDDeckLinkXLRDelayMsMaximum¶

The maximum time-based XLR output delay in milliseconds. See BMDAudioOutputXLRDelayType for details.

BMDDeckLinkXLRDelayFramesMaximum

enumerator BMDDeckLinkXLRDelayFramesMaximum¶

The maximum frame-based XLR output delay. See BMDAudioOutputXLRDelayType for details.

Floats

BMDDeckLinkVideoInputGainMinimum

enumerator BMDDeckLinkVideoInputGainMinimum¶

The minimum video input gain in dB for this device.

BMDDeckLinkVideoInputGainMaximum

enumerator BMDDeckLinkVideoInputGainMaximum¶

The maximum video input gain in dB for this device.

BMDDeckLinkVideoOutputGainMinimum

enumerator BMDDeckLinkVideoOutputGainMinimum¶

The minimum video output gain in dB for this device.

BMDDeckLinkVideoOutputGainMaximum

enumerator BMDDeckLinkVideoOutputGainMaximum¶

The maximum video output gain in dB for this device.

BMDDeckLinkMicrophoneInputGainMinimum

enumerator BMDDeckLinkMicrophoneInputGainMinimum¶

The minimum microphone input gain in dB for this device.

BMDDeckLinkMicrophoneInputGainMaximum

enumerator BMDDeckLinkMicrophoneInputGainMaximum¶

The maximum microphone input gain in dB for this device.

Strings

BMDDeckLinkSerialPortDeviceName

enumerator BMDDeckLinkSerialPortDeviceName¶

The operating system name of the RS422 serial port on this device.

This allocated string must be freed by the caller when no longer required.

BMDDeckLinkVendorName

enumerator BMDDeckLinkVendorName¶

Hardware vendor name. Returned as a static string which must not be freed by the caller.

BMDDeckLinkDisplayName

enumerator BMDDeckLinkDisplayName¶

The device’s display name. See IDeckLink::GetDisplayName().

BMDDeckLinkModelName

enumerator BMDDeckLinkModelName¶

Hardware Model Name. See IDeckLink::GetModelName().

BMDDeckLinkDeviceHandle

enumerator BMDDeckLinkDeviceHandle¶

String representing an unique identifier for the device.

BMDDeckLinkEthernetMACAddress

enumerator BMDDeckLinkEthernetMACAddress¶

For devices with Ethernet, the local MAC address.
  • ← 3.16 DeckLink Information ID
  • 3.18 DeckLink Configuration ID →
Desktop Video 15.0 SDK
© Copyright 2003-2025 Blackmagic Design. All rights reserved.