3.18 DeckLink Configuration ID¶
BMDDeckLinkConfigurationID
enumerates the set of configuration settings of a DeckLink device which may be queried or set (see IDeckLinkConfiguration
interface for details).
Key |
Description |
---|---|
Serial port Flags |
|
bmdDeckLinkConfigSwapSerialRxTx |
If set to true, the Rx and Tx lines of the RS422 port on the DeckLink device will be swapped. |
Video Input/Output Integers |
|
bmdDeckLinkConfigHDMI3DPackingFormat |
The 3D packing format setting. See |
bmdDeckLinkConfigBypass |
The state of the bypass feature. This parameter can be set to a value of -1 for normal operation or zero to bypass the card. A timeout of up to 65 seconds may be specified in milliseconds. If the timeout is reached without the parameter being reset, the card will be bypassed automatically. The actual timeout will be approximately the time requested. |
bmdDeckLinkConfigClockTimingAdjustment |
Clock frequency adjustment for fine output control. The acceptable range is from -127 to 127 PPM (Parts Per Million). |
bmdDeckLinkConfigAudioMeterType |
For products that support programmable front-panel LCD audio meters, this is the audio meter type. See |
Audio Input/Output Flags |
|
bmdDeckLinkConfigAnalogAudioConsumerLevels |
If set true the analog audio levels are set to maximum gain on audio input and maximum attenuation on audio output. If set false the selected analog input and output gain levels are used. |
bmdDeckLinkConfigSwapHDMICh3AndCh4OnInput |
If set, HDMI audio input channels 3 and 4 are swapped to support 5.1 audio channel ordering |
bmdDeckLinkConfigSwapHDMICh3AndCh4OnOutput |
If set, HDMI audio output channels 3 and 4 are swapped to support 5.1 audio channel ordering |
bmdDeckLinkConfigAnalogAudioOutputChannelsMutedByHeadphone |
If set, analog output channels are muted when the headphone is plugged in. |
bmdDeckLinkConfigAnalogAudioOutputChannelsMutedBySpeaker |
If set, analog output channels are muted when the speaker is active. |
Video Output Flags |
|
bmdDeckLinkConfigFieldFlickerRemoval |
Sets field flicker removal when paused functionality. True if enabled. |
bmdDeckLinkConfigHD1080p24ToHD1080i5994Conversion |
True if HD 1080p24 to HD 1080i5994 conversion is enabled. |
bmdDeckLinkConfig444SDIVideoOutput |
True if 444 video output is enabled. |
bmdDeckLinkConfigBlackVideoOutputDuringCapture |
True if black output during capture is enabled. This feature is only supported on legacy DeckLink devices. |
bmdDeckLinkConfigLowLatencyVideoOutput |
Reduces output latency on some older products. On newer products, this option will have no effect. |
bmdDeckLinkConfigDownConversionOnAllAnalogOutput |
Enable down conversion on all analog outputs. |
bmdDeckLinkConfigSMPTELevelAOutput |
Enable SMPTE level A output. |
bmdDeckLinkConfigRec2020Output |
If set to true, device will output Rec.709 frames in Rec.2020 colorspace (See |
bmdDeckLinkConfigQuadLinkSDIVideoOutputSquareDivisionSplit |
If set to true, Quad-link SDI is output in Square Division Quad Split mode. |
bmdDeckLinkConfigOutput1080pAsPsF |
If set, output 1080p or 2K progressive modes as PsF. |
bmdDeckLinkConfigOutputValidateEDIDForDolbyVision |
If set (default), process the sink EDID and potentially fail operations that aren’t supported. |
bmdDeckLinkConfigExtendedDesktop |
If set, enable extended desktop on a supported device. |
Video Output Integers |
|
bmdDeckLinkConfigVideoOutputConnection |
The output video connection. See Enabling video output on one connection will enable output on other available output connections which are compatible. The status of active output connection can be queried with this setting. Multiple video output connections can be active simultaneously. When querying the enabled video outputs, the returned integer is a bitmask of When setting active video outputs, only one video output connection can be enabled per call, ie, the integer argument must refer to a single video output connection. |
bmdDeckLinkConfigVideoOutputConversionMode |
Settings for video output conversion. The possible output modes are enumerated by |
bmdDeckLinkConfigVideoOutputConversionColorspaceDestination |
For colorspace conversion, the destination |
bmdDeckLinkConfigVideoOutputConversionColorspaceSource |
For colorspace conversion, the source |
bmdDeckLinkConfigAnalogVideoOutputFlags |
Settings for analog video output. |
bmdDeckLinkConfigReferenceInputTimingOffset |
Adjust genlock timing pixel offset. If the device supports wide genlock offset adjustment (see BMDDeckLinkSupportsFullFrameReferenceInput TimingOffset attribute) then the supported range is between +/- half the count of total pixels in the video frame. Otherwise the supported range is +/-511. |
bmdDeckLinkConfigReferenceOutputMode |
The reference output video mode for DeckLink devices where reference output does not follow SDI output (see |
bmdDeckLinkConfigVideoOutputIdleOperation |
Video output idle control. See |
bmdDeckLinkConfigDefaultVideoOutputMode |
The default video output mode. The |
bmdDeckLinkConfigDefaultVideoOutputModeFlags |
The default video output mode 2D or 3D flag setting. See |
bmdDeckLinkConfigSDIOutputLinkConfiguration |
The SDI link configuration for a single output video stream. See |
bmdDeckLinkConfigHDMITimecodePacking |
Set the HDMI timecode packing format for the video output stream (See |
bmdDeckLinkConfigPlaybackGroup |
Any 32-bit number to identify a playback group. All devices supporting synchronized playback with the same group number are started and stopped together. |
Video Output Floats |
|
bmdDeckLinkConfigVideoOutputComponentLumaGain |
The component video output luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputComponentChromaBlueGain |
The component video output chroma blue gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputComponentChromaRedGain |
The component video output chroma red gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputCompositeLumaGain |
The composite video output luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputCompositeChromaGain |
The composite video output chroma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputSVideoLumaGain |
The s-video output luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoOutputSVideoChromaGain |
The s-video output chroma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigDolbyVisionCMVersion |
A float represeting the Dolby Vision content mapping version to use when Dolby Vision output is enabled |
bmdDeckLinkConfigDolbyVisionMasterMinimumNits |
A float represeting the mastering monitor minimum brightness in nits |
bmdDeckLinkConfigDolbyVisionMasterMaximumNits |
A float represeting the mastering monitor maximum brightness in nits |
Video Input Flags |
|
bmdDeckLinkConfigVideoInputScanning |
The video input connector scanning on the H.264 Pro Recorder. True if enabled. |
bmdDeckLinkConfigUseDedicatedLTCInput |
Use the timecode from the LTC input rather than from the SDI stream. |
bmdDeckLinkConfigSDIInput3DPayloadOverride |
If set to true, the device will capture two genlocked SDI streams with matching video modes as a 3D stream. |
bmdDeckLinkConfigCapture1080pAsPsF |
If set, capture 1080p or 2K progressive modes as PsF. This flag is only required for devices that don’t support PsF input detection (see attribute |
Video Input Integers |
|
bmdDeckLinkConfigVideoInputConnection |
The input video connection. Only one video input connection can be active at a time. See |
bmdDeckLinkConfigAnalogVideoInputFlags |
The analog video input flags. See |
bmdDeckLinkConfigVideoInputConversionMode |
The video input conversion mode. See |
bmdDeckLinkConfig32PulldownSequenceInitialTimecodeFrame |
The A-frame setting for NTSC 23.98, which is used to appropriately adjust the timecode. The frame setting range is between 0 and 29. |
bmdDeckLinkConfigVANCSourceLine1Mapping |
The configuration of up to three lines of VANC to be transferred to or from the active picture on capture or output. The acceptable range is between 0 and 30. A value of 0 will disable the capture of that line. |
bmdDeckLinkConfigVANCSourceLine2Mapping |
The acceptable range is between 0 and 30. A value of 0 will disable the capture of the line. |
bmdDeckLinkConfigVANCSourceLine3Mapping |
The acceptable range is between 0 and 30. A value of 0 will disable the capture of the line. |
bmdDeckLinkConfigCapturePassThroughMode |
The capture pass through mode specifies how the monitoring video output is generated while capture is in progress. See |
bmdDeckLinkConfigCaptureGroup |
Any 32-bit number to identify a capture group. All devices supporting synchronized capture with the same group number are started and stopped together. |
Video Input Floats |
|
bmdDeckLinkConfigVideoInputComponentLumaGain |
The component video input luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputComponentChromaBlueGain |
The component video input chroma blue gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputComponentChromaRedGain |
The component video input chroma red gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputCompositeLumaGain |
The composite video input luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputCompositeChromaGain |
The composite video input chroma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputSVideoLumaGain |
The s-video input luma gain in dB. The accepted range can be determined by using the |
bmdDeckLinkConfigVideoInputSVideoChromaGain |
The s-video input chroma gain in dB. The accepted range can be determined by using the |
Keying Integers |
|
bmdDeckLinkConfigInternalKeyingAncillaryDataSource |
Set the source of VANC and timecode for output signal when internal keying is enabled (See |
Audio Input Flags |
|
bmdDeckLinkConfigMicrophonePhantomPower |
If set to true, the Microphone input will provide +48V Phantom Power. |
Audio Input Integers |
|
bmdDeckLinkConfigAudioInputConnection |
The configuration of the audio input connection. See |
Audio Input Floats |
|
bmdDeckLinkConfigAnalogAudioInputScaleChannel1 |
The analog audio input scale in dB. The supported range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioInputScaleChannel2 |
The analog audio input scale in dB. The supported range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioInputScaleChannel3 |
The analog audio input scale in dB. The supported range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioInputScaleChannel4 |
The analog audio input scale in dB. The supported range is between -12.00 and 12.00. |
bmdDeckLinkConfigDigitalAudioInputScale |
The digital audio input scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigMicrophoneInputGain |
The microphone input gain in dB. The acceptable range can be determined via |
bmdDeckLinkConfigAudioOutputXLRDelayFrames |
The frame number delay of XLR audio output relative to video playback. Value is active when |
Audio Output Integers |
|
bmdDeckLinkConfigAudioOutputAESAnalogSwitch |
The AES / analog audio output selection switch. This is applicable only to cards that support switchable analog audio outputs. |
bmdDeckLinkConfigAudioOutputXLRDelayTime |
The millisecond delay of XLR audio output relative to video playback. Value is active when |
bmdDeckLinkConfigAudioOutputXLRDelayType |
The type of configured XLR delay rate that should take effect. See |
Audio Output Floats |
|
bmdDeckLinkConfigAnalogAudioOutputScaleChannel1 |
The analog audio output scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioOutputScaleChannel2 |
The analog audio output scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioOutputScaleChannel3 |
The analog audio output scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigAnalogAudioOutputScaleChannel4 |
The analog audio output scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigDigitalAudioOutputScale |
The digital audio output scale in dB. The acceptable range is between -12.00 and 12.00. |
bmdDeckLinkConfigHeadphoneVolume |
Set the headphone volume, acceptable range is between 0.0 (mute), to 1.0 (full volume) |
bmdDeckLinkConfigSpeakerVolume |
Set the speaker volume, acceptable range is between 0.0 (mute), to 1.0 (full volume) |
Network Flags |
|
bmdDeckLinkConfigEthernetUseDHCP |
For devices with Ethernet. The local interface assigns a local IP address via DHCP, otherwise static. |
bmdDeckLinkConfigEthernetPTPFollowerOnly |
For devices that use PTP. Prevents the device from negotiating to become a PTP leader. False by default. |
bmdDeckLinkConfigEthernetPTPUseUDPEncapsulation |
For devices that use PTP. Sets if UDP Encapsulation will be used, otherwise Ethernet Encapsulation will be used. |
Network Integers |
|
bmdDeckLinkConfigEthernetPTPPriority1 |
For devices that use PTP. Sets PTP’s Priority1 field. The supported range is 0 to 255 with default value 128. |
bmdDeckLinkConfigEthernetPTPPriority2 |
For devices that use PTP. Sets PTP’s Priority2 field. The supported range is 0 to 255 with default value 128. |
bmdDeckLinkConfigEthernetPTPDomain |
For devices that use PTP. Sets PTP’s Domain field. The supported range is 0 to 127 with default value 127. |
bmdDeckLinkConfigEthernetPTPLogAnnounceInterval |
For devices that use PTP. Sets PTP’s log announce interval. The value of the parameter is the logarithm to base 2 of the time interval in seconds. The supported range is -3 to 1 with default value -2. |
Network Strings |
|
bmdDeckLinkConfigEthernetStaticLocalIPAddress |
For devices with Ethernet. Manual local IP address. Used when |
bmdDeckLinkConfigEthernetStaticSubnetMask |
For devices with Ethernet. Manual subnet mask. Used when |
bmdDeckLinkConfigEthernetStaticGatewayIPAddress |
For devices with Ethernet. Manual gateway IP address. Used when |
bmdDeckLinkConfigEthernetStaticPrimaryDNS |
For devices with Ethernet. Manual primary DNS. Used when |
bmdDeckLinkConfigEthernetStaticSecondaryDNS |
For devices with Ethernet. Manual secondary DNS. Used when |
bmdDeckLinkConfigEthernetVideoOutputAddress |
For devices with Ethernet. Set the output address for the video flow. Omission of either dotted-decimal IP or colon-port represents auto for either, or empty string for both. Get the actual used address from |
bmdDeckLinkConfigEthernetAudioOutputAddress |
For devices with Ethernet. Set the output address for the audio flow. Omission of either dotted-decimal IP or colon-port represents auto for either, or empty string for both. Get the actual used address from |
bmdDeckLinkConfigEthernetAncillaryOutputAddress |
For devices with Ethernet. Set the output address for the ancillary flow. Omission of either dotted-decimal IP or colon-port represents auto for either, or empty string for both. Get the actual used address from |
bmdDeckLinkConfigEthernetAudioOutputChannelOrder |
For devices with Ethernet. Sets the output audio SDP channel-order with the convention defined by ST 2110-30. |
Device Information Strings |
|
bmdDeckLinkConfigDeviceInformationLabel |
Set the label of the device. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility and overrides the string returned by |
bmdDeckLinkConfigDeviceInformationSerialNumber |
Set the serial number of the device. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility. |
bmdDeckLinkConfigDeviceInformationCompany |
Set the device’s seller name. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility. |
bmdDeckLinkConfigDeviceInformationPhone |
Set the device’s seller phone number. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility. |
bmdDeckLinkConfigDeviceInformationEmail |
Set the device’s seller email address. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility. |
bmdDeckLinkConfigDeviceInformationDate |
Set the device’s purchase date. This can only be set if the device has a persistent ID. This information will be saved onto the local machine but not onto the device. This information will also appear in Product Notes section of the Desktop Video Utility. |
Deck Control Integers |
|
bmdDeckLinkConfigDeckControlConnection |
The active RS422 deck control connection. See |
UI/UX Integers |
|
bmdDeckLinkConfigDisplayLanguage |
Front panel display language. See |