1. Epic GamesDeveloper
  3. FLiveLinkClient

FLiveLinkClient

API > API/Plugins > API/Plugins/LiveLink

Inheritance Hierarchy

References

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

Syntax

class FLiveLinkClient : public FLiveLinkClient_Base_DEPRECATED

Variables

  Type Name Description
Protected variable TUniquePtr< FLiveLinkSourceCollection > Collection The current collection used.
Protected variable FCriticalSection PendingFramesCriticalSection Lock to protect access on SubjectFrameToPush and SubjectStaticToPush.
Protected variable TSharedPtr< ILiveLinkProvider > RebroadcastLiveLinkProvider LiveLink Provider for rebroadcasting

Constructors

  Type Name Description
Public function   Default constructor that setups LiveLink to use the SamplingInput delegate to tick.
Public function  

FLiveLinkClient ( FSimpleMulticastDelegate& InTickingDelegate
)

  
Public function  

FLiveLinkClient ( FTSSimpleMulticastDelegate& InTickingDelegate
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddVirtualSubject ( FLiveLinkSubjectName VirtualSubjectName,
TSubclassOf< ULiveLinkVirtualSubject > VirtualSubjectClass
)

  
Public function void

AddVirtualSubject ( FName NewVirtualSubjectName
)

  
Protected function void

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

 Broadcast out to the SubjectFrameAddedHandles a frame data update.
Public function Const TArray< FGuid >

GetDisplayableSources ( bool bIncludeVirtualSources
)

 Get all sources that can be displayed in the UI's source list.
Public function Const FText  
Public function Const FText  
Protected function Virtual Const TSharedPtr< ILiveLinkProvider > Method that can be overriden in child classes to provide their own rebroadcast provider.
Public function Const FName

GetRebroadcastName ( const FLiveLinkSubjectKey& InSubjectKey
)

 Get the rebroadcast name for a given subject.
Public function Const const TArray< FGuid > & Function that are now deprecated
Public function Const FText  
Public function FLiveLinkSubjectTimeSyncData  
Public function void

OnPropertyChanged ( FGuid EntryGuid,
const FPropertyChangedEvent& PropertyChangedEvent
)

 Callback when property changed for one of the source settings
Public function void Push subject static data with additional metadata.
Protected function 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.
Public function FDelegateHandle

RegisterSourcesChangedHandle ( const FSimpleMulticastDelegate::FDelegate& SourcesChanged
)

  
Public function void Call initialize again on an existing virtual subject.
Public function void Remove all sources from the live link client
Public function bool

RemoveAllSourcesWithTimeout ( float InTimeout
)

 Remove all sources and wait for them to be removed. This is a blocking operation.
Public function void

Tick ()

 The tick callback to update the pending work and clear the subject's snapshot
Protected function void

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

 Remove the delegates that were triggered for all subjects.
Public function void  

Overridden from FLiveLinkClient_Base_DEPRECATED

  Type Name Description
Protected function Virtual void Function for Deprecation
Protected function Virtual void  
Protected function Virtual FLiveLinkSkeletonStaticData *  
Protected function Virtual void  

Overridden from ILiveLinkClient

  Type Name Description
Public function Virtual FGuid Add a new live link source to the client
Public function Virtual bool

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

 Add a new virtual subject to the client
Public function Virtual FGuid Add a new live link VirtualSubject source to the client
Public function Virtual void Clear all subjects frames
Public function Virtual void Claer the override static data used by the subject remapper.
Public function Virtual void Clear the stored frames associated with the enabled subject
Public function Virtual void Clear the stored frames associated with the subject
Public function Virtual bool

CreateSource ( const FLiveLinkSourcePreset& SourcePreset
)

 Create from the factory a new live link source and add it to the client.
Public function Virtual bool

CreateSubject ( const FLiveLinkSubjectPreset& SubjectPreset
)

 Create and add a new live link subject to the client
Public function Virtual Const bool Whether a subject support a particular role, either directly or through a translator
Public function Virtual Const bool Whether a subject support a particular role, either directly or through a translator
Public function Virtual bool Return the evaluated subject snapshot for a specific role.
Protected function Virtual bool  
Public function Virtual bool Evaluates a subject for a specific role at a scene time.
Public function Virtual bool Evaluates a subject for a specific role.
Public function Virtual bool Return the evaluated subject from a specific source snapshot for a specific role.
Public function Virtual void Performs an internal Tick().
Public function Virtual Const FText

GetSourceMachineName ( FGuid EntryGuid
)

 Get the machine name of the source.
Public function Virtual Const FText Get the source name override for a given subject.
Public function Virtual Const FLiveLinkSourcePreset

GetSourcePreset ( FGuid SourceGuid,
UObject* DuplicatedObjectOuter
)

 Get the source preset from the live link client.
Public function Virtual Const TArray< FGuid >

GetSources ( bool bEvenIfPendingKill
)

 Get a list of all the sources
Public function Virtual Const ULiveLinkSourceSettings *

GetSourceSettings ( const FGuid& SourceGuid
)

 Get the Settings of this source.
Public function Virtual Const FText

GetSourceStatus ( FGuid EntryGuid
)

 Get the status of a source
Public function Virtual Const FText

GetSourceType ( FGuid EntryGuid
)

 Get the type of a source
Public function Virtual Const FText Get the display name for a subject. Returns an empty text if the source is invalid.
Public function Virtual Const TArray< FLiveLinkTime > Get the time of all the frames for a specific subject, including computed offsets.
Public function Virtual Const TArray< FLiveLinkTime > Get the time of all the frames for a specific subject, including computed offsets.
Public function Virtual Const FLiveLinkSubjectPreset

GetSubjectPreset ( const FLiveLinkSubjectKey& SubjectKey,
UObject* DuplicatedObjectOuter
)

 Get the subject preset from the live link client.
Public function Virtual Const TSubclassOf< ULiveLinkRole > Get the role of a subject from a specific source
Public function Virtual Const TSubclassOf< ULiveLinkRole > Get the role of the subject with this name
Public function Virtual Const TArray< FLiveLinkSubjectKey >

GetSubjects ( bool bIncludeDisabledSubject,
bool bIncludeVirtualSubject
)

 Get a list of all subjects
Public function Virtual Const UObject *

GetSubjectSettings ( const FLiveLinkSubjectKey& SubjectKey
)

 Get the Settings of this subject.
Public function Virtual Const TArray< FLiveLinkSubjectKey >

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

 Get a list of name of subjects supporting a certain role
Public function Virtual Const ELiveLinkSubjectState Returns the state of the given subject name.
Public function Virtual Const const FLiveLinkStaticDataStruct *

GetSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey,
bool bGetOverrideData
)

 Utility method to grab a subject's static data.
Public function Virtual Const TArray< FGuid >

GetVirtualSources ( bool bEvenIfPendingKill
)

 Get a list of all the VirtualSubjects sources
Public function Virtual bool Returns true if the client has pending subject frames to process during its next tick
Public function Virtual Const bool Is the source been added
Public function Virtual Const bool

IsSourceStillValid ( FGuid EntryGuid
)

 Returns whether the Source is connected to its data provider and can still push valid data.
Public function Virtual Const bool

IsSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bForThisFrame
)

 Whether or not a subject from the specific source is the enabled subject.
Public function Virtual Const bool Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled.
Public function Virtual Const bool Whether or not the subject's data, from a specific source, is time synchronized or not
Public function Virtual Const bool Whether or not the subject's data is time synchronized or not
Public function Virtual Const bool Whether or not the client has a subject with this name that is valid and has valid snapshot data
Public function Virtual Const bool

IsSubjectValid ( const FLiveLinkSubjectKey& SubjectKey
)

 Whether or not a subject from a specific source is valid and has valid snapshot data
Public function Virtual Const bool

IsVirtualSubject ( const FLiveLinkSubjectKey& SubjectKey
)

 Whether the subject key points to a virtual subject
Public function Virtual FOnLiveLinkSourceChangedDelegate & Notify when a new source has been added
Public function Virtual FOnLiveLinkSourceChangedDelegate & Notify when a source has been removed
Public function Virtual FSimpleMulticastDelegate & Notify when the list of sources has changed.
Public function Virtual FOnLiveLinkSubjectChangedDelegate & Notify when a new subject has been added
Public function Virtual FOnLiveLinkSubjectEvaluated & Notify the debug interface when a subject has been evaluated.
Public function Virtual FOnLiveLinkSubjectChangedDelegate & Notify when a subject has been removed
Public function Virtual FSimpleMulticastDelegate & Notify when the list of subject has changed.
Public function Virtual FSimpleMulticastDelegate & Notify when the LiveLinkClient has ticked.
Public function Virtual void Push frame data for a specific subject for a certain role
Public function Virtual void Push static data for a specific subject for a certain role. This will clear all buffered frames
Public function Virtual void

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

 Register for when a frame data was received.
Public function Virtual bool

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

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

RemoveSource ( FGuid InEntryGuid
)

 Remove the source specified by the source Id from the live link client
Public function Virtual void Clear the subject from the specific source
Public function Virtual void

RemoveVirtualSubject ( const FLiveLinkSubjectKey& VirtualSubjectKey
)

 Removes a virtual subject from the client
Public function Virtual void

SetSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bEnabled
)

 Set the subject's from a specific source to enabled, disabling the other in the process.
Public function Virtual void

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

 Unregister delegate registered with RegisterForFrameDataReceived.
Public function Virtual void

UnregisterSubjectFramesHandle ( FLiveLinkSubjectName InSubjectName,
FDelegateHandle InStaticDataReceivedHandle,
FDelegateHandle InFrameDataReceivedHandle
)

 Unregister delegates registered with RegisterForSubjectFrames.

Classes

  Type Name Description
Public struct FPendingSubjectFrame Struct that hold the pending frame data that will be pushed next tick.  
Public struct FPendingSubjectStatic Struct that hold the pending static data that will be pushed next tick.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page