Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | UTimecodeProvider |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/TimecodeProvider.h |
| Include Path | #include "Engine/TimecodeProvider.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UTimecodeProvider : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UTimecodeProvider
Derived Classes
UTimecodeProvider derived class hierarchy
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FrameDelay | float | Number of frames to subtract from the qualified frame time when GetDelayedQualifiedFrameTime or GetDelayedTimecode is called. | Engine/TimecodeProvider.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void FetchAndUpdate () |
Update the state of the provider. | Engine/TimecodeProvider.h |
|
virtual bool FetchTimecode
(
FQualifiedFrameTime& OutFrameTime |
Fetch current timecode from its source. | Engine/TimecodeProvider.h |
|
| Return current frame time with FrameDelay applied. | Engine/TimecodeProvider.h |
|
|
FTimecode GetDelayedTimecode() |
Return the delayed frame time converted into a timecode value. | Engine/TimecodeProvider.h |
|
FFrameRate GetFrameRate() |
Return the frame rate of the frame time. | Engine/TimecodeProvider.h |
|
virtual FQualifiedFrameTime GetQualifiedFrameTime () |
Return current frame time. | Engine/TimecodeProvider.h |
|
virtual ETimecodeProviderSynchronizationState GetSynchronizationState() |
The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid. | Engine/TimecodeProvider.h |
|
FTimecode GetTimecode() |
Return the frame time converted into a timecode value. | Engine/TimecodeProvider.h |
|
virtual bool Initialize
(
UEngine* InEngine |
This Provider became the Engine's Provider. | Engine/TimecodeProvider.h | |
virtual bool IsAutoDetected() |
Get whether this provider is currently using autodetection. | Engine/TimecodeProvider.h | |
virtual void SetIsAutoDetected
(
bool bInIsAutoDetected |
Set the autodetected flag on this provider. | Engine/TimecodeProvider.h | |
virtual void Shutdown
(
UEngine* InEngine |
This Provider stopped being the Engine's Provider. | Engine/TimecodeProvider.h | |
virtual bool SupportsAutoDetected() |
Whether this provider supports format autodetection. | Engine/TimecodeProvider.h |