1. Epic GamesDeveloper
  3. FLiveLinkMessageBusSource

FLiveLinkMessageBusSource

API > API/Plugins > API/Plugins/LiveLink

Inheritance Hierarchy

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
Protected variable FThreadSafeBool bIsValid Current Validity of Source.
Protected variable ILiveLinkClient * Client  
Protected variable FMessageAddress ConnectionAddress Connection address of the livelink provider.
Protected variable TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe > MessageEndpoint Message bus endpoint responsible for communication with the livelink provider.

Constructors

  Type Name Description
Public function  

FLiveLinkMessageBusSource ( const FText& InSourceType,
const FText& InSourceMachineName,
const FMessageAddress& InConnectionAddress,
double InMachineTimeOffset
)

  

Functions

  Type Name Description
Protected function Virtual Const double Allows derived classes to provide their own timeout duration before a source is removed because the heartbeat timeout was hit.
Protected function Virtual Const const FName & Returns the source name to uniquely identify it among the FLiveLinkMessageBusSource classes.
Protected function Virtual void

InitializeAndPushFrameData_AnyThread ( FName SubjectName,
const FLiveLinkSubjectKey& SubjectKey,
const TSharedRef< IMessageContext, ESPMode::ThreadSafe >& Context,
UScriptStruct* MessageTypeInfo
)

 Initialize the frame data and send it to the clients.
Protected function Virtual void

InitializeAndPushStaticData_AnyThread ( FName SubjectName,
TSubclassOf< ULiveLinkRole > SubjectRole,
const FLiveLinkSubjectKey& SubjectKey,
const TSharedRef< IMessageContext, ESPMode::ThreadSafe >& Context,
UScriptStruct* MessageTypeInfo
)

 Initialize the static data and send it to the clients.
Protected function Virtual void This lets child classes the opportunity to add custom message handlers to the endpoint builder.
Public function Static FText Text description for an invalid source.
Protected function Const bool  
Protected function void Send the frame data to the clients.
Protected function void Send the static data to the clients.
Protected function Virtual void Send connect message to the provider and start the heartbeat emitter.
Protected function void

SendMessage ( MessageType* Message
)

 Send a message through the endpoint.
Protected function void Start the heartbeat emitter for this connection.
Public function Static FText Text description for a source that has timed out.
Public function Static FText Text description for a valid source.

Overridden from ILiveLinkSource

  Type Name Description
Public function Virtual Const TSubclassOf< ULiveLinkSourceSettings > Setting class to display and used by the Source.
Public function Virtual Const FText For UI, from where the source data is coming from.
Public function Virtual Const FText For UI, what is the status of the source.
Public function Virtual Const FText For UI, what is the identifier of the source.
Public function Virtual void The setting class has been created. Called after ReceiveClient.
Public function Virtual Const bool Returns whether the Source is connected to its data provider and can still push valid data.
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 Request the source to shutdown.
Public function Virtual void

Update ()

 Update the source.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page