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. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Settings
float32	FrameDelay
	Number of frames to subtract from the qualified frame time when GetDelayedQualifiedFrameTime or GetDelayedTimecode is called. @see GetDelayedQualifiedFrameTime, GetDelayedTimecode.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Provider
const FQualifiedFrameTime	DelayedQualifiedFrameTime
	Return current frame time with FrameDelay applied. Only assume valid when GetSynchronizationState() returns Synchronized.
const FTimecode	DelayedTimecode
	Return the delayed frame time converted into a timecode value.
const FFrameRate	FrameRate
	Return the frame rate of the frame time.
const FQualifiedFrameTime	QualifiedFrameTime
	Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.
const ETimecodeProviderSynchronizationState	SynchronizationState
	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
const FTimecode	Timecode
	Return the frame time converted into a timecode value.
FFrameRate	GetFrameRate () const
	Return the frame rate of the frame time.
bool	FetchTimecode (FQualifiedFrameTime &OutFrameTime)
	Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode.
FQualifiedFrameTime	GetDelayedQualifiedFrameTime () const
	Return current frame time with FrameDelay applied. Only assume valid when GetSynchronizationState() returns Synchronized.
FTimecode	GetDelayedTimecode () const
	Return the delayed frame time converted into a timecode value.
void	FetchAndUpdate ()
	Update the state of the provider. Call it to ensure timecode and state are updated. It is suggested to fetch timecode from its source and cache it for the getters.
FQualifiedFrameTime	GetQualifiedFrameTime () const
	Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.
ETimecodeProviderSynchronizationState	GetSynchronizationState () const
	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
FTimecode	GetTimecode () const
	Return the frame time converted into a timecode value.

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Detailed Description

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.

Member Function Documentation

◆ FetchAndUpdate()

void FetchAndUpdate ( )

Update the state of the provider. Call it to ensure timecode and state are updated. It is suggested to fetch timecode from its source and cache it for the getters.

◆ FetchTimecode()

bool FetchTimecode ( FQualifiedFrameTime & OutFrameTime )

Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode.

◆ GetDelayedQualifiedFrameTime()

FQualifiedFrameTime GetDelayedQualifiedFrameTime ( ) const

Return current frame time with FrameDelay applied. Only assume valid when GetSynchronizationState() returns Synchronized.

◆ GetDelayedTimecode()

FTimecode GetDelayedTimecode ( ) const

Return the delayed frame time converted into a timecode value.

◆ GetFrameRate()

FFrameRate GetFrameRate ( ) const

Return the frame rate of the frame time.

◆ GetQualifiedFrameTime()

FQualifiedFrameTime GetQualifiedFrameTime ( ) const

Return current frame time. Since it may be called several times per frame, it is suggested to return a cached value.

◆ GetSynchronizationState()

ETimecodeProviderSynchronizationState GetSynchronizationState ( ) const

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

◆ GetTimecode()

FTimecode GetTimecode ( ) const

Return the frame time converted into a timecode value.

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ DelayedQualifiedFrameTime

const FQualifiedFrameTime DelayedQualifiedFrameTime

Return current frame time with FrameDelay applied. Only assume valid when GetSynchronizationState() returns Synchronized.

◆ DelayedTimecode

const FTimecode DelayedTimecode

Return the delayed frame time converted into a timecode value.

◆ FrameDelay

float32 FrameDelay

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

◆ FrameRate

const FFrameRate FrameRate

Return the frame rate of the frame time.

◆ QualifiedFrameTime

const FQualifiedFrameTime QualifiedFrameTime