1. Epic GamesDeveloper
  3. FLiveLinkProvider

FLiveLinkProvider

Unreal Engine C++ API Reference > Runtime > LiveLinkMessageBusFramework

Inheritance Hierarchy

References

   
Module LiveLinkMessageBusFramework
Header /Engine/Source/Runtime/LiveLinkMessageBusFramework/Public/LiveLinkProviderImpl.h
Include #include "LiveLinkProviderImpl.h"

Syntax

struct FLiveLinkProvider : public ILiveLinkProvider

Constructors

  Type Name Description
Public function  

FLiveLinkProvider ( const FString& InProviderName
)

  
Protected function  

FLiveLinkProvider ( const FString& InProviderName,
bool bInCreateEndpoint
)

 Constructor for derived classes that allows specifying that no endpoint should be created.
Public function  

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

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

ClearSubject ( const FName& SubjectName
)

  
Protected function void

CloseConnection ( FMessageAddress Address
)

 Close a connection using its address.
Protected function void Create the message bus message endoing responsble for dispatching message bus messages to their respective handlers.
Protected function Virtual Const TMap< FName, FString > Get annotations to include on every message sent by this provider.
Protected function void

GetConnectedAddresses ( TArray< FMessageAddress >& Addresses
)

 Get the addresses of all connected instances.
Protected function TPair< UClass *, FLiveLinkStaticDataStruct * > Get the cached data struct for a subject.
Protected function Const const FString &  
Protected function Const const FString &  
Protected function void

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

 Update connected addresses and send information to the connected source.
Protected function Virtual void

OnConnectionsClosed ( const TArray< FMessageAddress >& ClosedAddresses
)

 Called after ValidateConnections removes invalid connections.
Protected function void Send a clear subject message to indicate that the subject should be removed from the connected client.
Protected function void

SendMessage ( MessageType* Message
)

  
Protected function void

SendMessage ( MessageType* Message,
const FMessageAddress& Address
)

  
Protected function void

SendMessage ( MessageType* Message,
const TArray< FMessageAddress >& Addresses
)

  
Protected function Virtual Const bool

ShouldTransmitToSubject_AnyThread ( FName SubjectName,
FMessageAddress Address
)

 Get whether a combination of a subject/client should receive livelink data.
Protected function void  
Public function Virtual void

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

  
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

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

  
Public function Virtual void

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

  
Protected function void Validate our current connections, removing those that have timed out.

Overridden from ILiveLinkProvider

  Type Name Description
Public function Virtual Const bool Is this provider currently connected to something.
Public function Virtual FDelegateHandle

RegisterConnStatusChangedHandle ( const FLiveLinkProviderConnectionStatusChanged::FDelegate& ConnStatusChanged
)

 Function for managing connection status changed delegate.
Public function Virtual void

RemoveSubject ( const FName SubjectName
)

 Inform UE that a subject won't be streamed anymore.
Public function Virtual void Function for managing connection status changed delegate.
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool

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

 Send the static data of a subject to UE.
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page