2.5.18 IDeckLinkKeyer Interface

The IDeckLinkKeyer interface allows configuration of the keying functionality available on most DeckLink cards. An IDeckLinkKeyer interface can be obtained from the IDeckLink interface using QueryInterface.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkKeyer object interface may be obtained from IDeckLink using QueryInterface

2.5.18.1 IDeckLinkKeyer::Enable method

HRESULT IDeckLinkKeyer::Enable(Boolean isExternal);

The Enable method turns on the keyer functionality.

If external keying is selected, the mask is output on CH A and the key on CH B. The following table lists the hardware that support various keyer capabilities. Currently capture of mask/key on dual channel inputs is not supported.

The following table displays hardware which supports the keyer functionality.

Device

Internal

External

10-bit YUVA

Rec.2020 + HDR

To Video Mode

DeckLink SDI 4K

yes

no

no

no

HD p60

DeckLink Studio 4K

yes

yes [1]

no

no

HD p60

DeckLink 4K Extreme 12G

yes

yes

no

no

UHD p60

DeckLink Duo 2

yes

yes

no

no

HD p60

DeckLink Quad 2

yes

yes

no

no

HD p60

DeckLink 8K Pro

yes

yes

no

yes

UHD p60

DeckLink IP/SDI HD

yes [2]

no

no

no

HD p60

DeckLink IP HD

yes

no

no

no

HD p60

DeckLink IP HD Optical

yes

no

no

no

HD p60

UltraStudio 4K Extreme 3

yes

yes

no

no

UHD p60

UltraStudio 4K Mini

yes

yes

yes

no

UHD p30

UltraStudio HD Mini

yes

yes

no

no

HD p60

Blackmagic Media Player

yes

yes

yes

no

UHD p60

Tip

The IDeckLinkOutput::DoesSupportVideoMode() method with video mode flag bmdSupportedVideoModeKeying should be used to determine whether keying is supported on a device with aparticular display mode.

Parameters:

isExternal – Specifies internal or external keying.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.18.2 IDeckLinkKeyer::SetLevel method

HRESULT IDeckLinkKeyer::SetLevel(uint8_t level);

The SetLevel method sets the level that the image is blended onto the frame. 0 is no blend, 255 is completely blended onto the frame.

Parameters:

level – The level that the image is to be blended onto the frame.

Return values:

S_OK – Success

2.5.18.3 IDeckLinkKeyer::RampUp method

HRESULT IDeckLinkKeyer::RampUp(uint32_t numberOfFrames);

The RampUp method progressively blends in an image over a given number of frames from level of 0 (no blend) to 255 (completely blended).

Parameters:

numberOfFrames – The number of frames that the image is progressively blended in.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.18.4 IDeckLinkKeyer::RampDown method

HRESULT IDeckLinkKeyer::RampDown(uint32_t numberOfFrames);

The RampDown method progressively blends out an image over a given number of frames from level of 255 (completely blended) to 0 (no blend).

Parameters:

numberOfFrames – The number of frames that the image is progressively blended out.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.18.5 IDeckLinkKeyer::Disable method

HRESULT IDeckLinkKeyer::Disable();

The Disable method turns off the keyer functionality.

Return values:

  • E_FAIL – Failure

  • S_OK – Success