ULiveLinkSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/LiveLink

Settings for LiveLink.


Name	ULiveLinkSettings
Type	class
Header File	/Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkSettings.h
Include Path	#include "LiveLinkSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Game, defaultconfig)  
class ULiveLinkSettings : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → ULiveLinkSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
ULiveLinkSettings()		LiveLinkSettings.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bPreProcessRebroadcastFrames	bool	Whether to Preprocess frames before rebroadcasting them.	LiveLinkSettings.h	Config
bTranslateRebroadcastFrames	bool	Whether to translate frames before rebroadcasting them.	LiveLinkSettings.h	Config
ClockOffsetCorrectionStep	float	Continuous clock offset correction step	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink"
DefaultLiveLinkPreset	TSoftObjectPtr< ULiveLinkPreset >	The default preset that should be applied	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink"
DefaultMessageBusSourceMode	ELiveLinkSourceMode	The default evaluation mode a source connected via the message bus should start with.	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink"
DefaultRoleSettings	TArray< FLiveLinkRoleProjectSetting >		LiveLinkSettings.h	Config EditAnywhere Category="LiveLink"
DefaultSettingsClass	FSoftClassPath	When a settings class is not speficied for a role, this settings class will be used.	LiveLinkSettings.h	Config
FrameInterpolationProcessor	TSubclassOf< ULiveLinkFrameInterpolationProcessor >	The interpolation class to use for new Subjects if no specific settings we set for the Subject's role.	LiveLinkSettings.h	Config
InvalidColor	FLinearColor	Color for Subjects that have not received data from their Source for TimeWithoutFrameToBeConsiderAsInvalid.	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink\|UI"
MessageBusHeartbeatFrequency	double	The refresh frequency of the heartbeat when a provider didn't send us an updated.	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink" Meta=(ConfigRestartRequired=true, ForceUnits=s)
MessageBusHeartbeatTimeout	double	How long we should wait before a provider become unresponsive.	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink" Meta=(ConfigRestartRequired=true, ForceUnits=s)
MessageBusPingRequestFrequency	double	The refresh frequency of the list of message bus provider (when discovery is requested).	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink" Meta=(ConfigRestartRequired=true, ForceUnits=s)
MessageBusTimeBeforeRemovingInactiveSource	double	Subjects will be removed when their source has been unresponsive for this long.	LiveLinkSettings.h	Config EditAnywhere AdvancedDisplay Category="LiveLink" Meta=(ForceUnits=s)
TextSizeSource	uint8	Font size of Source names shown in LiveLink Debug View.	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink\|UI\|Debug"
TextSizeSubject	uint8	Font size of Subject names shown in LiveLink Debug View.	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink\|UI\|Debug"
TimeWithoutFrameToBeConsiderAsInvalid	double	A source may still exist but does not send frames for a subject.	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink\|UI" DisplayName="Time Without Frame to be Considered as Invalid" Meta=(ForceUnits=s)
ValidColor	FLinearColor	Color for active Subjects receiving data from their Source.	LiveLinkSettings.h	Config EditAnywhere Category="LiveLink\|UI"

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
FLiveLinkRoleProjectSetting GetDefaultSettingForRole ( TSubclassOf< ULiveLinkRole > Role ) const		LiveLinkSettings.h
FLinearColor GetInvalidColor()		LiveLinkSettings.h
float GetMessageBusHeartbeatFrequency()		LiveLinkSettings.h
double GetMessageBusHeartbeatTimeout()		LiveLinkSettings.h
float GetMessageBusPingRequestFrequency()		LiveLinkSettings.h
double GetMessageBusTimeBeforeRemovingDeadSource()		LiveLinkSettings.h
const FDirectoryPath & GetPresetSaveDir()		LiveLinkSettings.h
double GetTimeWithoutFrameToBeConsiderAsInvalid()		LiveLinkSettings.h
FLinearColor GetValidColor()		LiveLinkSettings.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostInitProperties()		LiveLinkSettings.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FName GetDefaultRoleSettingsPropertyName()	Retrieve the name of the protected DefaultRoleSettings property.	LiveLinkSettings.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
bTransmitEvaluatedData_DEPRECATED	bool	Whether to rebroadcast evaluted data.	LiveLinkSettings.h	Meta=(DeprecatedProperty)
PresetSaveDir_DEPRECATED	FDirectoryPath		LiveLinkSettings.h	Config

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from UObject

Static

Deprecated Variables