FLiveLinkClient

Windows
MacOS
Linux

Inheritance Hierarchy

ILiveLinkClient_Base_DEPRECATED

ILiveLinkClient

FLiveLinkClient_Base_DEPRECATED

FLiveLinkClient

References

Module

LiveLink

Header

/Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkClient.h

Include

#include "LiveLinkClient.h"

Syntax

class FLiveLinkClient : public FLiveLinkClient_Base_DEPRECATED

Constructors

Name Description

Public function

FLiveLinkClient()

Destructors

Name Description

Public function Virtual

~FLiveLinkClient()

Functions

Name Description

Public function

void

 

AddVirtualSubject

(
    FLiveLinkSubjectName VirtualSubject...,
    TSubclassOf< ULiveLinkVirtualSubjec...
)

Add a new virtual subject to the client

Public function Const

TArray< FGui...

 

GetDisplayableSources()

Public function Const

FText

 

GetSourceMachineName

(
    FGuid EntryGuid
)

Public function Const

ULiveLinkSou...

 

GetSourceSettings

(
    FGuid InEntryGuid
)

Public function Const

FText

 

GetSourceStatus

(
    FGuid EntryGuid
)

Public function Const

UObject *...

 

GetSubjectSettings

(
    const FLiveLinkSubjectKey& Subject...
)

Public function

FLiveLinkSub...

 

GetTimeSyncData

(
    FLiveLinkSubjectName SubjectName
)

Public function Const

bool

 

IsVirtualSubject

(
    const FLiveLinkSubjectKey& Subject
)

Is the supplied subject virtual

Public function

void

 

OnPropertyChanged

(
    FGuid EntryGuid,
    const FPropertyChangedEvent& Prope...
)

Callback when property changed for one of the source settings

Public function

void

 

RemoveAllSources()

Remove all sources from the live link client

Public function

void

 

RemoveSource

(
    FGuid InEntryGuid
)

Remove the specified source from the live link client

Public function

void

 

Tick()

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

Overridden from FLiveLinkClient_Base_DEPRECATED

Name Description

Protected function Virtual

void

 

AquireLock_Deprecation()

Function for Deprecation

Protected function Virtual

void

 

ClearFrames_Deprecation

(
    const FLiveLinkSubjectKey& Subject...
)

Protected function Virtual

FLiveLinkSke...

 

GetSubjectAnimationStaticData_Deprecation

(
    const FLiveLinkSubjectKey& Subject...
)

Protected function Virtual

void

 

ReleaseLock_Deprecation()

Overridden from ILiveLinkClient

Name Description

Public function Virtual

FGuid

 

AddSource

(
    TSharedPtr< ILiveLinkSource > Sourc...
)

Add a new live link source to the client

Public function Virtual

void

 

ClearAllSubjectsFrames_AnyThread()

Clear all subjects frames

Public function Virtual

void

 

ClearSubjectsFrames_AnyThread

(
    FLiveLinkSubjectName SubjectName
)

Clear the stored frames associated with the enabled subject

Public function Virtual

void

 

ClearSubjectsFrames_AnyThread

(
    const FLiveLinkSubjectKey& Subject...
)

Clear the stored frames associated with the subject

Public function Virtual

bool

 

CreateSource

(
    const FLiveLinkSourcePreset& Sourc...
)

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

Public function Virtual

bool

 

CreateSubject

(
    const FLiveLinkSubjectPreset& Subj...
)

Create and add a new live link subject to the client

Public function Virtual Const

bool

 

DoesSubjectSupportsRole

(
    const FLiveLinkSubjectKey& Subject...,
    TSubclassOf< ULiveLinkRole > Suppor...
)

Whether a subject support a particular role, either directly or through a translator

Public function Virtual

bool

 

EvaluateFrame_AnyThread

(
    FLiveLinkSubjectName SubjectName,
    TSubclassOf< ULiveLinkRole > Role,
    FLiveLinkSubjectFrameData& OutFram...
)

Return the evaluated subject snapshot for a specific role.

Public function Virtual

bool

 

EvaluateFrameAtSceneTime_AnyThread

(
    FLiveLinkSubjectName SubjectName,
    const FTimecode& SceneTime,
    TSubclassOf< ULiveLinkRole > Desire...,
    FLiveLinkSubjectFrameData& OutFram...
)

Evaluates a subject for a specific role at a Timecode.

Public function Virtual

bool

 

EvaluateFrameAtWorldTime_AnyThread

(
    FLiveLinkSubjectName SubjectName,
    double WorldTime,
    TSubclassOf< ULiveLinkRole > Desire...,
    FLiveLinkSubjectFrameData& OutFram...
)

Evaluates a subject for a specific role.

Public function Virtual Const

FLiveLinkSou...

 

GetSourcePreset

(
    FGuid SourceGuid,
    UObject* DuplicatedObjectOuter
)

Get the source preset from the live link client.

Public function Virtual Const

TArray< FGui...

 

GetSources()

Get a list of all the sources

Public function Virtual Const

FText

 

GetSourceType

(
    FGuid SourceGuid
)

Get the type of a source

Public function Virtual Const

FLiveLinkSub...

 

GetSubjectPreset

(
    const FLiveLinkSubjectKey& Subject...,
    UObject* DuplicatedObjectOuter
)

Get the subject preset from the live link client.

Public function Virtual Const

TSubclassOf<...

 

GetSubjectRole

