FLiveLinkSubject | Unreal Engine 5.5 Documentation

Inheritance Hierarchy


Module	LiveLink
Header	/Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkSubject.h
Include	#include "LiveLinkSubject.h"

class FLiveLinkSubject :  
    public ILiveLinkSubject ,  
    public ITimedDataInputChannel

Manages subject manipulation either to add or get frame data for specific roles

Type	Name	Description
ULiveLinkFrameInterpolationProcessor::FWorkerSharedPtr	FrameInterpolationProcessor
TArray< ULiveLinkFramePreProcessor::FWorkerSharedPtr >	FramePreProcessors
TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr >	FrameTranslators	List of available translator the subject can use.
TSubclassOf< ULiveLinkRole >	Role	The role the subject was build with.
ULiveLinkSubjectRemapper::FWorkerSharedPtr	SubjectRemapper	Subject remapper used to modify static and frame data for a subject.

	Type	Name	Description
		FLiveLinkSubject ( TSharedPtr< FLiveLinkTimedDataInput > InTimedDataGroup )
		FLiveLinkSubject ( const FLiveLinkSubject& )

	Type	Name	Description
		~FLiveLinkSubject ()

Type	Name	Description
void	AddFrameData ( FLiveLinkFrameDataStruct&& InFrameData )	Add a frame of data from a FLiveLinkFrameData.
void	CacheSettings ( ULiveLinkSourceSettings* SourceSetting, ULiveLinkSubjectSettings* SubjectSetting )
void	ClearOverrideStaticData_AnyThread ()	Clear the override static data for this subject.
bool	EvaluateFrameAtSceneTime ( const FQualifiedFrameTime& InSceneTime, TSubclassOf< ULiveLinkRole > InDesiredRole, FLiveLinkSubjectFrameData& OutFrame )
bool	EvaluateFrameAtWorldTime ( double InWorldTime, TSubclassOf< ULiveLinkRole > InDesiredRole, FLiveLinkSubjectFrameData& OutFrame )
double	GetLastPushTime ()	Get the timestamp of the last time a frame was received for this subject.
ELiveLinkSourceMode	GetMode ()
FLiveLinkSubjectTimeSyncData	GetTimeSyncData ()
bool	HasStaticData ()
bool	IsTimeSynchronized ()
void	SetLastPushTime ( double InLastPushTime )	Set the last time a frame was received.
void	SetStaticData ( TSubclassOf< ULiveLinkRole > InRole, FLiveLinkStaticDataStruct&& InStaticData )	Handling setting a new static data. Create role data if not found in map.
bool	ValidateFrameData ( const FLiveLinkFrameDataStruct& InFrameData )	Validates if the incoming frame data is compatible with the static data for this subject.

Type	Name	Description
void	ClearFrames ()
const ULiveLinkSubjectRemapper::FWorkerSharedPtr	GetFrameRemapper ()	Get this subject's frame remapper.
const FLiveLinkSubjectFrameData &	GetFrameSnapshot ()
TArray< FLiveLinkTime >	GetFrameTimes ()
const TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr >	GetFrameTranslators ()	List of available translator the subject can use.
TSubclassOf< ULiveLinkRole >	GetRole ()
FLiveLinkStaticDataStruct &	GetStaticData ( bool bGetOverrideData )
const FLiveLinkStaticDataStruct &	GetStaticData ()
FLiveLinkSubjectKey	GetSubjectKey ()
bool	HasStaticDataBeenRebroadcasted ()	When rebroadcasting, has the static data been rebroadcasted?
bool	HasValidFrameSnapshot ()
void	Initialize ( FLiveLinkSubjectKey SubjectKey, TSubclassOf< ULiveLinkRole > InRole, ILiveLinkClient* LiveLinkClient )
bool	IsRebroadcasted ()	Whether this subject is rebroadcasted
void	PreprocessFrame ( FLiveLinkFrameDataStruct& InOutFrameData )	Apply this subject's preprocessors to a frame data.
void	SetStaticDataAsRebroadcasted ( const bool bInSent )	Sets the static data for this subject as rebroadcasted
void	Update ()

Type	Name	Description
int32	GetBufferOverflowStat ()	Return buffer overflow count detected by this input
int32	GetBufferUnderflowStat ()	Return buffer underflow count detected by this input
TArray< FTimedDataChannelSampleTime >	GetDataTimes ()	Get the time of all the data samples available.
FText	GetDisplayName ()	ITimedDataInput interface
int32	GetFrameDroppedStat ()	Return frame dropped count detected by this input
void	GetLastEvaluationData ( FTimedDataInputEvaluationData& OutEvaluationData )	Get data about last evaluation. Samples used, expected, number of samples.
FTimedDataChannelSampleTime	GetNewestDataTime ()	Get the time of the newest data sample available.
int32	GetNumberOfSamples ()	Get the number of data samples available.
FTimedDataChannelSampleTime	GetOldestDataTime ()	Get the time of the oldest data sample available.
ETimedDataInputState	GetState ()	Get the current state of the channel.
bool	IsBufferStatsEnabled ()	Is tracking of stats enabled for this input
void	ResetBufferStats ()	Resets internal stat counters
void	SetBufferStatsEnabled ( bool bEnable )	Enables or disables stats tracking for this input