Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

ULiveLinkVirtualSubject

A Virtual subject is made up of one or more real subjects from a source.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULiveLinkVirtualSubject

	ULiveLinkAnimationVirtualSubject
	ULiveLinkBlueprintVirtualSubject

References

Module	LiveLinkInterface
Header	/Engine/Source/Runtime/LiveLinkInterface/Public/LiveLinkVirtualSubject.h
Include	#include "LiveLinkVirtualSubject.h"

Syntax

class ULiveLinkVirtualSubject :
public UObject,
public ILiveLinkSubject

Remarks

A Virtual subject is made up of one or more real subjects from a source.

Variables

	Name	Description
bool	bHasStaticDataBeenRebroadcast	If true, static data has been sent for this rebroadcast
bool	bRebroadcastSubject	If enabled, rebroadcast this subject
TArray< ULiveLi...	FrameTranslators	List of available translator the subject can use.
ILiveLinkClient...	LiveLinkClient	LiveLinkClient to get access to subjects
TSubclassOf< UL...	Role	The role the subject was build with.
FCriticalSectio...	SnapshotAccessCriticalSection	Lock to protect the FrameSnapshot.
FLiveLinkSubjec...	SubjectKey	Name of the subject
TArray< FLiveLi...	Subjects	Names of the real subjects to combine into a virtual subject

Functions

	Name	Description
bool	DependsOnSubject ( FName SubjectName )	Returns true whether this virtual subject depends on the Subject named SubjectName
ILiveLinkCli...	GetClient()
const FLiveL...	GetFrameData()	Returns the current frame data of this virtual subject
const TArray...	GetSubjects()	Returns the live subjects associated with this virtual one
const TArray...	GetTranslators()	Returns the translators assigned to this virtual subject
bool	HasValidFrameData()	Whether snapshot has valid frame data
bool	HasValidStaticData()	Whether snapshot has valid static data
void	InvalidateFrameData()	Invalidates our snapshot's frame data
void	InvalidateStaticData()	Invalidates our snapshot's static data
void	UpdateFrameDataSnapshot ( FLiveLinkFrameDataStruct&& NewFram... )	Updates our snapshot's frame data
void	UpdateStaticDataSnapshot ( FLiveLinkStaticDataStruct&& NewSta... )	Updates our snapshot's static data
void	UpdateTranslatorsForThisFrame()	Updates the list of translators valid for this frame

Overridden from ILiveLinkSubject

	Name	Description
void	ClearFrames()
bool	EvaluateFrame ( TSubclassOf< ULiveLinkRole > InDesi..., FLiveLinkSubjectFrameData& OutFram... )
const FLiveL...	GetFrameSnapshot()
TArray< FLiv...	GetFrameTimes()
const TArray...	GetFrameTranslators()	List of available translator the subject can use.
TSubclassOf<...	GetRole()
FLiveLinkSta...	GetStaticData()
const FLiveL...	GetStaticData()
FLiveLinkSub...	GetSubjectKey()
bool	HasStaticDataBeenRebroadcasted()	When rebroadcasting, has the static data been rebroadcasted?
bool	HasValidFrameSnapshot()
void	Initialize ( FLiveLinkSubjectKey SubjectKey, TSubclassOf< ULiveLinkRole > Role, ILiveLinkClient* LiveLinkClien... )
bool	IsRebroadcasted()	Whether this subject is rebroadcasted
void	SetStaticDataAsRebroadcasted ( const bool bInSent )	Sets the static data for this subject as rebroadcasted
void	Update()

Deprecated Variables

		Name	Description
	FLiveLinkSubjec...	FrameSnapshot	VirtualSubject FrameSnapshot is now private to have thread safe accesses. Please use UpdateStaticDataSnapshot or UpdateFrameDataSnapshot to update its value

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss