description: Retrieves the set of columns registered by this protocol.

code: virtual void GetRegisteredColumns ( [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & OutColumns )


description: Add custom initializing of the protocol

module: RemoteControlProtocol

code: virtual void Init()


description: Build to core engine delegated and called at the end of a frame

code: virtual void OnEndFrame()


description: Populates protocol specific columns.

code: virtual void RegisterColumns()


description: Queue protocol entity and value to apply for the protocol It stores only unique tick entities which should be apply next frame. Prevents from applying more then one entity for frame.

code: virtual void QueueValue ( const [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InProtocolEntity, const double InProtocolValue )


code: FRemoteControlProtocol ( [FName](API\Runtime\Core\UObject\FName) InProtocolName )


className: FRemoteControlProtocol

description: Base class implementation for remote control protocol

code: class FRemoteControlProtocol : public [IRemoteControlProtocol](API\Plugins\RemoteControlProtocol\IRemoteControlProtocol)

ProtocolName

type: FName

description: Current Protocol Name

RegisteredColumns

type: TSet<FProtocol...

description: Holds a set of protocol specific columns.


className: FRemoteControlProtocolEntityPtr


className: FRemoteControlProtocolEntityWeakPtr


description: Bind the protocol entity to the protocol

code: void Bind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description:
Add the new protocol entity. That is created based on protocol specific script struct
A shared pointer protocol entity struct on scope

code: [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) CreateNewProtocolEntity ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty, [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * InOwner, [FGuid](API\Runtime\Core\Misc\FGuid) InPropertyId ) const


description: Get protocol specific Script Struct class

code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetProtocolScriptStruct() const


code: ~FRemoteControlProtocol()


description: Get range input template Property

code: virtual [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetRangeInputTemplateProperty() const


description: Retrieves the column reference by its name.

code: [FProtocolColumnPtr](API\Plugins\RemoteControlProtocol\FProtocolColumnPtr) GetRegisteredColumn ( const [FName](API\Runtime\Core\UObject\FName) & ByColumnName ) const


code: void GetRegisteredColumns ( [TSet](API\Runtime\Core\Containers\TSet)< [FName](API\Runtime\Core\UObject\FName) > & OutColumns )


description: Add custom initializing of the protocol

code: void Init()


code: void QueueValue ( const [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InProtocolEntity, const double InProtocolValue )


description: Unbind all protocol entities from the protocol

code: void UnbindAll()


description: Unbind the protocol entity from the protocol

code: void Unbind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description: Virtual destructor

code: virtual ~IRemoteControlProtocol()


description:
Register the protocol
true if protocol added

code: bool AddProtocol ( [FName](API\Runtime\Core\UObject\FName) InProtocolName, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IRemoteControlProtocol](API\Plugins\RemoteControlProtocol\IRemoteControlProtocol) > InProtocol )


className: IRemoteControlProtocol

description: Interface for remote control protocol

code: class IRemoteControlProtocol : public [TSharedFromThis< IRemoteControlProtocol >](API\Runtime\Core\Templates\TSharedFromThis)


description: Unregister all protocols

code: void EmptyProtocols()


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

code: static [IRemoteControlProtocolModule](API\Plugins\RemoteControlProtocol\IRemoteControlProtocolModule) & Get()


description: Get specific remote control protocol by given name

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteControlProtocol](API\Plugins\RemoteControlProtocol\IRemoteControlProtocol) > GetProtocolByName ( [FName](API\Runtime\Core\UObject\FName) InProtocolName ) const


description: Get array of all remote control protocol names

code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetProtocolNames() const


description: Get number of remote control protocols

code: int32 GetProtocolNum() const


description: Whether protocol disabled

code: bool IsRCProtocolsDisable() const


description: Unregister the protocol

code: void RemoveProtocol ( [FName](API\Runtime\Core\UObject\FName) InProtocolName, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IRemoteControlProtocol](API\Plugins\RemoteControlProtocol\IRemoteControlProtocol) > InProtocol )


className: IRemoteControlProtocolModule

description: A Remote Control Protocol module. That is base for all remote control protcols

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


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeMicro = 0.075f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeMini = 0.15f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeSmall = 0.21f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeNormal = 0.3f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeMedium = 0.5f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeLarge = 0.8f; }


code: namespace ProtocolColumnConstants { static float ProtocolColumnConstants::ColumnSizeExtraLarge = 1.f; }


description: Get bound range property. For example, the range could be bound toFFloatPropertyorFIntProperty, etc. It could be 0.f bound toFStructPropertyor 0 bound toFBoolPropertywhere 0.f or 0 are Range PropertyName Each protocol defines its own binding property type.

module: RemoteControlProtocolDMX

code: virtual [FName](API\Runtime\Core\UObject\FName) GetRangePropertyName() const


description: Get Size of the range property value

code: virtual uint8 GetRangePropertySize() const


description: Get the upper most value for the range property type, used for normalization

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


description: Initialize struct and delegates

code: void Initialize()


description: Called after the struct is serialized

code: void PostSerialize ( const [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Register(s) all the widgets of this protocol entity.

code: virtual void RegisterProperties()


description: Called when the struct is serialized

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


description: Try to get the port ID from dmx protocol settings

code: void UpdateInputPort()


description: Using as an inner struct for details customization. Useful to have type customization for the struct

bUseDefaultInputPort

type: bool

description: If set to true, uses the default input port set in Remote Control Protocol project settings

bUseLSB

description: Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number.

DataType

type: EDMXFixtureSign...

description: Defines the used number of channels (bytes)

InputPortId

type: FGuid

description: Reference of an input DMX port id

StartingChannel

description: Starting channel

Universe

description: DMX universe id


className: FRemoteControlDMXProtocolEntity

description: DMX protocol entity for remote control binding

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRemoteControlDMXProtocolEntity : public [FRemoteControlProtocolEntity](API\Plugins\RemoteControl\FRemoteControlProtocolEntity)

ExtraSetting

type: FRemoteControlD...

description: Extra protocol settings. Primary using for customization

RangeInputTemplate

description: DMX range input property template, used for binding.


description: Bind the protocol entity to the protocol

code: virtual void Bind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description: Get protocol specific Script Struct class

code: virtual [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetProtocolScriptStruct() const


description: Build to core engine delegated and called at the end of a frame

code: virtual void OnEndFrame()


className: ProtocolName

description: DMX protocol name

code: static const [FName](API\Runtime\Core\UObject\FName) ProtocolName = TEXT("DMX");


description: Populates protocol specific columns.

code: virtual void RegisterColumns()


description: Unbind the protocol entity from the protocol

code: virtual void Unbind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description: Unbind all protocol entities from the protocol

code: virtual void UnbindAll()


code: FRemoteControlProtocolDMX()


className: WithSerializer

code: enum &123; WithSerializer = true &125;


className: FRemoteControlProtocolDMX

description: DMX protocol implementation for Remote Control

code: class FRemoteControlProtocolDMX : public [FRemoteControlProtocol](API\Plugins\RemoteControlProtocol\FRemoteControlProtocol)


className: WithPostSerialize

code: enum &123; WithPostSerialize = true &125;


code: template<> struct TStructOpsTypeTraits< FRemoteControlDMXProtocolEntity > : public [TStructOpsTypeTraitsBase2< FRemoteControlDMXProtocolEntity >](API\Runtime\CoreUObject\UObject\TStructOpsTypeTraitsBase2)


description: Returns a delegate broadcast whenever the Remote Control Protocol DMX Settings changed

code: static FSimpleMulticastDelegate & GetOnRemoteControlProtocolDMXSettingsChanged()


description: Called when a property on this object has been modified externally

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


className: URemoteControlProtocolDMXSettings

description: DMX Remote Control Settings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig) class URemoteControlProtocolDMXSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: ERemoteControlMIDIDeviceSelector

description: MIDI protocol device selector type

module: RemoteControlProtocolMIDI

code: enum ERemoteControlMIDIDeviceSelector { ProjectSettings = 0, DeviceName = 1, DeviceId = 2, }


className: FMIDIDeviceCollection

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< [FFoundMIDIDevice](API\Plugins\MIDIDevice\FFoundMIDIDevice) >, ESPMode::ThreadSafe > FMIDIDeviceCollection


className: FOnMIDIDevicesUpdated

description: Callback called when MIDI devices are updated.

code: typedef TMulticastDelegate_OneParam< void, [FMIDIDeviceCollection](API\Plugins\RemoteControlProtocolMIDI\FMIDIDeviceCollection) & > FOnMIDIDevicesUpdated


description: Resolves the actual Midi Device Id given theFRemoteControlMIDIDeviceconfiguration. Returns INDEX_NONE if device not found or invalid.

code: int32 ResolveDeviceId ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFoundMIDIDevice](API\Plugins\MIDIDevice\FFoundMIDIDevice) > & InFoundDevices )


description: Sets DeviceId and DeviceName, disables bUseProjectSettings and bUseUserDeviceId.

code: void SetDevice ( const int32 InDeviceId, const [FName](API\Runtime\Core\UObject\FName) & InDeviceName )


description: Sets bUseProjectSettings = true, clears bUseUserDeviceId.

code: void SetUseProjectSettings()


description: Sets bUseUserDeviceId = true, clears bUseProjectSettings.

code: void SetUserDeviceId()


description: Default constructor

code: FRemoteControlMIDIDevice()


description: Creates a formatted string to display in the combobox


description: Construct for the given DeviceId

code: FRemoteControlMIDIDevice ( const int32 DeviceId )


description: Construct for the given DeviceId and DeviceName

code: FRemoteControlMIDIDevice ( const int32 DeviceId, const [FName](API\Runtime\Core\UObject\FName) & DeviceName )


className: FRemoteControlMIDIDevice

description: MIDI protocol device identifier

bDeviceIsAvailable

description: If device available for use.

DeviceId

description: User-specified Midi Device Id

DeviceName

description: Midi Device Name. If specified, takes priority over DeviceId.

DeviceSelector

type: ERemoteControlM...

description: Midi Device Selector

ResolvedDeviceId

description: Midi Resolved Device Id. Distinct from the user specified Device Id.


description: Get bound range property. For example, the range could be bound toFFloatPropertyorFIntProperty, etc. It could be 0.f bound toFStructPropertyor 0 bound toFBoolPropertywhere 0.f or 0 are Range PropertyName Each protocol defines its own binding property type.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetRangePropertyName() const


description: Checks if this entity has the same values as the Other. Used to check for duplicate inputs.

code: virtual bool IsSame ( const [FRemoteControlProtocolEntity](API\Plugins\RemoteControl\FRemoteControlProtocolEntity) * InOther )


className: FRemoteControlMIDIProtocolEntity

description: MIDI protocol entity for remote control binding

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRemoteControlMIDIProtocolEntity : public [FRemoteControlProtocolEntity](API\Plugins\RemoteControl\FRemoteControlProtocolEntity)

Channel

description: Midi device channel

Device

type: FRemoteControlM...

description: Midi Device

EventType

type: EMIDIEventType

description: Midi Event type

description: Midi button event message data id for binding

RangeInputTemplate

description: Midi range input property template, used for binding.


description: Register(s) all the widgets of this protocol entity.

code: virtual void RegisterProperties()


description: Bind the protocol entity to the protocol

code: virtual void Bind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description: Get protocol specific Script Struct class

code: virtual [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetProtocolScriptStruct() const


description: MIDI protocol name

code: static const [FName](API\Runtime\Core\UObject\FName) ProtocolName = TEXT("MIDI");


description: Populates protocol specific columns.

code: virtual void RegisterColumns()


description: Unbind the protocol entity from the protocol

code: virtual void Unbind ( [FRemoteControlProtocolEntityPtr](API\Plugins\RemoteControlProtocol\FRemoteControlProtocolEntityPtr) InEntityPtr )


description: Unbind all protocol entities from the protocol

code: virtual void UnbindAll()


code: FRemoteControlProtocolMIDI()


className: FRemoteControlProtocolMIDI

description: MIDI protocol implementation for Remote Control

code: class FRemoteControlProtocolMIDI : public [FRemoteControlProtocol](API\Plugins\RemoteControlProtocol\FRemoteControlProtocol)


className: GetTypeHash

description: FRemoteControlMIDIDeviceequality, depending on what properties are specified Comparison

code: uint64 GetTypeHash ( const [FRemoteControlMIDIDevice](API\Plugins\RemoteControlProtocolMIDI\FRemoteControlMIDIDevice) & InValue )


description: Get MIDI devices asynchronously. If bRefresh is true, device info is flushed and re-initialized.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< [FFoundMIDIDevice](API\Plugins\MIDIDevice\FFoundMIDIDevice) >, ESPMode::ThreadSafe > > GetMIDIDevices ( bool bRefresh )


description: Get MIDI Devices Updated callback.


description: Checks if MIDI devices are currently being refreshed/updated.

code: bool IsUpdatingDevices() const


className: IRemoteControlProtocolMIDIModule

description: MIDI remote control module interface

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


className: operator==

code: bool operator== ( const [FRemoteControlMIDIDevice](API\Plugins\RemoteControlProtocolMIDI\FRemoteControlMIDIDevice) & Lhs, const [FRemoteControlMIDIDevice](API\Plugins\RemoteControlProtocolMIDI\FRemoteControlMIDIDevice) & Rhs )


className: operator!=

code: bool operator!= ( const [FRemoteControlMIDIDevice](API\Plugins\RemoteControlProtocolMIDI\FRemoteControlMIDIDevice) & Lhs, const [FRemoteControlMIDIDevice](API\Plugins\RemoteControlProtocolMIDI\FRemoteControlMIDIDevice) & Rhs )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


code: URemoteControlProtocolMIDISettings()


className: URemoteControlProtocolMIDISettings

description: MIDI Remote Control Settings

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig) class URemoteControlProtocolMIDISettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

DefaultDevice

description: Midi Default Device


className: FOnActiveProtocolChanged

module: RemoteControlProtocolWidgets

code: typedef TMulticastDelegate_OneParam< void, const [FName](API\Runtime\Core\UObject\FName) > FOnActiveProtocolChanged


className: FOnProtocolBindingAddedOrRemoved

code: typedef TMulticastDelegate_OneParam< void, [ERCProtocolBinding::Op](API\Plugins\RemoteControlCommon\ERCProtocolBinding__Op) > FOnProtocolBindingAddedOrRemoved


description: Adds a new protocol binding of specified type to the current view model.

code: void AddProtocolBinding ( const [FName](API\Runtime\Core\UObject\FName) InProtocolName )


className: FRemoteControlProtocolEntitySet


description: Get the set of entities which is awaiting state and waiting for binding


description: Stop recording incoming protocol message handler

code: void OnStopRecording ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TStructOnScope](API\Runtime\CoreUObject\UObject\TStructOnScope)< [FRemoteControlProtocolEntity](API\Plugins\RemoteControl\FRemoteControlProtocolEntity) >> InEntity )


description: Start recording incoming protocol message handler

code: void OnStartRecording ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TStructOnScope](API\Runtime\CoreUObject\UObject\TStructOnScope)< [FRemoteControlProtocolEntity](API\Plugins\RemoteControl\FRemoteControlProtocolEntity) >> InEntity )


description: Refresh protocol binding list. Returns false if the backing widget wasn't valid.

code: bool Refresh ( bool bNavigateToEnd )


description: Virtual destructor

code: virtual ~IRCProtocolBindingList()


className: IRCProtocolBindingList

description: Interface class for RCProtocolBindingList widget

code: class IRCProtocolBindingList


description: Creates a widget for the given Preset Field and FieldType

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateDetailsForEntity ( [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * InPreset, const [FGuid](API\Runtime\Core\Misc\FGuid) & InFieldId, const [EExposedFieldType](API\Plugins\RemoteControl\EExposedFieldType) & InFieldType )


description: Called when active protocol selection changed.


description: Get the binding list public reference


description: Get the selected protocol name.

code: const [FName](API\Runtime\Core\UObject\FName) GetSelectedProtocolName() const


description: Reset protocol binding widget

code: void ResetProtocolBindingList()


description: Called when binding is added or removed.


className: IRemoteControlProtocolWidgetsModule

description: A Remote Control module that provides editor widgets for protocol bindings.

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


className: EMaskingType

code: enum EMaskingType { Color, Polar, Rotator, Vector, Quat, Unsupported, }


code: namespace EMasking { enum Bits { ETM_A, ETM_B, ETM_C, ETM_D, } }


description: True when the derived classes supports masking, false otherwise.

code: bool CanBeMasked&40;&41; const


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


description: Retrieves the masking type based on the property type.

code: EMaskingType GetMaskingType&40;&41;


description: True when derived classes has optional mask.

code: bool HasOptionalMask&40;&41; const


className: IHasMaskExtensibility

description: Ensures the maskability of the derived classes.

code: class IHasMaskExtensibility


code: namespace RemoteControlProtocolMasking { static RemoteControlProtocolMasking::OptionalMaskStructs = { TBaseStructure<FLinearColor>::Get(), TBaseStructure<FVector4>::Get(), TBaseStructure<FQuat>::Get(), TBaseStructure<FIntVector4>::Get() }; }


code: namespace RemoteControlProtocolMasking { static RemoteControlProtocolMasking::StructsToMaskingTypes = { { TBaseStructure<FColor>::Get(), EMaskingType::Color } , { TBaseStructure<FLinearColor>::Get(), EMaskingType::Color } , { TBaseStructure<FRotator>::Get(), EMaskingType::Rotator } , { TBaseStructure<FVector>::Get(), EMaskingType::Vector } , { TBaseStructure<FIntVector>::Get(), EMaskingType::Vector } , { TBaseStructure<FVector4>::Get(), EMaskingType::Quat } , { TBaseStructure<FIntVector4>::Get(), EMaskingType::Quat } , { TBaseStructure<FQuat>::Get(), EMaskingType::Quat } }; }


code: virtual bool CanBeMasked() const


description: Constructs this widget with InArgs

code: void Construct ( const [FArguments](API\Plugins\RemoteControlProtocolWidgets\Widgets\Masks\SRCProtocolMask\FArguments) & InArgs, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FRemoteControlField](API\Plugins\RemoteControl\FRemoteControlField) > InField )


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SRCProtocolMask >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: virtual bool HasOptionalMask() const


description: Retrieves the state of the mask.

code: virtual ECheckBoxState IsMaskEnabled ( [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) InMaskBit ) const


description: Handles masked state.

code: virtual void SetMaskEnabled ( ECheckBoxState NewState, [ERCMask](API\Plugins\RemoteControlCommon\ERCMask) NewMaskBit )


className: SRCProtocolMask

description: A widget that represents a mask.


description: Constructs this widget with InArgs

