Navigation
API > API/Plugins > API/Plugins/LiveLinkHub
Exposes queries and operations for Unreal Editor clients connected to the local LLH instance.
| Name | ILiveLinkHubClientsModel |
| Type | class |
| Header File | /Engine/Plugins/Animation/LiveLinkHub/Source/LiveLinkHub/Public/ILiveLinkHubClientsModel.h |
| Include Path | #include "ILiveLinkHubClientsModel.h" |
Syntax
class ILiveLinkHubClientsModel : public IModularFeature
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ILiveLinkHubClientsModel() |
ILiveLinkHubClientsModel.h |
Enums
Public
| Name | Remarks |
|---|---|
| EClientEventType | Types of client updates. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConnectTo
(
FLiveLinkHubClientId InClient |
Send a connection message to this discovered client. | ILiveLinkHubClientsModel.h | |
DECLARE_TS_MULTICAST_DELEGATE_TwoParams
(
FOnClientEvent, |
ILiveLinkHubClientsModel.h | ||
FText GetClientDisplayName
(
FLiveLinkHubClientId InClient |
Get the name of a client. | ILiveLinkHubClientsModel.h | |
TOptional< FLiveLinkHubUEClientInfo > GetClientInfo
(
FLiveLinkHubClientId InClient |
Get information about a given client given its address. | ILiveLinkHubClientsModel.h | |
FText GetClientStatus
(
FLiveLinkHubClientId Client |
Get the status text of a client. | ILiveLinkHubClientsModel.h | |
TOptional< FLiveLinkHubDiscoveredClientInfo > GetDiscoveredClientInfo
(
FLiveLinkHubClientId InClient |
Get information about a discovered client. | ILiveLinkHubClientsModel.h | |
TArray< FLiveLinkHubClientId > GetDiscoveredClients() |
Get the list of clients discovered by the hub. | ILiveLinkHubClientsModel.h | |
TArray< FLiveLinkHubClientId > GetSessionClients() |
Get the list of clients that should be displayed in the clients panel according to the current session config. | ILiveLinkHubClientsModel.h | |
bool IsClientConnected
(
FLiveLinkHubClientId InClient |
Get whether a client is connected to the hub. | ILiveLinkHubClientsModel.h | |
bool IsClientEnabled
(
FLiveLinkHubClientId InClient |
Get whether a client should receive livelink data. | ILiveLinkHubClientsModel.h | |
bool IsSubjectEnabled
(
FLiveLinkHubClientId InClient, |
Get whether a subject is enabled on a given client. | ILiveLinkHubClientsModel.h | |
FOnClientEvent & OnClientEvent() |
Delegate used to get noticed about changes to the client list. | ILiveLinkHubClientsModel.h | |
void RequestAuxiliaryChannel
(
FLiveLinkHubClientId InClientId, |
Request to open an auxiliary endpoint with a client. | ILiveLinkHubClientsModel.h | |
void RequestAuxiliaryChannel
(
FLiveLinkHubClientId InClientId, |
Request to open an auxiliary endpoint with a client. | ILiveLinkHubClientsModel.h | |
void SetClientEnabled
(
FLiveLinkHubClientId InClient, |
Set whether a client should receive livelink data. | ILiveLinkHubClientsModel.h | |
void SetSubjectEnabled
(
FLiveLinkHubClientId InClient, |
Set whether a subject should receive livelink data. | ILiveLinkHubClientsModel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ILiveLinkHubClientsModel * Get() |
Convenience accessor for modular feature implementation. | ILiveLinkHubClientsModel.h | |
static ILiveLinkHubClientsModel & GetChecked() |
Convenience accessor for modular feature implementation. | ILiveLinkHubClientsModel.h | |
static FName GetModularFeatureName() |
Name of the modular feature. | ILiveLinkHubClientsModel.h |