1. Epic GamesDeveloper
  3. FRemoteControlProtocolBinding

FRemoteControlProtocolBinding

Struct which holds the bound struct and serialized struct archive

API > API/Plugins > API/Plugins/RemoteControl

Struct which holds the bound struct and serialized struct archive

   
Name FRemoteControlProtocolBinding
Type struct
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlProtocolBinding.h
Include Path #include "RemoteControlProtocolBinding.h"

Syntax

USTRUCT ()  
struct FRemoteControlProtocolBinding

Constructors

Name Remarks Include Path Unreal Specifiers

FRemoteControlProtocolBinding ( const FName InProtocolName,
const FGuid& InPropertyId,
TSharedPtr< TStructOnScope< FRemoteControlProtocolEntity > > InRemoteControlProtocolEntityPtr,
const FGuid& InBindingId
)

   RemoteControlProtocolBinding.h  
  RemoteControlProtocolBinding.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
RemoteControlProtocolEntityPtr TSharedPtr< TStructOnScope< FRemoteControlProtocolEntity > > Pointer to struct on scope RemoteControlProtocolBinding.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMapping ( const FRemoteControlProtocolMapping& InProtocolMapping
)

 Add binding mapping to the protocol bound struct RemoteControlProtocolBinding.h  

void AddStructReferencedObjects ( FReferenceCollector& InCollector
)

   RemoteControlProtocolBinding.h  

void ClearMappings()

 Empty all mapping for the bound struct RemoteControlProtocolBinding.h  

FRemoteControlProtocolMapping * FindMapping ( const FGuid& InMappingId
)

 Remove the bound struct mapping based on given mapping id RemoteControlProtocolBinding.h  

void ForEachMapping ( FGetProtocolMappingCallback InCallback
)

 Loop through all mappings RemoteControlProtocolBinding.h  

const FGuid & GetId()

 Get protocol binding id RemoteControlProtocolBinding.h  

const FGuid & GetPropertyId()

 Get exposed property id RemoteControlProtocolBinding.h  

FName GetProtocolName()

 Get protocol bound protocol name, such as MIDI, DMX, OSC, etc RemoteControlProtocolBinding.h  

TSharedPtr< TStructOnScope< FRemoteControlProtocolEntity > > GetRemoteControlProtocolEntityPtr()

 Get pointer to the StructOnScope RemoteControlProtocolBinding.h  

TSharedPtr< FStructOnScope > GetStructOnScope()

 Get bound struct scope wrapper RemoteControlProtocolBinding.h  

int32 RemoveMapping ( const FGuid& InMappingId
)

 Remove the bound struct mapping based on given mapping id RemoteControlProtocolBinding.h  

bool Serialize ( FArchive& Ar
)

 Custom struct serialize RemoteControlProtocolBinding.h  

bool SetPropertyDataToMapping ( const FGuid& InMappingId,
const void* InPropertyValuePtr
)

 Set mapping property data to bound mapping struct. RemoteControlProtocolBinding.h  

bool SetRangeToMapping ( const FGuid& InMappingId,
T InRangeValue
)

 Set range value which is bound to mapping struct RemoteControlProtocolBinding.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsRangePropertyTypeSupported()

 Checks if the given PropertyType (FProperty) is supported RemoteControlProtocolBinding.h  

static bool IsRangeTypeSupported()

 Checks if the given ValueType is supported RemoteControlProtocolBinding.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FRemoteControlProtocolBinding& InProtocolBinding
) const

   RemoteControlProtocolBinding.h  

bool operator== ( FGuid InProtocolBindingId
) const

   RemoteControlProtocolBinding.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page