code: void Construct ( const [FArguments](API\Plugins\RemoteControlProtocolWidgets\Widgets\Masks\SRCProtocolMaskTriplet\FArguments) & InArgs )


code: WidgetArgsType & CanBeMasked &40; const TAttribute< bool > & InAttribute &41;


code: WidgetArgsType & EnableOptionalMask &40; bool InArg &41;


code: WidgetArgsType & MaskA &40; ERCMask InArg &41;


code: WidgetArgsType & MaskB &40; ERCMask InArg &41;


code: WidgetArgsType & MaskC &40; ERCMask InArg &41;


code: WidgetArgsType & MaskingType &40; EMaskingType InArg &41;


code: WidgetArgsType & OptionalMask &40; ERCMask InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SRCProtocolMaskTriplet >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Soft toggles masks based on active masks.

code: void LoadMasks()


className: SRCProtocolMaskTriplet

description: A widget that represents a triplet mask.

code: class SRCProtocolMaskTriplet : public [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder)

WidgetStyle

type: const FProtocol...

description: Protocol Widget Style reference.


className: FOnAddControllerExtensionColumn

description: Called when setting up / resetting the Controller panel list. Register to add custom column.

module: RemoteControlUI

code: typedef TMulticastDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & > FOnAddControllerExtensionColumn


className: FGenerateWidgetArgs

code: struct FGenerateWidgetArgs

bIsInLiveMode

type: TAttribute< boo...

ColumnSizeData

type: FRCColumnSizeDa...

Entity

type: TSharedPtr<FRe...

HighlightText

type: FText

Preset

type: URemoteControlP...

WidgetRegistry

type: TWeakPtr< FRCPa...


className: FOnCustomizeMetadataEntry

description: Callback called to customize the display of a metadata entry for entities.

code: typedef TBaseDelegate_FourParams< void, [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) *, const [FGuid](API\Runtime\Core\Misc\FGuid) &, [IDetailLayoutBuilder](API\Editor\PropertyEditor\IDetailLayoutBuilder) &, [IDetailCategoryBuilder](API\Editor\PropertyEditor\IDetailCategoryBuilder) & > FOnCustomizeMetadataEntry


className: FOnGenerateControllerExtensionsWidgets

description: Callback called to customize the extensible widget for controllers in controllers list

code: typedef TMulticastDelegate_OneParam< void, [FRCControllerExtensionWidgetsInfo](API\Plugins\RemoteControlUI\FRCControllerExtensionWidgetsInf-) & > FOnGenerateControllerExtensionsWidgets


className: FOnDisplayExposeIcon

description: Filter queried in order to determine if a property should be displayed.

code: typedef TBaseDelegate_OneParam< bool, const [FRCExposesPropertyArgs](API\Plugins\RemoteControlUI\FRCExposesPropertyArgs) & > FOnDisplayExposeIcon


className: FOnGenerateExtensions

code: typedef TMulticastDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > > & > FOnGenerateExtensions


className: FOnGenerateRCWidget

code: typedef TBaseDelegate_OneParam< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< SRCPanelTreeNode >, const [FGenerateWidgetArgs](API\Plugins\RemoteControlUI\FGenerateWidgetArgs) & > FOnGenerateRCWidget


className: FRCColumnSizeData

code: struct FRCColumnSizeData

LeftColumnWidth

type: TAttribute< flo...


code: void SetColumnWidth ( float InWidth )


description: Add a new widget, and associate it to the specified custom column

code: bool AddColumnWidget ( const [FName](API\Runtime\Core\UObject\FName) & InColumnName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InWidget )


code: FRCControllerExtensionWidgetsInfo ( [URCVirtualPropertyBase](API\Plugins\RemoteControl\URCVirtualPropertyBase) * InController )


className: FRCControllerExtensionWidgetsInfo

description: A struct used for controllers list items columns customization

Controller

type: URCVirtualPrope...

description: The controller being customized

CustomWidgetsMap

type: TMap<FName,TS...

description: A map associating each column with a widget


className: EType

description: Type of the Extension arguments

code: enum EType { E_Handle, E_OwnerObject, E_None, }


description: Get property on the exposed arguments type

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetProperty() const


description: Checked version of Get Property

code: [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetPropertyChecked() const


description: Get Type of the Extension Arguments


description: Whether extensions arguments valid

code: bool IsValid() const


code: FRCExposesPropertyArgs ( const [FOnGenerateGlobalRowExtensionArgs](API\Editor\PropertyEditor\FOnGenerateGlobalRowExtensionArg-) & InExtensionArgs )


code: FRCExposesPropertyArgs ( [FOnGenerateGlobalRowExtensionArgs](API\Editor\PropertyEditor\FOnGenerateGlobalRowExtensionArg-) && InExtensionArgs )


code: FRCExposesPropertyArgs ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IPropertyHandle](API\Editor\PropertyEditor\IPropertyHandle) > & InPropertyHandle )


code: FRCExposesPropertyArgs ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InOwnerObject, const [FString](API\Runtime\Core\Containers\FString) & InPropertyPath, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty )


className: FRCExposesPropertyArgs

description: Exposed property arguments The struct is wrapper struct to generate Remote Control Entity fromIPropertyHandleor OwnerObject with Property Path and Property instance

code: struct FRCExposesPropertyArgs

OwnerObject

type: TWeakObjectPtr<...

description: Owner object for the property extension

Property

type: TWeakFieldPtr< ...

description: Exposed property

PropertyHandle

type: TSharedPtr<IPr...

description: The detail row's property handle.

PropertyPath

type: FString

description: Path of the exposed property


description: Returns true when the derived classes has two or more protocol bindings.

code: const bool GetProtocolBindingsNum() const


description: Retrieves the protocol specific widget if protocol is specified, column specific widget otherwise.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetProtocolWidget ( const [FName](API\Runtime\Core\UObject\FName) ForColumnName, const [FName](API\Runtime\Core\UObject\FName) InProtocolName )


description: Ensures the derived classes supports protocols.

code: const bool HasProtocolExtension() const


description: Callback for the editable text's OnTextChanged event.

code: void OnProtocolTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const [FName](API\Runtime\Core\UObject\FName) InProtocolName )


description: Determines whether the derived class supports the given protocol.

code: const bool SupportsProtocol ( const [FName](API\Runtime\Core\UObject\FName) & InProtocolName ) const


className: IHasProtocolExtensibility

description: A simple interface provides protocol specific utilities.

code: class IHasProtocolExtensibility


description:
Add a property filter that indicates if the property handle should be displayed or not. When queried, returning true will allow the expose icon to be displayed in the details panel, false will hide it.  This filter will be queried after the RemoteControlModule's own filters.
A handle to the delegate, used to unregister the delegate with the module.

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddPropertyFilter ( [FOnDisplayExposeIcon](API\Plugins\RemoteControlUI\FOnDisplayExposeIcon) OnDisplayExposeIcon )


description: Tries to retrieve a Custom Controller Widget for the specified Controller

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > CreateCustomControllerWidget ( [URCVirtualPropertyBase](API\Plugins\RemoteControl\URCVirtualPropertyBase) * InController ) const


className: FOnRemoteControlPresetOpened

description: Delegate called when a Remote Control Preset panel is created/opened for the specified Remote Control Preset

code: typedef TMulticastDelegate_OneParam< void, [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * > FOnRemoteControlPresetOpened


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

code: static [IRemoteControlUIModule](API\Plugins\RemoteControlUI\IRemoteControlUIModule) & Get()


description: Get the preset currently being edited in the editor.

code: [URemoteControlPreset](API\Plugins\RemoteControl\URemoteControlPreset) * GetActivePreset() const


description: Get the toolbar extension generators. Usage: Bind a handler that adds a widget to the out array parameter.


description: Retrieves the advanced asset category type registered by Remote Control Module.


description: If a details panel is open, highlight a property specified by the path in it.

code: void HighlightPropertyInDetailsPanel ( const [FPropertyPath](API\Editor\PropertyEditor\FPropertyPath) & Path ) const


description: Register a delegate to customize how an entry is displayed in the entity details panel.

code: void RegisterMetadataCustomization ( [FName](API\Runtime\Core\UObject\FName) MetadataKey, [FOnCustomizeMetadataEntry](API\Plugins\RemoteControlUI\FOnCustomizeMetadataEntry) OnCustomizeCallback )


description: Register a widget factory to handle creating a widget in the control panel.

code: void RegisterWidgetFactoryForType ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * RemoteControlEntityType, const [FOnGenerateRCWidget](API\Plugins\RemoteControlUI\FOnGenerateRCWidget) & OnGenerateRCWidgetDelegate )


description: Remove a property filter using its id.

code: void RemovePropertyFilter ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & FilterDelegateHandle )


description: Set the list of selected objects.

code: void SelectObjects ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & Objects ) const


className: SettingsIniSection

description: The section of EditorPerProjectUserSettings in which to save filter settings

code: static const [FString](API\Runtime\Core\Containers\FString) SettingsIniSection = TEXT("RemoteControl");


description: Unregister the delegate used to customize how an entry is displayed in the entity details panel.

code: void UnregisterMetadataCustomization ( [FName](API\Runtime\Core\UObject\FName) MetadataKey )


description: Unregister a previously registered widget factory.

code: void UnregisterWidgetFactoryForType ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * RemoteControlEntityType )


className: IRemoteControlUIModule

description: A Remote Control module that allows exposing objects and properties from the editor.

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


description: The list of categories for Entity Types.

code: namespace EEntityTypeCategories { enum Type { None = 0, Core = 1 << 0, Strings = 1 << 1, Structs = 1 << 2, Containers = 1 << 3, Objects = 1 << 4, References = 1 << 5, UserDefined = 1 << 6, Assets = 1 << 7, Primary = 1 << 8, } }


description: Unlike normal filters, Type Filters are allowed to belong to multiple categories

code: void AddCategory ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > InCategory )


className: ArrayIcon

description: Array Slate Icon.

code: static [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) ArrayIcon = FSlateIcon(FAppStyle::GetAppStyleSetName(), "Kismet.VariableList.ArrayTypeIcon");


description: Add this filter to the input Backend Filter

code: void BuildBackendFilter ( [FRCFilter](API\Plugins\RemoteControlUI\UI\Filters\FRCFilter) & OutFilter )


className: EmptyIcon

description: Empty Slate Icon.


className: EntityIcon

description: Entity Slate Icon.

code: static [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) EntityIcon = FSlateIcon(FAppStyle::GetAppStyleSetName(), "Kismet.VariableList.TypeIcon");


description: Get the AssetTypeActions associated with this filter if they exist

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAssetTypeActions](API\Developer\AssetTools\IAssetTypeActions) > GetAssetTypeActions() const


description: Get the Catgories this filter belongs to

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > > GetCategories() const


description: Get the color of this filter


description: Get theUClassassociated with this filter

code: [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetClass() const


description: Get the Property Type associated with this filter

code: [FFieldClass](API\Runtime\CoreUObject\UObject\FFieldClass) * GetEntityType() const


description: Get the Entity Type Catgories this filter belongs to


description: Get the display name of this filter class


description: Get the logical name of this filter class


description: Returns proper name of the entity type to be displayed.


description: Retrieves the appropriate icon for the filter.


className: MapIcon

description: Map Slate Icon.

code: static [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) MapIcon = FSlateIcon(FAppStyle::GetAppStyleSetName(), "Kismet.VariableList.MapValueTypeIcon");


description: Remove this filter from the input Backend Filter

code: void ResetBackendFilter ( [FRCFilter](API\Plugins\RemoteControlUI\UI\Filters\FRCFilter) & OutFilter )


className: SetIcon

description: Set Slate Icon.

code: static [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) SetIcon = FSlateIcon(FAppStyle::GetAppStyleSetName(), "Kismet.VariableList.SetTypeIcon");


description: Returns proper icon of the entity type to be displayed.


description: You can provide anIAssetTypeActionsfor your type to get all the information from that

code: FCustomTypeFilterData ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IAssetTypeActions](API\Developer\AssetTools\IAssetTypeActions) > InAssetTypeAction )


description: Or you can provide aUClass, a Category and a Color to identify the filter

code: FCustomTypeFilterData ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > InCategory, [FLinearColor](API\Runtime\Core\Math\FLinearColor) InColor )


code: FCustomTypeFilterData ( [EEntityTypeCategories::Type](API\Plugins\RemoteControlUI\UI\Filters\EEntityTypeCategories__Type) InEntityTypeCategory, [FFieldClass](API\Runtime\CoreUObject\UObject\FFieldClass) * InEntityType, const [FName](API\Runtime\Core\UObject\FName) & InCustomTypeName )


code: FCustomTypeFilterData ( [EEntityTypeCategories::Type](API\Plugins\RemoteControlUI\UI\Filters\EEntityTypeCategories__Type) InEntityTypeCategory, [FFieldClass](API\Runtime\CoreUObject\UObject\FFieldClass) * InEntityType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > InCategory, const [FName](API\Runtime\Core\UObject\FName) & InCustomTypeName )


className: FCustomTypeFilterData

description: A custom view model to represent each type of filters we have.

code: class FCustomTypeFilterData


className: FEntityFilterType

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const SRCPanelTreeNode > FEntityFilterType


description: Adds an entity type to the filters list.

code: void AddTypeFilter ( [FFieldClass](API\Runtime\CoreUObject\UObject\FFieldClass) * InEntityTypeFilter )


description: Adds a custom type to the filters list.

code: void AddTypeFilter ( const [FName](API\Runtime\Core\UObject\FName) InCustomTypeFilter )


description: Adds an asset type to the filters list.

code: void AddTypeFilter ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InAssetTypeFilter )


description: Returns true if the given item passes atleast one filter.

code: bool DoesPassFilters ( FEntityFilterType InEntityItem )


description: Returns true if atleast one of the type filters are populated.

code: bool HasAnyActiveFilters()


description: Removes an entity type from the filters list.

code: void RemoveTypeFilter ( [FFieldClass](API\Runtime\CoreUObject\UObject\FFieldClass) * InEntityTypeFilter )


description: Removes a custom type from the filters list.

code: void RemoveTypeFilter ( const [FName](API\Runtime\Core\UObject\FName) & InCustomTypeFilter )


description: Removes an asset type from the filters list.

code: void RemoveTypeFilter ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InAssetTypeFilter )


className: FRCFilter

description: A data model to represent combined backend filter.

code: class FRCFilter


code: namespace RemoteControlTypes { static RemoteControlTypes::NAME_RCActors = "Exposed Actors"; }


code: namespace RemoteControlTypes { static RemoteControlTypes::NAME_RCFunctions = "Exposed Functions"; }


description: Final override of Exec that asserts if called

module: RemoteControlWebInterface

code: virtual bool Exec ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


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


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

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FRemoteControlWebInterfaceModule

code: class FRemoteControlWebInterfaceModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface), public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


className: EStatus

code: enum EStatus { Stopped, Launching, Running, Error, }


description: Get the webapp's status.


description: Exit

code: virtual uint32 Run()


description: Enable / disable external logger

code: void SetExternalLoggerEnabled ( bool bEnableExternalLog )


description: Shutdown the webapp external process

code: void Shutdown()


description: Starts the webapp external process, first launch will take some time as it needs to compile the webapp

code: void Start()


code: FRemoteControlWebInterfaceProcess()


className: FRemoteControlWebInterfaceProcess

code: class FRemoteControlWebInterfaceProcess : private [FRunnable](API\Runtime\Core\HAL\FRunnable)


description: Closes connection to database.

module: RemoteDatabaseSupport

code: virtual void Close()


description:
Executes the passed in command on the database.
true if execution was successful, false otherwise

code: virtual bool Execute ( const TCHAR * CommandString )


description:
Executes the passed in command on the database. The caller is responsible for deleting the created RecordSet.
true if execution was successful, false otherwise

code: virtual bool Execute ( const TCHAR * CommandString, [FDataBaseRecordSet](API\Plugins\DatabaseSupport\FDataBaseRecordSet) *& RecordSet )


description:
Opens a connection to the database.
true if connection was successfully established, false otherwise

code: virtual bool Open ( const TCHAR * ConnectionString, const TCHAR * RemoteConnectionIP, const TCHAR * RemoteConnectionStringOverride )


description: Sets the connection string to be used for this connection in the DB proxy.

code: bool SetConnectionString ( const TCHAR * ConnectionString )


className: FRemoteDatabaseConnection

description: This class allows for connections to a remote database proxy that allows any platform, regardless of native DB support, to talk to a DB.

code: class FRemoteDatabaseConnection : public [FDataBaseConnection](API\Plugins\DatabaseSupport\FDataBaseConnection)


description: Constructor.

code: FRemoteDatabaseConnection()


description: Destructor.

code: virtual ~FRemoteDatabaseConnection()


description: Returns a float associated with the passed in field/ column for the current row.

code: virtual float GetFloat ( const TCHAR * Column ) const


description: Returns a string associated with the passed in field/ column for the current row.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetString ( const TCHAR * Column ) const


description: Returns an integer associated with the passed in field/ column for the current row.

code: virtual int32 GetInt ( const TCHAR * Column ) const


description:
Returns whether we are at the end.
true if at the end, false otherwise

code: virtual bool IsAtEnd() const


description: Moves to the first record in the set.

code: virtual void MoveToFirst()


description: Moves to the next record in the set.

code: virtual void MoveToNext()


description: Constructor.

code: FRemoteDataBaseRecordSet ( int32 ResultSetID, [FSocket](API\Runtime\Sockets\FSocket) * Connection )


description: Virtual destructor as class has virtual functions.

code: virtual ~FRemoteDataBaseRecordSet()


className: FRemoteDataBaseRecordSet

description: A record set that is accessed from a DB proxy.

code: class FRemoteDataBaseRecordSet : public [FDataBaseRecordSet](API\Plugins\DatabaseSupport\FDataBaseRecordSet)


code: static [IRemoteDatabaseSupport](API\Plugins\RemoteDatabaseSupport\IRemoteDatabaseSupport) & Get()


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

code: static bool IsAvailable()


className: IRemoteDatabaseSupport

description: The public interface to this module

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


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

module: RemoteSession

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


code: void AddTrackable ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Added )


className: FactoryInstance

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSystemProxy](API\Plugins\RemoteSession\Channels\FARSystemProxy), ESPMode::ThreadSafe > FactoryInstance;


description: Given a scene component find the ARPin which it is pinned by, if any.

code: virtual [UARPin](API\Runtime\AugmentedReality\UARPin) * FindARPinByComponent ( const [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component ) const


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSystemProxy](API\Plugins\RemoteSession\Channels\FARSystemProxy), ESPMode::ThreadSafe > Get()


code: virtual void * GetARSessionRawPointer()


code: static [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * GetARSystemPtr()


code: virtual void * GetGameThreadARFrameRawPointer()


description: Overload this method to report a name for your referencer

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


code: [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * GetTrackable ( [FGuid](API\Runtime\Core\Misc\FGuid) UniqueId )


description: Returns true/false based on whether AR features are available

code: virtual bool IsARAvailable() const


code: void NotifyUpdated ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Updated )


description: Tells the ARSystem to generate a capture probe at the specified location if supported

code: virtual bool OnAddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )


description:
Add candidate image at runtime
True if it added the iamge successfully

code: virtual bool OnAddRuntimeCandidateImage ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * SessionConfig, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * CandidateTexture, [FString](API\Runtime\Core\Containers\FString) FriendlyName, float PhysicalWidth )


description: aTArrayof all the pins that attach components to TrackedGeometries

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [UARPin](API\Runtime\AugmentedReality\UARPin) * > OnGetAllPins() const


description: aTArrayof all the tracked geometries known to your ar system

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * > OnGetAllTrackedGeometries() const


description: the info about whether the session is running normally or encountered some kind of error.

code: virtual [FARSessionStatus](API\Runtime\AugmentedReality\FARSessionStatus) OnGetARSessionStatus() const


code: virtual [UARTextureCameraDepth](API\Runtime\AugmentedReality\UARTextureCameraDepth) * OnGetCameraDepth()


code: virtual [UARTextureCameraImage](API\Runtime\AugmentedReality\UARTextureCameraImage) * OnGetCameraImage()


description: Generates aUARCandidateObjectfrom the point cloud data within the location and its extent using an async task

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARGetCandidateObjectAsyncTask](API\Runtime\AugmentedReality\FARGetCandidateObjectAsyncTask), ESPMode::ThreadSafe > OnGetCandidateObject ( FVector Location, FVector Extent ) const


description: Not supported methods

code: virtual [UARLightEstimate](API\Runtime\AugmentedReality\UARLightEstimate) * OnGetCurrentLightEstimate() const


description: the current point cloud data for the ar scene

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< FVector > OnGetPointCloud() const


description: The list of supported video formats for this device and session type

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > OnGetSupportedVideoFormats ( EARSessionType SessionType ) const


description: the tracking quality; if unable to determine tracking quality, return EARTrackingQuality::NotAvailable

code: virtual EARTrackingQuality OnGetTrackingQuality() const


description: the reason of limited tracking quality; if the state is not limited, return EARTrackingQualityReason::None

code: virtual EARTrackingQualityReason OnGetTrackingQualityReason() const


description: the current mapping status

code: virtual EARWorldMappingState OnGetWorldMappingStatus() const


description: whether the specified tracking type is supported by this device

code: virtual bool OnIsTrackingTypeSupported ( EARSessionType SessionType ) const


description:
Trace all the tracked geometries and determine which have been hit by a ray cast fromScreenCoord_. Only geometries specified inTraceChannels_ are considered.
a list of all the geometries that were hit, sorted by distance

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > OnLineTraceTrackedObjects ( const FVector2D ScreenCoord, EARLineTraceChannels TraceChannels )


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FARTraceResult](API\Runtime\AugmentedReality\FARTraceResult) > OnLineTraceTrackedObjects ( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels )


description: Stop the AR system but leave its internal state intact.

code: virtual void OnPauseARSession()


description:
Pin an Unreal Component to a location in the world. Optionally, associate with a TrackedGeometry to receive transform updates that effectively attach the component to the geometry.
theUARPinobject that is pinning the component to the world and (optionally) a TrackedGeometry

code: virtual [UARPin](API\Runtime\AugmentedReality\UARPin) * OnPinComponent ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, const FTransform & PinToWorldTransform, [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * TrackedGeometry, const [FName](API\Runtime\Core\UObject\FName) DebugName )


description:
Pin a component to an existing ARPin. If the component is alreayd pinned it will first be removed from that pin, which will be left empty. If the target Pin is already in use the component previously pinned to it will be unpinned.
true if the operation was successful

code: virtual bool OnPinComponentToARPin ( [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * ComponentToPin, [UARPin](API\Runtime\AugmentedReality\UARPin) * Pin )


description: Saves the AR world to a byte array using an async task

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSaveWorldAsyncTask](API\Runtime\AugmentedReality\FARSaveWorldAsyncTask), ESPMode::ThreadSafe > OnSaveWorld() const


description: Given a pin, remove it and stop updating the associated component based on the tracked geometry. The component in question will continue to track with the world, but will not get updates specific to a TrackedGeometry.

code: virtual void OnRemovePin ( [UARPin](API\Runtime\AugmentedReality\UARPin) * PinToRemove )


description: Set a transform that will align the Tracking Space origin to the World Space origin. This is useful for supporting static geometry and static lighting in AR. Note: Usually, an app will ask the user to select an appropriate location for some experience. This allows us to choose an appropriate alignment transform.

code: virtual void OnSetAlignmentTransform ( const FTransform & InAlignmentTransform )


description: Stop the AR system and reset its internal state; this task must succeed.

code: virtual void OnStopARSession()


description: End todo block.

code: virtual void OnStartARSession ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * Config )


code: void RemoveTrackable ( [FGuid](API\Runtime\Core\Misc\FGuid) UniqueId )


code: void SetSessionConfig ( [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig) * InConfig )


description: Methods called by the message handlers.

code: void SetSupportedVideoFormats ( const [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > & InFormats )


description: Only the factory method should construct this

code: FARSystemProxy()


className: FARSystemProxy

description: This class acts as if there is a AR system present on the desktop that is receiving data from a remote device

code: class FARSystemProxy : public [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject), public [TSharedFromThis< FARSystemProxy, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


description: Returns the post process material to render with. The textures are set on the fly

code: [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetPostProcessMaterial() const


description: Overload this method to report a name for your referencer

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


code: virtual const TCHAR * GetType() const


description: Compresses in the background and queues for sending

code: void QueueARCameraImage()


description: Handles data coming from the client

code: void ReceiveARCameraImage ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


description: BeginIRemoteSessionChannelimplementation

code: static const TCHAR * StaticType()


description: Sends the most recent compressed AR camera image to the remote

code: void SendARCameraImage()


code: FRemoteSessionARCameraChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


description: Updates the next texture to be rendered

code: void UpdateRenderingTexture()


code: ~FRemoteSessionARCameraChannel()


code: virtual void Tick ( const float InDeltaTime )


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel) > Construct ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InMode, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection ) const


className: FRemoteSessionARCameraChannel

code: class FRemoteSessionARCameraChannel : public [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject)


code: void ReceiveAddTrackable ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: void ReceiveAddTrackable_GameThread ( [FString](API\Runtime\Core\Containers\FString) ClassPathName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > DataCopy )


description: Message handlers.

code: void ReceiveARInit ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


description: Game thead message handlers.

code: void ReceiveARInit_GameThread ( [FString](API\Runtime\Core\Containers\FString) ConfigObjectPathName, [TArray](API\Runtime\Core\Containers\TArray)< [FARVideoFormat](API\Runtime\AugmentedReality\FARVideoFormat) > Formats )


code: void ReceiveRemoveTrackable ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: void ReceiveRemoveTrackable_GameThread ( [FGuid](API\Runtime\Core\Misc\FGuid) UniqueId )


code: void ReceiveUpdateTrackable ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: void ReceiveUpdateTrackable_GameThread ( [FGuid](API\Runtime\Core\Misc\FGuid) UniqueId, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > DataCopy )


description: Sends the name of the config object we're using so it can be loaded on the remote. Also passes the video settings and supported session types

code: void SendARInitMessage()


description: AR notification handlers that send the data to the listener.

code: void SendAddedMessage ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Added )


code: void SendRemovedMessage ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Removed )


code: void SendUpdatedMessage ( [UARTrackedGeometry](API\Runtime\AugmentedReality\UARTrackedGeometry) * Updated )


code: FRemoteSessionARSystemChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


className: FRemoteSessionARSystemChannel

description: Class used to deliver AR trackable items to the remote machine. Inherits from the XR tracking channel which handles sending all of the position & orientation updates. Do not use both this channel and the XR tracking at the same time, since they both hook GEngine->XRSystem and you will get inconsistent results

code: class FRemoteSessionARSystemChannel : public [FRemoteSessionXRTrackingChannel](API\Plugins\RemoteSession\Channels\FRemoteSessionXRTrackingChannel)


code: static const TCHAR * StaticType()


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel) > CreateChannel ( const FStringView InChannelName, [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InMode, TBackChannelSharedPtr< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection) > InConnection )


code: static [FRemoteSessionChannelRegistry](API\Plugins\RemoteSession\Channels\FRemoteSessionChannelRegistry) & Get()


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FRemoteSessionChannelInfo](API\Plugins\RemoteSession\FRemoteSessionChannelInfo) > & GetRegisteredFactories() const


code: void RegisterChannelFactory ( const TCHAR * InChannelName, [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InHostMode, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IRemoteSessionChannelFactoryWorker](API\Plugins\RemoteSession\Channels\IRemoteSessionChannelFactoryWork-) > InFactory )


code: void RemoveChannelFactory ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IRemoteSessionChannelFactoryWorker](API\Plugins\RemoteSession\Channels\IRemoteSessionChannelFactoryWork-) > InFactory )


code: FRemoteSessionChannelRegistry()


className: FRemoteSessionChannelRegistry

code: class FRemoteSessionChannelRegistry

KnownChannels

type: TArray<FRemote...

RegisteredFactories

type: TMap<FString, ...


code: void ExitBackgroundThread()


