FLiveLinkXRSource

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

LiveLinkXR

Header

/Engine/Plugins/VirtualProduction/LiveLinkXR/Source/LiveLinkXR/Public/LiveLinkXRSource.h

Include

#include "LiveLinkXRSource.h"

Syntax

class FLiveLinkXRSource :
    public ILiveLinkSource,
    public FRunnable,
    public TSharedFromThis< FLiveLinkXRSource >

Constructors

Name Description

Public function

FLiveLinkXRSource

(
    const FLiveLinkXRConnectionSettings...
)

Destructors

Name Description

Public function Virtual

~FLiveLinkXRSource()

Functions

Name Description

Public function

const FStrin...

 

GetDeviceTypeName

(
    EXRTrackedDeviceType DeviceType
)

Public function

void

 

Send

(
    FLiveLinkFrameDataStruct* Fram...,
    FName SubjectName
)

Public function

void

 

Start()

Overridden from ILiveLinkSource

Name Description

Public function Virtual Const

TSubclassOf<...

 

GetSettingsClass()

Setting class to display and used by the Source.

Public function Virtual Const

FText

 

GetSourceMachineName()

For UI, from where the source data is coming from.

Public function Virtual Const

FText

 

GetSourceStatus()

For UI, what is the status of the source.

Public function Virtual Const

FText

 

GetSourceType()

For UI, what is the identifier of the source.

Public function Virtual

void

 

InitializeSettings

(
    ULiveLinkSourceSettings* Setti...
)

The setting class has been created. Called after ReceiveClient.

Public function Virtual Const

bool

 

IsSourceStillValid()

Returns whether the Source is connected to its data provider and can still push valid data.

Public function Virtual

void

 

OnSettingsChanged

(
    ULiveLinkSourceSettings* Setti...,
    const FPropertyChangedEvent& Prope...
)

Notification when a setting value has changed via the UI.

Public function Virtual

void

 

ReceiveClient

(
    ILiveLinkClient* InClient,
    FGuid InSourceGuid
)

The source has been added to the Client and a Guid has been associated.

Public function Virtual

bool

 

RequestSourceShutdown()

Request the source to shutdown.

Public function Virtual

void

 

Update()

Update the source.

Overridden from FRunnable

Name Description

Public function Virtual

void

 

Exit()

Exits the runnable object.

Public function Virtual

bool

 

Init()

Initializes the runnable object.

Public function Virtual

uint32

 

Run()

Runs the runnable object.

Public function Virtual

void

 

Stop()

Stops the runnable object.

This is called if a thread is requested to terminate early.