1. Epic GamesDeveloper
  3. FLiveLinkClient

FLiveLinkClient

API > API/Plugins > API/Plugins/LiveLink

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

Syntax

class FLiveLinkClient : public ILiveLinkClient

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor that setups LiveLink to use the SamplingInput delegate to tick. LiveLinkClient.h  

FLiveLinkClient ( FSimpleMulticastDelegate& InTickingDelegate
)

   LiveLinkClient.h  

FLiveLinkClient ( FTSSimpleMulticastDelegate& InTickingDelegate
)

   LiveLinkClient.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLiveLinkClient()

   LiveLinkClient.h  

Structs

Name Remarks
FPendingSubjectFrame Struct that hold the pending frame data that will be pushed next tick.
FPendingSubjectStatic Struct that hold the pending static data that will be pushed next tick.
FSubjectFramesAddedHandles  
FSubjectFramesReceivedHandles  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnableParentSubjects bool Whether or not parent subject support is enabled. LiveLinkClient.h  
bPreProcessRebroadcastFrames bool Whether to Preprocess frames before rebroadcasting them. LiveLinkClient.h  
bTranslateRebroadcastFrames bool Whether to translate frames before rebroadcasting them. LiveLinkClient.h  
CachedEngineFrameTime TOptional< FQualifiedFrameTime >   LiveLinkClient.h  
CachedEngineTime double Cached value of the engine timecode and frame rate LiveLinkClient.h  
EnabledSubjects TMap< FLiveLinkSubjectName, FLiveLinkSubjectKey > Key funcs for looking up a set of cached keys by its layout element LiveLinkClient.h  
OnLiveLinkSubjectEvaluatedDelegate FOnLiveLinkSubjectEvaluated Delegate when a subject is evaluated. LiveLinkClient.h  
OnLiveLinkTickedDelegate FSimpleMulticastDelegate Delegate when LiveLinkClient has ticked. LiveLinkClient.h  
RebroadcastedSubjects TSet< FLiveLinkSubjectKey >   LiveLinkClient.h  
RebroadcastLiveLinkProviderName FString   LiveLinkClient.h  
SubjectFrameAddedHandles TMap< FLiveLinkSubjectName, FSubjectFramesAddedHandles > Map of delegates to notify interested parties when the client receives a static or data frame for each subject LiveLinkClient.h  
SubjectFrameReceivedHandles TMap< FLiveLinkSubjectKey, FSubjectFramesReceivedHandles > Delegate when LiveLinkClient received a subject static or frame data. LiveLinkClient.h  
SubjectFrameReceivedHandleseCriticalSection FCriticalSection Lock to to access SubjectFrameReceivedHandles LiveLinkClient.h  
SubjectFrameToPush TArray< FPendingSubjectFrame > Pending frame info to add to a subject. LiveLinkClient.h  
SubjectStaticToPush TArray< FPendingSubjectStatic > Pending static info to add to a subject. LiveLinkClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CacheSubjectSettings ( const FLiveLinkSubjectKey& SubjectKey,
ULiveLinkSubjectSettings* Settings
) const

 (Internal use only) Cache subject settings for a given subject. LiveLinkClient.h  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FLiveLinkTickDelegate,
ELiveLinkTickType
)

   LiveLinkClient.h  

TArray< FGuid > GetDisplayableSources ( bool bIncludeVirtualSources
) const

 Get all sources that can be displayed in the UI's source list. LiveLinkClient.h  

FName GetRebroadcastName ( const FLiveLinkSubjectKey& InSubjectKey
) const

 Get the rebroadcast name for a given subject. LiveLinkClient.h  

FLiveLinkSubjectTimeSyncData GetTimeSyncData ( FLiveLinkSubjectName SubjectName
)

   LiveLinkClient.h  

void OnPropertyChanged ( FGuid EntryGuid,
const FPropertyChangedEvent& PropertyChangedEvent
)

 Callback when property changed for one of the source settings LiveLinkClient.h  

void PushPendingSubject_AnyThread ( FPendingSubjectStatic&& PendingSubject
)

 Push subject static data with additional metadata. LiveLinkClient.h  

