Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > AjaMedia > UAjaTimecodeProvider

Light Theme

Dark Theme

UAjaTimecodeProvider

Class to fetch a timecode via an AJA card.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTimecodeProvider

UGenlockedTimecodeProvider

UAjaTimecodeProvider

References

Module	AjaMedia
Header	/Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h
Include	#include "AjaTimecodeProvider.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew,
       Meta=(DisplayName="AJA SDI Input", MediaIOCustomLayout="AJA"))
class UAjaTimecodeProvider :
    public UGenlockedTimecodeProvider,
    public FTickableGameObject

Remarks

Class to fetch a timecode via an AJA card. When the signal is lost in the editor (not in PIE), the TimecodeProvider will try to re-synchronize every second.

Variables

	Name	Description
bool	bUseDedicatedPin	Should we read the timecode from a dedicated LTC pin or an SDI input.
bool	bUseReferenceIn	Read LTC timecode from reference pin. Will fail if device doesn't support that feature.
FAjaMediaTimeco...	LTCConfiguration	Where to read LTC timecode from with which FrameRate expected
FAjaMediaTimeco...	VideoConfiguration	It read the timecode from an input source.

Constructors

	Name	Description
	UAjaTimecodeProvider ( const FObjectInitializer& ObjectIn... )

Overridden from UTimecodeProvider

	Name	Description
bool	FetchTimecode ( FQualifiedFrameTime& OutFrameTime )	Fetch current timecode from its source.
ETimecodePro...	GetSynchronizationState()	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
bool	Initialize ( UEngine* InEngine )	This Provider became the Engine's Provider.
void	Shutdown ( UEngine* InEngine )	This Provider stopped being the Engine's Provider.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.
	bool	IsTickableWhenPaused()	Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
ETickableTic...	GetTickableTickType()	Virtual that can be overloaded by the inheriting class.
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Classes

	Name	Description
	FAJACallback

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

Take our survey

Dismiss