1. Epic GamesDeveloper
  3. FLiveLinkSubject

FLiveLinkSubject

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

API > API/Plugins > API/Plugins/LiveLink

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

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

Syntax

class FLiveLinkSubject :  
    public ILiveLinkSubject ,  
    public ITimedDataInputChannel

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers
  LiveLinkSubject.h  
  LiveLinkSubject.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLiveLinkSubject()

   LiveLinkSubject.h  

Structs

Name Remarks
FLiveLinkCachedSettings  
FSubjectEvaluationStatistics  

Typedefs

Name Type Remarks Include Path
Super ILiveLinkSubject   LiveLinkSubject.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bClearOverrideStaticData std::atomic< bool > Flag set to clear the override static data for a subject. LiveLinkSubject.h  
bIsStatLoggingEnabled bool Logging stats is enabled by default. LiveLinkSubject.h  
bNeedsStaticRemap bool If true, override static data may remap when caching settings. LiveLinkSubject.h  
bPaused std::atomic< bool > Flag set to indicate that a subject is currently paused, so it should keep its last snapshot. LiveLinkSubject.h  
bRebroadcastStaticDataSent bool If true, static data has been sent for this rebroadcast LiveLinkSubject.h  
bRebroadcastSubject bool If enabled, rebroadcast this subject LiveLinkSubject.h  
CachedSettings FLiveLinkCachedSettings Connection settings specified by user LiveLinkSubject.h  
EvaluationStatistics FSubjectEvaluationStatistics Some stats compiled by the subject. LiveLinkSubject.h  
FrameData TArray< FLiveLinkFrameDataStruct > Frames added to the subject LiveLinkSubject.h  
FrameSnapshot FLiveLinkSubjectFrameData Current frame snapshot of the evaluation LiveLinkSubject.h  
LastPushTime double Last time a frame was pushed LiveLinkSubject.h  
LastRebroadcastFrameId FLiveLinkFrameIdentifier Last frame ID that was rebroadcasted. LiveLinkSubject.h  
LastTimecodeFrameRate FFrameRate Last Timecode FrameRate received LiveLinkSubject.h  
ModeOverride TOptional< ELiveLinkSourceMode > Override mode, determined by frame data LiveLinkSubject.h  
NextIdentifier FLiveLinkFrameIdentifier Next identifier to assign to next received frame LiveLinkSubject.h  
OnStateChangedDelegate FOnStateChanged Delegate called when the state of this subject has changed. LiveLinkSubject.h  
OverrideStaticData TOptional< FLiveLinkStaticDataStruct > Override static data, set by the remapper. LiveLinkSubject.h  
ReceivedOrderedFrames TQueue< FLiveLinkFrameIdentifier > Contains identifier of each frame in the order they were received LiveLinkSubject.h  
SettingsCriticalSection FCriticalSection Used to protect access to translators, preprocessors and interpolation processors since they can be set and accessed in different threads. LiveLinkSubject.h  
State ELiveLinkSubjectState Current state of this subject. LiveLinkSubject.h  
StaticData FLiveLinkStaticDataStruct Static data of the subject LiveLinkSubject.h  
StatisticCriticalSection FCriticalSection Evaluation can be done on any thread so we need to protect statistic logging Some stats requires more than atomic sized vars so a critical section is used to protect when necessary LiveLinkSubject.h  
SubjectKey FLiveLinkSubjectKey Name of the subject LiveLinkSubject.h  
TimedDataGroup TWeakPtr< FLiveLinkTimedDataInput > Timed data input group for the subject LiveLinkSubject.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddFrameData ( FLiveLinkFrameDataStruct&& InFrameData
)

 Add a frame of data from a FLiveLinkFrameData LiveLinkSubject.h  

void CacheSettings ( ULiveLinkSourceSettings* SourceSetting,
ULiveLinkSubjectSettings* SubjectSetting
)

   LiveLinkSubject.h  

void ClearOverrideStaticData_AnyThread()

 Clear the override static data for this subject. LiveLinkSubject.h  

bool EvaluateFrameAtSceneTime ( const FQualifiedFrameTime& InSceneTime,
TSubclassOf< ULiveLinkRole > InDesiredRole,
FLiveLinkSubjectFrameData& OutFrame
)

   LiveLinkSubject.h  

bool EvaluateFrameAtWorldTime ( double InWorldTime,
TSubclassOf< ULiveLinkRole > InDesiredRole,
FLiveLinkSubjectFrameData& OutFrame
)

   LiveLinkSubject.h  

virtual int32 GetBufferOverflowStat()

   LiveLinkSubject.h  

virtual int32 GetBufferUnderflowStat()

   LiveLinkSubject.h  

virtual TArray< FTimedDataChannelSampleTime > GetDataTimes()

   LiveLinkSubject.h  

virtual FText GetDisplayName()

 ITimedDataInput interface LiveLinkSubject.h  

virtual int32 GetFrameDroppedStat()

   LiveLinkSubject.h  

virtual void GetLastEvaluationData ( FTimedDataInputEvaluationData& OutEvaluationData
) const

   LiveLinkSubject.h  

double GetLastPushTime()

 Get the timestamp of the last time a frame was received for this subject. LiveLinkSubject.h  

FLiveLinkFrameIdentifier GetLastRebroadcastedFrameId()

   LiveLinkSubject.h  
  LiveLinkSubject.h  

virtual FTimedDataChannelSampleTime GetNewestDataTime()

   LiveLinkSubject.h  

virtual int32 GetNumberOfSamples()

   LiveLinkSubject.h  

virtual FTimedDataChannelSampleTime GetOldestDataTime()

   LiveLinkSubject.h  

virtual ETimedDataInputState GetState()

   LiveLinkSubject.h  

FLiveLinkSubjectTimeSyncData GetTimeSyncData()

   LiveLinkSubject.h  

bool HasStaticData()

   LiveLinkSubject.h  

virtual bool IsBufferStatsEnabled()

   LiveLinkSubject.h  

bool IsTimeSynchronized()

   LiveLinkSubject.h  

FOnStateChanged & OnStateChanged()

 Get the delegate triggered when the state changes. LiveLinkSubject.h  

virtual void ResetBufferStats()

   LiveLinkSubject.h  

virtual void SetBufferStatsEnabled ( bool bEnable
)

   LiveLinkSubject.h  

void SetLastPushTime ( double InLastPushTime
)

 Set the last time a frame was received. LiveLinkSubject.h  

void SetLastRebroadcastedFrameId ( FLiveLinkFrameIdentifier FrameId
)

   LiveLinkSubject.h  

void SetStaticData ( TSubclassOf< ULiveLinkRole > InRole,
FLiveLinkStaticDataStruct&& InStaticData
)

 Handling setting a new static data. Create role data if not found in map. LiveLinkSubject.h  

bool ValidateFrameData ( const FLiveLinkFrameDataStruct& InFrameData
)

 Validates if the incoming frame data is compatible with the static data for this subject. LiveLinkSubject.h  

Overridden from ILiveLinkSubject

Name Remarks Include Path Unreal Specifiers

virtual void ClearFrames()

   LiveLinkSubject.h  

virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr GetFrameRemapper()

   LiveLinkSubject.h  

virtual TArray< FLiveLinkTime > GetFrameTimes()

   LiveLinkSubject.h  

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

   LiveLinkSubject.h  

virtual TSubclassOf< ULiveLinkRole > GetRole()

   LiveLinkSubject.h  

virtual const FLiveLinkStaticDataStruct & GetStaticData ()

   LiveLinkSubject.h  

virtual FLiveLinkStaticDataStruct & GetStaticData ( bool bGetOverrideData
)

   LiveLinkSubject.h  

virtual FLiveLinkSubjectKey GetSubjectKey()

   LiveLinkSubject.h  

virtual bool HasStaticDataBeenRebroadcasted()

   LiveLinkSubject.h  

virtual bool HasValidFrameSnapshot()

   LiveLinkSubject.h  

virtual void Initialize ( FLiveLinkSubjectKey SubjectKey,
TSubclassOf< ULiveLinkRole > InRole,
ILiveLinkClient* LiveLinkClient
)

   LiveLinkSubject.h  

virtual bool IsPaused()

   LiveLinkSubject.h  

virtual bool IsRebroadcasted()

   LiveLinkSubject.h  

virtual void PauseSubject()

   LiveLinkSubject.h  

virtual void PreprocessFrame ( FLiveLinkFrameDataStruct& InOutFrameData
)

   LiveLinkSubject.h  

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

   LiveLinkSubject.h  

virtual void SetStaticDataAsRebroadcasted ( const bool bInSent
)

   LiveLinkSubject.h  

virtual void UnpauseSubject()

   LiveLinkSubject.h  

virtual void Update()

   LiveLinkSubject.h  

Protected

Overridden from ILiveLinkSubject

Name Remarks Include Path Unreal Specifiers

virtual const FLiveLinkSubjectFrameData & GetFrameSnapshot()

   LiveLinkSubject.h  

Operators

Name Remarks Include Path Unreal Specifiers

FLiveLinkSubject & operator= ( const FLiveLinkSubject&
)

   LiveLinkSubject.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page