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

> Unreal Engine API Reference > Runtime > LiveLinkInterface > ILiveLinkClient

Light Theme

Dark Theme

ILiveLinkClient

Interface for streaming and consuming data from external sources into UE4.

Windows

MacOS

Linux

Inheritance Hierarchy

ILiveLinkClient_Base_DEPRECATED

ILiveLinkClient

FLiveLinkClient_Base_DEPRECATED

FLiveLinkClient

References

Module	LiveLinkInterface
Header	/Engine/Source/Runtime/LiveLinkInterface/Public/ILiveLinkClient.h
Include	#include "ILiveLinkClient.h"

Syntax

class ILiveLinkClient : public ILiveLinkClient_Base_DEPRECATED

Remarks

Interface for streaming and consuming data from external sources into UE4. A LiveLinkSource, may stream multiple LiveLinkSubject. Pushing and evaluating data can be executed on any thread. The other functions must be executed on the Game Thread. Subject may shared name between sources, but only 1 of those subjects may be enabled.

Destructors

	Name	Description
	~ILiveLinkClient()

Functions

	Name	Description
FGuid	AddSource ( TSharedPtr< ILiveLinkSource > Sourc... )	Add a new live link source to the client
bool	AddVirtualSubject ( const FLiveLinkSubjectKey& Virtual..., TSubclassOf< ULiveLinkVirtualSubjec... )	Add a new virtual subject to the client
FGuid	AddVirtualSubjectSource ( FName SourceName )	Add a new live link VirtualSubject source to the client
void	ClearAllSubjectsFrames_AnyThread()	Clear all subjects frames
void	ClearSubjectsFrames_AnyThread ( FLiveLinkSubjectName SubjectName )	Clear the stored frames associated with the enabled subject
void	ClearSubjectsFrames_AnyThread ( const FLiveLinkSubjectKey& Subject... )	Clear the stored frames associated with the subject
bool	CreateSource ( const FLiveLinkSourcePreset& Sourc... )	Create from the factory a new live link source and add it to the client.
bool	CreateSubject ( const FLiveLinkSubjectPreset& Subj... )	Create and add a new live link subject to the client
bool	DoesSubjectSupportsRole ( const FLiveLinkSubjectKey& Subject..., TSubclassOf< ULiveLinkRole > Suppor... )	Whether a subject support a particular role, either directly or through a translator
bool	EvaluateFrame_AnyThread ( FLiveLinkSubjectName SubjectName, TSubclassOf< ULiveLinkRole > Role, FLiveLinkSubjectFrameData& OutFram... )	Return the evaluated subject snapshot for a specific role.
bool	EvaluateFrameAtSceneTime_AnyThread ( FLiveLinkSubjectName SubjectName, const FQualifiedFrameTime& SceneTi..., TSubclassOf< ULiveLinkRole > Desire..., FLiveLinkSubjectFrameData& OutFram... )	Evaluates a subject for a specific role at a scene time.
bool	EvaluateFrameAtWorldTime_AnyThread ( FLiveLinkSubjectName SubjectName, double WorldTime, TSubclassOf< ULiveLinkRole > Desire..., FLiveLinkSubjectFrameData& OutFram... )	Evaluates a subject for a specific role.
bool	EvaluateFrameFromSource_AnyThread ( const FLiveLinkSubjectKey& Subject..., TSubclassOf< ULiveLinkRole > Role, FLiveLinkSubjectFrameData& OutFram... )	Return the evaluated subject from a specific source snapshot for a specific role.
void	ForceTick()	Performs an internal Tick().
FLiveLinkSou...	GetSourcePreset ( FGuid SourceGuid, UObject* DuplicatedObjectOuter )	Get the source preset from the live link client.
TArray< FGui...	GetSources()	Get a list of all the sources
ULiveLinkSou...	GetSourceSettings ( const FGuid& SourceKey )	Get the Settings of this source.
FText	GetSourceType ( FGuid SourceGuid )	Get the type of a source
TArray< FLiv...	GetSubjectFrameTimes ( FLiveLinkSubjectName SubjectName )	Get the time of all the frames for a source. Use for debugging purposes.
TArray< FLiv...	GetSubjectFrameTimes ( const FLiveLinkSubjectKey& Subject... )	Get the time of all the frames for a specific source. Use for debugging purposes.
FLiveLinkSub...	GetSubjectPreset ( const FLiveLinkSubjectKey& Subject..., UObject* DuplicatedObjectOuter )	Get the subject preset from the live link client.
TSubclassOf<...	GetSubjectRole ( FLiveLinkSubjectName SubjectName )	Get the role of the subject with this name
TSubclassOf<...	GetSubjectRole ( const FLiveLinkSubjectKey& Subject... )	Get the role of a subject from a specific source
TArray< FLiv...	GetSubjects ( bool bIncludeDisabledSubject, bool bIncludeVirtualSubject )	Get a list of all subjects
UObject *...	GetSubjectSettings ( const FLiveLinkSubjectKey& Subject... )	Get the Settings of this subject.
TArray< FLiv...	GetSubjectsSupportingRole ( TSubclassOf< ULiveLinkRole > Suppor..., bool bIncludeDisabledSubject, bool bIncludeVirtualSubject )	Get a list of name of subjects supporting a certain role
TArray< FGui...	GetVirtualSources()	Get a list of all the VirtualSubjects sources
bool	HasSourceBeenAdded ( TSharedPtr< ILiveLinkSource > Sourc... )	Is the source been added
bool	IsSubjectEnabled ( const FLiveLinkSubjectKey& Subject..., bool bForThisFrame )	Whether or not a subject from the specific source is the enabled subject.
bool	IsSubjectEnabled ( FLiveLinkSubjectName SubjectName )	Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled.
bool	IsSubjectTimeSynchronized ( FLiveLinkSubjectName SubjectName )	Whether or not the subject's data is time synchronized or not
bool	IsSubjectTimeSynchronized ( const FLiveLinkSubjectKey& Subject... )	Whether or not the subject's data, from a specific source, is time synchronized or not
bool	IsSubjectValid ( FLiveLinkSubjectName SubjectName )	Whether or not the client has a subject with this name that is valid and has valid snapshot data
bool	IsSubjectValid ( const FLiveLinkSubjectKey& Subject... )	Whether or not a subject from a specific source is valid and has valid snapshot data
FOnLiveLinkS...	OnLiveLinkSourceAdded()	Notify when a new source has been added
FOnLiveLinkS...	OnLiveLinkSourceRemoved()	Notify when a source has been removed
FSimpleMulti...	OnLiveLinkSourcesChanged()	Notify when the list of sources has changed.
FOnLiveLinkS...	OnLiveLinkSubjectAdded()	Notify when a new subject has been added
FOnLiveLinkS...	OnLiveLinkSubjectEvaluated()	Notify the debug interface when a subject has been evaluated.
FOnLiveLinkS...	OnLiveLinkSubjectRemoved()	Notify when a subject has been removed
FSimpleMulti...	OnLiveLinkSubjectsChanged()	Notify when the list of subject has changed.
FSimpleMulti...	OnLiveLinkTicked()	Notify when the LiveLinkClient has ticked.
void	PushSubjectFrameData_AnyThread ( const FLiveLinkSubjectKey& Subject..., FLiveLinkFrameDataStruct&& FrameDa... )	Push frame data for a specific subject for a certain role
void	PushSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& Subject..., TSubclassOf< ULiveLinkRole > Role, FLiveLinkStaticDataStruct&& Static... )	Push static data for a specific subject for a certain role. This will clear all buffered frames
void	RegisterForFrameDataReceived ( const FLiveLinkSubjectKey& InSubje..., const FOnLiveLinkSubjectStaticDataR..., const FOnLiveLinkSubjectFrameDataRe..., FDelegateHandle& OutStaticDataRece..., FDelegateHandle& OutFrameDataRecei... )	Register for when a frame data was received.
bool	RegisterForSubjectFrames ( FLiveLinkSubjectName SubjectName, const FOnLiveLinkSubjectStaticDataA..., const FOnLiveLinkSubjectFrameDataAd..., FDelegateHandle& OutStaticDataAdde..., FDelegateHandle& OutFrameDataAdded..., TSubclassOf< ULiveLinkRole >& OutS..., FLiveLinkStaticDataStruct* Out... )	Register for when a frame has been validated, added and ready to be used.
void	RemoveSource ( TSharedPtr< ILiveLinkSource > Sourc... )	Remove the specified source from the live link client
void	RemoveSource ( FGuid SourceGuid )	Remove the source specified by the source Id from the live link client
void	RemoveSubject_AnyThread ( const FLiveLinkSubjectKey& Subject... )	Clear the subject from the specific source
void	RemoveVirtualSubject ( const FLiveLinkSubjectKey& Virtual... )	Removes a virtual subject from the client
void	SetSubjectEnabled ( const FLiveLinkSubjectKey& Subject..., bool bEnabled )	Set the subject's from a specific source to enabled, disabling the other in the process.
void	UnregisterForFrameDataReceived ( const FLiveLinkSubjectKey& InSubje..., FDelegateHandle InStaticDataReceive..., FDelegateHandle InFrameDataReceived... )	Unregister delegate registered with RegisterForFrameDataReceived.
void	UnregisterSubjectFramesHandle ( FLiveLinkSubjectName SubjectName, FDelegateHandle StaticDataAddedHand..., FDelegateHandle FrameDataAddedHandl... )	Unregister delegates registered with RegisterForSubjectFrames.

Constants

Name	Description
LIVELINK_VERSION
ModularFeatureName

Deprecated Functions

		Name	Description
	bool	EvaluateFrameAtSceneTime_AnyThread ( FLiveLinkSubjectName SubjectName, const FTimecode& SceneTime, TSubclassOf< ULiveLinkRole > Desire..., FLiveLinkSubjectFrameData& OutFram... )	ILiveLinkClient::EvaluateFrameAtSceneTime_AnyThread is deprecated. Please use ILiveLinkClient::EvaluateFrameAtSceneTime_AnyThread with a QualifiedFrameTime instead!

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

Take our survey

Dismiss