void ReinitializeVirtualSubject ( const FLiveLinkSubjectKey& SubjectKey
)

 Call initialize again on an existing virtual subject. LiveLinkClient.h  

void RemoveAllSources()

 Remove all sources from the live link client LiveLinkClient.h  

bool RemoveAllSourcesWithTimeout ( float InTimeout
)

 Remove all sources and wait for them to be removed. This is a blocking operation. LiveLinkClient.h  

void Tick ( ELiveLinkTickType TickType
)

 The tick callback to update the pending work and clear the subject's snapshot LiveLinkClient.h  

Overridden from ILiveLinkClient

Name Remarks Include Path Unreal Specifiers

virtual FGuid AddSource ( TSharedPtr< ILiveLinkSource > Source
)

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual FGuid AddVirtualSubjectSource ( FName SourceName
)

   LiveLinkClient.h  

virtual void ClearAllSubjectsFrames_AnyThread()

   LiveLinkClient.h  

virtual void ClearOverrideStaticData_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey
)

   LiveLinkClient.h  

virtual void ClearSubjectsFrames_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey
)

   LiveLinkClient.h  
  LiveLinkClient.h  

virtual bool CreateSource ( const FLiveLinkSourcePreset& SourcePreset
)

   LiveLinkClient.h  

virtual bool CreateSubject ( const FLiveLinkSubjectPreset& SubjectPreset
)

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual bool DoesSubjectSupportsRole_AnyThread ( FLiveLinkSubjectName SubjectName,
TSubclassOf< ULiveLinkRole > SupportedRole
) const

   LiveLinkClient.h  

virtual bool EvaluateFrame_AnyThread ( FLiveLinkSubjectName SubjectName,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkSubjectFrameData& OutFrame
)

   LiveLinkClient.h  

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

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual bool EvaluateFrameFromSource_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkSubjectFrameData& OutFrame
)

   LiveLinkClient.h  

virtual void ForceTick()

   LiveLinkClient.h  

virtual FText GetSourceMachineName ( FGuid EntryGuid
) const

   LiveLinkClient.h  

virtual FText GetSourceNameOverride ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual FLiveLinkSourcePreset GetSourcePreset ( FGuid SourceGuid,
UObject* DuplicatedObjectOuter
) const

   LiveLinkClient.h  

virtual TArray< FGuid > GetSources ( bool bEvenIfPendingKill
) const

   LiveLinkClient.h  

virtual ULiveLinkSourceSettings * GetSourceSettings ( const FGuid& SourceGuid
) const

   LiveLinkClient.h  

virtual FText GetSourceStatus ( FGuid EntryGuid
) const

   LiveLinkClient.h  

virtual FText GetSourceToolTip ( FGuid EntryGuid
) const

   LiveLinkClient.h  

virtual FText GetSourceType ( FGuid EntryGuid
) const

   LiveLinkClient.h  

virtual FText GetSubjectDisplayName ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual TArray< FLiveLinkTime > GetSubjectFrameTimes ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  
  LiveLinkClient.h  

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

   LiveLinkClient.h  
  LiveLinkClient.h  
  LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual UObject * GetSubjectSettings ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual ELiveLinkSubjectState GetSubjectState ( FLiveLinkSubjectName InSubjectName
) const

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual TSubclassOf< ULiveLinkRole > GetSubjectTranslatedRole_AnyThread ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual TArray< FGuid > GetVirtualSources ( bool bEvenIfPendingKill
) const

   LiveLinkClient.h  

virtual bool HasPendingSubjectFrames()

   LiveLinkClient.h  

virtual bool HasSourceBeenAdded ( TSharedPtr< ILiveLinkSource > Source
) const

   LiveLinkClient.h  

virtual bool IsSourceStillValid ( FGuid EntryGuid
) const

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual bool IsSubjectEnabled ( FLiveLinkSubjectName SubjectName
) const

   LiveLinkClient.h  

virtual bool IsSubjectTimeSynchronized ( FLiveLinkSubjectName SubjectName
) const

   LiveLinkClient.h  

virtual bool IsSubjectTimeSynchronized ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual bool IsSubjectValid ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual bool IsSubjectValid ( FLiveLinkSubjectName SubjectName
) const

   LiveLinkClient.h  

