timecode.UseDropFormatTimecodeByDefaultWhenSupported

timecode.UseDropFormatTimecodeByDefaultWhenSupported

#Overview

name: timecode.UseDropFormatTimecodeByDefaultWhenSupported

This variable is created as a Console Variable (cvar).

• type: Var
• help: By default, should we generate a timecode in drop frame format when the frame rate does support it.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of timecode.UseDropFormatTimecodeByDefaultWhenSupported is to control whether timecodes should be generated in drop frame format by default when the frame rate supports it. This setting is primarily used in the timecode system of Unreal Engine.

The Unreal Engine subsystem that relies on this setting variable is the Core module, specifically the timecode functionality within it. This can be inferred from the file location (Engine/Source/Runtime/Core/Private/Misc/Timecode.cpp) where the variable is defined and used.

The value of this variable is set as a console variable using TAutoConsoleVariable. It is initialized with a default value of 1.0f (true), meaning that by default, drop frame format will be used when supported.

The associated variable CVarUseDropFormatTimecodeByDefaultWhenSupported interacts directly with this setting. It is the actual console variable object that stores and provides access to the setting’s value.

Developers must be aware that this setting affects the default behavior of timecode generation. When set to true, it will use drop frame format for timecodes when the frame rate supports it. This can impact timecode accuracy and compatibility with external systems that expect a specific timecode format.

Best practices when using this variable include:

1. Understanding the implications of drop frame vs. non-drop frame timecodes for your specific use case.
2. Ensuring that any external systems or workflows that interact with the engine’s timecodes are compatible with the chosen format.
3. Considering overriding this setting explicitly in code or configuration if a specific format is required for certain parts of the project.

Regarding the associated variable CVarUseDropFormatTimecodeByDefaultWhenSupported:

• Its purpose is to provide programmatic access to the timecode.UseDropFormatTimecodeByDefaultWhenSupported setting.
• It is used within the FTimecode::UseDropFormatTimecodeByDefaultWhenSupported() function to retrieve the current value of the setting.
• The value is accessed using the GetValueOnAnyThread() method, which suggests that this setting can be safely read from multiple threads.
• Developers should use this variable when they need to check the current state of the drop frame format preference in their code, rather than directly accessing the console variable.

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/Core/Private/Misc/Timecode.cpp:5

Scope: file

Source code excerpt:

static TAutoConsoleVariable<bool> CVarUseDropFormatTimecodeByDefaultWhenSupported(
	TEXT("timecode.UseDropFormatTimecodeByDefaultWhenSupported"),
	1.0f,
	TEXT("By default, should we generate a timecode in drop frame format when the frame rate does support it."),
	ECVF_Default);

/* FTimecode interface
 *****************************************************************************/

#Associated Variable and Callsites

This variable is associated with another variable named CVarUseDropFormatTimecodeByDefaultWhenSupported. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Runtime/Core/Private/Misc/Timecode.cpp:4

Scope: file

Source code excerpt:

static TAutoConsoleVariable<bool> CVarUseDropFormatTimecodeByDefaultWhenSupported(
	TEXT("timecode.UseDropFormatTimecodeByDefaultWhenSupported"),
	1.0f,
	TEXT("By default, should we generate a timecode in drop frame format when the frame rate does support it."),
	ECVF_Default);

/* FTimecode interface

#Loc: <Workspace>/Engine/Source/Runtime/Core/Private/Misc/Timecode.cpp:14

Scope (from outer to inner):

file
function     bool FTimecode::UseDropFormatTimecodeByDefaultWhenSupported

Source code excerpt:

bool FTimecode::UseDropFormatTimecodeByDefaultWhenSupported()
{
	return CVarUseDropFormatTimecodeByDefaultWhenSupported.GetValueOnAnyThread();
}