FLiveLinkMessageBusSource | Unreal Engine 5.3 Documentation

Inheritance Hierarchy


Module	LiveLink
Header	/Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkMessageBusSource.h
Include	#include "LiveLinkMessageBusSource.h"

class FLiveLinkMessageBusSource : public ILiveLinkSource

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

Type	Name	Description
const FName &	GetSourceName ()	Returns the source name to uniquely identify it among the FLiveLinkMessageBusSource classes.
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.
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.
void	InitializeMessageEndpoint ( FMessageEndpointBuilder& EndpointBuilder )	This lets child classes the opportunity to add custom message handlers to the endpoint builder.
bool	IsMessageEndpointConnected ()
void	PushClientSubjectFrameData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey, FLiveLinkFrameDataStruct&& FrameData )	Send the frame data to the clients.
void	PushClientSubjectStaticData_AnyThread ( const FLiveLinkSubjectKey& SubjectKey, TSubclassOf< ULiveLinkRole > Role, FLiveLinkStaticDataStruct&& StaticData )	Send the static data to the clients.
void	SendMessage ( MessageType* Message )	Send a message through the endpoint.

Type	Name	Description
TSubclassOf< ULiveLinkSourceSettings >	GetSettingsClass ()	Setting class to display and used by the Source.
FText	GetSourceMachineName ()	For UI, from where the source data is coming from.
FText	GetSourceStatus ()	For UI, what is the status of the source.
FText	GetSourceType ()	For UI, what is the identifier of the source.
void	InitializeSettings ( ULiveLinkSourceSettings* Settings )	The setting class has been created. Called after ReceiveClient.
bool	IsSourceStillValid ()	Returns whether the Source is connected to its data provider and can still push valid data.
void	ReceiveClient ( ILiveLinkClient* InClient, FGuid InSourceGuid )	The source has been added to the Client and a Guid has been associated.
bool	RequestSourceShutdown ()	Request the source to shutdown.
void	Update ()	Update the source.