1. Epic GamesDeveloper
  3. FLiveLinkProvider

FLiveLinkProvider

API > API/Runtime > API/Runtime/LiveLinkMessageBusFramework

   
Name FLiveLinkProvider
Type struct
Header File /Engine/Source/Runtime/LiveLinkMessageBusFramework/Public/LiveLinkProviderImpl.h
Include Path #include "LiveLinkProviderImpl.h"

Syntax

struct FLiveLinkProvider : public ILiveLinkProvider

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FLiveLinkProvider ( const FString& InProviderName,
FMessageEndpointBuilder&& EndpointBuilder
)

   LiveLinkProviderImpl.h  

FLiveLinkProvider ( const FString& InProviderName,
bool bInCreateEndpoint
)

 Constructor for derived classes that allows specifying that no endpoint should be created. LiveLinkProviderImpl.h  

FLiveLinkProvider ( const FString& InProviderName
)

   LiveLinkProviderImpl.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLiveLinkProvider()

   LiveLinkProviderImpl.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ConnectedAddresses TArray< struct FTrackedAddress > Array of our current connections. LiveLinkProviderImpl.h  
CriticalSection FCriticalSection Lock to stop multiple threads accessing the CurrentPreset at the same time. LiveLinkProviderImpl.h  
FrameDatas TArray< struct FTrackedFrameData >   LiveLinkProviderImpl.h  
MachineName const FString   LiveLinkProviderImpl.h  
MessageEndpoint TSharedPtr< class FMessageEndpoint, ESPMode::ThreadSafe >   LiveLinkProviderImpl.h  
OnConnectionStatusChanged FLiveLinkProviderConnectionStatusChanged Delegate to notify interested parties when the client sources have changed. LiveLinkProviderImpl.h  
ProviderName const FString   LiveLinkProviderImpl.h  
StaticDatas TArray< struct FTrackedStaticData > Cache of our current subject state. LiveLinkProviderImpl.h  
Subjects TMap< FName, FTrackedSubject >   LiveLinkProviderImpl.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ClearSubject ( const FName& SubjectName
)

   LiveLinkProviderImpl.h  

virtual void UpdateSubject ( const FName& SubjectName,
const TArray< FName >& BoneNames,
const TArray< int32 >& BoneParents
)

   LiveLinkProviderImpl.h  

virtual void UpdateSubjectFrame ( const FName& SubjectName,
const TArray< FTransform >& BoneTransforms,
const TArray< FLiveLinkCurveElement >& CurveData,
const FLiveLinkMetaData& MetaData,
double Time
)

   LiveLinkProviderImpl.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void UpdateSubjectFrame ( const FName& SubjectName,
const TArray< FTransform >& BoneTransforms,
const TArray< FLiveLinkCurveElement >& CurveData,
double Time
)

   LiveLinkProviderImpl.h  

Overridden from ILiveLinkProvider

Name Remarks Include Path Unreal Specifiers

virtual bool HasConnection()

 Is this provider currently connected to something. LiveLinkProviderImpl.h  

virtual FDelegateHandle RegisterConnStatusChangedHandle ( const FLiveLinkProviderConnectionStatusChanged::FDelegate& ConnStatusChanged
)

 Function for managing connection status changed delegate. LiveLinkProviderImpl.h  

virtual void RemoveSubject ( const FName SubjectName
)

 Inform UE that a subject won't be streamed anymore. LiveLinkProviderImpl.h  

virtual void UnregisterConnStatusChangedHandle ( FDelegateHandle Handle
)

 Function for managing connection status changed delegate. LiveLinkProviderImpl.h  

virtual bool UpdateSubjectFrameData ( const FName SubjectName,
FLiveLinkFrameDataStruct&& FrameData,
const TMap< FName, FString >& ExtraAnnotations
)

 Send the static data of a subject to UE. LiveLinkProviderImpl.h  

virtual bool UpdateSubjectStaticData ( const FName SubjectName,
TSubclassOf< ULiveLinkRole > Role,
FLiveLinkStaticDataStruct&& StaticData,
const TMap< FName, FString >& ExtraAnnotations
)

 Send, to UE, the static data of a subject. LiveLinkProviderImpl.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CloseConnection ( FMessageAddress Address
)

 Close a connection using its address. LiveLinkProviderImpl.h  

void CreateMessageEndpoint ( FMessageEndpointBuilder& EndpointBuilder
)

 Create the message bus message endoing responsble for dispatching message bus messages to their respective handlers. LiveLinkProviderImpl.h  

virtual TMap< FName, FString > GetAnnotations()

 Get annotations to include on every message sent by this provider. LiveLinkProviderImpl.h  

void GetConnectedAddresses ( TArray< FMessageAddress >& Addresses
)

 Get the addresses of all connected instances. LiveLinkProviderImpl.h  

FMessageAddress GetEndpointAddress()

 Get the MessageBus address of the provider. LiveLinkProviderImpl.h  

TPair< UClass *, FLiveLinkStaticDataStruct * > GetLastSubjectStaticDataStruct ( FName SubjectName
)

 Get the cached data struct for a subject. LiveLinkProviderImpl.h  

const FString & GetMachineName()

 Get the name of this machine. LiveLinkProviderImpl.h  

const FString & GetProviderName()

 Get the name of this provider. LiveLinkProviderImpl.h  

void HandleConnectMessage ( const FLiveLinkConnectMessage& Message,
const TSharedRef< class IMessageContext, ESPMode::ThreadSafe >& Context
)

 Update connected addresses and send information to the connected source. LiveLinkProviderImpl.h  

virtual void OnConnectionsClosed ( const TArray< FMessageAddress >& ClosedAddresses
)

 Called after ValidateConnections removes invalid connections. LiveLinkProviderImpl.h  

virtual void OnMessageBusNotification ( const FMessageBusNotification& Notification
)

 Invoked by MessageBus when a node is registered or unregistered. LiveLinkProviderImpl.h  

void Publish ( MessageType* Message
)

 Broadcast message on the network. LiveLinkProviderImpl.h  

void SendClearSubjectToConnections ( FName SubjectName
)

 Send a clear subject message to indicate that the subject should be removed from the connected client. LiveLinkProviderImpl.h  

void SendMessage ( MessageType* Message,
const TArray< FMessageAddress >& Addresses,
EMessageFlags Flags,
const TMap< FName, FString >& Annotations
)

 Send message to a list of addresses. LiveLinkProviderImpl.h  

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

 Send message to a specific address. LiveLinkProviderImpl.h  

void SendMessage ( MessageType* Message,
EMessageFlags Flags
)

 Send message (only to connected addresses) LiveLinkProviderImpl.h  

virtual bool ShouldTransmitToSubject_AnyThread ( FName SubjectName,
FMessageAddress Address
) const

 Get whether a combination of a subject/client should receive livelink data. LiveLinkProviderImpl.h  

void Subscribe()

 Subscribe to a message that's been published. LiveLinkProviderImpl.h  

void ValidateConnections()

 Validate our current connections, removing those that have timed out. LiveLinkProviderImpl.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetSupportedLiveLinkVersion()

 Get the minimum supported version of livelink clients that can connect to this provider. LiveLinkProviderImpl.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page