className: EAjaHDRMetadataEOTF

description: HDR Transfer function. Must matchAJA::EAjaHDRMetadataEOTF.

module: AjaMedia

code: enum EAjaHDRMetadataEOTF { SDR, HLG, PQ, }


className: EAjaHDRMetadataGamut

description: HDR Color Gamut. Must matchAJA::EAjaHDRMetadataGamut.

code: enum EAjaHDRMetadataGamut { Rec709, Rec2020, }


className: EAjaMediaAudioChannel

description: Available number of audio channel supported by Unreal Engine & AJA

code: enum EAjaMediaAudioChannel { Channel6, Channel8, }


className: EAjaMediaSourceColorFormat

description: Native data format.

code: enum EAjaMediaSourceColorFormat { YUV2_8bit, YUV_10bit, }


description: Auto detect sources that are currently streaming to the device

code: void AutoDetectConfiguration ( [FOnConfigurationAutoDetected](API\Plugins\AjaMedia\FAjaDeviceProvider\FOnConfigurationAutoDetected) OnAutoDetected )


description: Can device do fill and key

code: bool CanDeviceDoAlpha ( const [FMediaIODevice](API\Plugins\MediaIOCore\FMediaIODevice) & InDevice ) const


code: void EndAutoDetectConfiguration()


className: FMediaIOConfigurationWithTimecodeFormat

Configuration

type: FMediaIOConfigu...

TimecodeFormat

type: EMediaIOTimecod...


className: FOnConfigurationAutoDetected

code: typedef TBaseDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConfigurationWithTimecodeFormat](API\Plugins\AjaMedia\FAjaDeviceProvider\FMediaIOConfigurationWithTimecod-) > > FOnConfigurationAutoDetected


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) > GetConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) > GetConfigurations ( bool bAllowInput, bool bAllowOutput ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOConnection](API\Plugins\MediaIOCore\FMediaIOConnection) > GetConnections() const


code: virtual [FMediaIOConfiguration](API\Plugins\MediaIOCore\FMediaIOConfiguration) GetDefaultConfiguration() const


code: virtual [FMediaIOMode](API\Plugins\MediaIOCore\FMediaIOMode) GetDefaultMode() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIODevice](API\Plugins\MediaIOCore\FMediaIODevice) > GetDevices() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOInputConfiguration](API\Plugins\MediaIOCore\FMediaIOInputConfiguration) > GetInputConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOMode](API\Plugins\MediaIOCore\FMediaIOMode) > GetModes ( const [FMediaIODevice](API\Plugins\MediaIOCore\FMediaIODevice) & InDevice, bool bInOutput ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOOutputConfiguration](API\Plugins\MediaIOCore\FMediaIOOutputConfiguration) > GetOutputConfigurations() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FMediaIOVideoTimecodeConfiguration](API\Plugins\MediaIOCore\FMediaIOVideoTimecodeConfigurati-) > GetTimecodeConfigurations() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FAjaMediaTimecodeReference](API\Plugins\AjaMedia\FAjaMediaTimecodeReference) > GetTimecodeReferences() const


code: [FAjaDeviceProvider](API\Plugins\AjaMedia\FAjaDeviceProvider) & operator= ( const [FAjaDeviceProvider](API\Plugins\AjaMedia\FAjaDeviceProvider) & )


code: FAjaDeviceProvider ( const [FAjaDeviceProvider](API\Plugins\AjaMedia\FAjaDeviceProvider) & )


className: FAjaDeviceProvider

description: Implementation ofIMediaIOCoreDeviceProviderfor AJA

code: class FAjaDeviceProvider : public [IMediaIOCoreDeviceProvider](API\Plugins\MediaIOCore\IMediaIOCoreDeviceProvider)


className: FAjaMediaHDROptions

description: Set of metadata describing a HDR video signal.

EOTF

type: EAjaHDRMetadata...

description: Transfer function to use for converting the video signal to an optical signal.

Gamut

description: The color gamut of the video signal.


description: Used by the UX to have a default selected value. May not be valid with every device.


code: bool operator== ( const [FAjaMediaTimecodeConfiguration](API\Plugins\AjaMedia\FAjaMediaTimecodeConfiguration) & Other ) const


description: Return true if the configuration has been set properly

code: bool IsValid() const


description:
Get the configuration text representation.
String representation, i.e. "Video/Single1/1080p30fps/LTC".


code: FAjaMediaTimecodeConfiguration()


className: FAjaMediaTimecodeConfiguration

description: Configuration of an AJA timecode from Video

MediaConfiguration

description: Read the timecode from a video signal.

TimecodeFormat

description: Timecode format to read from a video signal.


code: bool operator== ( const [FAjaMediaTimecodeReference](API\Plugins\AjaMedia\FAjaMediaTimecodeReference) & Other ) const


description: Get the configuration text representation.


className: FAjaMediaTimecodeReference

description: Configuration of an AJA timecode.

Device

type: FMediaIODevice

description: The frame rate of the LTC from the reference pin.

LtcFrameRate

type: FFrameRate

LtcIndex

description: The LTC index to read from the reference pin.


description: true if the Aja card can be used

code: bool CanBeUsed() const


description:
Create an AJA based media player.
A new media player, or nullptr if a player couldn't be created.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > CreatePlayer ( [IMediaEventSink](API\Runtime\Media\IMediaEventSink) & EventSink )


code: static [IAjaMediaModule](API\Plugins\AjaMedia\IAjaMediaModule) & Get()


description: SlateStyleSet to be used across the AjaMedia module


description: true if the Aja module and AJA dll could be loaded

code: bool IsInitialized() const


className: IAjaMediaModule

description: Interface for the AjaMedia module.

code: class IAjaMediaModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual void OnInitializationCompleted &40; bool bSucceed &41;


code: FAJACallback &40; UAjaCustomTimeStep &42; InOwner &41;


className: FAJACallback

code: struct FAJACallback : public [AJA::IAJASyncChannelCallbackInterface](API\Plugins\AjaCore\IAJASyncChannelCallbackInterface)

Owner

type: UAjaCustomTimeS...


description: Get The fixed FrameRate

code: virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const


description: The state of the CustomTimeStep.

code: virtual ECustomTimeStepSynchronizationState GetSynchronizationState() const


description: Get the sync rate (not always the same as the fixed frame rate)

code: virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetSyncRate() const


description: This CustomTimeStep became the Engine's CustomTimeStep.

code: virtual bool Initialize ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Returns how many syncs occurred since the last tick

code: virtual uint32 GetLastSyncCountDelta() const


description: Returns true if the Sync related functions will return valid data

code: virtual bool IsLastSyncDataValid() const


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: This CustomTimeStep stop being the Engine's CustomTimeStep.

code: virtual void Shutdown ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Whether automatic format detection is supported.

code: virtual bool SupportsFormatAutoDetection() const


description:
Update FApp::CurrentTime/FApp::DeltaTime and optionally wait until the end of the frame.
true if the Engine's TimeStep should also be performed; false otherwise.

code: virtual bool UpdateTimeStep ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Blocks until it gets a sync signal. Returns false if unsuccessful

code: virtual bool WaitForSync()


code: UAjaCustomTimeStep ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UAjaCustomTimeStep

description: Control the Engine TimeStep via the AJA card. When the signal is lost in the editor (not in PIE), the CustomTimeStep will try to re-synchronize every second.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew, Meta=(DisplayName="AJA SDI Input", MediaIOCustomLayout="AJA")) class UAjaCustomTimeStep : public [UGenlockedCustomTimeStep](API\Runtime\TimeManagement\UGenlockedCustomTimeStep)

bEnableOverrunDetection

type: bool

description: Enable mechanism to detect Engine loop overrunning the source

bUseReferenceIn

description: If true, the Engine will wait for a signal coming in from the Reference In pin.

bWaitForFrameToBeReady

description: If true, the Engine will wait for the frame to be read.

MediaConfiguration

description: The device, port and video settings that correspond to where the Genlock signal will be coming from

TimecodeFormat

description: The type of Timecode to read from SDI stream.


className: UAjaMediaSettings

description: Settings for the AjaMedia plug-in.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=AjaMedia) class UAjaMediaSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description:
Get a Boolean media option.
The option value.

code: virtual bool GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool DefaultValue ) const


description:
Get a signed integer media option.
The option value.

code: virtual int64 GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 DefaultValue ) const


description:
Get a string media option.
The option value.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue ) const


description: GetProxies

code: virtual [FString](API\Runtime\Core\Containers\FString) GetUrl() const


description:
Check whether the specified option is set.
true if the option is set, false otherwise.

code: virtual bool HasMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description:
Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise.

code: virtual bool Validate() const


className: UAjaMediaSource

description: No constructors are accessible with public or protected access.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="AJA")) class UAjaMediaSource : public [UCaptureCardMediaSource](API\Plugins\MediaIOCore\UCaptureCardMediaSource)

AudioChannel

type: EAjaMediaAudioC...

description: Desired number of audio channel to capture.

AutoDetectableTimecodeFormat

type: EMediaIOAutoDet...

description: Use the time code embedded in the input stream.

bCaptureAncillary

description: Capture Ancillary from the AJA source. It will decrease performance

bCaptureAudio

description: Capture Audio from the AJA source.

bCaptureVideo

description: Capture Video from the AJA source.

bCaptureWithAutoCirculating

description: Use a ring buffer to capture and transfer data.

bEncodeTimecodeInTexel

description: Burn Frame Timecode in the input texture without any frame number clipping.

bLogDropFrame

description: Log a warning when there's a drop frame.

ColorFormat

type: EAjaMediaSource...

description: Native data format internally used by the device after being converted from SDI/HDMI signal.

MaxNumAncillaryFrameBuffer

description: Maximum number of ancillary data frames to buffer.

MaxNumAudioFrameBuffer

description: Maximum number of audio frames to buffer.

MaxNumVideoFrameBuffer

description: Maximum number of video frames to buffer.

MediaConfiguration

description: The device, port and video settings that correspond to the input.


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual void OnInitializationCompleted &40; bool bSucceed &41;


code: FAJACallback &40; UAjaTimecodeProvider &42; InOwner &41;


code: struct FAJACallback : public [AJA::IAJATimecodeChannelCallbackInterface](API\Plugins\AjaCore\IAJATimecodeChannelCallbackInter-)

Owner

type: UAjaTimecodePro...


description: Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode.

code: virtual bool FetchTimecode ( [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & OutFrameTime )


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description: The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.

code: virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


description: This Provider became the Engine's Provider.

code: virtual bool Initialize ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Get whether this provider is currently using autodetection.

code: virtual bool IsAutoDetected() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if object is ready to be ticked, false otherwise.

code: virtual bool IsTickable() const


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


description:
Used to determine if an object should be ticked when the game is paused. Defaults to false, as that mimics old behavior.
true if it should be ticked when paused, false otherwise

code: virtual bool IsTickableWhenPaused() const


description: Set the autodetected flag on this provider.

code: virtual void SetIsAutoDetected ( bool bInIsAutoDetected )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: This Provider stopped being the Engine's Provider.

code: virtual void Shutdown ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine )


description: Whether this provider supports format autodetection.

code: virtual bool SupportsAutoDetected() const


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


className: UAjaTimecodeProvider

description: 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.

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

bUseDedicatedPin

description: Should we read the timecode from a dedicated LTC pin or an SDI input.

bUseReferenceIn

description: Read LTC timecode from reference pin. Will fail if device doesn't support that feature.

LTCConfiguration

type: FAjaMediaTimeco...

description: Where to read LTC timecode from with which FrameRate expected

TimecodeConfiguration

type: FMediaIOVideoTi...

description: Use the time code embedded in the input stream. Timecode format to read from a video signal.