1. Epic GamesDeveloper
  3. FLiveLinkMessageBusSource

FLiveLinkMessageBusSource

API > API/Plugins > API/Plugins/LiveLink

   
Name FLiveLinkMessageBusSource
Type class
Header File /Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkMessageBusSource.h
Include Path #include "LiveLinkMessageBusSource.h"

Syntax

class FLiveLinkMessageBusSource : public ILiveLinkSource

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

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

   LiveLinkMessageBusSource.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AccumulatedBytes float Number of bytes received since LastThroughputUpdate. LiveLinkMessageBusSource.h  
bDiscovering bool Actively discovering the source. LiveLinkMessageBusSource.h  
bInitialized bool Flag to keep track of initialization state. LiveLinkMessageBusSource.h  
CachedThroughput float Cached throughput (in kb/s) of data going through this messagebus source. LiveLinkMessageBusSource.h  
ConnectionLastActive double Time we last received anything. LiveLinkMessageBusSource.h  
ConnectionLastActiveSection FCriticalSection Critical section to allow for threadsafe updating of the connection time. LiveLinkMessageBusSource.h  
LastThroughputUpdate float Timestamp of the last update to the cached throughput. LiveLinkMessageBusSource.h  
MachineTimeOffset double Offset between sender's machine engine time and receiver's machine engine time. LiveLinkMessageBusSource.h  
RoleInstances TArray< TWeakObjectPtr< ULiveLinkRole > > List of the roles available when the bus was opened. LiveLinkMessageBusSource.h  
SourceMachineName FText   LiveLinkMessageBusSource.h  
SourceType FText   LiveLinkMessageBusSource.h  

Functions

Public

Overridden from ILiveLinkSource

Name Remarks Include Path Unreal Specifiers

virtual TSubclassOf< ULiveLinkSourceSettings > GetSettingsClass()

   LiveLinkMessageBusSource.h  

virtual FText GetSourceMachineName()

   LiveLinkMessageBusSource.h  

virtual FText GetSourceStatus()

   LiveLinkMessageBusSource.h  

virtual FText GetSourceToolTip()

   LiveLinkMessageBusSource.h  

virtual FText GetSourceType()

   LiveLinkMessageBusSource.h  

virtual void InitializeSettings ( ULiveLinkSourceSettings* Settings
)

   LiveLinkMessageBusSource.h  

virtual bool IsSourceStillValid()

   LiveLinkMessageBusSource.h  

virtual void ReceiveClient ( ILiveLinkClient* InClient,
FGuid InSourceGuid
)

   LiveLinkMessageBusSource.h  

virtual bool RequestSourceShutdown()

   LiveLinkMessageBusSource.h  

virtual void Update()

   LiveLinkMessageBusSource.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddAnnotations ( TMap< FName, FString >& InOutAnnotations
) const

 Add compress payload support annotations. LiveLinkMessageBusSource.h  

virtual double GetDeadSourceTimeout()

 Allows derived classes to provide their own timeout duration before a source is removed because the heartbeat timeout was hit. LiveLinkMessageBusSource.h  

virtual const FName & GetSourceName()

 Returns the source name to uniquely identify it among the FLiveLinkMessageBusSource classes. LiveLinkMessageBusSource.h  

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. LiveLinkMessageBusSource.h  

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. LiveLinkMessageBusSource.h  

virtual void InitializeMessageEndpoint ( FMessageEndpointBuilder& EndpointBuilder
)

 This lets child classes the opportunity to add custom message handlers to the endpoint builder. LiveLinkMessageBusSource.h  

bool IsMessageEndpointConnected()

   LiveLinkMessageBusSource.h  

void PushClientSubjectFrameData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
FLiveLinkFrameDataStruct&& FrameData
)

 Send the frame data to the clients. LiveLinkMessageBusSource.h  

void PushClientSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkStaticDataStruct&& StaticData
)

 Send the static data to the clients. LiveLinkMessageBusSource.h  

virtual void SendConnectMessage()

 Send connect message to the provider and start the heartbeat emitter. LiveLinkMessageBusSource.h  

void SendMessage ( MessageType* Message,
const TMap< FName, FString >& Annotations
)

 Send a message through the endpoint. LiveLinkMessageBusSource.h  

void StartHeartbeatEmitter()

 Start the heartbeat emitter for this connection. LiveLinkMessageBusSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static FText InvalidSourceStatus()

 Text description for an invalid source. LiveLinkMessageBusSource.h  

static FText TimeoutSourceStatus()

 Text description for a source that has timed out. LiveLinkMessageBusSource.h  

static FText ValidSourceStatus()

 Text description for a valid source. LiveLinkMessageBusSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page