2.5.23 IDeckLinkTimecode Interface

The IDeckLinkTimecode interface represents a video timecode and provides methods to access the timecode or its components.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkVideoFrame

IID_IDeckLinkVideoFrame

IDeckLinkVideoFrame::GetTimecode() outputs an IDeckLinkTimecode object interface

IDeckLinkMutableVideoFrame

IID_IDeckLinkMutableVideoFrame

An IDeckLinkTimecode object interface is set into a video frame with IDeckLinkMutableVideoFrame::SetTimecode()

IDeckLinkEncoderVideoPacket

IID_IDeckLinkEncoderVideoPacket

IDeckLinkEncoderVideoPacket::GetTimecode() outputs an IDeckLinkTimecode object interface

IDeckLinkDeckControl

IID_IDeckLinkDeckControl

IDeckLinkDeckControl::GetTimecode() outputs an IDeckLinkTimecode object interface

2.5.23.1 IDeckLinkTimecode::GetBCD method

BMDTimecodeBCD IDeckLinkTimecode::GetBCD();

The GetBCD method returns the timecode in Binary Coded Decimal representation.

Returns:

Timecode value in BCD format (See BMDTimecodeBCD for details)

2.5.23.2 IDeckLinkTimecode::GetComponents method

HRESULT IDeckLinkTimecode::GetComponents(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint8_t *frames);

The GetComponents method returns individual components of the timecode. Specify NULL for any unwanted parameters.

Parameters:

  • hours – Hours component of timecode

  • minutes – Minutes component of timecode

  • seconds – Seconds component of timecode

  • frames – Frames component of timecode

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.23.3 IDeckLinkTimecode::GetString method

HRESULT IDeckLinkTimecode::GetString(string *timecode);

The GetString method returns the timecode formatted as a standard timecode string.

Parameters:

timecode – Timecode formatted as a standard timecode string: “HH:MM:SS:FF”. This allocated string must be freed by the caller when no longer required.

Return values:

  • E_FAIL – Failure

  • S_OK – Success

2.5.23.4 IDeckLinkTimecode::GetFlags method

BMDTimecodeFlags IDeckLinkTimecode::GetFlags();

The GetFlags method returns the flags accompanying a timecode.

Returns:

Timecode flags (see BMDTimecodeFlags for details)

2.5.23.5 IDeckLinkTimecode::GetTimecodeUserBits method

HRESULT IDeckLinkTimecode::GetTimecodeUserBits(BMDTimecodeUserBits *userBits);

The GetTimecodeUserBits method returns the timecode user bits.

Parameters:

userBits – The user bits.

Return values:

  • E_POINTER – The userBits parameter is NULL.

  • S_OK – Success