1. Epic GamesDeveloper
  3. ULiveLinkBlueprintLibrary

ULiveLinkBlueprintLibrary

API > API/Plugins > API/Plugins/LiveLink

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

Syntax

UCLASS (MinimalAPI)  
class ULiveLinkBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static int ChildCount ( FLiveLinkTransform& LiveLinkTransform
)

 Returns the number of Children for a given LiveLink Transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static void ComponentSpaceTransform ( FLiveLinkTransform& LiveLinkTransform,
FTransform& Transform
)

 Returns the Transform value in Root Space for a given LiveLink Transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static bool EvaluateLiveLinkFrame ( FLiveLinkSubjectRepresentation SubjectRepresentation,
FLiveLinkBaseBlueprintData& OutBlueprintData
)

   LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category=LiveLink
  • Meta=(DeprecatedFunction, CustomStructureParam="OutBlueprintData", BlueprintInternalUseOnly="true", AllowAbstract="false")

static bool EvaluateLiveLinkFrameAtSceneTime ( FLiveLinkSubjectName SubjectName,
TSubclassOf< ULiveLinkRole > Role,
FTimecode SceneTime,
FLiveLinkBaseBlueprintData& OutBlueprintData
)

 Fetches a frame on a subject for a specific role at a specified scene time (timecode). LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category=LiveLink
  • Meta=(CustomStructureParam="OutBlueprintData", BlueprintInternalUseOnly="true", AllowAbstract="false")

static bool EvaluateLiveLinkFrameAtWorldTimeOffset ( FLiveLinkSubjectName SubjectName,
TSubclassOf< ULiveLinkRole > Role,
float WorldTimeOffset,
FLiveLinkBaseBlueprintData& OutBlueprintData
)

 Fetches a frame on a subject for a specific role at an offset from the application current time. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category=LiveLink
  • Meta=(CustomStructureParam="OutBlueprintData", BlueprintInternalUseOnly="true", AllowAbstract="false")

static bool EvaluateLiveLinkFrameWithSpecificRole ( FLiveLinkSubjectName SubjectName,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkBaseBlueprintData& OutBlueprintData
)

 Fetches a frame on a subject for a specific role. Output is evaluated based on the role LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category=LiveLink
  • Meta=(DisplayName="EvaluateLiveLinkFrame", CustomStructureParam="OutBlueprintData", BlueprintInternalUseOnly="true", AllowAbstract="false")

static bool GetAnimationFrameData ( FSubjectFrameHandle& SubjectFrameHandle,
FLiveLinkAnimationFrameData& AnimationFrameData
)

 Returns the Subject's frame data stored in the Subject Frame. Returns false if no valid data found. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static bool GetAnimationStaticData ( FSubjectFrameHandle& SubjectFrameHandle,
FLiveLinkSkeletonStaticData& AnimationStaticData
)

 Returns the Subject's static data stored in the Subject Frame. Returns false if no valid data found. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void GetBasicData ( FSubjectFrameHandle& SubjectFrameHandle,