description: Creates a texture to receive images into

code: void CreateTexture ( const int32 InSlot, const int32 InWidth, const int32 InHeight )


className: FImageData

code: struct FImageData

ImageData

type: TArray< uint8 >

TimeCreated

type: double


description: Send an image to the connected clients

code: void SendRawImageToClients &40; int32 Width, int32 Height, const void &42; ImageData, int32 AllocatedImageDataSize, int32 BytesPerRow &41;


description: Send an image to the connected clients

code: void SendRawImageToClients &40; int32 Width, int32 Height, const TArray< FColor > & ImageData, int32 BytesPerRow &41;


description: Set the jpg compression quality

code: void SetCompressQuality &40; int32 InQuality &41;


code: FImageSender &40; TSharedPtr< IBackChannelConnection, ESPMode::ThreadSafe > InConnection &41;


className: FImageSender

description: A helper object responsible to take the raw data, encode it to jpg and send it to the client for the RemoteSessionImageChannel

code: class FImageSender


description: Get the client Texture2D to display

code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetHostScreen() const


description: Return the image sender connected to the clients


description: Decode the incoming images on a dedicated thread

code: void ProcessIncomingTextures()


code: virtual const TCHAR * GetType() const


description: Bound to receive incoming images

code: void ReceiveHostImage ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


description: Background thread for decoding incoming images

code: virtual uint32 Run()


description: Set the jpg compression quality

code: void SetCompressQuality ( int32 InQuality )


description: Sets up an image provider that mirrors the games framebuffer. Will be the default if no ImageProvider is set.

code: void SetFramebufferAsImageProvider()


description: Set the ImageProvider that will produce the images that will be sent to the client

code: void SetImageProvider ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionImageProvider](API\Plugins\RemoteSession\Channels\IRemoteSessionImageProvider) > ImageProvider )


code: void StartBackgroundThread()


code: static const TCHAR * StaticType()


description: Tick this channel

code: virtual void Tick ( const float InDeltaTime )


code: FRemoteSessionImageChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


code: ~FRemoteSessionImageChannel()


className: FRemoteSessionImageChannel

description: A channel that takes an image (created by anIRemoteSessionImageProvider), then sends it to the client (with a FRemoteSessionImageSender). On the client images are decoded into a double-buffered texture that can be accessed via GetHostScreen.

code: class FRemoteSessionImageChannel : public [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel), private [FRunnable](API\Runtime\Core\HAL\FRunnable)

BackgroundThread

type: FRunnableThread...

Connection

type: TWeakPtr<IBack...

description: Underlying connection

DecodedImageMutex

type: FCriticalSectio...

DecodedTextureIndex

type: TSharedPtr<TAt...

ExitRequested

type: FThreadSafeBool

HaveConfiguredImageProvider

type: bool

ImageProvider

type: TSharedPtr<IRe...

ImageSender

type: TSharedPtr<FIm...

description: Image sender used by the channel

IncomingDecodedImages

type: TArray<TUnique...

LastDecodedImageIndex

description: Last processed decode image

LastIncomingImageIndex

description: Last processed incoming image

MessageCallbackHandle

type: FDelegateHandle

description: So we can manage callback lifetimes properly

ReceiveStats

type: FRemoteSessionI...

Role

type: ERemoteSessionC...

description: Our role

ScreenshotEvent

type: FEvent*


className: FRemoteSessionImageReceiveStats

code: struct FRemoteSessionImageReceiveStats


description:
Only useful during playback.
Null when recording, Pointer to delegate during playback.


code: void OnRemoteMessage ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: virtual void RecordMessage ( const TCHAR * MsgName, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: void SetInputRect ( const FVector2D & TopLeft, const FVector2D & Extents )


code: void SetPlaybackWindow ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > InWindow, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > InViewport )


code: void TryRouteTouchMessageToWidget ( bool bRouteMessageToWidget )


code: FRemoteSessionInputChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


code: ~FRemoteSessionInputChannel()


className: FRemoteSessionInputChannel

code: class FRemoteSessionInputChannel : public [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel), public IRecordingMessageHandlerWriter

Connection

type: TSharedPtr<IBa...

DefaultHandler

type: TSharedPtr<FGe...

PlaybackHandler

type: TSharedPtr< FRe...


code: virtual const TCHAR * GetType() const


description: Handles data coming from the client

code: void ReceiveLiveLinkHello ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


description: Sends the current location and rotation for the XRTracking system to the remote

code: void SendLiveLinkHello ( const FStringView InSubjectName )


code: static const TCHAR * StaticType()


code: FRemoteSessionLiveLinkChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


code: virtual void Tick ( const float InDeltaTime )


className: FRemoteSessionLiveLinkChannel

code: class FRemoteSessionLiveLinkChannel : public [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel)


description: Handles data coming from the client

code: void ReceiveXRTracking ( [IBackChannelPacket](API\Plugins\BackChannel\BackChannel\IBackChannelPacket) & Message )


code: void SendXRTracking()


code: FRemoteSessionXRTrackingChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection )


description: Only to be called by child classes

code: FRemoteSessionXRTrackingChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection), ESPMode::ThreadSafe > InConnection, [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * ARSystemSupport )


className: FRemoteSessionXRTrackingChannel

code: class FRemoteSessionXRTrackingChannel : public [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel)

ARSystemSupport

type: IARSystemSuppor...

description: Used by a child class to pass in a AR system to use as part of the proxy

ProxyXRSystem

type: TSharedPtr<FXR...

description: Used to set the values from the remote client as the XRTracking's pose

XRSystem

type: TSharedPtr<IXR...

description: If we're sending, this is GEngine->XRSystem.


description: Whether or not the system supports positional tracking (either via sensor or other means). The default implementation always returns false, indicating that only rotational tracking is supported.

code: virtual bool DoesSupportPositionalTracking() const


className: FRemoteSesstionImageCaptureStats

description: Receiving counters and stats.

code: struct FRemoteSesstionImageCaptureStats

LastUpdateTime

type: double


description: Reports all devices currently available to the system, optionally limiting the result to a given class of devices.

code: virtual bool EnumerateTrackedDevices ( [TArray](API\Runtime\Core\Containers\TArray)< int32 > & OutDevices, EXRTrackedDeviceType Type )


description:
Get the current pose for a device. This method must be callable both on the render thread and the game thread. For devices that don't support positional tracking, OutPosition will be at the base position.
true if the pose is valid or not.

code: virtual bool GetCurrentPose ( int32 DeviceId, FQuat & OutOrientation, FVector & OutPosition )


description:
Returns a unique identifier that's supposed to represent the third party system that this object is part of (Vive, Oculus, PSVR, etc.).
A name unique to the system which this object belongs to.

code: virtual [FName](API\Runtime\Core\UObject\FName) GetSystemName() const


description:
This method should return the world to meters scale for the current frame. Should be callable on both the render and the game threads.
the current world to meter scale.

code: virtual float GetWorldToMetersScale() const


description: Returns device specific flags.

code: virtual int32 GetXRSystemFlags() const


description: Returns true, if head tracking is allowed. Most common case: it returns true when GEngine->IsStereoscopic3D() is true, but some overrides are possible.

code: virtual bool IsHeadTrackingAllowed() const


description:
Check current tracking status of a device.
The default implementation returns the result of calling GetCurrentPose(DeviceId, ...), ignoring the returned pose.
true if the system currently has valid tracking info for the given device ID.

code: virtual bool IsTracking ( int32 DeviceId )


description: Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction and assuming current position as a 'zero-point' (for positional tracking).

code: virtual void ResetOrientationAndPosition ( float Yaw )


code: FXRTrackingProxy ( [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * InARSystemSupport )


className: FXRTrackingProxy

code: class FXRTrackingProxy : public [FXRTrackingSystemBase](API\Plugins\XRBase\FXRTrackingSystemBase)


code: const TCHAR * GetType() const


code: void Tick ( const float InDeltaTime )


code: IRemoteSessionChannel ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InRole, TBackChannelSharedPtr< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection) > InConnection )


code: virtual ~IRemoteSessionChannel()


className: IRemoteSessionChannel

code: class IRemoteSessionChannel


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel) > Construct ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InMode, TBackChannelSharedPtr< [IBackChannelConnection](API\Plugins\BackChannel\BackChannel\IBackChannelConnection) > InConnection ) const


className: IRemoteSessionChannelFactoryWorker


code: virtual ~IRemoteSessionImageProvider()


className: IRemoteSessionImageProvider

code: class IRemoteSessionImageProvider


className: ERemoteSessionChannelChange

code: enum ERemoteSessionChannelChange { Created, Destroyed, }


className: ERemoteSessionChannelMode

code: enum ERemoteSessionChannelMode { Unknown, Read, Write, MaxValue, }


className: ERemoteSessionConnectionChange

code: enum ERemoteSessionConnectionChange { Connected, Disconnected, }


className: FOnRemoteSessionChannelChange

code: typedef TMulticastDelegate_ThreeParams< void, [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) *, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel) >, [ERemoteSessionChannelChange](API\Plugins\RemoteSession\ERemoteSessionChannelChange) > FOnRemoteSessionChannelChange


className: FOnRemoteSessionConnectionChange

code: typedef TMulticastDelegate_TwoParams< void, [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) *, [ERemoteSessionConnectionChange](API\Plugins\RemoteSession\ERemoteSessionConnectionChange) > FOnRemoteSessionConnectionChange


className: FOnRemoteSessionReceiveChannelList

