1. Epic GamesDeveloper
  3. ILiveLinkClient

ILiveLinkClient

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

API > API/Runtime > API/Runtime/LiveLinkInterface

Inheritance Hierarchy

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

  Type Name Description
Public function Virtual    

Functions

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

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

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

CreateSource ( const FLiveLinkSourcePreset& SourcePreset
)

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

CreateSubject ( const FLiveLinkSubjectPreset& SubjectPreset
)

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

GetSourceMachineName ( FGuid EntryGuid
)

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

GetSourcePreset ( FGuid SourceGuid,
UObject* DuplicatedObjectOuter
)

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

GetSources ( bool bEvenIfPendingKill
)

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

GetSourceSettings ( const FGuid& SourceKey
)

 Get the Settings of this source.
Public function Const FText

GetSourceStatus ( FGuid EntryGuid
)

 Get the status of a source
Public function Const FText

GetSourceType ( FGuid SourceGuid
)

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

GetSubjectPreset ( const FLiveLinkSubjectKey& SubjectKey,
UObject* DuplicatedObjectOuter
)

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

GetSubjects ( bool bIncludeDisabledSubject,
bool bIncludeVirtualSubject
)

 Get a list of all subjects
Public function Const UObject *

GetSubjectSettings ( const FLiveLinkSubjectKey& SubjectKey
)

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

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

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

GetSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& InSubjectKey,
bool bGetOverrideData
)

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

GetVirtualSources ( bool bEvenIfPendingKill
)

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

IsSourceStillValid ( FGuid EntryGuid
)

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

IsSubjectEnabled ( const FLiveLinkSubjectKey& SubjectKey,
bool bForThisFrame
)

 Whether or not a subject from the specific source is the enabled subject.
Public function 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 Const bool Whether or not the subject's data is time synchronized or not
Public function Const bool Whether or not the subject's data, from a specific source, is time synchronized or not
Public function Const bool Whether or not the client has a subject with this name that is valid and has valid snapshot data
Public function Const bool

IsSubjectValid ( const FLiveLinkSubjectKey& SubjectKey
)

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

IsVirtualSubject ( const FLiveLinkSubjectKey& SubjectKey
)

 Whether the subject key points to a virtual subject
Public function FOnLiveLinkSourceChangedDelegate & Notify when a new source has been added
Public function FOnLiveLinkSourceChangedDelegate & Notify when a source has been removed
Public function FSimpleMulticastDelegate & Notify when the list of sources has changed.
Public function FOnLiveLinkSubjectChangedDelegate & Notify when a new subject has been added
Public function FOnLiveLinkSubjectEvaluated & Notify the debug interface when a subject has been evaluated.
Public function FOnLiveLinkSubjectChangedDelegate & Notify when a subject has been removed
Public function FSimpleMulticastDelegate & Notify when the list of subject has changed.
Public function FSimpleMulticastDelegate & Notify when the LiveLinkClient has ticked.
Public function void Push frame data for a specific subject for a certain role
Public function void Push static data for a specific subject for a certain role. This will clear all buffered frames
Public function 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.
Public function 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.
Public function void Remove the specified source from the live link client
Public function void

RemoveSource ( FGuid SourceGuid
)

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

RemoveVirtualSubject ( const FLiveLinkSubjectKey& VirtualSubjectKey
)

 Removes a virtual subject from the client
Public function 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 void

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

 Unregister delegate registered with RegisterForFrameDataReceived.
Public function void

UnregisterSubjectFramesHandle ( FLiveLinkSubjectName SubjectName,
FDelegateHandle StaticDataAddedHandle,
FDelegateHandle FrameDataAddedHandle
)

 Unregister delegates registered with RegisterForSubjectFrames.

Constants

Name Description
LIVELINK_VERSION  
ModularFeatureName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page