(
    const FLiveLinkSubjectKey& Subject...
)

Get the role of a subject from a specific source

Public function Virtual Const

TSubclassOf<...

 

GetSubjectRole

(
    FLiveLinkSubjectName SubjectName
)

Get the role of the subject with this name

Public function Virtual Const

TArray< FLiv...

 

GetSubjects

(
    bool bIncludeDisabledSubject,
    bool bIncludeVirtualSubject
)

Get a list of all subjects

Public function Virtual Const

TArray< FLiv...

 

GetSubjectsSupportingRole

(
    TSubclassOf< ULiveLinkRole > Suppor...,
    bool bIncludeDisabledSubject,
    bool bIncludeVirtualSubject
)

Get a list of name of subjects supporting a certain role

Public function Virtual Const

bool

 

HasSourceBeenAdded

(
    TSharedPtr< ILiveLinkSource > Sourc...
)

Is the source been added

Public function Virtual Const

bool

 

IsSubjectEnabled

(
    const FLiveLinkSubjectKey& Subject...,
    bool bUseSnaphot
)

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

Public function Virtual Const

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.

Public function Virtual Const

bool

 

IsSubjectTimeSynchronized

(
    FLiveLinkSubjectName SubjectName
)

Whether or not the subject's data is time synchronized or not

Public function Virtual Const

bool

 

IsSubjectTimeSynchronized

(
    const FLiveLinkSubjectKey& Subject...
)

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

Public function Virtual Const

bool

 

IsSubjectValid

(
    FLiveLinkSubjectName SubjectName
)

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& Subject...
)

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

Public function Virtual

FOnLiveLinkS...

 

OnLiveLinkSourceAdded()

Notify when a new source has been added

Public function Virtual

FOnLiveLinkS...

 

OnLiveLinkSourceRemoved()

Notify when a source has been removed

Public function Virtual

FSimpleMulti...

 

OnLiveLinkSourcesChanged()

Notify when the list of sources has changed.

Public function Virtual

FOnLiveLinkS...

 

OnLiveLinkSubjectAdded()

Notify when a new subject has been added

Public function Virtual

FOnLiveLinkS...

 

OnLiveLinkSubjectRemoved()

Notify when a subject has been removed

Public function Virtual

FSimpleMulti...

 

OnLiveLinkSubjectsChanged()

Notify when the list of subject has changed.

Public function Virtual

void

 

PushSubjectFrameData_AnyThread

(
    const FLiveLinkSubjectKey& Subject...,
    FLiveLinkFrameDataStruct&& FrameDa...
)

Push frame data for a specific subject for a certain role

Public function Virtual

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

Public function Virtual

bool

 

RegisterForSubjectFrames

(
    FLiveLinkSubjectName SubjectName,
    const FOnLiveLinkSubjectStaticDataR...,
    const FOnLiveLinkSubjectFrameDataRe...,
    FDelegateHandle& OutStaticDataRece...,
    FDelegateHandle& OutFrameDataRecei...,
    TSubclassOf< ULiveLinkRole >& OutS...,
    FLiveLinkStaticDataStruct* Out...
)

Register for when a frame has been received for a subject

Public function Virtual

void

 

RemoveSource

(
    TSharedPtr< ILiveLinkSource > Sourc...
)

Remove the specified source from the live link client

Public function Virtual

void

 

RemoveSubject_AnyThread

(
    const FLiveLinkSubjectKey& Subject...
)

Clear the subject from the specific source

Public function Virtual

void

 

SetSubjectEnabled

(
    const FLiveLinkSubjectKey& Subject...,
    bool bEnabled
)

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

Public function Virtual

void

 

UnregisterSubjectFramesHandle

(
    FLiveLinkSubjectName InSubjectName,
    FDelegateHandle InStaticDataReceive...,
    FDelegateHandle InFrameDataReceived...
)

Deprecated Functions

Name Description

Public function

void

 

AddVirtualSubject

(
    FName NewVirtualSubjectName
)

FLiveLinkClient::AddVirtualSubject(FName) is deprecated. Please use AddVirtualSubject(FName, TSubClass) instead!

Public function Const

FText

 

GetEntryStatusForEntry

(
    FGuid EntryGuid
)

FLiveLinkClient::GetEntryStatusForEntry is deprecated. Please use GetSourceStatus instead!

Public function Const

FText

 

GetMachineNameForEntry

(
    FGuid EntryGuid
)

FLiveLinkClient::GetMachineNameForEntry is deprecated. Please use GetSourceMachineName instead!

Public function Const

const TArray...

 

GetSourceEntries()

FLiveLinkClient::GetSourceEntries is deprecated. Please use ILiveLinkClient::GetSources instead!

Public function Const

FText

 

GetSourceTypeForEntry

(
    FGuid EntryGuid
)

FLiveLinkClient::GetSourceTypeForEntry is deprecated. Please use GetSourceType instead!

Public function

FDelegateHan...

 

RegisterSourcesChangedHandle

(
    const FSimpleMulticastDelegate::FDe...
)

FLiveLinkClient::OnLiveLinkSourcesChanged is deprecated. Please use OnLiveLinkSourceAdded instead!

Public function

void

 

UnregisterSourcesChangedHandle

(
    FDelegateHandle Handle
)

FLiveLinkClient::OnLiveLinkSourcesChanged is deprecated. Please use OnLiveLinkSourceAdded instead!

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback