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

ULiveLinkSettings

Settings for LiveLink.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULiveLinkSettings

References

Module	LiveLink
Header	/Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkSettings.h
Include	#include "LiveLinkSettings.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game, defaultconfig)
class ULiveLinkSettings : public UObject

Remarks

Settings for LiveLink.

Variables

	Name	Description
float	ClockOffsetCorrectionStep	Continuous clock offset correction step
TSoftObjectPtr<...	DefaultLiveLinkPreset	The default preset that should be applied
ELiveLinkSource...	DefaultMessageBusSourceMode	The default evaluation mode a source connected via the message bus should start with.
TArray< FLiveLi...	DefaultRoleSettings
TSubclassOf< UL...	FrameInterpolationProcessor	The interpolation class to use for new Subjects if no specific settings we set for the Subject's role.
FLinearColor	InvalidColor	Color for Subjects that have not received data from their Source for TimeWithoutFrameToBeConsiderAsInvalid.
double	MessageBusHeartbeatFrequency	The refresh frequency of the heartbeat when a provider didn't send us an updated.
double	MessageBusHeartbeatTimeout	How long we should wait before a provider become unresponsive.
double	MessageBusPingRequestFrequency	The refresh frequency of the list of message bus provider (when discovery is requested).
double	MessageBusTimeBeforeRemovingInactiveSource	Subjects will be removed when their source has been unresponsive for this long.
FDirectoryPath	PresetSaveDir	The default location in which to save take presets
uint8	TextSizeSource	Font size of Source names shown in LiveLink Debug View.
uint8	TextSizeSubject	Font size of Subject names shown in LiveLink Debug View.
double	TimeWithoutFrameToBeConsiderAsInvalid	A source may still exist but does not send frames for a subject.
FLinearColor	ValidColor	Color for active Subjects receiving data from their Source.

Constructors

	Name	Description
	ULiveLinkSettings()

Functions

		Name	Description
	FLiveLinkRol...	GetDefaultSettingForRole ( TSubclassOf< ULiveLinkRole > Role )
	FLinearColor	GetInvalidColor()
	float	GetMessageBusHeartbeatFrequency()
	double	GetMessageBusHeartbeatTimeout()
	float	GetMessageBusPingRequestFrequency()
	double	GetMessageBusTimeBeforeRemovingDeadSource()
	const FDirec...	GetPresetSaveDir()
	double	GetTimeWithoutFrameToBeConsiderAsInvalid()
	FLinearColor	GetValidColor()

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

Take our survey

Dismiss