code: typedef TMulticastDelegate_TwoParams< void, [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) *, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FRemoteSessionChannelInfo](API\Plugins\RemoteSession\FRemoteSessionChannelInfo) > > FOnRemoteSessionReceiveChannelList


code: FRemoteSessionChannelInfo()


code: FRemoteSessionChannelInfo ( [FString](API\Runtime\Core\Containers\FString) InType, [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InMode )


className: FRemoteSessionChannelInfo

Type

type: FString


description: Safely create the frame grabber

code: void CreateFrameGrabber ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > Viewport )


description: Signals that the viewport was resized

code: void OnViewportResized ( FVector2D NewSize )


description: When the window is destroyed

code: void OnWindowClosedEvent ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > & )


description: Release the FrameGrabber

code: void ReleaseFrameGrabber()


description: Specifies the framerate at

code: void SetCaptureFrameRate ( int32 InFramerate )


description: Specifies which viewport to capture

code: void SetCaptureViewport ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSceneViewport](API\Runtime\Engine\Slate\FSceneViewport) > Viewport )


description: Tick this channel

code: virtual void Tick ( const float InDeltaTime )


code: FRemoteSessionFrameBufferImageProvider ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FRemoteSessionImageChannel::FImageSender](API\Plugins\RemoteSession\Channels\FRemoteSessionImageChannel\FImageSender), ESPMode::ThreadSafe > ImageSender )


description: Initialization method to prepare implementation for capture

code: virtual bool InitializeCapture()


className: FRemoteSessionFrameBufferImageProvider

description: Use the FrameGrabber on the host to provide an image to the image channel.

code: class FRemoteSessionFrameBufferImageProvider : public [IRemoteSessionImageProvider](API\Plugins\RemoteSession\Channels\IRemoteSessionImageProvider)

CaptureStats

type: FRemoteSesstion...

FrameGrabber

type: TSharedPtr<FFr...

ImageSender

type: TWeakPtr<FRemo...

LastSentImageTime

description: Time we last sent an image

NumDecodingTasks

type: TSharedPtr<FTh...

SceneViewport

type: TWeakPtr<FScen...

description: Holds a reference to the scene viewport

SceneViewportWindow

type: TWeakPtr<SWind...

description: Holds a reference to the SceneViewportSWindow

ViewportResized

description: Shows that the viewport was just resized


code: 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, int BytesPerRow )


className: URemoteSessionMediaCapture

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class URemoteSessionMediaCapture : public [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture)


code: virtual [UMediaCapture](API\Plugins\MediaIOCore\UMediaCapture) * CreateMediaCaptureImpl()


description: The conversion we wish to accomplish on the GPU before the DMA transfer occurs.

code: virtual [EMediaCaptureConversionOperation](API\Plugins\MediaIOCore\EMediaCaptureConversionOperation) GetConversionOperation ( [EMediaCaptureSourceType](API\Plugins\MediaIOCore\EMediaCaptureSourceType) InSourceType ) const


description: The pixel format of the buffer we wish to capture. Some conversion are available. See EMediaCaptureConversionOperation

code: virtual EPixelFormat GetRequestedPixelFormat() const


description: The size of the buffer we wish to capture. The size of the buffer can not change during the capture. Return UMediaOutput::RequestCaptureSourceSize if you wish to take the buffer size as the requested size.

code: virtual FIntPoint GetRequestedSize() const


code: void SetImageChannel ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FRemoteSessionImageChannel](API\Plugins\RemoteSession\Channels\FRemoteSessionImageChannel) > ImageChannel )


className: URemoteSessionMediaOutput

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType) class URemoteSessionMediaOutput : public [UMediaOutput](API\Plugins\MediaIOCore\UMediaOutput)


description: Register a third party channel

code: void AddChannelFactory ( const FStringView InChannelName, [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InHostMode, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IRemoteSessionChannelFactoryWorker](API\Plugins\RemoteSession\Channels\IRemoteSessionChannelFactoryWork-) > Worker )


description: Client implementation Returns a reference to the client role (if any)

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) > CreateClient ( const TCHAR * RemoteAddress )


description: Returns host that is not controlled by the module

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionUnmanagedRole](API\Plugins\RemoteSession\IRemoteSessionUnmanagedRole) > CreateHost ( [TArray](API\Runtime\Core\Containers\TArray)< [FRemoteSessionChannelInfo](API\Plugins\RemoteSession\FRemoteSessionChannelInfo) > SupportedChannels, int32 Port ) const


description: Returns a reference to the server role (if any)

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) > GetHost() const


description: Returns true/false if a client is connected

code: bool IsHostConnected() const


description: Server implementation Starts a RemoteSession server that listens for clients on the provided port

code: void InitHost ( const int16 Port )


description: Returns true/false based on the running state of the host server

code: bool IsHostRunning() const


className: kDefaultPort

description: EndIModuleInterfaceimplementation

code: enum { kDefaultPort = 2049 }


description: Unregister a channel factory

code: void RemoveChannelFactory ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IRemoteSessionChannelFactoryWorker](API\Plugins\RemoteSession\Channels\IRemoteSessionChannelFactoryWork-) > Worker )


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

code: void ShutdownModule()


description: IModuleInterfaceimplementation

code: void StartupModule()


description: Stops the client. After thisCreateClient()must be called if a new connection is desired

code: void StopClient ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole) > Client, const [FString](API\Runtime\Core\Containers\FString) & InReason )


description: Stops the server, after thisInitHost()must be called if a new connection is desired

code: void StopHost ( const [FString](API\Runtime\Core\Containers\FString) & InReason )


className: IRemoteSessionModule

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


code: template<class T> [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< T > GetChannel()


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRemoteSessionChannel](API\Plugins\RemoteSession\Channels\IRemoteSessionChannel) > GetChannel ( const TCHAR * Type )


description: Future versions will support querying the version type, at the moment we just have old & new

code: bool IsLegacyConnection() const


code: bool OpenChannel ( const [FRemoteSessionChannelInfo](API\Plugins\RemoteSession\FRemoteSessionChannelInfo) & Info )


description: Register for notifications whenever a change in the state of a channel occurs

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterChannelChangeDelegate ( FOnRemoteSessionChannelChange::FDelegate InDelegate )


description: Register for notifications when the host sends a list of available channels

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterChannelListDelegate ( FOnRemoteSessionReceiveChannelList::FDelegate InDelegate )


description: Registers a delegate for notifications of connection changes

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterConnectionChangeDelegate ( FOnRemoteSessionConnectionChange::FDelegate InDelegate )


description: Unregister all delegates for the specified object

code: void RemoveAllDelegates ( void * UserObject )


className: IRemoteSessionRole

code: class IRemoteSessionRole


code: void Close ( const [FString](API\Runtime\Core\Containers\FString) & InReason )


code: void Tick ( float DeltaTime )


className: IRemoteSessionUnmanagedRole

code: class IRemoteSessionUnmanagedRole : public [IRemoteSessionRole](API\Plugins\RemoteSession\IRemoteSessionRole)


className: LexFromString

code: void LexFromString ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) & Value, const TCHAR * String )


className: LexToString

code: const TCHAR * LexToString ( [ERemoteSessionChannelMode](API\Plugins\RemoteSession\ERemoteSessionChannelMode) InMode )


className: URemoteSessionSettings

description: Settings for the Asset Management framework, which can be used to discover, load, and audit game-specific asset types

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

AllowedChannels

type: TArray<FString...

description: Restrict remote session to these channels. If empty all registered channels are available

bAllowInShipping

type: bool

description: Whether RemoteSession is functional in a shipping build

bAutoHostWithGame

description: Does launching a game automatically host a session?

bAutoHostWithPIE

description: Does PIE automatically start hosting a session?

ConnectionTimeout

description: Time until a connection will timeout

ConnectionTimeoutWhenDebugging

description: Time until a connection will timeout when a debugger is attached

DeniedChannels

description: Don't allow these channels to be used

FrameRate

description: Framerate of images from the host (will be min of this value and the actual framerate of the game

HostPort

description: Port that the host will listen on

ImageQuality

description: Image quality (1-100)

PingTime

description: Time between pings


module: RenderGrid

code: virtual [URenderGridPropsSourceBase](API\Plugins\RenderGrid\RenderGrid\URenderGridPropsSourceBase) * CreateInstance ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * PropsSourceOrigin )


className: IRenderGridPropsSourceFactory

description: The base class for the factory classes that will createURenderGridPropsSourceBaseinstances.

code: class IRenderGridPropsSourceFactory


className: FLogCategoryLogRenderGrid

code: struct FLogCategoryLogRenderGrid : public [FLogCategory< ELogVerbosity::Log, ELogVerbosity::All >](API\Runtime\Core\Logging\FLogCategory)


description: Creates aURenderGridPropsSourceBaseinstance, based on the given ERenderGridPropsSourceType.

code: [URenderGridPropsSourceBase](API\Plugins\RenderGrid\RenderGrid\URenderGridPropsSourceBase) * CreatePropsSource ( [ERenderGridPropsSourceType](API\Plugins\RenderGrid\RenderGrid\ERenderGridPropsSourceType) PropsSourceType, [UObject](API\Runtime\CoreUObject\UObject\UObject) * PropsSourceOrigin )


description:
Singleton-like access toIRenderGridModule.
Returns RenderGridModule singleton instance, loading the module on demand if needed.

code: static [IRenderGridModule](API\Plugins\RenderGrid\IRenderGridModule) & Get()


description: Returns all setIRenderGridPropsSourceFactoryinstances, these are used to createURenderGridPropsSourceBaseinstances based on a given ERenderGridPropsSourceType.

code: const [TMap](API\Runtime\Core\Containers\TMap)< [ERenderGridPropsSourceType](API\Plugins\RenderGrid\RenderGrid\ERenderGridPropsSourceType), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IRenderGridPropsSourceFactory](API\Plugins\RenderGrid\Factories\IRenderGridPropsSourceFactory) > > & GetPropsSourceFactories() const


className: IRenderGridModule

description: RenderGrid module interface.

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


className: ERenderGridPropsSourceType

description: The type of the properties source. In other words, where the properties come from that each render grid job can have.

code: enum ERenderGridPropsSourceType { Local = 0, RemoteControl = 1, }


className: FOnRenderGridQueueFinished

description: A delegate for when a rendering queue has finished.

code: typedef TMulticastDelegate_TwoParams< void, [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) *, bool > FOnRenderGridQueueFinished


className: FOnRenderGridQueueStarted

description: A delegate for when a rendering queue is about to start.

code: typedef TMulticastDelegate_OneParam< void, [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * > FOnRenderGridQueueStarted


description: A delegate for whenFRenderGridManager::RenderPreviewFramehas finished.

code: typedef TBaseDelegate_OneParam< void, bool > FRenderGridManagerRenderPreviewFrameArgsCallback


description: Applies the props of the given render grid job, also requires the render grid to be given as well (to know what props the render grid job is using).

code: [FRenderGridManagerPreviousPropValues](API\Plugins\RenderGrid\RenderGrid\FRenderGridManagerPreviousPropVa-) ApplyJobPropValues ( const [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * Grid, const [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job )


description: Batch render the given render grid job(s) of the given render grid. Only renders a single frame of each job.

code: [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * CreateBatchRenderQueueSingleFrame ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * Grid, const [TArray](API\Runtime\Core\Containers\TArray)< [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * > & Jobs, const int32 Frame )


description:
Singleton-like access toFRenderGridManager. Will error if this module hasn't started (or has stopped).
Returns RenderGridManager singleton instance.

code: [FRenderGridManager](API\Plugins\RenderGrid\RenderGrid\FRenderGridManager) & GetManager() const


description: Batch render the given render grid job(s) of the given render grid. Only renders a single frame of each job. The frame number it renders is based on the given FramePosition (0.0 is the first frame, 1.0 is the last frame, 0.5 is the frame in the middle, etc).

code: [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * CreateBatchRenderQueueSingleFramePosition ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * Grid, const [TArray](API\Runtime\Core\Containers\TArray)< [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * > & Jobs, const double FramePosition )


description: Batch render the given render grid job(s) of the given render grid.

code: [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * CreateBatchRenderQueue ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * Grid, const [TArray](API\Runtime\Core\Containers\TArray)< [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * > & Jobs )


className: GeneratedIdCharacterLength

description: The number of characters for a generated ID. For example, a value of 4 results in IDs: "0001", "0002", etc.

code: static constexpr int32 GeneratedIdCharacterLength = 4;


description: Gets the rendered preview frame of the given frame number (of a rendering in which the frame number was not specified).

code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetRenderedPreviewFrame ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job, const int32 Frame )


code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetRenderedPreviewFrame ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job, const int32 Frame, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * ReusingTexture2D, bool & bOutReusedGivenTexture2D )


description: Gets the rendered preview frame (of a rendering in which the frame number was specified).

code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetSingleRenderedPreviewFrame ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job )


code: [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * GetSingleRenderedPreviewFrame ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * ReusingTexture2D, bool & bOutReusedGivenTexture2D )


description: Render a preview frame (or multiple if no frame number is specified) of the given render grid job.

code: [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * RenderPreviewFrame ( const [FRenderGridManagerRenderPreviewFrameArgs](API\Plugins\RenderGrid\RenderGrid\FRenderGridManagerRenderPreviewF-) & Args )


description: Restores the props that were previously applied, to the values that they were before.

code: void RestorePropValues ( const [FRenderGridManagerPreviousPropValues](API\Plugins\RenderGrid\RenderGrid\FRenderGridManagerPreviousPropVa-) & PreviousPropValues )


className: TmpRenderedFramesPath

description: A folder in which rendered frames for temporary use will be placed in.

code: static [FString](API\Runtime\Core\Containers\FString) TmpRenderedFramesPath = FPaths::AutomationTransientDir() / TEXT("RenderGrid");


description: Makes sure that all the data from the current props source is stored in all of the render grid jobs of this render grid.

code: void UpdateStoredRenderGridJobsPropValues ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * Grid )


className: FRenderGridManager

description: This functionality is separated from the UI in order to make it is reusable, meaning that it can also be used in other modules.

code: class FRenderGridManager


code: FRenderGridManagerPreviousPropValues()


code: FRenderGridManagerPreviousPropValues ( const [TMap](API\Runtime\Core\Containers\TMap)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [URenderGridPropRemoteControl](API\Plugins\RenderGrid\RenderGrid\URenderGridPropRemoteControl) >, [FRenderGridRemoteControlPropertyData](API\Plugins\RenderGrid\RenderGrid\FRenderGridRemoteControlProperty-) > & InRemoteControlData )


className: FRenderGridManagerPreviousPropValues

description: This struct keeps track of the values of the properties before new values were applied, so we can rollback to the previous state.

RemoteControlData

type: TMap<TObjectPt...

description: The previous values of the remote control properties.


description: The arguments for theFRenderGridManager::RenderPreviewFramefunction.

bHeadless

description: Whether it should run invisibly (so without any UI elements popping up during rendering) or not.

Callback

type: FRenderGridMana...

description: The delegate for when the rendering has finished.

Frame

type: TOptional< int3...

description: The specific frame number that will be rendered.

RenderGrid

type: TStrongObjectPt...

description: The render grid of the given render grid jobs that will be rendered.

RenderGridJob

description: The specific render grid job that will be rendered.

Resolution

type: FIntPoint

description: The resolution it will be rendered in.


className: FRenderGridQueueCreateArgs

description: The arguments for theURenderGridQueue::Createfunction.

code: struct FRenderGridQueueCreateArgs

bEnsureSequentialFilenames

description: Whether it should make sure it will output files named 0000000001, 0000000002, etc (if this bool is true, it will override the FileNameFormat to simply output the frame number, and it will add 1000000000 to that frame number to hopefully ensure that any negative frame numbers will not result in filenames starting with a minus character).

bForceOnlySingleOutput

description: Whether it should make sure it will only output in a single format (if this bool is true, if for example JPG and PNG output are enabled, one will be disabled, so that there will only be 1 output that's enabled).

bForceOutputImage

description: Whether it should make sure it will output an image or not (if this bool is true, it will test if JPG/PNG/etc output is enabled, if none are, it will enable PNG output).

bForceUseSequenceFrameRate

description: Whether it should use the sequence's framerate rather than any manually set framerate (if this bool is true, it will make sure bUseCustomFrameRate is set to false).

bIsBatchRender

description: Whether it should run the Begin and End Batch Render events or not.

DisablePipelineSettingsClasses

type: TArray<TSubcla...

description: The movie pipeline settings classes to disable (things like Anti-Aliasing, High-Res, etc).

FramePosition

type: TOptional< doub...

description: The specific frame number (percentage-wise, between 0.0 and 1.0) that will be rendered.

PipelineExecutorClass

type: TSubclassOf<UM...

description: If not null, it will override the movie pipeline executor class with this class.

RenderGridJobs

type: TArray<TStrong...

description: The specific render grid jobs that will be rendered.


code: FRenderGridRemoteControlPropertyData()


code: FRenderGridRemoteControlPropertyData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBytes )


className: FRenderGridRemoteControlPropertyData

description: It's currently simply a wrapper around a byte array. This struct is needed so that that byte array can be used in another UPROPERTY container (TMap,TArray, etc).

Bytes

type: TArray< uint8 >

description: The property data, as bytes.


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Render Grid") void AddRenderGridJob ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job )


description: Overridable native event for when batch rendering begins.

code: virtual void BeginBatchRender ( [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * Queue )


description: Overridable native event for when this asset is opened in the editor. The asset will also be closed and reopened during a blueprint compile.

code: virtual void BeginEditor()


description: Overridable native event for when job rendering begins.

code: virtual void BeginJobRender ( [URenderGridQueue](API\Plugins\RenderGrid\RenderGrid\URenderGridQueue) * Queue, [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job )


description: Overridable native event for when job rendering for the viewport viewer-mode begins.

code: virtual void BeginViewportRender ( [URenderGridJob](API\Plugins\RenderGrid\RenderGrid\URenderGridJob) * Job )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Render Grid", Meta=(Keywords="remove delete all")) void ClearRenderGridJobs()


description: Copy all properties from the given RenderGrid to self.

code: void CopyAllProperties ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * From )


description: Copy all properties except jobs from the given RenderGrid to self.

code: void CopyAllPropertiesExceptJobs ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * From )


description: Copy all user variables (configured in the blueprint graph) from the given RenderGrid to self.

code: void CopyAllUserVariables ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * From )


description: Copy jobs from the given RenderGrid to self.

code: void CopyJobs ( [URenderGrid](API\Plugins\RenderGrid\RenderGrid\URenderGrid) * From )


description: Creates a new job and adds it to this grid.


description: Creates a new job. This job won't be added to the grid, so it will eventually be garbage collected.