1. Epic GamesDeveloper
  3. UTimecodeSynchronizer

UTimecodeSynchronizer

Unreal Engine C++ API Reference > Plugins > TimecodeSynchronizer

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UTimecodeSynchronizer :  
    public UTimecodeProvider,  
    public FTickableGameObject

Variables

  Type Name Description
Public variable UProperty bool bUsePreRollingTimecodeMarginOfErrors Enable verification of margin between synchronized time and source time
Public variable UProperty bool bUsePreRollingTimeout Enable PreRoll timeout
Public variable UProperty Category, EditAnywhere, Meta FFrameRate FixedFrameRate The fixed framerate to use.
Public variable UProperty Category, EditAnywhere, Meta ETimecodeSynchronizationFrameRateSources FrameRateSource Frame Rate Source.
Public variable UProperty Category, EditAnywhere int32 MainSynchronizationSourceIndex Index of the source that drives the synchronized Timecode.
Public variable UProperty Category, EditAnywhere, Meta int32 PreRollingTimecodeMarginOfErrors Maximum gap size between synchronized time and source time
Public variable UProperty Category, EditAnywhere, Meta float PreRollingTimeout How long to wait for all source to be ready
Public variable UProperty Category, EditAnywhere, Meta instanced TObjectPtr< UTimecodeProvider > TimecodeProvider Custom strategy to tick in a interval.
Public variable UProperty Category, EditAnywhere, Meta ETimecodeSynchronizationTimecodeType TimecodeProviderType Use a Timecode Provider.
Public variable UProperty Category, EditAnywhere instanced TArray< TObjectPtr< UTimeSynchronizationSource > > TimeSynchronizationInputSources ONLY MODIFY THESE IN EDITOR TODO: Deprecate this and make it private.

Constructors

  Type Name Description
Public function   UTimecodeSynchronizer

Functions

  Type Name Description
Public function void Adds a "runtime" source to the synchronizer.
Public function Const int32 Returns the index of the Main Synchronization Source in the Synchronized Sources list.
Public function Const FFrameTime Get Current System Frame Time which is synchronized
Public function Const const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & Returns the list of sources that are not actively being used in synchronization.
Public function Const const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & Returns the list of sources that are used to perform synchronization.
Public function UTimecodeSynchronizer::FOnTimecodeSynchronizationEvent TBaseMulticastDelegate_OneParam  
Public function bool Starts the synchronization process.
Public function void Stops the synchronization process.

Overridden from UTimecodeProvider

  Type Name Description
Public function Virtual Const FQualifiedFrameTime Return current frame time.
Public function Virtual Const ETimecodeProviderSynchronizationState The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
Public function Virtual bool

Initialize ( UEngine* InEngine
)

 This Provider became the Engine's Provider.
Public function Virtual void

Shutdown ( UEngine* InEngine
)

 This Provider stopped being the Engine's Provider.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.
Public function Virtual Const bool Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Public class FOnTimecodeSynchronizationEvent Get an event delegate that is invoked when a Asset synchronization event occurred.  

Enums

  Type Name Description
Private enum ESynchronizationState Synchronization states  

Deprecated Functions

  Type Name Description
Public function Const const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & Please use GetNonSynchronizedSources.
Public function Const const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & Please use GetSynchronizedSources.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page