UTimecodeProvider

A class responsible of fetching a timecode from a source.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/TimecodeProvider.h

Include

#include "Engine/TimecodeProvider.h"

Syntax

class UTimecodeProvider : public UObject

Remarks

A class responsible of fetching a timecode from a source. Note, FApp::GetTimecode and FApp::GetTimecodeFramerate should be used to retrieve the current system Timecode and Framerate.

Variables

Name Description

Public variable

float

 

FrameDelay

Number of frames to subtract from the qualified frame time when GetDelayedQualifiedFrameTime or GetDelayedTimecode is called.

Functions

Name Description

Public function Virtual

void

 

FetchAndUpdate()

Update the state of the provider.

Public function Virtual

bool

 

FetchTimecode

(
    FQualifiedFrameTime& OutFrameTime
)

Fetch current timecode from its source.

Public function Const

FQualifiedFr...

 

GetDelayedQualifiedFrameTime()

Return current frame time with FrameDelay applied.

Public function Const

FTimecode

 

GetDelayedTimecode()

Return the delayed frame time converted into a timecode value.

Public function Const

FFrameRate

 

GetFrameRate()

Return the frame rate of the frame time.

Public function Virtual Const

FQualifiedFr...

 

GetQualifiedFrameTime()

Return current frame time.

Public function Virtual Const

ETimecodePro...

 

GetSynchronizationState()

The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.

Public function Const

FTimecode

 

GetTimecode()

Return the frame time converted into a timecode value.

Public function Virtual

bool

 

Initialize

(
    UEngine* InEngine
)

This Provider became the Engine's Provider.

Public function Virtual

void

 

Shutdown

(
    UEngine* InEngine
)

This Provider stopped being the Engine's Provider.