UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
ILiveLinkSubject Class Referenceabstract

#include <ILiveLinkSubject.h>

+ Inheritance diagram for ILiveLinkSubject:

Public Member Functions

virtual ~ILiveLinkSubject ()
 
virtual void Initialize (FLiveLinkSubjectKey SubjectKey, TSubclassOf< ULiveLinkRole > Role, ILiveLinkClient *LiveLinkClient)=0
 
virtual void Update ()=0
 
virtual LIVELINKINTERFACE_API bool EvaluateFrame (TSubclassOf< ULiveLinkRole > InDesiredRole, FLiveLinkSubjectFrameData &OutFrame)
 
virtual void ClearFrames ()=0
 
virtual FLiveLinkSubjectKey GetSubjectKey () const =0
 
virtual TSubclassOf< ULiveLinkRole > GetRole () const =0
 
virtual LIVELINKINTERFACE_API bool SupportsRole (TSubclassOf< ULiveLinkRole > InDesiredRole) const
 
virtual bool HasValidFrameSnapshot () const =0
 
virtual FLiveLinkStaticDataStruct & GetStaticData (bool bGetOverrideData=true)=0
 
virtual const FLiveLinkStaticDataStruct & GetStaticData () const =0
 
virtual TArray< FLiveLinkTime > GetFrameTimes () const =0
 
virtual const TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr > GetFrameTranslators () const =0
 
virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr GetFrameRemapper () const =0
 
virtual bool IsRebroadcasted () const =0
 
virtual bool HasStaticDataBeenRebroadcasted () const =0
 
virtual void SetStaticDataAsRebroadcasted (const bool bInSent)=0
 
virtual void PreprocessFrame (FLiveLinkFrameDataStruct &InOutFrameData)
 
virtual void PreprocessFrame (const FLiveLinkStaticDataStruct &InStaticData, FLiveLinkFrameDataStruct &InOutFrameData)
 
virtual void RemapFrame (FLiveLinkSkeletonStaticData &InOutSkeletonData, FLiveLinkAnimationFrameData &InOutFrameData)
 
virtual bool IsPaused () const =0
 
virtual void PauseSubject ()=0
 
virtual void UnpauseSubject ()=0
 
FLiveLinkFrameIdentifier GetSnapshotFrameId () const
 

Protected Member Functions

virtual const FLiveLinkSubjectFrameData & GetFrameSnapshot () const =0
 

Static Protected Member Functions

static LIVELINKINTERFACE_API bool Translate (const ILiveLinkSubject *LinkSubject, TSubclassOf< ULiveLinkRole > DesiredRole, const FLiveLinkStaticDataStruct &StaticData, const FLiveLinkFrameDataStruct &FrameData, FLiveLinkSubjectFrameData &OutFrame)
 

Detailed Description

The base class of a LiveLink subject. Subjects are individual streams of data within the client. An animating character could be a subject for instance.

Constructor & Destructor Documentation

◆ ~ILiveLinkSubject()

virtual ILiveLinkSubject::~ILiveLinkSubject ( )
inlinevirtual

Member Function Documentation

◆ ClearFrames()

virtual void ILiveLinkSubject::ClearFrames ( )
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ EvaluateFrame()

bool ILiveLinkSubject::EvaluateFrame ( TSubclassOf< ULiveLinkRole >  InDesiredRole,
FLiveLinkSubjectFrameData &  OutFrame 
)
virtual

Reimplemented in ULiveLinkVirtualSubject.

◆ GetFrameRemapper()

virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr ILiveLinkSubject::GetFrameRemapper ( ) const
pure virtual

Get this subject's frame remapper.

Implemented in ULiveLinkVirtualSubject.

◆ GetFrameSnapshot()

virtual const FLiveLinkSubjectFrameData & ILiveLinkSubject::GetFrameSnapshot ( ) const
protectedpure virtual

Implemented in ULiveLinkVirtualSubject.

◆ GetFrameTimes()

virtual TArray< FLiveLinkTime > ILiveLinkSubject::GetFrameTimes ( ) const
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ GetFrameTranslators()

virtual const TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr > ILiveLinkSubject::GetFrameTranslators ( ) const
pure virtual

List of available translator the subject can use.

Implemented in ULiveLinkVirtualSubject.

◆ GetRole()

virtual TSubclassOf< ULiveLinkRole > ILiveLinkSubject::GetRole ( ) const
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ GetSnapshotFrameId()

FLiveLinkFrameIdentifier ILiveLinkSubject::GetSnapshotFrameId ( ) const
inline

Get the frame ID of the last snapshot that was captured.

◆ GetStaticData() [1/2]

virtual const FLiveLinkStaticDataStruct & ILiveLinkSubject::GetStaticData ( ) const
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ GetStaticData() [2/2]

virtual FLiveLinkStaticDataStruct & ILiveLinkSubject::GetStaticData ( bool  bGetOverrideData = true)
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ GetSubjectKey()

virtual FLiveLinkSubjectKey ILiveLinkSubject::GetSubjectKey ( ) const
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ HasStaticDataBeenRebroadcasted()

virtual bool ILiveLinkSubject::HasStaticDataBeenRebroadcasted ( ) const
pure virtual

When rebroadcasting, has the static data been rebroadcasted?

Implemented in ULiveLinkVirtualSubject.

◆ HasValidFrameSnapshot()

virtual bool ILiveLinkSubject::HasValidFrameSnapshot ( ) const
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ Initialize()

virtual void ILiveLinkSubject::Initialize ( FLiveLinkSubjectKey  SubjectKey,
TSubclassOf< ULiveLinkRole >  Role,
ILiveLinkClient *  LiveLinkClient 
)
pure virtual

Implemented in ULiveLinkVirtualSubject.

◆ IsPaused()

virtual bool ILiveLinkSubject::IsPaused ( ) const
pure virtual

Pause/Unpause subject.

Implemented in ULiveLinkVirtualSubject.

◆ IsRebroadcasted()

virtual bool ILiveLinkSubject::IsRebroadcasted ( ) const
pure virtual

Whether this subject is rebroadcasted

Implemented in ULiveLinkVirtualSubject.

◆ PauseSubject()

virtual void ILiveLinkSubject::PauseSubject ( )
pure virtual

Pause subject.

Implemented in ULiveLinkVirtualSubject.

◆ PreprocessFrame() [1/2]

virtual void ILiveLinkSubject::PreprocessFrame ( const FLiveLinkStaticDataStruct &  InStaticData,
FLiveLinkFrameDataStruct &  InOutFrameData 
)
inlinevirtual

Apply this subject's preprocessors to frame data. Provides static data as a const reference.

◆ PreprocessFrame() [2/2]

virtual void ILiveLinkSubject::PreprocessFrame ( FLiveLinkFrameDataStruct &  InOutFrameData)
inlinevirtual

Apply this subject's preprocessors to frame data.

◆ RemapFrame()

virtual void ILiveLinkSubject::RemapFrame ( FLiveLinkSkeletonStaticData &  InOutSkeletonData,
FLiveLinkAnimationFrameData &  InOutFrameData 
)
inlinevirtual

Apply a remapper to a frame data. Called after preprocessing.

◆ SetStaticDataAsRebroadcasted()

virtual void ILiveLinkSubject::SetStaticDataAsRebroadcasted ( const bool  bInSent)
pure virtual

Sets the static data for this subject as rebroadcasted

Implemented in ULiveLinkVirtualSubject.

◆ SupportsRole()

bool ILiveLinkSubject::SupportsRole ( TSubclassOf< ULiveLinkRole >  InDesiredRole) const
virtual

◆ Translate()

bool ILiveLinkSubject::Translate ( const ILiveLinkSubject *  LinkSubject,
TSubclassOf< ULiveLinkRole >  DesiredRole,
const FLiveLinkStaticDataStruct &  StaticData,
const FLiveLinkFrameDataStruct &  FrameData,
FLiveLinkSubjectFrameData &  OutFrame 
)
staticprotected

◆ UnpauseSubject()

virtual void ILiveLinkSubject::UnpauseSubject ( )
pure virtual

Unpause subject.

Implemented in ULiveLinkVirtualSubject.

◆ Update()

virtual void ILiveLinkSubject::Update ( )
pure virtual

Implemented in ULiveLinkVirtualSubject.

The documentation for this class was generated from the following files: