Navigation
API > API/Runtime > API/Runtime/LiveLinkInterface
A Virtual subject is made up of one or more real subjects from a source.
| Name | ULiveLinkVirtualSubject |
| Type | class |
| Header File | /Engine/Source/Runtime/LiveLinkInterface/Public/LiveLinkVirtualSubject.h |
| Include Path | #include "LiveLinkVirtualSubject.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class ULiveLinkVirtualSubject :
public UObject ,
public ILiveLinkSubject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → ULiveLinkVirtualSubject
Implements Interfaces
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SyncSubject | FLiveLinkSubjectName | If set, the virtual subject will only update and transmit data when the sync subject receives new data. | LiveLinkVirtualSubject.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bPaused | std::atomic< bool > | LiveLinkVirtualSubject.h | ||
| CurrentFrameSnapshot | FLiveLinkSubjectFrameData | Last evaluated frame for this subject. | LiveLinkVirtualSubject.h | |
| CurrentFrameTranslators | TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr > | LiveLinkVirtualSubject.h | ||
| CurrentSubjectRemapper | ULiveLinkSubjectRemapper::FWorkerSharedPtr | Current subject remapper. | LiveLinkVirtualSubject.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool DependsOnSubject
(
FName SubjectName |
Returns true whether this virtual subject depends on the Subject named SubjectName | LiveLinkVirtualSubject.h | |
ILiveLinkClient * GetClient() |
LiveLinkVirtualSubject.h | ||
virtual FText GetDisplayName() |
Get display name for this subject. | LiveLinkVirtualSubject.h | |
const FLiveLinkFrameDataStruct & GetFrameData() |
Returns the current frame data of this virtual subject | LiveLinkVirtualSubject.h | |
virtual FName GetRebroadcastName() |
Get the name that should be used when the subject is rebroadcast. | LiveLinkVirtualSubject.h | |
const TArray< FLiveLinkSubjectName > & GetSubjects() |
Returns the live subjects associated with this virtual one | LiveLinkVirtualSubject.h | |
const TArray< ULiveLinkFrameTranslator * > & GetTranslators() |
Returns the translators assigned to this virtual subject | LiveLinkVirtualSubject.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
LiveLinkVirtualSubject.h |
Overridden from ILiveLinkSubject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearFrames() |
LiveLinkVirtualSubject.h | ||
virtual bool EvaluateFrame
(
TSubclassOf< ULiveLinkRole > InDesiredRole, |
LiveLinkVirtualSubject.h | ||
virtual const ULiveLinkSubjectRemapper::FWorkerSharedPtr GetFrameRemapper() |
Get this subject's frame remapper. | LiveLinkVirtualSubject.h | |
virtual TArray< FLiveLinkTime > GetFrameTimes() |
LiveLinkVirtualSubject.h | ||
virtual const TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr > GetFrameTranslators() |
List of available translator the subject can use. | LiveLinkVirtualSubject.h | |
virtual TSubclassOf< ULiveLinkRole > GetRole() |
LiveLinkVirtualSubject.h | ||
virtual const FLiveLinkStaticDataStruct & GetStaticData () |
LiveLinkVirtualSubject.h | ||
virtual FLiveLinkStaticDataStruct & GetStaticData
(
bool bGetOverrideData |
LiveLinkVirtualSubject.h | ||
virtual FLiveLinkSubjectKey GetSubjectKey() |
LiveLinkVirtualSubject.h | ||
virtual bool HasStaticDataBeenRebroadcasted() |
When rebroadcasting, has the static data been rebroadcasted? | LiveLinkVirtualSubject.h | |
virtual bool HasValidFrameSnapshot() |
LiveLinkVirtualSubject.h | ||
virtual void Initialize
(
FLiveLinkSubjectKey SubjectKey, |
LiveLinkVirtualSubject.h | ||
virtual bool IsPaused() |
Pause/Unpause subject. | LiveLinkVirtualSubject.h | |
virtual bool IsRebroadcasted() |
Whether this subject is rebroadcasted | LiveLinkVirtualSubject.h | |
virtual void PauseSubject() |
Pause subject. | LiveLinkVirtualSubject.h | |
virtual void SetStaticDataAsRebroadcasted
(
const bool bInSent |
Sets the static data for this subject as rebroadcasted | LiveLinkVirtualSubject.h | |
virtual void UnpauseSubject() |
Unpause subject. | LiveLinkVirtualSubject.h | |
virtual void Update() |
LiveLinkVirtualSubject.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool HasValidFrameData() |
Whether snapshot has valid frame data | LiveLinkVirtualSubject.h | |
bool HasValidStaticData() |
Whether snapshot has valid static data | LiveLinkVirtualSubject.h | |
void InvalidateFrameData() |
Invalidates our snapshot's frame data | LiveLinkVirtualSubject.h | |
void InvalidateStaticData() |
Invalidates our snapshot's static data | LiveLinkVirtualSubject.h | |
void UpdateFrameDataSnapshot
(
FLiveLinkFrameDataStruct&& NewFrameData |
Updates our snapshot's frame data | LiveLinkVirtualSubject.h | |
void UpdateStaticDataSnapshot
(
FLiveLinkStaticDataStruct&& NewStaticData |
Updates our snapshot's static data | LiveLinkVirtualSubject.h | |
void UpdateTranslatorsForThisFrame() |
Updates the list of translators valid for this frame | LiveLinkVirtualSubject.h |
Overridden from ILiveLinkSubject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FLiveLinkSubjectFrameData & GetFrameSnapshot() |
LiveLinkVirtualSubject.h |