className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 3
36
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
FAjaMediaTimecodeConfiguration::operator== | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | AjaMedia | bool operator== ( const [FAjaMediaTimecodeConfiguration](API\Plugins\AjaMedia\FAjaMediaTimecodeConfiguration) & Other ) const | []
|
|
FAjaMediaTimecodeConfiguration::IsValid | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Return true if the configuration has been set properly | AjaMedia | bool IsValid() const | []
|
FAjaMediaTimecodeConfiguration::ToText | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Get the configuration text representation.
String representation, i.e. "Video/Single1/1080p30fps/LTC". | AjaMedia | [FText](API\Runtime\Core\Internationalization\FText) ToText() const | []
|
FAjaMediaTimecodeConfiguration::FAjaMediaTimecodeConfiguration | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | AjaMedia | FAjaMediaTimecodeConfiguration() | []
|
|
FAjaMediaTimecodeConfiguration | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Configuration of an AJA timecode from Video | AjaMedia | [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FAjaMediaTimecodeConfiguration | [
{
"type": "FMediaIOConfigu...",
"name": "MediaConfiguration",
"description": "Read the timecode from a video signal."
},
{
"type": "EMediaIOTimecod...",
"name": "TimecodeFormat",
"description": "Timecode format to read from a video signal."
}
]
|
FAjaMediaTimecodeReference::GetDefault | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Used by the UX to have a default selected value. May not be valid with every device. | AjaMedia | static [FAjaMediaTimecodeReference](API\Plugins\AjaMedia\FAjaMediaTimecodeReference) GetDefault() | []
|
FAjaMediaTimecodeReference::IsValid | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Return true if the configuration has been set properly | AjaMedia | bool IsValid() const | []
|
FAjaMediaTimecodeReference::operator== | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | AjaMedia | bool operator== ( const [FAjaMediaTimecodeReference](API\Plugins\AjaMedia\FAjaMediaTimecodeReference) & Other ) const | []
|
|
FAjaMediaTimecodeReference::ToText | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Get the configuration text representation. | AjaMedia | [FText](API\Runtime\Core\Internationalization\FText) ToText() const | []
|
FAjaMediaTimecodeReference::FAjaMediaTimecodeReference | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | AjaMedia | FAjaMediaTimecodeReference() | []
|
|
FAjaMediaTimecodeReference | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaDeviceProvider.h | Configuration of an AJA timecode. | AjaMedia | [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FAjaMediaTimecodeReference | [
{
"type": "FMediaIODevice",
"name": "Device",
"description": "The frame rate of the LTC from the reference pin."
},
{
"type": "FFrameRate",
"name": "LtcFrameRate",
"description": "The frame rate of the LTC from the reference pin."
},
{
"type": "int32",
"name": "LtcIndex",
"description": "The LTC index to read from the reference pin."
}
]
|
IAjaMediaModule::CanBeUsed | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | true if the Aja card can be used | AjaMedia | bool CanBeUsed() const | []
|
IAjaMediaModule::CreatePlayer | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | Create an AJA based media player.
A new media player, or nullptr if a player couldn't be created. | AjaMedia | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > CreatePlayer ( [IMediaEventSink](API\Runtime\Media\IMediaEventSink) & EventSink ) | []
|
IAjaMediaModule::Get | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | AjaMedia | static [IAjaMediaModule](API\Plugins\AjaMedia\IAjaMediaModule) & Get() | []
|
|
IAjaMediaModule::GetStyle | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | SlateStyleSet to be used across the AjaMedia module | AjaMedia | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > GetStyle() | []
|
IAjaMediaModule::IsInitialized | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | true if the Aja module and AJA dll could be loaded | AjaMedia | bool IsInitialized() const | []
|
IAjaMediaModule | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/IAjaMediaModule.h | Interface for the AjaMedia module. | AjaMedia | class IAjaMediaModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
UAjaCustomTimeStep::BeginDestroy | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | 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. | AjaMedia | virtual void BeginDestroy() | []
|
UAjaCustomTimeStep::FAJACallback::OnInitializationCompleted | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaCustomTimeStep.cpp | AjaMedia | virtual void OnInitializationCompleted &40; bool bSucceed &41; | []
|
|
UAjaCustomTimeStep::FAJACallback::FAJACallback | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaCustomTimeStep.cpp | AjaMedia | FAJACallback &40; UAjaCustomTimeStep &42; InOwner &41; | []
|
|
FAJACallback | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaCustomTimeStep.cpp | AjaMedia | struct FAJACallback : public [AJA::IAJASyncChannelCallbackInterface](API\Plugins\AjaCore\IAJASyncChannelCallbackInterface) | [
{
"type": "UAjaCustomTimeS...",
"name": "Owner",
"description": ""
}
]
|
|
UAjaCustomTimeStep::GetFixedFrameRate | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Get The fixed FrameRate | AjaMedia | virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetFixedFrameRate() const | []
|
UAjaCustomTimeStep::GetSynchronizationState | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | The state of the CustomTimeStep. | AjaMedia | virtual ECustomTimeStepSynchronizationState GetSynchronizationState() const | []
|
UAjaCustomTimeStep::GetSyncRate | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Get the sync rate (not always the same as the fixed frame rate) | AjaMedia | virtual [FFrameRate](API\Runtime\Core\Misc\FFrameRate) GetSyncRate() const | []
|
UAjaCustomTimeStep::Initialize | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | This CustomTimeStep became the Engine's CustomTimeStep. | AjaMedia | virtual bool Initialize ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine ) | []
|
UAjaCustomTimeStep::GetLastSyncCountDelta | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Returns how many syncs occurred since the last tick | AjaMedia | virtual uint32 GetLastSyncCountDelta() const | []
|
UAjaCustomTimeStep::IsLastSyncDataValid | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Returns true if the Sync related functions will return valid data | AjaMedia | virtual bool IsLastSyncDataValid() const | []
|
UAjaCustomTimeStep::PostEditChangeChainProperty | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | 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. | AjaMedia | virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent ) | []
|
UAjaCustomTimeStep::Shutdown | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | This CustomTimeStep stop being the Engine's CustomTimeStep. | AjaMedia | virtual void Shutdown ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine ) | []
|
UAjaCustomTimeStep::SupportsFormatAutoDetection | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Whether automatic format detection is supported. | AjaMedia | virtual bool SupportsFormatAutoDetection() const | []
|
UAjaCustomTimeStep::UpdateTimeStep | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | 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. | AjaMedia | virtual bool UpdateTimeStep ( [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine ) | []
|
UAjaCustomTimeStep::WaitForSync | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | Blocks until it gets a sync signal. Returns false if unsuccessful | AjaMedia | virtual bool WaitForSync() | []
|
UAjaCustomTimeStep::UAjaCustomTimeStep | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | AjaMedia | UAjaCustomTimeStep ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | []
|
|
UAjaCustomTimeStep | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaCustomTimeStep.h | 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. | AjaMedia | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, EditInlineNew, Meta=(DisplayName="AJA SDI Input", MediaIOCustomLayout="AJA")) class UAjaCustomTimeStep : public [UGenlockedCustomTimeStep](API\Runtime\TimeManagement\UGenlockedCustomTimeStep) | [
{
"type": "bool",
"name": "bEnableOverrunDetection",
"description": "Enable mechanism to detect Engine loop overrunning the source"
},
{
"type": "bool",
"name": "bUseReferenceIn",
"description": "If true, the Engine will wait for a signal coming in from the Reference In pin."
},
{
"type": "bool",
"name": "bWaitForFrameToBeReady",
"description": "If true, the Engine will wait for the frame to be read."
},
{
"type": "FMediaIOConfigu...",
"name": "MediaConfiguration",
"description": "The device, port and video settings that correspond to where the Genlock signal will be coming from"
},
{
"type": "EMediaIOTimecod...",
"name": "TimecodeFormat",
"description": "The type of Timecode to read from SDI stream."
}
]
|
UAjaMediaSettings | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSettings.h | Settings for the AjaMedia plug-in. | AjaMedia | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=AjaMedia) class UAjaMediaSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject) | []
|
UAjaMediaSource::CanEditChange | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | 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 | AjaMedia | virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const | []
|
UAjaMediaSource::GetMediaOption | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | Get a Boolean media option.
The option value. | AjaMedia | virtual bool GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, bool DefaultValue ) const | []
|
UAjaMediaSource::GetMediaOption | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | Get a signed integer media option.
The option value. | AjaMedia | virtual int64 GetMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key, int64 DefaultValue ) const | []
|
UAjaMediaSource::GetMediaOption | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | Get a string media option.
The option value. | AjaMedia | 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 | []
|
UAjaMediaSource::GetUrl | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | GetProxies | AjaMedia | virtual [FString](API\Runtime\Core\Containers\FString) GetUrl() const | []
|
UAjaMediaSource::HasMediaOption | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | Check whether the specified option is set.
true if the option is set, false otherwise. | AjaMedia | virtual bool HasMediaOption ( const [FName](API\Runtime\Core\UObject\FName) & Key ) const | []
|
UAjaMediaSource::PostEditChangeChainProperty | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | 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. | AjaMedia | virtual void PostEditChangeChainProperty ( struct [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent ) | []
|
UAjaMediaSource::PostLoad | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | 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. | AjaMedia | virtual void PostLoad() | []
|
UAjaMediaSource::SupportsFormatAutoDetection | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | AjaMedia | virtual bool SupportsFormatAutoDetection() const | []
|
|
UAjaMediaSource::Validate | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | Validate the media source settings (must be implemented in child classes).
true if validation passed, false otherwise. | AjaMedia | virtual bool Validate() const | []
|
UAjaMediaSource | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h | No constructors are accessible with public or protected access. | AjaMedia | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="AJA")) class UAjaMediaSource : public [UCaptureCardMediaSource](API\Plugins\MediaIOCore\UCaptureCardMediaSource) | [
{
"type": "EAjaMediaAudioC...",
"name": "AudioChannel",
"description": "Desired number of audio channel to capture."
},
{
"type": "EMediaIOAutoDet...",
"name": "AutoDetectableTimecodeFormat",
"description": "Use the time code embedded in the input stream."
},
{
"type": "bool",
"name": "bCaptureAncillary",
"description": "Capture Ancillary from the AJA source. It will decrease performance"
},
{
"type": "bool",
"name": "bCaptureAudio",
"description": "Capture Audio from the AJA source."
},
{
"type": "bool",
"name": "bCaptureVideo",
"description": "Capture Video from the AJA source."
},
{
"type": "bool",
"name": "bCaptureWithAutoCirculating",
"description": "Use a ring buffer to capture and transfer data."
},
{
"type": "bool",
"name": "bEncodeTimecodeInTexel",
"description": "Burn Frame Timecode in the input texture without any frame number clipping."
},
{
"type": "bool",
"name": "bLogDropFrame",
"description": "Log a warning when there's a drop frame."
},
{
"type": "EAjaMediaSource...",
"name": "ColorFormat",
"description": "Native data format internally used by the device after being converted from SDI/HDMI signal."
},
{
"type": "int32",
"name": "MaxNumAncillaryFrameBuffer",
"description": "Maximum number of ancillary data frames to buffer."
},
{
"type": "int32",
"name": "MaxNumAudioFrameBuffer",
"description": "Maximum number of audio frames to buffer."
},
{
"type": "int32",
"name": "MaxNumVideoFrameBuffer",
"description": "Maximum number of video frames to buffer."
},
{
"type": "FMediaIOConfigu...",
"name": "MediaConfiguration",
"description": "The device, port and video settings that correspond to the input."
}
]
|
UAjaTimecodeProvider::BeginDestroy | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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. | AjaMedia | virtual void BeginDestroy() | []
|
UAjaTimecodeProvider::FAJACallback::OnInitializationCompleted | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaTimecodeProvider.cpp | AjaMedia | virtual void OnInitializationCompleted &40; bool bSucceed &41; | []
|
|
UAjaTimecodeProvider::FAJACallback::FAJACallback | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaTimecodeProvider.cpp | AjaMedia | FAJACallback &40; UAjaTimecodeProvider &42; InOwner &41; | []
|
|
FAJACallback | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Private/Assets/AjaTimecodeProvider.cpp | AjaMedia | struct FAJACallback : public [AJA::IAJATimecodeChannelCallbackInterface](API\Plugins\AjaCore\IAJATimecodeChannelCallbackInter-) | [
{
"type": "UAjaTimecodePro...",
"name": "Owner",
"description": ""
}
]
|
|
UAjaTimecodeProvider::FetchTimecode | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Fetch current timecode from its source. e.g. From hardware/network/file/etc. It is recommended to cache the fetched timecode. | AjaMedia | virtual bool FetchTimecode ( [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & OutFrameTime ) | []
|
UAjaTimecodeProvider::GetStatId | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Return the stat id to use for this tickable | AjaMedia | virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const | []
|
UAjaTimecodeProvider::GetSynchronizationState | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid. | AjaMedia | virtual ETimecodeProviderSynchronizationState GetSynchronizationState() const | []
|
UAjaTimecodeProvider::GetTickableTickType | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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. | AjaMedia | virtual ETickableTickType GetTickableTickType() const | []
|
UAjaTimecodeProvider::Initialize | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | This Provider became the Engine's Provider. | AjaMedia | virtual bool Initialize ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine ) | []
|
UAjaTimecodeProvider::IsAutoDetected | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Get whether this provider is currently using autodetection. | AjaMedia | virtual bool IsAutoDetected() const | []
|
UAjaTimecodeProvider::IsTickable | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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. | AjaMedia | virtual bool IsTickable() const | []
|
UAjaTimecodeProvider::IsTickableInEditor | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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 | AjaMedia | virtual bool IsTickableInEditor() const | []
|
UAjaTimecodeProvider::IsTickableWhenPaused | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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 | AjaMedia | virtual bool IsTickableWhenPaused() const | []
|
UAjaTimecodeProvider::PostLoad | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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. | AjaMedia | virtual void PostLoad() | []
|
UAjaTimecodeProvider::SetIsAutoDetected | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Set the autodetected flag on this provider. | AjaMedia | virtual void SetIsAutoDetected ( bool bInIsAutoDetected ) | []
|
UAjaTimecodeProvider::Serialize | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables. | AjaMedia | virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar ) | []
|
UAjaTimecodeProvider::Shutdown | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | This Provider stopped being the Engine's Provider. | AjaMedia | virtual void Shutdown ( class [UEngine](API\Runtime\Engine\Engine\UEngine) * InEngine ) | []
|
UAjaTimecodeProvider::SupportsAutoDetected | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | Whether this provider supports format autodetection. | AjaMedia | virtual bool SupportsAutoDetected() const | []
|
UAjaTimecodeProvider::Tick | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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) | AjaMedia | virtual void Tick ( float DeltaTime ) | []
|
UAjaTimecodeProvider::UAjaTimecodeProvider | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | AjaMedia | UAjaTimecodeProvider() | []
|
|
UAjaTimecodeProvider | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaTimecodeProvider.h | 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. | AjaMedia | [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) | [
{
"type": "bool",
"name": "bAutoDetectTimecode",
"description": ""
},
{
"type": "bool",
"name": "bUseDedicatedPin",
"description": "Should we read the timecode from a dedicated LTC pin or an SDI input."
},
{
"type": "bool",
"name": "bUseReferenceIn",
"description": "Read LTC timecode from reference pin. Will fail if device doesn't support that feature."
},
{
"type": "FAjaMediaTimeco...",
"name": "LTCConfiguration",
"description": "Where to read LTC timecode from with which FrameRate expected"
},
{
"type": "FMediaIOVideoTi...",
"name": "TimecodeConfiguration",
"description": "Use the time code embedded in the input stream. Timecode format to read from a video signal."
}
]
|
EAjaMediaOutputAudioSampleRate | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaOutput.h | AjaMediaOutput | enum EAjaMediaOutputAudioSampleRate { SR_48k = 48000, } | []
|
|
EAjaMediaOutputChannelConfiguration | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaOutput.h | Number of output audio channels | AjaMediaOutput | enum EAjaMediaOutputChannelConfiguration { CH_6 = 6, CH_8 = 8, CH_16 = 16, } | []
|
EAjaMediaOutputPixelFormat | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaOutput.h | Native data format. | AjaMediaOutput | enum EAjaMediaOutputPixelFormat { PF_8BIT_YUV, PF_10BIT_YUV, } | []
|
IAjaMediaOutputModule::Get | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/IAjaMediaOutputModule.h | Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed | AjaMediaOutput | static [IAjaMediaOutputModule](API\Plugins\AjaMediaOutput\IAjaMediaOutputModule) & Get() | []
|
IAjaMediaOutputModule::IsAvailable | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/IAjaMediaOutputModule.h | Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use | AjaMediaOutput | static bool IsAvailable() | []
|
IAjaMediaOutputModule | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/IAjaMediaOutputModule.h | The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin. | AjaMediaOutput | class IAjaMediaOutputModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | []
|
UAjaFrameGrabberProtocol::CanWriteToFileImpl | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | Test whether this capture protocol thinks the file should be written to. Only called when we're not overwriting existing files.Bydefault, we simply test for the file's existence, however this can be overridden to afford complex behaviour like writing out multiple video files for different file names
Whether we should deem this file writable or not | AjaMediaOutput | virtual bool CanWriteToFileImpl ( const TCHAR * InFilename, bool bOverwriteExisting ) const | []
|
UAjaFrameGrabberProtocol::FinalizeImpl | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | Called when we have finished capturing | AjaMediaOutput | virtual void FinalizeImpl() | []
|
UAjaFrameGrabberProtocol::HasFinishedProcessingImpl | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | Check whether this protocol has any processing left to do, or whether it should be finalized. Only called when the capture has been asked to end. | AjaMediaOutput | virtual bool HasFinishedProcessingImpl() const | []
|
UAjaFrameGrabberProtocol::StartCaptureImpl | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | ~UMovieSceneCaptureProtocolBase implementation | AjaMediaOutput | virtual bool StartCaptureImpl() | []
|
UAjaFrameGrabberProtocol::UAjaFrameGrabberProtocol | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | UAjaFrameGrabberProtocol | AjaMediaOutput | UAjaFrameGrabberProtocol ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjInit ) | []
|
UAjaFrameGrabberProtocol | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaFrameGrabberProtocol.h | AjaMediaOutput | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(DisplayName="AJA Output", CommandLineID="AJAOutput")) class UAjaFrameGrabberProtocol : public [UMovieSceneImageCaptureProtocolBase](API\Runtime\MovieSceneCapture\UMovieSceneImageCaptureProtocolB-) | [
{
"type": "FString",
"name": "Information",
"description": "States unused options for AJAFrameGrabberProtocolSettings"
},
{
"type": "FSoftObjectPath",
"name": "MediaOutput",
"description": "~EndUMovieSceneCaptureProtocolBaseimplementation AJA Setting to use for the FrameGrabberProtocol"
}
]
|
|
UAjaMediaCapture::FAjaOutputCallback::OnCompletion | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual void OnCompletion &40; bool bSucceed &41; | []
|
|
UAjaMediaCapture::FAjaOutputCallback::OnInitializationCompleted | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual void OnInitializationCompleted &40; bool bSucceed &41; | []
|
|
UAjaMediaCapture::FAjaOutputCallback::OnInputFrameReceived | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual bool OnInputFrameReceived &40; const AJA::AJAInputFrameData & InInputFrame, const AJA::AJAAncillaryFrameData & InAncillaryFrame, const AJA::AJAAudioFrameData & AudioFrame, const AJA::AJAVideoFrameData & VideoFrame &41; | []
|
|
UAjaMediaCapture::FAjaOutputCallback::OnOutputFrameCopied | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual bool OnOutputFrameCopied &40; const AJA::AJAOutputFrameData & InFrameData &41; | []
|
|
UAjaMediaCapture::FAjaOutputCallback::OnOutputFrameStarted | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual void OnOutputFrameStarted&40;&41; | []
|
|
UAjaMediaCapture::FAjaOutputCallback::OnRequestInputBuffer | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | virtual bool OnRequestInputBuffer &40; const AJA::AJARequestInputBufferData & RequestBuffer, AJA::AJARequestedInputBufferData & OutRequestedBuffer &41; | []
|
|
UAjaMediaCapture::FAJAOutputChannel::FAJAOutputChannel | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | FAJAOutputChannel&40;&41; | []
|
|
FAjaOutputCallback | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | struct FAjaOutputCallback : public [AJA::IAJAInputOutputChannelCallbackInterface](API\Plugins\AjaCore\IAJAInputOutputChannelCallbackIn-) | [
{
"type": "uint64",
"name": "LastFrameDropCount",
"description": "Last frame drop count to detect count"
},
{
"type": "UAjaMediaCaptur...",
"name": "Owner",
"description": ""
},
{
"type": "uint64",
"name": "PreviousDroppedCount",
"description": ""
}
]
|
|
FAJAOutputChannel | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Private/AjaMediaCapture.cpp | AjaMediaOutput | struct FAJAOutputChannel : public [AJA::AJAOutputChannel](API\Plugins\AjaCore\AJAOutputChannel) | []
|
|
UAjaMediaCapture::GetRGBToYUVConversionMatrix | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Get the RGB to YUV Conversion Matrix, should be overriden for media outputs that support different color gamuts (ie. BT 2020). Will default to returning the RGBToYUV Rec709 matrix. | AjaMediaOutput | virtual const FMatrix & GetRGBToYUVConversionMatrix() const | []
|
UAjaMediaCapture::HasFinishedProcessing | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Check whether this capture has any processing left to do. | AjaMediaOutput | virtual bool HasFinishedProcessing() const | []
|
UAjaMediaCapture::InitializeCapture | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Initialization method to prepare implementation for capture | AjaMediaOutput | virtual bool InitializeCapture() | []
|
UAjaMediaCapture::LockDMATexture_RenderThread | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | AjaMediaOutput | virtual void LockDMATexture_RenderThread ( FTextureRHIRef InTexture ) | []
|
|
UAjaMediaCapture::OnFrameCaptured_AnyThread | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Callback when the buffer was successfully copied to CPU ram. The buffer is only valid for the duration of the callback. SupportsAnyThreadCapture must return true in the implementation in order for this to be called. | AjaMediaOutput | virtual void OnFrameCaptured_AnyThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, const [FMediaCaptureResourceData](API\Plugins\MediaIOCore\UMediaCapture\FMediaCaptureResourceData) & InResourceData ) | []
|
UAjaMediaCapture::OnFrameCaptured_RenderingThread | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Callback when the buffer was successfully copied to CPU ram. The callback in called from a critical point. If you intend to process the buffer, do so in another thread. The buffer is only valid for the duration of the callback. | AjaMediaOutput | virtual void OnFrameCaptured_RenderingThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, void * InBuffer, int32 Width, int32 Height, int32 BytesPerRow ) | []
|
UAjaMediaCapture::OnRHIResourceCaptured_AnyThread | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | AnyThread version of the above callbacks. SupportsAnyThreadCapture must return true in the implementation in order for this to be called. | AjaMediaOutput | virtual void OnRHIResourceCaptured_AnyThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, FTextureRHIRef InTexture ) | []
|
UAjaMediaCapture::OnRHIResourceCaptured_RenderingThread | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Callbacks when the buffer was successfully copied on the GPU ram. The callback in called from a critical point. If you intend to process the texture/buffer, do so in another thread. The texture is valid for the duration of the callback. | AjaMediaOutput | virtual void OnRHIResourceCaptured_RenderingThread ( const [FCaptureBaseData](API\Plugins\MediaIOCore\UMediaCapture\FCaptureBaseData) & InBaseData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMediaCaptureUserData](API\Plugins\MediaIOCore\FMediaCaptureUserData), ESPMode::ThreadSafe > InUserData, FTextureRHIRef InTexture ) | []
|
UAjaMediaCapture::PostInitializeCaptureViewport | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Called after initialize for viewport capture type | AjaMediaOutput | virtual bool PostInitializeCaptureViewport ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > & InSceneViewport ) | []
|
UAjaMediaCapture::ShouldCaptureRHIResource | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Should we callOnFrameCaptured_RenderingThread()with a RHI resource -or- readback the memory to CPU ram and callOnFrameCaptured_RenderingThread(). | AjaMediaOutput | virtual bool ShouldCaptureRHIResource() const | []
|
UAjaMediaCapture::StopCaptureImpl | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | AjaMediaOutput | virtual void StopCaptureImpl ( bool bAllowPendingFrameToBeProcess ) | []
|
|
UAjaMediaCapture::SupportsAnyThreadCapture | /Engine/Plugins/Media/AjaMedia/Source/AjaMediaOutput/Public/AjaMediaCapture.h | Whether the capture callbacks can be called on any thread. If true, the _AnyThread callbacks will be used instead of the _RenderThread ones. | AjaMediaOutput | virtual bool SupportsAnyThreadCapture() const | []
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.