#include <LiveLinkProviderImpl.h>

Inheritance diagram for FLiveLinkProvider:

Public Member Functions
UE_API	FLiveLinkProvider (const FString &InProviderName)

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

virtual UE_API	~FLiveLinkProvider () override

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

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

virtual UE_API void	ClearSubject (const FName &SubjectName)

virtual UE_API void	RemoveSubject (const FName SubjectName) override

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

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

UE_API virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool	UpdateSubjectFrameData (const FName SubjectName, FLiveLinkFrameDataStruct &&FrameData, const TMap< FName, FString > &ExtraAnnotations={}) override

virtual UE_API bool	HasConnection () const override

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

virtual UE_API void	UnregisterConnStatusChangedHandle (FDelegateHandle Handle) override

Public Member Functions inherited from ILiveLinkProvider
virtual	~ILiveLinkProvider ()

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

UE_API void	CreateMessageEndpoint (struct FMessageEndpointBuilder &EndpointBuilder)

UE_API void	GetConnectedAddresses (TArray< FMessageAddress > &Addresses)

UE_API void	ValidateConnections ()

UE_API void	CloseConnection (FMessageAddress Address)

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

virtual void	OnMessageBusNotification (const FMessageBusNotification &Notification)

template<typename MessageType >
void	SendMessage (MessageType *Message, EMessageFlags Flags=EMessageFlags::None)

template<typename MessageType >
void	SendMessage (MessageType *Message, const FMessageAddress &Address, EMessageFlags Flags=EMessageFlags::None, const TMap< FName, FString > &Annotations={})

template<typename MessageType >
void	SendMessage (MessageType *Message, const TArray< FMessageAddress > &Addresses, EMessageFlags Flags=EMessageFlags::None, const TMap< FName, FString > &Annotations={})

template<typename MessageType >
void	Publish (MessageType *Message)

template<typename MessageType >
void	Subscribe ()

const FString &	GetProviderName () const

const FString &	GetMachineName () const

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

virtual TMap< FName, FString >	GetAnnotations () const

virtual bool	ShouldTransmitToSubject_AnyThread (FName SubjectName, FMessageAddress Address) const

UE_API void	SendClearSubjectToConnections (FName SubjectName)

UE_API FMessageAddress	GetEndpointAddress () const

UE_API	FLiveLinkProvider (const FString &InProviderName, bool bInCreateEndpoint)

Static Protected Member Functions
static UE_API int32	GetSupportedLiveLinkVersion ()

Additional Inherited Members
Static Public Member Functions inherited from ILiveLinkProvider
static LIVELINKMESSAGEBUSFRAMEWORK_API TSharedPtr< ILiveLinkProvider >	CreateLiveLinkProvider (const FString &ProviderName)

template<typename T >
static TSharedPtr< ILiveLinkProvider >	CreateLiveLinkProvider (const FString &ProviderName, struct FMessageEndpointBuilder &&EndpointBuilder)

Constructor & Destructor Documentation

◆ FLiveLinkProvider() [1/3]

FLiveLinkProvider::FLiveLinkProvider	(	const FString &	InProviderName,
		bool	bInCreateEndpoint
	)

protected

◆ FLiveLinkProvider() [2/3]

FLiveLinkProvider::FLiveLinkProvider ( const FString & InProviderName )

◆ FLiveLinkProvider() [3/3]

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

◆ ~FLiveLinkProvider()

FLiveLinkProvider::~FLiveLinkProvider ( )

overridevirtual

Member Function Documentation

◆ ClearSubject()

void FLiveLinkProvider::ClearSubject ( const FName & SubjectName )

virtual

◆ CloseConnection()

void FLiveLinkProvider::CloseConnection ( FMessageAddress Address )

protected

◆ CreateMessageEndpoint()

void FLiveLinkProvider::CreateMessageEndpoint ( struct FMessageEndpointBuilder & EndpointBuilder )

protected

◆ GetAnnotations()

virtual TMap< FName, FString > FLiveLinkProvider::GetAnnotations ( ) const

inlineprotectedvirtual

◆ GetConnectedAddresses()

void FLiveLinkProvider::GetConnectedAddresses ( TArray< FMessageAddress > & Addresses )

protected

◆ GetEndpointAddress()

FMessageAddress FLiveLinkProvider::GetEndpointAddress ( ) const

protected

◆ GetLastSubjectStaticDataStruct()

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

protected

◆ GetMachineName()

const FString & FLiveLinkProvider::GetMachineName ( ) const

inlineprotected

◆ GetProviderName()

const FString & FLiveLinkProvider::GetProviderName ( ) const

inlineprotected

◆ GetSupportedLiveLinkVersion()

int32 FLiveLinkProvider::GetSupportedLiveLinkVersion ( )

staticprotected

◆ HandleConnectMessage()

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

protected

◆ HasConnection()

bool FLiveLinkProvider::HasConnection ( ) const

overridevirtual

Is this provider currently connected to something.

Implements ILiveLinkProvider.

◆ OnConnectionsClosed()

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

inlineprotectedvirtual

◆ OnMessageBusNotification()

virtual void FLiveLinkProvider::OnMessageBusNotification ( const FMessageBusNotification & Notification )

inlineprotectedvirtual

◆ Publish()

template<typename MessageType >

void FLiveLinkProvider::Publish ( MessageType * Message )

inlineprotected

◆ RegisterConnStatusChangedHandle()

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

overridevirtual

