Navigation
API > API/Plugins > API/Plugins/LiveLinkXR
Inheritance Hierarchy
- ILiveLinkSource
- FRunnable
- TSharedFromThis
- FLiveLinkXRSource
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
| Type | Name | Description | |
|---|---|---|---|
FLiveLinkXRSource
(
const FLiveLinkXRConnectionSettings& InConnectionSettings |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void | Start () |
Overridden from ILiveLinkSource
| Type | Name | Description | |
|---|---|---|---|
| TSubclassOf< ULiveLinkSourceSettings > | Setting class to display and used by the Source. | ||
| FText | For UI, from where the source data is coming from. | ||
| FText | For UI, what is the status of the source. | ||
| FText | For UI, what is the identifier of the source. | ||
| void | InitializeSettings
(
ULiveLinkSourceSettings* Settings |
The setting class has been created. Called after ReceiveClient. | |
| bool | Returns whether the Source is connected to its data provider and can still push valid data. | ||
| void | ReceiveClient
(
ILiveLinkClient* InClient, |
The source has been added to the Client and a Guid has been associated. | |
| bool | Request the source to shutdown. | ||
| void | Update () |
Update the source. |
Overridden from FRunnable
| Type | Name | Description | |
|---|---|---|---|
| void | Exit () |
Exits the runnable object. | |
| bool | Init () |
Initializes the runnable object. | |
| uint32 | Run () |
Runs the runnable object. | |
| void | Stop () |
Stops the runnable object.This is called if a thread is requested to terminate early. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| const FString | GetDeviceTypeName
(
EXRTrackedDeviceType DeviceType |
LiveLinkXR no longer uses EXRTrackedDeviceType. |