virtual bool IsVirtualSubject ( const FLiveLinkSubjectKey& SubjectKey
) const

   LiveLinkClient.h  

virtual FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceAdded()

   LiveLinkClient.h  

virtual FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceRemoved()

   LiveLinkClient.h  

virtual FSimpleMulticastDelegate & OnLiveLinkSourcesChanged()

   LiveLinkClient.h  

virtual FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectAdded()

   LiveLinkClient.h  

virtual FOnLiveLinkSubjectEnabledDelegate & OnLiveLinkSubjectEnabledChanged()

   LiveLinkClient.h  

virtual FOnLiveLinkSubjectEvaluated & OnLiveLinkSubjectEvaluated()

   LiveLinkClient.h  

virtual FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectRemoved()

   LiveLinkClient.h  

virtual FSimpleMulticastDelegate & OnLiveLinkSubjectsChanged()

   LiveLinkClient.h  

virtual FOnLiveLinkSubjectStateChanged & OnLiveLinkSubjectStateChanged()

   LiveLinkClient.h  

virtual FSimpleMulticastDelegate & OnLiveLinkTicked()

   LiveLinkClient.h  

virtual void PauseSubject_AnyThread ( FLiveLinkSubjectName SubjectName
)

   LiveLinkClient.h  

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

   LiveLinkClient.h  

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

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual bool RegisterForSubjectFrames ( FLiveLinkSubjectName SubjectName,
const FOnLiveLinkSubjectStaticDataAdded::FDelegate& OnStaticDataAdded,
const FOnLiveLinkSubjectFrameDataAdded::FDelegate& OnFrameDataAdded,
FDelegateHandle& OutStaticDataReceivedHandle,
FDelegateHandle& OutFrameDataReceivedHandle,
TSubclassOf< ULiveLinkRole >& OutSubjectRole,
FLiveLinkStaticDataStruct* OutStaticData
)

   LiveLinkClient.h  

virtual void RemoveSource ( TSharedPtr< ILiveLinkSource > Source
)

   LiveLinkClient.h  

virtual void RemoveSource ( FGuid InEntryGuid
)

   LiveLinkClient.h  

virtual void RemoveSubject_AnyThread ( const FLiveLinkSubjectKey& SubjectKey
)

   LiveLinkClient.h  

virtual void RemoveVirtualSubject ( const FLiveLinkSubjectKey& VirtualSubjectKey
)

   LiveLinkClient.h  

virtual void SetSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bEnabled
)

   LiveLinkClient.h  

virtual void UnpauseSubject_AnyThread ( FLiveLinkSubjectName SubjectName
)

   LiveLinkClient.h  

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

   LiveLinkClient.h  

virtual void UnregisterSubjectFramesHandle ( FLiveLinkSubjectName InSubjectName,
FDelegateHandle InStaticDataReceivedHandle,
FDelegateHandle InFrameDataReceivedHandle
)

   LiveLinkClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastFrameDataUpdate ( const FLiveLinkSubjectKey& InSubjectKey,
const FLiveLinkFrameDataStruct& InFrameData
)

 Broadcast out to the SubjectFrameAddedHandles a frame data update. LiveLinkClient.h  

virtual TSharedPtr< ILiveLinkProvider > GetRebroadcastLiveLinkProvider()

 Method that can be overriden in child classes to provide their own rebroadcast provider. LiveLinkClient.h  

bool RegisterGlobalSubjectFramesDelegate ( const FOnLiveLinkSubjectStaticDataAdded::FDelegate& InOnStaticDataAdded,
const FOnLiveLinkSubjectFrameDataAdded::FDelegate& InOnFrameDataAdded,
FDelegateHandle& OutStaticDataAddedHandle,
FDelegateHandle& OutFrameDataAddedHandle,
bool bUseUnmappedData
)

 Add delegates that will be triggered for all subjects. LiveLinkClient.h  

void UnregisterGlobalSubjectFramesDelegate ( FDelegateHandle& InStaticDataAddedHandle,
FDelegateHandle& InFrameDataAddedHandle,
bool bUseUnmappedData
)

 Remove the delegates that were triggered for all subjects. LiveLinkClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page