FTimecode::FromFrameNumber

Create a [FTimecode](API\Runtime\Core\Misc\FTimecode) from a specific frame number at the given frame rate.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Timecode.h

Include

#include "Misc/Timecode.h"

Syntax

static FTimecode FromFrameNumber
(
    const FFrameNumber & InFrameNumber,
    const FFrameRate & InFrameRate,
    bool InbDropFrame
)

Remarks

Create a FTimecode from a specific frame number at the given frame rate. Optionally supports creating a drop frame timecode, which drops certain timecode display numbers to help account for NTSC frame rates which are fractional.

Parameters

Parameter

Description

InFrameNumber

The frame number to convert into a timecode. This should already be converted to InFrameRate's resolution.

InFrameRate

The framerate that this timecode is based in. This should be the playback framerate as it is used to determine when the Frame value wraps over.

InbDropFrame

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 format from a non-valid framerate. All framerates can be represented when in non-drop frame format.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss