FQualifiedFrameTime Struct Reference

#include <QualifiedFrameTime.h>

Collaboration diagram for FQualifiedFrameTime:

Public Member Functions
	FQualifiedFrameTime ()
	FQualifiedFrameTime (const FFrameTime &InTime, const FFrameRate &InRate)
	FQualifiedFrameTime (const FTimecode &InTimecode, const FFrameRate &InRate)
double	AsSeconds () const
FFrameTime	ConvertTo (FFrameRate DesiredRate) const
FTimecode	ToTimecode () const
FTimecode	ToTimecode (bool bDropFrame) const

Public Attributes
FFrameTime	Time
FFrameRate	Rate

Detailed Description

A frame time qualified by a frame rate context

Definition at line 12 of file QualifiedFrameTime.h.

Constructor & Destructor Documentation

FQualifiedFrameTime() [1/3]

FQualifiedFrameTime::FQualifiedFrameTime ( )

inline

Default construction for UObject purposes

Definition at line 18 of file QualifiedFrameTime.h.

Here is the call graph for this function:

Here is the caller graph for this function:

FQualifiedFrameTime() [2/3]

FQualifiedFrameTime::FQualifiedFrameTime ( const FFrameTime & InTime, const FFrameRate & InRate )

inline

User construction from a frame time and its frame rate

Definition at line 25 of file QualifiedFrameTime.h.

FQualifiedFrameTime() [3/3]

FQualifiedFrameTime::FQualifiedFrameTime ( const FTimecode & InTimecode, const FFrameRate & InRate )

inline

User construction from a timecode and its frame rate

Definition at line 32 of file QualifiedFrameTime.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

AsSeconds()

double FQualifiedFrameTime::AsSeconds ( ) const

inline

Convert this frame time to a value in seconds

Definition at line 43 of file QualifiedFrameTime.h.

ConvertTo()

FFrameTime FQualifiedFrameTime::ConvertTo ( FFrameRate DesiredRate ) const

inline

Convert this frame time to a different frame rate

Definition at line 51 of file QualifiedFrameTime.h.

Here is the call graph for this function:

ToTimecode() [1/2]

FTimecode FQualifiedFrameTime::ToTimecode ( ) const

inline

Create an FTimecode from this qualified frame time.

Any subframe value in the frame time will be ignored. Whether or not the returned timecode is a drop-frame timecode will be determined by the qualified frame time's frame rate and the CVar specifying whether to generate drop-frame timecodes by default for supported frame rates.

Definition at line 63 of file QualifiedFrameTime.h.

Here is the call graph for this function:

ToTimecode() [2/2]

FTimecode FQualifiedFrameTime::ToTimecode ( bool bDropFrame ) const

inline

Create an FTimecode from this qualified frame time. Optionally supports creating a drop-frame timecode, which drops certain timecode display numbers to help account for NTSC frame rates which are fractional.

Parameters

bDropFrame

If true, the returned timecode will drop the first two frames on every minute (except when Minute % 10 == 0). This is only valid for NTSC framerates (29.97, 59.94) and will assert if you try to create a drop-frame timecode from a non-valid framerate. All framerates can be represented by non-drop timecode.

Definition at line 76 of file QualifiedFrameTime.h.

Here is the call graph for this function:

Member Data Documentation

Rate

FFrameRate FQualifiedFrameTime::Rate

The rate that this frame time is in

Definition at line 87 of file QualifiedFrameTime.h.

Time

FFrameTime FQualifiedFrameTime::Time

The frame time

Definition at line 84 of file QualifiedFrameTime.h.

---

The documentation for this struct was generated from the following file:

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/QualifiedFrameTime.h