1. Epic GamesDeveloper
  3. ILiveLinkClient

ILiveLinkClient

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

API > API/Runtime > API/Runtime/LiveLinkInterface

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.

   
Name ILiveLinkClient
Type class
Header File /Engine/Source/Runtime/LiveLinkInterface/Public/ILiveLinkClient.h
Include Path #include "ILiveLinkClient.h"

Syntax

class ILiveLinkClient : public IModularFeature

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ILiveLinkClient()

   ILiveLinkClient.h  

Constants

Name Type Remarks Include Path
LIVELINK_VERSION const int32   ILiveLinkClient.h
ModularFeatureName FName   ILiveLinkClient.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FGuid AddSource ( TSharedPtr< ILiveLinkSource > Source
)

 Add a new live link source to the client ILiveLinkClient.h  

bool AddVirtualSubject ( const FLiveLinkSubjectKey& VirtualSubjectKey,
TSubclassOf< ULiveLinkVirtualSubject > VirtualSubjectClass
)

 Add a new virtual subject to the client ILiveLinkClient.h  

FGuid AddVirtualSubjectSource ( FName SourceName
)

 Add a new live link VirtualSubject source to the client ILiveLinkClient.h  

void ClearAllSubjectsFrames_AnyThread()

 Clear all subjects frames ILiveLinkClient.h  

void ClearOverrideStaticData_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey
)

 Claer the override static data used by the subject remapper. ILiveLinkClient.h  
Clear the stored frames associated with the subject ILiveLinkClient.h  
Clear the stored frames associated with the enabled subject ILiveLinkClient.h  

bool CreateSource ( const FLiveLinkSourcePreset& SourcePreset
)

 Create from the factory a new live link source and add it to the client. ILiveLinkClient.h  

bool CreateSubject ( const FLiveLinkSubjectPreset& SubjectPreset
)

 Create and add a new live link subject to the client ILiveLinkClient.h  

bool DoesSubjectSupportsRole_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
TSubclassOf< ULiveLinkRole > SupportedRole
) const

 Whether a subject support a particular role, either directly or through a translator ILiveLinkClient.h  
Whether a subject support a particular role, either directly or through a translator ILiveLinkClient.h  
Return the evaluated subject snapshot for a specific role. ILiveLinkClient.h  
Evaluates a subject for a specific role at a scene time. ILiveLinkClient.h  

virtual bool EvaluateFrameAtSceneTime_AnyThread ( FLiveLinkSubjectName SubjectName,
const FTimecode& SceneTime,
TSubclassOf< ULiveLinkRole > DesiredRole,
FLiveLinkSubjectFrameData& OutFrame
)

   ILiveLinkClient.h  

bool EvaluateFrameAtWorldTime_AnyThread ( FLiveLinkSubjectName SubjectName,
double WorldTime,
TSubclassOf< ULiveLinkRole > DesiredRole,
FLiveLinkSubjectFrameData& OutFrame
)

 Evaluates a subject for a specific role. ILiveLinkClient.h  
Return the evaluated subject from a specific source snapshot for a specific role. ILiveLinkClient.h  

void ForceTick ()

 Performs an internal Tick(). ILiveLinkClient.h  

FText GetSourceMachineName ( FGuid EntryGuid
) const

 Get the machine name of the source. ILiveLinkClient.h  

FText GetSourceNameOverride ( const FLiveLinkSubjectKey& SubjectKey
) const

 Get the source name override for a given subject. ILiveLinkClient.h  

FLiveLinkSourcePreset GetSourcePreset ( FGuid SourceGuid,
UObject* DuplicatedObjectOuter
) const

 Get the source preset from the live link client. ILiveLinkClient.h  

TArray< FGuid > GetSources ( bool bEvenIfPendingKill
) const

 Get a list of all the sources ILiveLinkClient.h  

ULiveLinkSourceSettings * GetSourceSettings ( const FGuid& SourceKey
) const

 Get the Settings of this source. ILiveLinkClient.h  

FText GetSourceStatus ( FGuid EntryGuid
) const

 Get the status of a source ILiveLinkClient.h  

FText GetSourceToolTip ( FGuid EntryGuid
) const

 Get the tooltip of a source ILiveLinkClient.h  

FText GetSourceType ( FGuid SourceGuid
) const

 Get the type of a source ILiveLinkClient.h  

FText GetSubjectDisplayName ( const FLiveLinkSubjectKey& SubjectKey
) const

 Get the display name for a subject. Returns an empty text if the source is invalid. ILiveLinkClient.h  
Get the time of all the frames for a specific subject, including computed offsets. ILiveLinkClient.h  
Get the time of all the frames for a specific subject, including computed offsets. ILiveLinkClient.h  

FLiveLinkSubjectPreset GetSubjectPreset ( const FLiveLinkSubjectKey& SubjectKey,
UObject* DuplicatedObjectOuter
) const

 Get the subject preset from the live link client. ILiveLinkClient.h  
Get the role of a subject from a specific source ILiveLinkClient.h  
Get the role of the subject with this name ILiveLinkClient.h  

TArray< FLiveLinkSubjectKey > GetSubjects ( bool bIncludeDisabledSubject,
bool bIncludeVirtualSubject
) const

 Get a list of all subjects ILiveLinkClient.h  

UObject * GetSubjectSettings ( const FLiveLinkSubjectKey& SubjectKey
) const

 Get the Settings of this subject. ILiveLinkClient.h  

TArray< FLiveLinkSubjectKey > GetSubjectsSupportingRole ( TSubclassOf< ULiveLinkRole > SupportedRole,
bool bIncludeDisabledSubject,
bool bIncludeVirtualSubject
) const

 Get a list of name of subjects supporting a certain role ILiveLinkClient.h  

ELiveLinkSubjectState GetSubjectState ( FLiveLinkSubjectName InSubjectName
) const

 Returns the state of the given subject name. ILiveLinkClient.h  

const FLiveLinkStaticDataStruct * GetSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey,
bool bGetOverrideData
) const

 Utility method to grab a subject's static data. ILiveLinkClient.h  

TArray< FGuid > GetVirtualSources ( bool bEvenIfPendingKill
) const

 Get a list of all the VirtualSubjects sources ILiveLinkClient.h  

bool HasPendingSubjectFrames()

 Returns true if the client has pending subject frames to process during its next tick ILiveLinkClient.h  

bool HasSourceBeenAdded ( TSharedPtr< ILiveLinkSource > Source
) const

 Is the source been added ILiveLinkClient.h  

bool IsSourceStillValid ( FGuid EntryGuid
) const

 Returns whether the Source is connected to its data provider and can still push valid data. ILiveLinkClient.h  

bool IsSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bForThisFrame
) const

 Whether or not a subject from the specific source is the enabled subject. ILiveLinkClient.h  

bool IsSubjectEnabled ( FLiveLinkSubjectName SubjectName
) const

 Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled. ILiveLinkClient.h  

bool IsSubjectTimeSynchronized ( FLiveLinkSubjectName SubjectName
) const

 Whether or not the subject's data is time synchronized or not ILiveLinkClient.h  

bool IsSubjectTimeSynchronized ( const FLiveLinkSubjectKey& SubjectKey
) const

 Whether or not the subject's data, from a specific source, is time synchronized or not ILiveLinkClient.h  

bool IsSubjectValid ( const FLiveLinkSubjectKey& SubjectKey
) const

 Whether or not a subject from a specific source is valid and has valid snapshot data ILiveLinkClient.h  

bool IsSubjectValid ( FLiveLinkSubjectName SubjectName
) const

 Whether or not the client has a subject with this name that is valid and has valid snapshot data ILiveLinkClient.h  

bool IsVirtualSubject ( const FLiveLinkSubjectKey& SubjectKey
) const

 Whether the subject key points to a virtual subject ILiveLinkClient.h  

FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceAdded()

 Notify when a new source has been added ILiveLinkClient.h  

FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceRemoved()

 Notify when a source has been removed ILiveLinkClient.h  

