2.5.11 IDeckLinkVideoInputFrame Interface

The IDeckLinkVideoInputFrame interface represents a video frame which has been captured by an IDeckLinkInput interface. IDeckLinkVideoInputFrame is a subclass of IDeckLinkVideoFrame and inherits all its methods.

Objects with an IDeckLinkVideoInputFrame interface are passed to the IDeckLinkInputCallback::VideoInputFrameArrived() callback.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkInputCallback

IID_IDeckLinkInputCallback

An IDeckLinkVideoInputFrame object interface is passed to IDeckLinkInputCallback::VideoInputFrameArrived()

IDeckLinkVideoFrame

IID_IDeckLinkVideoFrame

IDeckLinkVideoInputFrame subclasses IDeckLinkVideoFrame

2.5.11.1 IDeckLinkVideoInputFrame::GetStreamTime method

HRESULT IDeckLinkVideoInputFrame::GetStreamTime(BMDTimeValue *frameTime, BMDTimeValue *frameDuration, BMDTimeScale timeScale);

The GetStreamTime method returns the time and duration of a captured video frame for a given timescale.

Parameters:

  • frameTime – Frame time (in units of timeScale)

  • frameDuration – Frame duration (in units of timeScale)

  • timeScale – Time scale for output parameters

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.11.2 IDeckLinkVideoInputFrame::GetHardwareReferenceTimestamp method

HRESULT IDeckLinkVideoInputFrame::GetHardwareReferenceTimestamp(BMDTimeScale timeScale, BMDTimeValue *frameTime, BMDTimeValue *frameDuration);

The GetHardwareReferenceTimestamp method returns timestamp at the point of video input frame arrival and frame duration for a given timescale.

The absolute values returned by this method are meaningless, however the relative differences between subsequent calls can be used to determine elapsed time between video input frames.

Parameters:

  • timeScale – The time scale (see BMDTimeScale for details).

  • frameTime – The frame time (see BMDTimeValue for details).

  • frameDuration – The frame duration (see BMDTimeValue for details).

Return values:

  • E_INVALIDARG – Timescale is not set

  • S_OK – Success