Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UTimecodeProvider

Light Theme

Dark Theme

UTimecodeProvider

A class responsible of fetching a timecode from a source.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTimecodeProvider

UGenlockedTimecodeProvider

	UAjaTimecodeProvider
	UAudioCaptureTimecodeProvider
	UBlackmagicTimecodeProvider

ULiveLinkTimecodeProvider

USystemTimeTimecodeProvider

UTimecodeSynchronizer

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
	float	FrameDelay	Number of frames to subtract from the qualified frame time when GetDelayedQualifiedFrameTime or GetDelayedTimecode is called.

Functions

	Name	Description
void	FetchAndUpdate()	Update the state of the provider.
bool	FetchTimecode ( FQualifiedFrameTime& OutFrameTime )	Fetch current timecode from its source.
FQualifiedFr...	GetDelayedQualifiedFrameTime()	Return current frame time with FrameDelay applied.
FTimecode	GetDelayedTimecode()	Return the delayed frame time converted into a timecode value.
FFrameRate	GetFrameRate()	Return the frame rate of the frame time.
FQualifiedFr...	GetQualifiedFrameTime()	Return current frame time.
ETimecodePro...	GetSynchronizationState()	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
FTimecode	GetTimecode()	Return the frame time converted into a timecode value.
bool	Initialize ( UEngine* InEngine )	This Provider became the Engine's Provider.
void	Shutdown ( UEngine* InEngine )	This Provider stopped being the Engine's Provider.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss