Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FTimecode

Light Theme

Dark Theme

FTimecode

A timecode that stores time in HH:MM:SS format with the remainder of time represented by an integer frame count.

Choose your operating system:

Windows

macOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/Timecode.h
Include	#include "Misc/Timecode.h"

Syntax

struct FTimecode

Remarks

A timecode that stores time in HH:MM:SS format with the remainder of time represented by an integer frame count.

Variables

		Name	Description
	bool	bDropFrameFormat	If true, this Timecode represents a Drop Frame timecode used to account for fractional frame rates in NTSC play rates.
	int32	Frames	How many frames does this timecode represent
	int32	Hours	How many hours does this timecode represent
	int32	Minutes	How many minutes does this timecode represent
	int32	Seconds	How many seconds does this timecode represent

Constructors

	Name	Description
	FTimecode()	Default construction for UObject purposes
	FTimecode ( double InSeconds, const FFrameRate& InFrameRate, bool InbRollover )	User construction from a time in seconds
	FTimecode ( double InSeconds, const FFrameRate& InFrameRate, bool InbDropFrame, bool InbRollover )	User construction from a time in seconds
	FTimecode ( int32 InHours, int32 InMinutes, int32 InSeconds, int32 InFrames, bool InbDropFrame )	User construction from a number of hours minutes seconds and frames.

Functions

		Name	Description
	FTimecode	FromFrameNumber ( const FFrameNumber& InFrameNumber, const FFrameRate& InFrameRate )	Create a FTimecode from a specific frame number at the given frame rate.
	FTimecode	FromFrameNumber ( const FFrameNumber& InFrameNumber, const FFrameRate& InFrameRate, bool InbDropFrame )	Create a FTimecode from a specific frame number at the given frame rate.
	FTimecode	FromTimespan ( const FTimespan& InTimespan, const FFrameRate& InFrameRate, bool InbRollover )	Create a FTimecode from a timespan at the given frame rate.
	FTimecode	FromTimespan ( const FTimespan& InTimespan, const FFrameRate& InFrameRate, bool InbDropFrame, bool InbRollover )	Create a FTimecode from a timespan at the given frame rate.
	bool	IsDropFormatTimecodeSupported ( const FFrameRate& InFrameRate )	Drop frame is only support for frame rate of 29.97 or 59.94.
	FFrameNumber	ToFrameNumber ( const FFrameRate& InFrameRate )	Converts this Timecode back into a Frame Number at the given framerate, taking into account if this is a drop-frame format timecode.
	FString	ToString ( bool bForceSignDisplay )	Get the Qualified Timecode formatted in HH:MM:SS:FF or HH:MM:SS;FF depending on if this represents drop-frame timecode or not.
	FTimespan	ToTimespan ( const FFrameRate& InFrameRate )	Converts this Timecode back into a timespan at the given framerate, taking into account if this is a drop-frame format timecode.
	bool	UseDropFormatTimecode ( const FFrameRate& InFrameRate )	If the frame rate support drop frame format and the app wish to use drop frame format by default.
	bool	UseDropFormatTimecodeByDefaultWhenSupported()	By default, should we generate a timecode in drop frame format when the frame rate does support it.