Navigation
API > API/Plugins > API/Plugins/TimecodeSynchronizer
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UTimecodeProvider
- UTimecodeSynchronizer
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 | |
|---|---|---|---|
  |
bool | bUsePreRollingTimecodeMarginOfErrors | Enable verification of margin between synchronized time and source time |
  |
bool | bUsePreRollingTimeout | Enable PreRoll timeout |
   |
FFrameRate | FixedFrameRate | The fixed framerate to use. |
   |
ETimecodeSynchronizationFrameRateSources | FrameRateSource | Frame Rate Source. |
   |
int32 | MainSynchronizationSourceIndex | Index of the source that drives the synchronized Timecode. |
   |
int32 | PreRollingTimecodeMarginOfErrors | Maximum gap size between synchronized time and source time |
   |
float | PreRollingTimeout | How long to wait for all source to be ready |
    |
TObjectPtr< UTimecodeProvider > | TimecodeProvider | Custom strategy to tick in a interval. |
   |
ETimecodeSynchronizationTimecodeType | TimecodeProviderType | Use a Timecode Provider. |
    |
TArray< TObjectPtr< UTimeSynchronizationSource > > | TimeSynchronizationInputSources | ONLY MODIFY THESE IN EDITOR TODO: Deprecate this and make it private. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UTimecodeSynchronizer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Adds a "runtime" source to the synchronizer. | |
  |
int32 | Returns the index of the Main Synchronization Source in the Synchronized Sources list. | |
  |
FFrameTime | Get Current System Frame Time which is synchronized | |
  |
const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & | Returns the list of sources that are not actively being used in synchronization. | |
  |
const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & | Returns the list of sources that are used to perform synchronization. | |
 |
UTimecodeSynchronizer::FOnTimecodeSynchronizationEvent TBaseMulticastDelegate_OneParam | ||
 |
bool | Starts the synchronization process. | |
 |
void | Stops the synchronization process. |
Overridden from UTimecodeProvider
| Type | Name | Description | |
|---|---|---|---|
   |
FQualifiedFrameTime | Return current frame time. | |
   |
ETimecodeProviderSynchronizationState | 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 | This Provider stopped being the Engine's Provider. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
Called before destroying the object. |
   |
bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. |
  |
void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. |
Overridden from FTickableGameObject
| Type | Name | Description | |
|---|---|---|---|
   |
bool | Used to determine whether the object should be ticked in the editor. | |
   |
bool | Used to determine if an object should be ticked when the game is paused. |
Overridden from FTickableObjectBase
| Type | Name | Description | |
|---|---|---|---|
   |
TStatId | GetStatId () |
Return the stat id to use for this tickable |
   |
ETickableTickType | 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
| Type | Name | Description | |
|---|---|---|---|
 |
FOnTimecodeSynchronizationEvent | Get an event delegate that is invoked when a Asset synchronization event occurred. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
ESynchronizationState | Synchronization states |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & | Please use GetNonSynchronizedSources. | |
  |
const TArray< FTimecodeSynchronizerActiveTimecodedInputSource > & | Please use GetSynchronizedSources. |