FSimpleMulticastDelegate & OnLiveLinkSourcesChanged()

 Notify when the list of sources has changed. ILiveLinkClient.h  

FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectAdded()

 Notify when a new subject has been added ILiveLinkClient.h  

FOnLiveLinkSubjectEvaluated & OnLiveLinkSubjectEvaluated ()

 Notify the debug interface when a subject has been evaluated. ILiveLinkClient.h  

FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectRemoved()

 Notify when a subject has been removed ILiveLinkClient.h  

FSimpleMulticastDelegate & OnLiveLinkSubjectsChanged()

 Notify when the list of subject has changed. ILiveLinkClient.h  

FOnLiveLinkSubjectStateChanged & OnLiveLinkSubjectStateChanged()

 Notify when a subject's state has changed. ILiveLinkClient.h  

FSimpleMulticastDelegate & OnLiveLinkTicked()

 Notify when the LiveLinkClient has ticked. ILiveLinkClient.h  

void PauseSubject_AnyThread ( FLiveLinkSubjectName SubjectName
)

 Pause a subject. It will keep its subject snapshot until it's unpaused. ILiveLinkClient.h  

void PushSubjectFrameData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
FLiveLinkFrameDataStruct&& FrameData
)

 Push frame data for a specific subject for a certain role ILiveLinkClient.h  

void PushSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkStaticDataStruct&& StaticData
)

 Push static data for a specific subject for a certain role. This will clear all buffered frames ILiveLinkClient.h  

void RegisterForFrameDataReceived ( const FLiveLinkSubjectKey& InSubjectKey,
const FOnLiveLinkSubjectStaticDataReceived::FDelegate& OnStaticDataReceived_AnyThread,
const FOnLiveLinkSubjectFrameDataReceived::FDelegate& OnFrameDataReceived_AnyThread,
FDelegateHandle& OutStaticDataReceivedHandle,
FDelegateHandle& OutFrameDataReceivedHandleconst
)

 Register for when a frame data was received. ILiveLinkClient.h  

bool RegisterForSubjectFrames ( FLiveLinkSubjectName SubjectName,
const FOnLiveLinkSubjectStaticDataAdded::FDelegate& OnStaticDataAdded,
const FOnLiveLinkSubjectFrameDataAdded::FDelegate& OnFrameDataAddedd,
FDelegateHandle& OutStaticDataAddedHandle,
FDelegateHandle& OutFrameDataAddeddHandle,
TSubclassOf< ULiveLinkRole >& OutSubjectRole,
FLiveLinkStaticDataStruct* OutStaticData
)

 Register for when a frame has been validated, added and ready to be used. ILiveLinkClient.h  
Remove the specified source from the live link client ILiveLinkClient.h  

void RemoveSource ( FGuid SourceGuid
)

 Remove the source specified by the source Id from the live link client ILiveLinkClient.h  

void RemoveSubject_AnyThread ( const FLiveLinkSubjectKey& SubjectName
)

 Clear the subject from the specific source ILiveLinkClient.h  

void RemoveVirtualSubject ( const FLiveLinkSubjectKey& VirtualSubjectKey
)

 Removes a virtual subject from the client ILiveLinkClient.h  

void SetSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bEnabled
)

 Set the subject's from a specific source to enabled, disabling the other in the process. ILiveLinkClient.h  

void UnpauseSubject_AnyThread ( FLiveLinkSubjectName SubjectName
)

 Unpause a subject, resuming its normal operation. ILiveLinkClient.h  

void UnregisterForFrameDataReceived ( const FLiveLinkSubjectKey& InSubjectKey,
FDelegateHandle InStaticDataReceivedHandle,
FDelegateHandle InFrameDataReceivedHandle
)

 Unregister delegate registered with RegisterForFrameDataReceived. ILiveLinkClient.h  

void UnregisterSubjectFramesHandle ( FLiveLinkSubjectName SubjectName,
FDelegateHandle StaticDataAddedHandle,
FDelegateHandle FrameDataAddedHandle
)

 Unregister delegates registered with RegisterForSubjectFrames. ILiveLinkClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page