FLiveLinkBasicBlueprintData& BasicBlueprintData
)

 Returns the Subject base structure stored in the Subject Frame. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void GetChildren ( FLiveLinkTransform& LiveLinkTransform,
TArray< FLiveLinkTransform >& Children
)

 Returns an array of Child LiveLink Transforms for a given LiveLink Transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static void GetCurves ( FSubjectFrameHandle& SubjectFrameHandle,
TMap< FName, float >& Curves
)

 Returns the float curves stored in the Subject Frame as a map. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static TArray< FLiveLinkSubjectName > GetLiveLinkEnabledSubjectNames ( bool bIncludeVirtualSubject
)

 Get a list of all enabled subject names LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static TSubclassOf< ULiveLinkRole > GetLiveLinkSubjectRole ( const FLiveLinkSubjectName SubjectName
)

 Get the role of the subject with this name LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static TArray< FLiveLinkSubjectKey > GetLiveLinkSubjects ( bool bIncludeDisabledSubject,
bool bIncludeVirtualSubject
)

 Get a list of all subjects LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static ELiveLinkSubjectState GetLiveLinkSubjectState ( const FLiveLinkSubjectName SubjectName
)

 Returns the state of the subject with the given name. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static void GetMetadata ( FSubjectFrameHandle& SubjectFrameHandle,
FSubjectMetadata& Metadata
)

 Returns the Subject Metadata structure stored in the Subject Frame. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void GetParent ( FLiveLinkTransform& LiveLinkTransform,
FLiveLinkTransform& Parent
)

 Returns the Parent LiveLink Transform if one exists or an Identity transform if no parent exists. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static bool GetPropertyValue ( FLiveLinkBasicBlueprintData& BasicData,
FName PropertyName,
float& Value
)

 Returns the value of a property stored in the Subject Frame. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static void GetRootTransform ( FSubjectFrameHandle& SubjectFrameHandle,
FLiveLinkTransform& LiveLinkTransform
)

 Returns the Root Transform for the Subject Frame as a LiveLink Transform or the Identity if there are no transforms. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static FText GetSourceMachineName ( FLiveLinkSourceHandle& SourceHandle
)

 Get the machine name of a LiveLink Source via its handle. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static FText GetSourceStatus ( FLiveLinkSourceHandle& SourceHandle
)

 Get the text status of a LiveLink Source via its handle. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static FText GetSourceType ( FLiveLinkSourceHandle& SourceHandle
)

 Get the type of a LiveLink Source via its handle. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static FText GetSourceTypeFromGuid ( FGuid SourceGuid
)

 Get the type of a source from the given GUID LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static TSubclassOf< ULiveLinkRole > GetSpecificLiveLinkSubjectRole ( const FLiveLinkSubjectKey SubjectKey
)

 Get the role of a subject from a specific source LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static void GetTransformByIndex ( FSubjectFrameHandle& SubjectFrameHandle,
int TransformIndex,
FLiveLinkTransform& LiveLinkTransform
)

 Returns the LiveLink Transform stored in a Subject Frame at a given index. Returns an Identity transform if Transform Index is invalid. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void GetTransformByName ( FSubjectFrameHandle& SubjectFrameHandle,
FName TransformName,
FLiveLinkTransform& LiveLinkTransform
)

 Returns the LiveLink Transform stored in a Subject Frame with a given name. Returns an Identity transform if Transform Name is invalid. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static bool HasParent ( FLiveLinkTransform& LiveLinkTransform
)

 Returns whether a given LiveLink Transform has a parent transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static bool IsLiveLinkSubjectEnabled ( const FLiveLinkSubjectName SubjectName
)

 Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static bool IsSourceStillValid ( FLiveLinkSourceHandle& SourceHandle
)

 Checks whether the LiveLink Source is valid via its handle. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static bool IsSpecificLiveLinkSubjectEnabled ( const FLiveLinkSubjectKey SubjectKey,
bool bForThisFrame
)

 Whether or not a subject from the specific source is the enabled subject. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static int NumberOfTransforms ( FSubjectFrameHandle& SubjectFrameHandle
)

 Returns the number of Transforms stored in the Subject Frame. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void ParentBoneSpaceTransform ( FLiveLinkTransform& LiveLinkTransform,
FTransform& Transform
)

 Returns the Transform value in Parent Space for a given LiveLink Transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static void PauseSubject ( const FLiveLinkSubjectName SubjectName
)

 Pause a subject, freezing its evaluation to the last data it received. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static bool RemoveSource ( FLiveLinkSourceHandle& SourceHandle
)

 Requests the given LiveLink Source to shut down via its handle. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static void SetLiveLinkSubjectEnabled ( const FLiveLinkSubjectKey SubjectKey,
bool bEnabled
)

 Set the subject's from a specific source to enabled, disabling the other in the process. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

static void TransformName ( FLiveLinkTransform& LiveLinkTransform,
FName& Name
)

 Returns the Name of a given LiveLink Transform. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink"

static void TransformNames ( FSubjectFrameHandle& SubjectFrameHandle,
TArray< FName >& TransformNames
)

 Returns an array of Transform Names stored in the Subject Frame. LiveLinkBlueprintLibrary.h
  • BlueprintPure
  • Category="LiveLink|Animation"

static void UnpauseSubject ( const FLiveLinkSubjectName SubjectName
)

 Unpause a subject, resuming its normal operation. LiveLinkBlueprintLibrary.h
  • BlueprintCallable
  • Category="LiveLink"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page