Navigation
API > API/Plugins > API/Plugins/LiveLink
Inheritance Hierarchy
- ILiveLinkSource
- FLiveLinkMessageBusSource
References
| Module | LiveLink |
| Header | /Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkMessageBusSource.h |
| Include | #include "LiveLinkMessageBusSource.h" |
Syntax
class FLiveLinkMessageBusSource : public ILiveLinkSource
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FThreadSafeBool | bIsValid | Current Validity of Source. |
 |
FMessageAddress | ConnectionAddress | Connection address of the livelink provider. |
 |
TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe > | MessageEndpoint | Message bus endpoint responsible for communication with the livelink provider. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FLiveLinkMessageBusSource
(
const FText& InSourceType, |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
double | Allows derived classes to provide their own timeout duration before a source is removed because the heartbeat timeout was hit. | |
   |
const FName & | Returns the source name to uniquely identify it among the FLiveLinkMessageBusSource classes. | |
  |
void | InitializeAndPushFrameData_AnyThread
(
FName SubjectName, |
Initialize the frame data and send it to the clients. |
  |
void | InitializeAndPushStaticData_AnyThread
(
FName SubjectName, |
Initialize the static data and send it to the clients. |
  |
void | InitializeMessageEndpoint
(
FMessageEndpointBuilder& EndpointBuilder |
This lets child classes the opportunity to add custom message handlers to the endpoint builder. |
  |
FText | Text description for an invalid source. | |
  |
bool | ||
 |
void | PushClientSubjectFrameData_AnyThread
(
const FLiveLinkSubjectKey& SubjectKey, |
Send the frame data to the clients. |
 |
void | PushClientSubjectStaticData_AnyThread
(
const FLiveLinkSubjectKey& SubjectKey, |
Send the static data to the clients. |
  |
void | Send connect message to the provider and start the heartbeat emitter. | |
 |
void | SendMessage
(
MessageType* Message |
Send a message through the endpoint. |
 |
void | Start the heartbeat emitter for this connection. | |
  |
FText | Text description for a source that has timed out. | |
  |
FText | Text description for a valid source. |
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. |