1. Epic GamesDeveloper
  3. UTimecodeSynchronizer

UTimecodeSynchronizer

API > API/Plugins > API/Plugins/TimecodeSynchronizer

   
Name UTimecodeSynchronizer
Type class
Header File /Engine/Plugins/Media/TimecodeSynchronizer/Source/TimecodeSynchronizer/Public/TimecodeSynchronizer.h
Include Path #include "TimecodeSynchronizer.h"

Syntax

UCLASS ()  
class UTimecodeSynchronizer :  
    public UTimecodeProvider ,  
    public FTickableGameObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UTimecodeSynchronizer()

 UTimecodeSynchronizer TimecodeSynchronizer.h  

Classes

Name Remarks
FOnTimecodeSynchronizationEvent Get an event delegate that is invoked when a Asset synchronization event occurred.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUsePreRollingTimecodeMarginOfErrors bool Enable verification of margin between synchronized time and source time TimecodeSynchronizer.h  
bUsePreRollingTimeout bool Enable PreRoll timeout TimecodeSynchronizer.h  
FixedFrameRate FFrameRate The fixed framerate to use. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Frame Rate Settings"
  • Meta=(ClampMin="15.0")
FrameRateSource ETimecodeSynchronizationFrameRateSources Frame Rate Source. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Frame Rate Settings"
  • Meta=(DisplayName="Frame Rate Source")
MainSynchronizationSourceIndex int32 Index of the source that drives the synchronized Timecode. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Timecode Provider"
PreRollingTimecodeMarginOfErrors int32 Maximum gap size between synchronized time and source time TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"
  • Meta=(EditCondition="bUsePreRollingTimecodeMarginOfErrors", ClampMin="0")
PreRollingTimeout float How long to wait for all source to be ready TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"
  • Meta=(EditCondition="bUsePreRollingTimeout", ClampMin="0.0", ForceUnits=s)
TimecodeProvider TObjectPtr< UTimecodeProvider > Custom strategy to tick in a interval. TimecodeSynchronizer.h
  • EditAnywhere
  • Instanced
  • Category="Timecode Provider"
  • Meta=(DisplayName="Timecode Source")
TimecodeProviderType ETimecodeSynchronizationTimecodeType Use a Timecode Provider. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Timecode Provider"
  • Meta=(DisplayName="Select")
TimeSynchronizationInputSources TArray< TObjectPtr< UTimeSynchronizationSource > > ONLY MODIFY THESE IN EDITOR TODO: Deprecate this and make it private. TimecodeSynchronizer.h
  • EditAnywhere
  • Instanced
  • Category="Input"

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveMainSynchronizationTimecodedSourceIndex int32 Index of the active source that drives the synchronized Timecode TimecodeSynchronizer.h  
ActualFrameOffset int32   TimecodeSynchronizer.h
  • Transient
  • DuplicateTransient
  • VisibleAnywhere
  • Category="Synchronization"
AutoFrameOffset int32 Similar to FrameOffset. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"
  • Meta=(ClampMin="0", ClampMax="640")
bAddSourcesGuard bool   TimecodeSynchronizer.h  
bFailGuard bool   TimecodeSynchronizer.h  
bIsTickEnabled bool   TimecodeSynchronizer.h  
bPreviousUseFixedFrameRate bool   TimecodeSynchronizer.h  
bRegistered bool Whether or not we are registered as the TimecodeProvider TimecodeSynchronizer.h  
bShouldResetTimecodeProvider bool   TimecodeSynchronizer.h  
bWithRollover bool Whether or not the specified Provider's timecode rolls over. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"
CachedPreviousTimecodeProvider TObjectPtr< UTimecodeProvider >   TimecodeSynchronizer.h
  • Transient
CachedProxiedTimecodeProvider TObjectPtr< UTimecodeProvider >   TimecodeSynchronizer.h
  • Transient
CachedSyncState FTimecodeSynchronizerCachedSyncState   TimecodeSynchronizer.h  
CurrentProviderFrameTime FFrameTime The current frame from our specified provider. TimecodeSynchronizer.h  
CurrentSystemFrameTime TOptional< FFrameTime > Frame time that we'll use for the system TimecodeSynchronizer.h  
DynamicSources TArray< TObjectPtr< UTimeSynchronizationSource > >   TimecodeSynchronizer.h
  • Transient
FrameOffset int32 When UserDefined mode is used, the number of frames delayed from the Provider's timecode. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"
  • Meta=(ClampMin="-640", ClampMax="640")
LastUpdatedSources int64   TimecodeSynchronizer.h  
NonSynchronizedSources TArray< FTimecodeSynchronizerActiveTimecodedInputSource > Sources that wants to be synchronized TimecodeSynchronizer.h
  • Transient
  • DuplicateTransient
  • VisibleAnywhere
  • Category=Debug
OnSynchronizationEvent enum UTimecodeSynchronizer::ESynchronizationState &   TimecodeSynchronizer.h  
PreviousFixedFrameRate float   TimecodeSynchronizer.h  
RegisteredCustomTimeStep TObjectPtr< UFixedFrameRateCustomTimeStep >   TimecodeSynchronizer.h
  • Transient
StartPreRollingTime double Timestamp when PreRolling has started TimecodeSynchronizer.h  
State ESynchronizationState The actual synchronization state TimecodeSynchronizer.h  
SynchronizationEvent FOnTimecodeSynchronizationEvent An event delegate that is invoked when a synchronization event occurred. TimecodeSynchronizer.h  
SynchronizedSources TArray< FTimecodeSynchronizerActiveTimecodedInputSource > Sources used for synchronization TimecodeSynchronizer.h
  • Transient
  • DuplicateTransient
  • VisibleAnywhere
  • Category=Debug
SyncMode ETimecodeSynchronizationSyncMode What mode will be used for synchronization. TimecodeSynchronizer.h
  • EditAnywhere
  • Category="Synchronization"

Functions

Public

Name Remarks Include Path Unreal Specifiers
Adds a "runtime" source to the synchronizer. TimecodeSynchronizer.h  

int32 GetActiveMainSynchronizationTimecodedSourceIndex()

 Returns the index of the Main Synchronization Source in the Synchronized Sources list. TimecodeSynchronizer.h  

FFrameTime GetCurrentSystemFrameTime()

 Get Current System Frame Time which is synchronized TimecodeSynchronizer.h  

const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & GetNonSynchronizedSources()

 Returns the list of sources that are not actively being used in synchronization. TimecodeSynchronizer.h  

const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & GetSynchronizationSources()

   TimecodeSynchronizer.h  

const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & GetSynchronizedSources()

 Returns the list of sources that are used to perform synchronization. TimecodeSynchronizer.h  

const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & GetTimecodedSources()

   TimecodeSynchronizer.h  

UTimecodeSynchronizer::FOnTimecodeSynchronizationEvent TBaseMulticastDelegate_OneParam OnSynchronizationEvent()

   TimecodeSynchronizer.h  
Starts the synchronization process. TimecodeSynchronizer.h  
Stops the synchronization process. TimecodeSynchronizer.h  

Overridden from UTimecodeProvider

Name Remarks Include Path Unreal Specifiers

virtual FQualifiedFrameTime GetQualifiedFrameTime()

   TimecodeSynchronizer.h  

virtual ETimecodeProviderSynchronizationState GetSynchronizationState()

   TimecodeSynchronizer.h  

virtual bool Initialize ( UEngine* InEngine
)

   TimecodeSynchronizer.h  

virtual void Shutdown ( UEngine* InEngine
)

   TimecodeSynchronizer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   TimecodeSynchronizer.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   TimecodeSynchronizer.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   TimecodeSynchronizer.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   TimecodeSynchronizer.h  

virtual bool IsTickableWhenPaused()

   TimecodeSynchronizer.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   TimecodeSynchronizer.h  

virtual ETickableTickType GetTickableTickType()

   TimecodeSynchronizer.h  

virtual bool IsTickable()

   TimecodeSynchronizer.h  

virtual void Tick ( float DeltaTime
)

   TimecodeSynchronizer.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString SynchronizationStateToString ( ESynchronizationState InState
)

   TimecodeSynchronizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page