Navigation
API > API/Plugins > API/Plugins/AjaMedia
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.
| Name | UAjaTimecodeProvider |
| Type | class |
| Header File | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h |
| Include Path | #include "AjaTimecodeProvider.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew,
Meta=(DisplayName="AJA SDI Input", MediaIOCustomLayout="AJA"))
class UAjaTimecodeProvider :
public UGenlockedTimecodeProvider,
public FTickableGameObject
Inheritance Hierarchy
- FTickableObjectBase → FTickableGameObject → UAjaTimecodeProvider
- UObjectBase → UObjectBaseUtility → UObject → UTimecodeProvider → UGenlockedTimecodeProvider → UAjaTimecodeProvider
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAjaTimecodeProvider() |
AjaTimecodeProvider.h |
Structs
| Name | Remarks |
|---|---|
| FAJACallback |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAutoDetectTimecode | bool | AjaTimecodeProvider.h | ||
| bUseDedicatedPin | bool | Should we read the timecode from a dedicated LTC pin or an SDI input. | AjaTimecodeProvider.h |
|
| bUseReferenceIn | bool | Read LTC timecode from reference pin. Will fail if device doesn't support that feature. | AjaTimecodeProvider.h |
|
| LTCConfiguration | FAjaMediaTimecodeReference | Where to read LTC timecode from with which FrameRate expected | AjaTimecodeProvider.h |
|
| TimecodeConfiguration | FMediaIOVideoTimecodeConfiguration | Use the time code embedded in the input stream. Timecode format to read from a video signal. | AjaTimecodeProvider.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DeviceProvider | TUniquePtr< FAjaDeviceProvider > | AjaTimecodeProvider.h | ||
| FAJACallback | friend | AjaTimecodeProvider.h | ||
| InitializedEngine | TObjectPtr< UEngine > | Engine used to initialize the Provider | AjaTimecodeProvider.h |
|
| LastAutoSynchronizeInEditorAppTime | double | The time the last attempt to auto synchronize was triggered. | AjaTimecodeProvider.h | |
| State | ETimecodeProviderSynchronizationState | The current SynchronizationState of the TimecodeProvider | AjaTimecodeProvider.h | |
| SyncCallback | FAJACallback * | AjaTimecodeProvider.h | ||
| TimecodeChannel | AJA::AJATimecodeChannel * | AJA channel associated with reading LTC timecode | AjaTimecodeProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
AjaTimecodeProvider.h | ||
virtual bool FetchTimecode
(
FQualifiedFrameTime& OutFrameTime |
AjaTimecodeProvider.h | ||
virtual ETimecodeProviderSynchronizationState GetSynchronizationState() |
AjaTimecodeProvider.h | ||
virtual bool Initialize
(
UEngine* InEngine |
AjaTimecodeProvider.h | ||
virtual bool IsAutoDetected() |
AjaTimecodeProvider.h | ||
virtual void PostLoad() |
AjaTimecodeProvider.h | ||
virtual void Serialize
(
FArchive& Ar |
AjaTimecodeProvider.h | ||
virtual void SetIsAutoDetected
(
bool bInIsAutoDetected |
AjaTimecodeProvider.h | ||
virtual void Shutdown
(
UEngine* InEngine |
AjaTimecodeProvider.h | ||
virtual bool SupportsAutoDetected() |
AjaTimecodeProvider.h |
Overridden from FTickableGameObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsTickableInEditor() |
AjaTimecodeProvider.h | ||
virtual bool IsTickableWhenPaused() |
AjaTimecodeProvider.h |
Overridden from FTickableObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TStatId GetStatId() |
AjaTimecodeProvider.h | ||
virtual ETickableTickType GetTickableTickType() |
AjaTimecodeProvider.h | ||
virtual bool IsTickable() |
AjaTimecodeProvider.h | ||
virtual void Tick
(
float DeltaTime |
AjaTimecodeProvider.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| VideoConfiguration_DEPRECATED | FAjaMediaTimecodeConfiguration | It read the timecode from an input source. | AjaTimecodeProvider.h |
|