2.5.29 IDeckLinkDeckControlStatusCallback Interface

The IDeckLinkDeckControlStatusCallback interface is a callback class which is called when the Deck control status has changed.

An object with the IDeckLinkDeckControlStatusCallback interface may be registered as a callback with the IDeckLinkDeckControl interface.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkDeckControl

IID_IDeckLinkDeckControl

An IDeckLinkDeckControlStatusCallback object interface is registered with IDeckLinkDeckControl::SetCallback()

2.5.29.1 IDeckLinkDeckControlStatusCallback::TimecodeUpdate method

HRESULT IDeckLinkDeckControlStatusCallback::TimecodeUpdate(BMDTimecodeBCD currentTimecode);

The TimecodeUpdate method is called when there is a change to the timecode.

Timecodes may be missed when playing at non 1x speed. This method will not be called during capture, and the serial timecode attached to each frame delivered by the API should be used instead.

Parameters:

currentTimecode – The current timecode.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.29.2 IDeckLinkDeckControlStatusCallback::VTRControlStateChanged method

HRESULT IDeckLinkDeckControlStatusCallback::VTRControlStateChanged(BMDDeckControlVTRControlState newState, BMDDeckControlError error);

The VTRControlStateChanged method is called when there is a change in the deck control state. Refer to BMDDeckControlVTRControlState for the possible states. This method is only called while in VTR control mode.

Parameters:
Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.29.3 IDeckLinkDeckControlStatusCallback::DeckControlEventReceived method

HRESULT IDeckLinkDeckControlStatusCallback::DeckControlEventReceived(BMDDeckControlEvent event, BMDDeckControlError error);

The DeckControlEventReceived method is called when a deck control event occurs.

Parameters:

  • event – The deck control event that has occurred see BMDDeckControlEvent for details.

  • error – The deck control error that has occurred.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.29.4 IDeckLinkDeckControlStatusCallback::DeckControlStatusChanged method

HRESULT IDeckLinkDeckControlStatusCallback::DeckControlStatusChanged(BMDDeckControlStatusFlags flags, uint32_t mask);

The DeckControlStatusChanged method is called when the deck control status has changed.

Parameters:

  • flags – The deck control current status see BMDDeckControlStatusFlags for details.

  • mask – The deck control status event flag(s) that have changed.

Return values:

  • E_FAIL – Failure

  • S_OK – Success