Navigation
API > API/Runtime > API/Runtime/LiveLinkInterface
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
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bHasStaticDataBeenRebroadcast | If true, static data has been sent for this rebroadcast |
 |
bool | bRebroadcastSubject | If enabled, rebroadcast this subject |
 |
TArray< TObjectPtr< ULiveLinkFrameTranslator > > | FrameTranslators | List of available translator the subject can use. |
 |
ILiveLinkClient * | LiveLinkClient | LiveLinkClient to get access to subjects |
 |
TSubclassOf< ULiveLinkRole > | Role | The role the subject was build with. |
 |
FCriticalSection | SnapshotAccessCriticalSection | Lock to protect the FrameSnapshot. |
 |
FLiveLinkSubjectKey | SubjectKey | Name of the subject |
 |
TArray< FLiveLinkSubjectName > | Subjects | Names of the real subjects to combine into a virtual subject |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | DependsOnSubject
(
FName SubjectName |
Returns true whether this virtual subject depends on the Subject named SubjectName |
  |
ILiveLinkClient * | GetClient () |
|
  |
const FLiveLinkFrameDataStruct & | GetFrameData () |
Returns the current frame data of this virtual subject |
  |
const TArray< FLiveLinkSubjectName > & | GetSubjects () |
Returns the live subjects associated with this virtual one |
  |
const TArray< ULiveLinkFrameTranslator * > & | Returns the translators assigned to this virtual subject | |
  |
bool | Whether snapshot has valid frame data | |
  |
bool | Whether snapshot has valid static data | |
 |
void | Invalidates our snapshot's frame data | |
 |
void | Invalidates our snapshot's static data | |
 |
void | UpdateFrameDataSnapshot
(
FLiveLinkFrameDataStruct&& NewFrameData |
Updates our snapshot's frame data |
 |
void | UpdateStaticDataSnapshot
(
FLiveLinkStaticDataStruct&& NewStaticData |
Updates our snapshot's static data |
 |
void | Updates the list of translators valid for this frame |
Overridden from ILiveLinkSubject
| Type | Name | Description | |
|---|---|---|---|
  |
void | ClearFrames () |
|
  |
bool | EvaluateFrame
(
TSubclassOf< ULiveLinkRole > InDesiredRole, |
|
   |
const FLiveLinkSubjectFrameData & | ||
   |
TArray< FLiveLinkTime > | ||
   |
const TArray< ULiveLinkFrameTranslator::FWorkerSharedPtr > | List of available translator the subject can use. | |
   |
TSubclassOf< ULiveLinkRole > | GetRole () |
|
  |
FLiveLinkStaticDataStruct & | ||
   |
const FLiveLinkStaticDataStruct & | ||
   |
FLiveLinkSubjectKey | ||
   |
bool | When rebroadcasting, has the static data been rebroadcasted? | |
   |
bool | ||
  |
void | Initialize
(
FLiveLinkSubjectKey SubjectKey, |
|
   |
bool | Whether this subject is rebroadcasted | |
  |
void | SetStaticDataAsRebroadcasted
(
const bool bInSent |
Sets the static data for this subject as rebroadcasted |
  |
void | Update () |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FLiveLinkSubjectFrameData | FrameSnapshot | VirtualSubject FrameSnapshot is now private to have thread safe accesses. Please use UpdateStaticDataSnapshot or UpdateFrameDataSnapshot to update its value |