FQualifiedFrameTime Struct Reference

#include <QualifiedFrameTime.h>

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

Constructor & Destructor Documentation

FQualifiedFrameTime() [1/3]

FQualifiedFrameTime::FQualifiedFrameTime ( )

inline

Default construction for UObject purposes

FQualifiedFrameTime() [2/3]

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

inline

User construction from a frame time and its frame rate

FQualifiedFrameTime() [3/3]

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

inline

User construction from a timecode and its frame rate

Member Function Documentation

AsSeconds()

double FQualifiedFrameTime::AsSeconds ( ) const

inline

Convert this frame time to a value in seconds

ConvertTo()

FFrameTime FQualifiedFrameTime::ConvertTo ( FFrameRate  DesiredRate ) const

inline

Convert this frame time to a different frame rate

ToTimecode() [1/2]

FTimecode FQualifiedFrameTime::ToTimecode ( ) const

inline

Create an FTimecode from this qualified frame time.

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.

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.

Member Data Documentation

Rate

FFrameRate FQualifiedFrameTime::Rate

The rate that this frame time is in

Time

FFrameTime FQualifiedFrameTime::Time

IMPORTANT: If you change the struct data, ensure that you also update the version in NoExportTypes.h
The frame time

---

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

• Engine/Source/Runtime/Core/Public/Misc/QualifiedFrameTime.h