ULiveLinkComponent

An actor component to enable accessing LiveLink data in Blueprints.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

LiveLink

Header

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

Include

#include "LiveLinkComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(LiveLink), Meta=(BlueprintSpawnableComponent),
       Meta=(DisplayName="LiveLink Skeletal Animation"))
class ULiveLinkComponent : public UActorComponent

Remarks

An actor component to enable accessing LiveLink data in Blueprints. Data can be accessed in Editor through the "OnLiveLinkUpdated" event. Any Skeletal Mesh Components on the parent will be set to animate in editor causing their AnimBPs to run.

Variables

Name Description

Public variable UProperty Category BlueprintAssignable

FLiveLinkTickSi...

 

OnLiveLinkUpdated

This Event is triggered any time new LiveLink data is available, including in the editor.

Constructors

Name Description

Public function

ULiveLinkComponent()

Sets default values for this component's properties.

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Called every frame.

Deprecated Functions

Name Description

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetAvailableSubjectNames

(
    TArray< FName >& SubjectNames
)

GetAvailableSubjectNames is deprecated, use GetLiveLinkEnabledSubjectNames.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetSubjectData

(
    const FName SubjectName,
    bool& bSuccess,
    FSubjectFrameHandle& SubjectFrameH...
)

GetSubjectData is deprecated, use EvaluateLiveLinkFrame.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetSubjectDataAtSceneTime

(
    const FName SubjectName,
    const FTimecode& SceneTime,
    bool& bSuccess,
    FSubjectFrameHandle& SubjectFrameH...
)

GetSubjectDataAtSceneTime is deprecated, use EvaluateLiveLinkFrameAtSceneTime.

Public function

void

 

GetSubjectDataAtTime

(
    const FName SubjectName,
    const double WorldTime,
    bool& bSuccess,
    FSubjectFrameHandle& SubjectFrameH...
)

GetSubjectDataAtTime is deprecated, use EvaluateLiveLinkFrameAtSceneTime.

Public function UFunction BlueprintCallable, Category, Meta

void

 

GetSubjectDataAtWorldTime

(
    const FName SubjectName,
    const float WorldTime,
    bool& bSuccess,
    FSubjectFrameHandle& SubjectFrameH...
)

GetSubjectDataAtWorldTime is deprecated, use EvaluateLiveLinkFrameAtWorldTime.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss