className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
ISocketSubsystem::Shutdown
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Performs platform specific socket clean up
Sockets
void Shutdown()
[]
ISocketSubsystem::ShutdownAllSystems
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Shutdown all registered subsystems
Sockets
static void ShutdownAllSystems()
[]
ISocketSubsystem::TranslateErrorCode
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Translates the platform error code to a ESocketErrors enum
Sockets
ESocketErrors TranslateErrorCode ( int32 Code )
[]
ISocketSubsystem::TranslatePacketTimestamp
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Converts a platform packet timestamp, into a local timestamp, or into a time delta etc. Returns the translated timestamp or delta
Sockets
virtual double TranslatePacketTimestamp ( const [FPacketTimestamp](API\Runtime\NetCommon\Net\Common\Packets\FPacketTimestamp) & Timestamp, ETimestampTranslation Translation )
[]
ISocketSubsystem::~ISocketSubsystem
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Sockets
virtual ~ISocketSubsystem()
[]
ISocketSubsystem
/Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
This is the base interface to abstract platform specific sockets API differences.
Sockets
class ISocketSubsystem
[]
NFS_Channels::Type
/Engine/Source/Runtime/Sockets/Public/NetworkMessage.h
Reserved channels for the network file system over multichannel tcp.
Sockets
namespace NFS_Channels { enum Type { Main = 100, UnsolicitedFiles = 101, Heatbeat = 102, } }
[]
NFS_Messages::Type
/Engine/Source/Runtime/Sockets/Public/NetworkMessage.h
Message commands, these correspond to the operations of the low level file system.
Sockets
namespace NFS_Messages { enum Type { SyncFile, DeleteFile, MoveFile, SetReadOnly, OpenRead, OpenWrite, OpenAppend, CreateDirectory, DeleteDirectory, IterateDirectory, IterateDirectoryRecursively, DeleteDirectoryRecursively, CopyFile, GetFileInfo, Read, Write, Close, Seek, SetTimeStamp, ToAbsolutePathForRead, ToAbsolutePathForWrite, ReportLocalFiles, GetFileList, Heartbeat, RecompileShaders, } }
[]
FAmbisonicsSoundfieldBuffer::Duplicate
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
Create a new version of this packet.
SoundFieldRendering
virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) > Duplicate() const
[]
FAmbisonicsSoundfieldBuffer::Reset
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
Zero out the contents of this packet.
SoundFieldRendering
virtual void Reset()
[]
FAmbisonicsSoundfieldBuffer::Serialize
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
Read or write this packet to a byte buffer.
SoundFieldRendering
virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )
[]
FAmbisonicsSoundfieldBuffer::FAmbisonicsSoundfieldBuffer
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
FAmbisonicsSoundfieldBuffer()
[]
FAmbisonicsSoundfieldBuffer::~FAmbisonicsSoundfieldBuffer
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
virtual ~FAmbisonicsSoundfieldBuffer()
[]
FAmbisonicsSoundfieldSettings::Duplicate
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
This should return a new, identical encoding settings.
SoundFieldRendering
virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) > Duplicate() const
[]
FAmbisonicsSoundfieldBuffer
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
class FAmbisonicsSoundfieldBuffer : public [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket)
[ { "type": "Audio::FAligned...", "name": "AudioBuffer", "description": "Interleaved audio buffer for all vector parts of the ambisonics stream." }, { "type": "int32", "name": "NumChannels", "description": "Number of channels in the Ambisonics stream." }, { "type": "FQuat", "name": "PreviousRotation", "description": "" }, { "type": "FQuat", "name": "Rotation", "description": "This is the rotation of the ambisonics source." } ]
FAmbisonicsSoundfieldSettings::GetUniqueId
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
This should return a unique This is used so that we don't call the same encode operation multiple times for a single source being sent to identical submixes.
SoundFieldRendering
virtual uint32 GetUniqueId() const
[]
FAmbisonicsSoundfieldSettings
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
class FAmbisonicsSoundfieldSettings : public [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy)
[ { "type": "int32", "name": "Order", "description": "" } ]
FSoundFieldDecoder::DecodeAudioToSevenOneAndDownmixToDevice
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
void DecodeAudioToSevenOneAndDownmixToDevice ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & OutputPositions, [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutputData )
[]
FSoundFieldDecoder::DecodeAudioDirectlyToDeviceOutputPositions
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
void DecodeAudioDirectlyToDeviceOutputPositions ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & OutputPositions, [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutputData )
[]
FSoundFieldDecoder::FoaRotationInPlace
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static void FoaRotationInPlace ( [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InOutFrames, const float XRotDegrees, const float YRotDegrees, const float ZRotDegrees )
[]
FSoundFieldDecoder::RotateFirstOrderAmbisonicsBed
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static void RotateFirstOrderAmbisonicsBed ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & OutputData, const FQuat & DestinationRotation, const FQuat & PreviousRotation )
[]
Sqrt2Over2Vec
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static const VectorRegister Sqrt2Over2Vec = MakeVectorRegister(0.707f, 0.707f, 0.707f, 0.707f);
[]
SphereHarmCalc
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static [FSphericalHarmonicCalculator](API\Runtime\SoundFieldRendering\FSphericalHarmonicCalculator) SphereHarmCalc;
[]
VirtualSpeakerLocationsHorzOnly
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static [TArray](API\Runtime\Core\Containers\TArray)< [Audio::FChannelPositionInfo](API\Runtime\AudioExtensions\FChannelPositionInfo) > VirtualSpeakerLocationsHorzOnly = { {EAudioMixerChannel::FrontLeft, 330, 0} ,{EAudioMixerChannel::FrontRight, 30, 0} ,{EAudioMixerChannel::FrontCenter, 0, 0} ,{EAudioMixerChannel::LowFrequency, -1, 0} ,{EAudioMixerChannel::BackLeft, 210, 0} ,{EAudioMixerChannel::BackRight, 150, 0} ,{EAudioMixerChannel::SideLeft, 250, 0} ,{EAudioMixerChannel::SideRight, 110, 0} ,{EAudioMixerChannel::BackCenter, 180,0} };
[]
FSoundFieldDecoder::FSoundFieldDecoder
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
FSoundFieldDecoder()
[]
ZeroVec
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
static const VectorRegister ZeroVec = VectorZero();
[]
FSoundFieldDecoder
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
class FSoundFieldDecoder
[]
FSoundFieldEncoder::EncodeAudioDirectlyFromOutputPositions
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
void EncodeAudioDirectlyFromOutputPositions ( const [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & InputPositions, const [FAmbisonicsSoundfieldSettings](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldSettings) & Settings, [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & OutputData )
[]
FSoundFieldEncoder::FSoundFieldEncoder
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
FSoundFieldEncoder()
[]
FSoundFieldEncoder
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRendering.h
SoundFieldRendering
class FSoundFieldEncoder
[]
FSoundFieldRenderingModule::ShutdownModule
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRenderingModule.h
Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.
SoundFieldRendering
virtual void ShutdownModule()
[]
FSoundFieldRenderingModule
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRenderingModule.h
SoundFieldRendering
class FSoundFieldRenderingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
FSoundFieldRenderingModule::StartupModule
/Engine/Source/Runtime/SoundFieldRendering/Public/SoundFieldRenderingModule.h
FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));
SoundFieldRendering
virtual void StartupModule()
[]
FSphericalHarmonicCalculator::AdjustUESphericalCoordinatesForAmbisonics
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
SoundFieldRendering
static void AdjustUESphericalCoordinatesForAmbisonics ( FVector2D & InOutVector )
[]
FSphericalHarmonicCalculator::ComputeSoundfieldChannelGains
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
SoundFieldRendering
static void ComputeSoundfieldChannelGains ( const int32 Order, const float Azimuth, const float Elevation, float * OutGains )
[]
AmbiChanNumber
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
SoundFieldRendering
enum AmbiChanNumber { ACN_0 = 0, ACN_1, ACN_2, ACN_3, ACN_4, ACN_5, ACN_6, ACN_7, ACN_8, ACN_9, ACN_10, ACN_11, ACN_12, ACN_13, ACN_14, ACN_15, ACN_16, ACN_17, ACN_18, ACN_19, ACN_20, ACN_21, ACN_22, ACN_23, ACN_24, ACN_25, ACN_26, ACN_27, ACN_28, ACN_29, ACN_30, ACN_31, ACN_32, ACN_33, ACN_34, ACN_35, }
[]
FSphericalHarmonicCalculator::GenerateFirstOrderRotationMatrixGivenRadians
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
SoundFieldRendering
static void GenerateFirstOrderRotationMatrixGivenRadians ( const float RotXRadians, const float RotYRadians, const float RotZRadians, FMatrix & OutMatrix )
[]
FSphericalHarmonicCalculator::GenerateFirstOrderRotationMatrixGivenDegrees
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
SoundFieldRendering
static void GenerateFirstOrderRotationMatrixGivenDegrees ( const float RotXDegrees, const float RotYDegrees, const float RotZDegrees, FMatrix & OutMatrix )
[]
FSphericalHarmonicCalculator
/Engine/Source/Runtime/SoundFieldRendering/Public/SphericalHarmonicCalculator.h
Azimuth angle is measured CCW from front. Elevation is 0 horizontal plane, + is above horizontal plane
SoundFieldRendering
class FSphericalHarmonicCalculator
[]
FSslModule::GetCertificateManager
/Engine/Source/Runtime/Online/SSL/Public/SslModule.h
Accessor for the SSL certificate manager SSL certificate manager manager
SSL
[ISslCertificateManager](API\Runtime\SSL\Interfaces\ISslCertificateManager) & GetCertificateManager()
[]
FSslModule::Get
/Engine/Source/Runtime/Online/SSL/Public/SslModule.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
SSL
static [FSslModule](API\Runtime\SSL\FSslModule) & Get()
[]
Singleton
/Engine/Source/Runtime/Online/SSL/Public/SslModule.h
Singleton for the module while loaded and available
SSL
static [FSslModule](API\Runtime\SSL\FSslModule) * Singleton = NULL;
[]
FSslModule::FSslModule
/Engine/Source/Runtime/Online/SSL/Public/SslModule.h
Constructor
SSL
FSslModule()
[]
FSslModule::GetSslManager
/Engine/Source/Runtime/Online/SSL/Public/SslModule.h
SSL
[ISslManager](API\Runtime\SSL\Interfaces\ISslManager) & GetSslManager()
[]
FSslModule
/Engine/Source/Runtime/Online/SSL/Public/SslModule.h
Module for SSL/TLS certificate management
SSL
class FSslModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
FCertInfo
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
struct FCertInfo
[ { "type": "FString", "name": "Issuer", "description": "" }, { "type": "TArray< uint8, ...", "name": "KeyDigest", "description": "" }, { "type": "FString", "name": "Subject", "description": "" }, { "type": "TArray< uint8, ...", "name": "Thumbprint", "description": "" } ]
FVerifySslCertificates
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [TArray](API\Runtime\Core\Containers\TArray)< [FCertInfo](API\Runtime\SSL\Interfaces\FSslCertificateDelegates\FCertInfo) > & > FVerifySslCertificates
[]
FSslCertificateDelegates
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
class FSslCertificateDelegates
[]
VerifySslCertificates
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
static [FVerifySslCertificates](API\Runtime\SSL\Interfaces\FSslCertificateDelegates\FVerifySslCertificates) VerifySslCertificates;
[]
FSslContextCreateOptions
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Options for creating an SSL context using FSslManager::CreateSslContext
SSL
struct FSslContextCreateOptions
[ { "type": "bool", "name": "bAddCertificates", "description": "Automatically add certificates from the certificate manager?" }, { "type": "bool", "name": "bAllowCompression", "description": "Do we want to allow compression?" }, { "type": "ESslTlsProtocol", "name": "MaximumProtocol", "description": "Maximum version of SSL/TLS to allow" }, { "type": "ESslTlsProtocol", "name": "MinimumProtocol", "description": "Minimum version of SSL/TLS to allow" } ]
ISslCertificateManager::AddCertificatesToSslContext
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Add trusted root certificates to the SSL context
SSL
void AddCertificatesToSslContext ( SSL_CTX * SslContextPtr ) const
[]
ISslCertificateManager::ClearAllPinnedPublicKeys
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Clear all pinned keys
SSL
void ClearAllPinnedPublicKeys()
[]
ISslCertificateManager::HasCertificatesAvailable
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
true if certificates are available
SSL
bool HasCertificatesAvailable() const
[]
CERT_DIGEST_SIZE
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
static CERT_DIGEST_SIZE = 20;
[]
ISslCertificateManager::HasPinnedPublicKeys
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Check if keys have been pinned yet
SSL
bool HasPinnedPublicKeys() const
[]
ISslCertificateManager::IsDomainPinned
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Check if the domain is currently pinned
SSL
bool IsDomainPinned ( const [FString](API\Runtime\Core\Containers\FString) & Domain )
[]
PUBLIC_KEY_DIGEST_SIZE
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
static constexpr int PUBLIC_KEY_DIGEST_SIZE = 32;
[]
ISslCertificateManager::SetPinnedPublicKeys
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Set digests for pinned certificate public key for a domain
SSL
void SetPinnedPublicKeys ( const [FString](API\Runtime\Core\Containers\FString) & Domain, const [FString](API\Runtime\Core\Containers\FString) & PinnedKeyDigests )
[]
ISslCertificateManager::VerifySslCertificates
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Performs additional ssl validation (certificate pinning) false if validation fails
SSL
bool VerifySslCertificates ( X509_STORE_CTX * Context, const [FString](API\Runtime\Core\Containers\FString) & Domain ) const
[]
ISslCertificateManager::VerifySslCertificates
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
Performs additional ssl validation (certificate pinning) false if validation fails
SSL
bool VerifySslCertificates ( [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8, [TFixedAllocator](API\Runtime\Core\Containers\TFixedAllocator)< PUBLIC_KEY_DIGEST_SIZE >>> & Digests, const [FString](API\Runtime\Core\Containers\FString) & Domain ) const
[]
ISslCertificateManager::~ISslCertificateManager
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
virtual ~ISslCertificateManager()
[]
ISslCertificateManager
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslCertificateManager.h
SSL
class ISslCertificateManager
[]
ISslManager::CreateSslContext
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Create an SSL context an SSL context, may be null if an error occurred
SSL
SSL_CTX * CreateSslContext ( const [FSslContextCreateOptions](API\Runtime\SSL\Interfaces\FSslContextCreateOptions) & CreateOptions )
[]
ISslManager::DestroySslContext
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Destroy an SSL context
SSL
void DestroySslContext ( SSL_CTX * SslContext )
[]
ISslManager::InitializeSsl
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Initialize the ssl library. Can be called multiple times (may not do anything beyond first call). ShutdownSsl must be called once for each call to InitializeSsl true if ssl was successfully initialized, false if not
SSL
bool InitializeSsl()
[]
ISslManager::ShutdownSsl
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Shutdown the ssl library. Must be called once per call to InitializeSsl
SSL
void ShutdownSsl()
[]
ISslManager::~ISslManager
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Destructor
SSL
virtual ~ISslManager()
[]
ISslManager
/Engine/Source/Runtime/Online/SSL/Public/Interfaces/ISslManager.h
Manager of the ssl library
SSL
class ISslManager
[]
FAssetLoadingStateProviderMessage::ToString
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Method to override if a detailed description is desired in the monitor event viewer
StageDataCore
virtual [FString](API\Runtime\Core\Containers\FString) ToString() const
[]
FAssetLoadingStateProviderMessage::FAssetLoadingStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FAssetLoadingStateProviderMessage()
[]
FAssetLoadingStateProviderMessage::FAssetLoadingStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FAssetLoadingStateProviderMessage ( EStageLoadingState InState, const [FString](API\Runtime\Core\Containers\FString) & InAssetName )
[]
FAssetLoadingStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Message sent to indicate that the node has entered or exited a loading state.
StageDataCore
struct FAssetLoadingStateProviderMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)
[ { "type": "FString", "name": "AssetName", "description": "Name of the asset currently loading." }, { "type": "EStageLoadingSt...", "name": "LoadingState", "description": "Event for this critical state" } ]
FCriticalStateProviderMessage::ToString
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Method to override if a detailed description is desired in the monitor event viewer
StageDataCore
virtual [FString](API\Runtime\Core\Containers\FString) ToString() const
[]
FCriticalStateProviderMessage::FCriticalStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FCriticalStateProviderMessage()
[]
FCriticalStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Message sent to notify about critical state change.
StageDataCore
struct FCriticalStateProviderMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)
[ { "type": "FName", "name": "SourceName", "description": "Source of the critical state. i.e. TakeName, CustomRecorder, etc..." }, { "type": "EStageCriticalS...", "name": "State", "description": "Event for this critical state" } ]
FStageDataBaseMessage::~FStageDataBaseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
virtual ~FStageDataBaseMessage()
[]
FStageInstanceDescriptor
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Holds descriptive information about that data providers. Information that won't change for a session Used when monitor and provider connects
StageDataCore
struct FStageInstanceDescriptor
[ { "type": "FName", "name": "FriendlyName", "description": "Friendly name for this Unreal instance. If empty, this will be MachineName - ProcessId" }, { "type": "FString", "name": "MachineName", "description": "Machine name read from FPlatformProcess::ComputerName()" }, { "type": "uint32", "name": "ProcessId", "description": "ProcessId read from FPlatformProcess::GetCurrentProcessId" }, { "type": "FString", "name": "RolesStringified", "description": "Simple stringified view of the roles of that instance" }, { "type": "int32", "name": "SessionId", "description": "Session Id that may be used to differentiate different sessions on the network" } ]
FStageDataBaseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Base structure for all stage monitoring messages
StageDataCore
struct FStageDataBaseMessage
[ { "type": "FGuid", "name": "Identifier", "description": "Identifier of this instance" }, { "type": "int32", "name": "StageMessageVersion", "description": "Provision for versioning if we need to differentiate version of messages." } ]
FStageMonitorBaseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Monitor only messages - listened by providers Base structure for all monitor messages
StageDataCore
struct FStageMonitorBaseMessage : public [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage)
[]
FStageMonitorCloseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Message sent when monitor is going down to let know linked providers
StageDataCore
struct FStageMonitorCloseMessage : public [FStageMonitorBaseMessage](API\Runtime\StageDataCore\FStageMonitorBaseMessage)
[]
FCriticalStateProviderMessage::FCriticalStateProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FCriticalStateProviderMessage ( EStageCriticalStateEvent InEvent, [FName](API\Runtime\Core\UObject\FName) InSourceName )
[]
FStageProviderCloseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Message sent by Providers to notify monitors they are closing down
StageDataCore
struct FStageProviderCloseMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)
[]
FStageProviderDiscoveryMessage::FStageProviderDiscoveryMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FStageProviderDiscoveryMessage()
[]
FStageProviderDiscoveryMessage::FStageProviderDiscoveryMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FStageProviderDiscoveryMessage ( [FStageInstanceDescriptor](API\Runtime\StageDataCore\FStageInstanceDescriptor) && InDescriptor )
[]
FStageProviderDiscoveryMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Message broadcasted periodically by the monitor to discover new providers
StageDataCore
struct FStageProviderDiscoveryMessage : public [FStageMonitorBaseMessage](API\Runtime\StageDataCore\FStageMonitorBaseMessage)
[ { "type": "FStageInstanceD...", "name": "Descriptor", "description": "Detailed description of that monitor" } ]
FStageProviderDiscoveryResponseMessage::FStageProviderDiscoveryResponseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FStageProviderDiscoveryResponseMessage()
[]
FStageProviderDiscoveryResponseMessage::FStageProviderDiscoveryResponseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FStageProviderDiscoveryResponseMessage ( [FStageInstanceDescriptor](API\Runtime\StageDataCore\FStageInstanceDescriptor) && InDescriptor )
[]
FStageProviderDiscoveryResponseMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Response to a received discovery message sent by providers
StageDataCore
struct FStageProviderDiscoveryResponseMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)
[ { "type": "FStageInstanceD...", "name": "Descriptor", "description": "Detailed description of that provider" } ]
FStageProviderMessage::ToString
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Method to override if a detailed description is desired in the monitor event viewer
StageDataCore
virtual [FString](API\Runtime\Core\Containers\FString) ToString() const
[]
FStageProviderEventMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Base Provider messages that are events
StageDataCore
struct FStageProviderEventMessage : public [FStageProviderMessage](API\Runtime\StageDataCore\FStageProviderMessage)
[]
FStageProviderMessage::FStageProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
StageDataCore
FStageProviderMessage()
[]
FStageProviderMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Base Provider messages listened by monitors
StageDataCore
struct FStageProviderMessage : public [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage)
[ { "type": "FDateTime", "name": "DateTime", "description": "DateTime of the sender. Used to keep track of messages order through Timecode rollover." }, { "type": "FQualifiedFrame...", "name": "FrameTime", "description": "FrameTime of the sender." } ]
FStageProviderPeriodicMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/StageMessages.h
Base Provider messages that are periodic
StageDataCore
struct FStageProviderPeriodicMessage : public [FStageProviderMessage](API\Runtime\StageDataCore\FStageProviderMessage)
[]
ModularFeatureName
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Name of the DataProvider modular feature
StageDataCore
static [FName](API\Runtime\Core\UObject\FName) ModularFeatureName = "ModularFeature_StageDataProvider";
[]
IStageDataProvider::SendMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Generic send message to support constructor parameters directly and temp object created
StageDataCore
template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, Args &&... args )
[]
IStageDataProvider::SendMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Specialized send message for lvalue type without a temp object
StageDataCore
template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, MessageType & Message )
[]
IStageDataProvider::SendMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Specialized send message for rvalue type without a temp object
StageDataCore
template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, MessageType && Message )
[]
IStageDataProvider::SendMessage
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Internal method where all send messages are funneled before being sent to the data provider instance
StageDataCore
template<typename MessageType> static bool SendMessage &40; MessageType && Message, EStageMessageFlags InFlags &41;
[]
IStageDataProvider::SendMessageInternal
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
Method to actually send message from a data provider to monitors
StageDataCore
bool SendMessageInternal ( [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage) * Payload, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Type, EStageMessageFlags InFlags )
[]
IStageDataProvider::~IStageDataProvider
/Engine/Source/Runtime/VirtualProduction/StageDataCore/Public/IStageDataProvider.h
StageDataCore
virtual ~IStageDataProvider()
[]