Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FRemoteControlProtocolBinding

Struct which holds the bound struct and serialized struct archive

Windows

MacOS

Linux

References

Module	RemoteControl
Header	/Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h
Include	#include "RemoteControlProtocolBinding.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FRemoteControlProtocolBinding

Remarks

Struct which holds the bound struct and serialized struct archive

Variables

	Name	Description
FGuid	Id	Binding Id
FName	MappingPropertyName	Property name which we using for protocol range mapping
FGuid	PropertyId	Property Unique ID
FName	ProtocolName	Protocol name which we using for binding

Constructors

	Name	Description
	FRemoteControlProtocolBinding()
	FRemoteControlProtocolBinding ( const FName InProtocolName, const FGuid& InPropertyId, TSharedPtr< TStructOnScope< FRemote... )

Functions

	Name	Description
void	AddMapping ( const FRemoteControlProtocolMapping... )	Add binding mapping to the protocol bound struct
void	ClearMappings()	Empty all mapping for the bound struct
FRemoteContr...	FindMapping ( const FGuid& InMappingId )	Remove the bound struct mapping based on given mapping id
void	ForEachMapping ( FGetProtocolMappingCallback InCallb... )	Loop through all mappings
const FGuid ...	GetId()	Get protocol binding id
const FGuid ...	GetPropertyId()	Get exposed property id
FName	GetProtocolName()	Get protocol bound protocol name, such as MIDI, DMX, OSC, etc
TSharedPtr< ...	GetRemoteControlProtocolEntityPtr()	Get pointer to the StructOnScope
TSharedPtr< ...	GetStructOnScope()	Get bound struct scope wrapper
bool	IsRangePropertyTypeSupported()	Checks if the given PropertyType (FProperty) is supported
bool	IsRangeTypeSupported()	Checks if the given ValueType is supported
int32	RemoveMapping ( const FGuid& InMappingId )	Remove the bound struct mapping based on given mapping id
bool	Serialize ( FArchive& Ar )	Custom struct serialize
bool	SetPropertyDataToMapping ( const FGuid& InMappingId, const void* InPropertyValuePtr )	Set mapping property data to bound mapping struct.
bool	SetRangeToMapping ( const FGuid& InMappingId, T InRangeValue )	Set range value which is bound to mapping struct

Operators

		Name	Description
	bool	operator== ( const FRemoteControlProtocolBinding... )
	bool	operator== ( FGuid InProtocolBindingId )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss