• 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
    • 3.85 Ancillary Data Space
    • 3.86 DeckLink Statistic ID
    • 3.87 NMOS Registration Status
  • Docs »
  • 3 Common Data Types »
  • 3.58 DeckLink Status ID
  • ← 3.57 Packet Type
  • 3.59 Video Status Flags →

3.58 DeckLink Status ID¶

enum BMDDeckLinkStatusID¶

BMDDeckLinkStatusID enumerates the set of status information for a DeckLink device which may be queried (see the IDeckLinkStatus interface for details).

Key

Description

Integers / Interfaces

bmdDeckLinkStatusDetectedVideoInputMode

enumerator bmdDeckLinkStatusDetectedVideoInputMode¶

The detected video input mode (BMDDisplayMode for GetInt or IDeckLinkDisplayMode for GetInterface), available on devices which support input format detection.

bmdDeckLinkStatusCurrentVideoInputMode

enumerator bmdDeckLinkStatusCurrentVideoInputMode¶

The currently enabled video input mode (BMDDisplayMode for GetInt or IDeckLinkDisplayMode for GetInterface).

bmdDeckLinkStatusCurrentVideoOutputMode

enumerator bmdDeckLinkStatusCurrentVideoOutputMode¶

The currently enabled video output mode (BMDDisplayMode for GetInt or IDeckLinkDisplayMode for GetInterface).

bmdDeckLinkStatusHDMIOutputActualMode

enumerator bmdDeckLinkStatusHDMIOutputActualMode¶

The actual HDMI output mode (BMDDisplayMode for GetInt or IDeckLinkDisplayMode for GetInterface).

HDMI output can drop down to lower modes such as when dropping from FRL to lower FRL rates or TMDS protocol when errors are encountered, this value indicates the actual mode being transmitted.

Integers

bmdDeckLinkStatusDetectedVideoInputFormatFlags

enumerator bmdDeckLinkStatusDetectedVideoInputFormatFlags¶

The detected video input format flags (BMDDetectedVideoInputFormatFlags), available on devices which support input format detection.

bmdDeckLinkStatusDetectedVideoInputFieldDominance

enumerator bmdDeckLinkStatusDetectedVideoInputFieldDominance¶

The field dominance of the detected video input mode (BMDFieldDominance).

bmdDeckLinkStatusDetectedVideoInputColorspace

enumerator bmdDeckLinkStatusDetectedVideoInputColorspace¶

The colorspace of the detected video input (BMDColorspace).

bmdDeckLinkStatusDetectedVideoInputDynamicRange

enumerator bmdDeckLinkStatusDetectedVideoInputDynamicRange¶

The dynamic range of the detected video input (BMDDynamicRange).

bmdDeckLinkStatusDetectedSDILinkConfiguration

enumerator bmdDeckLinkStatusDetectedSDILinkConfiguration¶

The SDI video link configuration of the detected video input (BMDLinkConfiguration).

bmdDeckLinkStatusCurrentVideoInputPixelFormat

enumerator bmdDeckLinkStatusCurrentVideoInputPixelFormat¶

The currently enabled video input pixel format (BMDPixelFormat).

bmdDeckLinkStatusCurrentVideoInputFlags

enumerator bmdDeckLinkStatusCurrentVideoInputFlags¶

The currently enabled video input flags (BMDDeckLinkVideoStatusFlags)

bmdDeckLinkStatusCurrentVideoOutputFlags

enumerator bmdDeckLinkStatusCurrentVideoOutputFlags¶

The currently enabled video output flags (BMDDeckLinkVideoStatusFlags).

bmdDeckLinkStatusPCIExpressLinkWidth

enumerator bmdDeckLinkStatusPCIExpressLinkWidth¶

PCIe link width, x1, x4, etc.

bmdDeckLinkStatusPCIExpressLinkSpeed

enumerator bmdDeckLinkStatusPCIExpressLinkSpeed¶

PCIe link speed, Gen. 1, Gen. 2, etc.

bmdDeckLinkStatusLastVideoOutputPixelFormat

enumerator bmdDeckLinkStatusLastVideoOutputPixelFormat¶

The last video output pixel format (BMDPixelFormat).

bmdDeckLinkStatusReferenceSignalMode

enumerator bmdDeckLinkStatusReferenceSignalMode¶

The detected reference input mode (BMDDisplayMode), available on devices which support reference input format detection.

bmdDeckLinkStatusReferenceSignalFlags

enumerator bmdDeckLinkStatusReferenceSignalFlags¶

The detected reference input flags (BMDDeckLinkVideoStatusFlags), available on devices which support reference input format detection.

bmdDeckLinkStatusBusy

enumerator bmdDeckLinkStatusBusy¶

The current busy state of the device. (See BMDDeviceBusyState for more information).

bmdDeckLinkStatusInterchangeablePanelType

enumerator bmdDeckLinkStatusInterchangeablePanelType¶

The interchangeable panel installed (BMDPanelType).

bmdDeckLinkStatusHDMIOutputActualFormatFlags

enumerator bmdDeckLinkStatusHDMIOutputActualFormatFlags¶

Format flags representing the actual HDMI output (BMDFormatFlags).

HDMI output can change to other formats such as when dropping from FRL to lower FRL rates or TMDS protocol when errors are encountered, this value indicates the actual format being transmitted.

bmdDeckLinkStatusHDMIOutputFRLRate

enumerator bmdDeckLinkStatusHDMIOutputFRLRate¶

The output FRL rate or 0 for TMDS.

bmdDeckLinkStatusHDMIInputFRLRate

enumerator bmdDeckLinkStatusHDMIInputFRLRate¶

The input FRL rate or 0 for TMDS.

bmdDeckLinkStatusEthernetManualNMOSRegistry

enumerator bmdDeckLinkStatusEthernetManualNMOSRegistry¶

The current manual NMOS registry state (BMDEthernetNMOSRegistryState). If manual NMOS registry is not enabled, GetInt will return S_FALSE.

bmdDeckLinkStatusHDMIOutputTMDSLineRate

enumerator bmdDeckLinkStatusHDMIOutputTMDSLineRate¶

The line rate of HDMI output (MHz). Valid when using TMDS protocol only.

Floats

bmdDeckLinkStatusSinkSupportsDolbyVision

enumerator bmdDeckLinkStatusSinkSupportsDolbyVision¶

Reports the Dolby Vision content mapping version supported by the sink

Flags

bmdDeckLinkStatusVideoInputSignalLocked

enumerator bmdDeckLinkStatusVideoInputSignalLocked¶

True if the video input signal is locked.

bmdDeckLinkStatusAncillaryInputSignalLocked

enumerator bmdDeckLinkStatusAncillaryInputSignalLocked¶

True if the ancillary input signal is locked. This is co-incident with the video signal lock, except for Ethernet where ancillary data is carried independently.

bmdDeckLinkStatusReferenceSignalLocked

enumerator bmdDeckLinkStatusReferenceSignalLocked¶

True if the reference input signal is locked.

Strings

bmdDeckLinkStatusEthernetPTPGrandmasterIdentity

enumerator bmdDeckLinkStatusEthernetPTPGrandmasterIdentity¶

For devices with Ethernet, the current negotiated PTP grandmaster clock identity. If no PTP lock then this returns S_FALSE and an empty string.

bmdDeckLinkStatusEthernetAudioInputChannelOrder

enumerator bmdDeckLinkStatusEthernetAudioInputChannelOrder¶

For devices with Ethernet, the input audio SDP channel-order as per ST 2110-30.

bmdDeckLinkStatusEthernetCurrentNMOSRegistry

enumerator bmdDeckLinkStatusEthernetCurrentNMOSRegistry¶

For devices with Ethernet, the current NMOS Registry.

Bytes

bmdDeckLinkStatusReceivedEDID

enumerator bmdDeckLinkStatusReceivedEDID¶

The received EDID of a connected HDMI sink device.

Parameterized Integers

bmdDeckLinkStatusParamEthernetLink

enumerator bmdDeckLinkStatusParamEthernetLink¶

For devices with Ethernet, the state of the link (BMDEthernetLinkState) of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector

bmdDeckLinkStatusParamEthernetLinkMbps

enumerator bmdDeckLinkStatusParamEthernetLinkMbps¶

For devices with Ethernet, the speed of the link in Mbps of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector

Parameterized Strings

bmdDeckLinkStatusParamEthernetLocalIPAddress

enumerator bmdDeckLinkStatusParamEthernetLocalIPAddress¶

For devices with Ethernet, the current negotiated or static local IP address of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. Valid if bmdDeckLinkStatusParamEthernetLink for the connector is bmdEthernetLinkStateConnectedBound. For other link states, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetSubnetMask

enumerator bmdDeckLinkStatusParamEthernetSubnetMask¶

For devices with Ethernet, the current negotiated or static subnet mask of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. Valid if bmdDeckLinkStatusParamEthernetLink for the connector is bmdEthernetLinkStateConnectedBound. For other link states, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetGatewayIPAddress

enumerator bmdDeckLinkStatusParamEthernetGatewayIPAddress¶

For devices with Ethernet, the current negotiated or static gateway IP address of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. Valid if bmdDeckLinkStatusParamEthernetLink for the connector is bmdEthernetLinkStateConnectedBound. For other link states, or unassigned, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetPrimaryDNS

enumerator bmdDeckLinkStatusParamEthernetPrimaryDNS¶

For devices with Ethernet, the current negotiated or static primary DNS IP address of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. Valid if bmdDeckLinkStatusParamEthernetLink for the connector is bmdEthernetLinkStateConnectedBound. For other link states, or unassigned, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetSecondaryDNS

enumerator bmdDeckLinkStatusParamEthernetSecondaryDNS¶

For devices with Ethernet, the current negotiated or static secondary DNS IP address of a specific Ethernet connector. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. Valid if bmdDeckLinkStatusParamEthernetLink for the connector is bmdEthernetLinkStateConnectedBound. For other link states, or unassigned, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetSFPStaticInfo

enumerator bmdDeckLinkStatusParamEthernetSFPStaticInfo¶

For devices with optical Ethernet, the static information about the optical transceiver module plugged into a specific Ethernet connector. Please refer to SNIA SFF-8636, section 6 “Memory Map” for reference to the keys in the returned JSON string. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector. For devices without optical Ethernet, this returns S_FALSE and an empty string.

bmdDeckLinkStatusParamEthernetVideoOutputAddress

enumerator bmdDeckLinkStatusParamEthernetVideoOutputAddress¶

For devices with Ethernet, the video output destination address. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector.

bmdDeckLinkStatusParamEthernetAudioOutputAddress

enumerator bmdDeckLinkStatusParamEthernetAudioOutputAddress¶

For devices with Ethernet, the audio output destination address. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector.

bmdDeckLinkStatusParamEthernetAncillaryOutputAddress

enumerator bmdDeckLinkStatusParamEthernetAncillaryOutputAddress¶

For devices with Ethernet, the ancillary output destination address. The parameter corresponds to the 0-indexed ID associated with a specific Ethernet connector.
  • ← 3.57 Packet Type
  • 3.59 Video Status Flags →
Desktop Video 16.0 SDK
© Copyright 2003-2026 Blackmagic Design. All rights reserved.