Function for managing connection status changed delegate.

Implements ILiveLinkProvider.

◆ RemoveSubject()

void FLiveLinkProvider::RemoveSubject ( const FName SubjectName )

overridevirtual

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

Parameters

SubjectName The name of the subject.

Implements ILiveLinkProvider.

◆ SendClearSubjectToConnections()

void FLiveLinkProvider::SendClearSubjectToConnections ( FName SubjectName )

protected

◆ SendMessage() [1/3]

template<typename MessageType >

void FLiveLinkProvider::SendMessage	(	MessageType *	Message,
		const FMessageAddress &	Address,
		EMessageFlags	Flags = `EMessageFlags::None`,
		const TMap< FName, FString > &	Annotations = `{}`
	)

inlineprotected

◆ SendMessage() [2/3]

template<typename MessageType >

void FLiveLinkProvider::SendMessage	(	MessageType *	Message,
		const TArray< FMessageAddress > &	Addresses,
		EMessageFlags	Flags = `EMessageFlags::None`,
		const TMap< FName, FString > &	Annotations = `{}`
	)

inlineprotected

◆ SendMessage() [3/3]

template<typename MessageType >

void FLiveLinkProvider::SendMessage	(	MessageType *	Message,
		EMessageFlags	Flags = `EMessageFlags::None`
	)

inlineprotected

◆ ShouldTransmitToSubject_AnyThread()

virtual bool FLiveLinkProvider::ShouldTransmitToSubject_AnyThread	(	FName	SubjectName,
		FMessageAddress	Address
	)		const

inlineprotectedvirtual

◆ Subscribe()

template<typename MessageType >

void FLiveLinkProvider::Subscribe ( )

inlineprotected

◆ UnregisterConnStatusChangedHandle()

void FLiveLinkProvider::UnregisterConnStatusChangedHandle ( FDelegateHandle Handle )

overridevirtual

Function for managing connection status changed delegate.

Implements ILiveLinkProvider.

◆ UpdateSubject()

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

virtual

◆ UpdateSubjectFrame() [1/2]

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

virtual

◆ UpdateSubjectFrame() [2/2]

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

virtual

◆ UpdateSubjectFrameData()

bool FLiveLinkProvider::UpdateSubjectFrameData	(	const FName	SubjectName,
		FLiveLinkFrameDataStruct &&	FrameData,
		const TMap< FName, FString > &	ExtraAnnotations = `{}`
	)

overridevirtual

Send the static data of a subject to UE.

Parameters

SubjectName	The name of the subject
StaticData	The frame data of the subject. The type should match the role's data send with UpdateSubjectStaticData. The FLiveLinkFrameDataStruct doesn't have a copy constructor. The argument is passed by r-value to help the user understand the compiler error message.
ExtraAnnotations	Extra annotations to pass in with the frame data message.

Returns: True if the message was sent or is pending an active connection.

See also: UpdateSubjectStaticData, RemoveSubject

Implements ILiveLinkProvider.

◆ UpdateSubjectStaticData()

bool FLiveLinkProvider::UpdateSubjectStaticData	(	const FName	SubjectName,
		TSubclassOf< ULiveLinkRole >	Role,
		FLiveLinkStaticDataStruct &&	StaticData,
		const TMap< FName, FString > &	ExtraAnnotations = `{}`
	)

overridevirtual

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

Parameters

SubjectName	The name of the subject
Role	The Live Link role of the subject. The StaticData type should match the role's data.
StaticData	The static data of the subject. The FLiveLinkStaticDataStruct doesn't have a copy constructor. The argument is passed by r-value to help the user understand the compiler error message.
ExtraAnnotations	Extra annotations to pass in with the static data message.

Returns: True if the message was sent or is pending an active connection.

See also: UpdateSubjectFrameData, RemoveSubject

Implements ILiveLinkProvider.

◆ ValidateConnections()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void FLiveLinkProvider::ValidateConnections ( )

protected

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/LiveLinkMessageBusFramework/Public/LiveLinkProviderImpl.h
Engine/Source/Runtime/LiveLinkMessageBusFramework/Private/LiveLinkProvider.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FLiveLinkProvider() [1/3]

◆ FLiveLinkProvider() [2/3]

◆ FLiveLinkProvider() [3/3]

◆ ~FLiveLinkProvider()

Member Function Documentation

◆ ClearSubject()

◆ CloseConnection()

◆ CreateMessageEndpoint()

◆ GetAnnotations()

◆ GetConnectedAddresses()

◆ GetEndpointAddress()

◆ GetLastSubjectStaticDataStruct()

◆ GetMachineName()

◆ GetProviderName()

◆ GetSupportedLiveLinkVersion()

◆ HandleConnectMessage()

◆ HasConnection()

◆ OnConnectionsClosed()

◆ OnMessageBusNotification()

◆ Publish()

◆ RegisterConnStatusChangedHandle()

◆ RemoveSubject()

◆ SendClearSubjectToConnections()

◆ SendMessage() [1/3]

◆ SendMessage() [2/3]

◆ SendMessage() [3/3]

◆ ShouldTransmitToSubject_AnyThread()

◆ Subscribe()

◆ UnregisterConnStatusChangedHandle()

◆ UpdateSubject()

◆ UpdateSubjectFrame() [1/2]

◆ UpdateSubjectFrame() [2/2]

◆ UpdateSubjectFrameData()

◆ UpdateSubjectStaticData()

◆ ValidateConnections()