ILiveLinkProvider Struct Reference

#include <LiveLinkProvider.h>

Inheritance diagram for ILiveLinkProvider:

Public Member Functions
virtual	~ILiveLinkProvider ()
virtual bool	UpdateSubjectStaticData (const FName SubjectName, TSubclassOf< ULiveLinkRole > Role, FLiveLinkStaticDataStruct &&StaticData, const TMap< FName, FString > &ExtraAnnotations={})=0
virtual void	RemoveSubject (const FName SubjectName)=0
virtual bool	UpdateSubjectFrameData (const FName SubjectName, FLiveLinkFrameDataStruct &&FrameData, const TMap< FName, FString > &ExtraAnnotations={})=0
virtual bool	HasConnection () const =0
virtual FDelegateHandle	RegisterConnStatusChangedHandle (const FLiveLinkProviderConnectionStatusChanged::FDelegate &ConnStatusChanged)=0
virtual void	UnregisterConnStatusChangedHandle (FDelegateHandle Handle)=0

Static Public Member Functions
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

~ILiveLinkProvider()

virtual ILiveLinkProvider::~ILiveLinkProvider ( )

inlinevirtual

Member Function Documentation

CreateLiveLinkProvider() [1/2]

TSharedPtr< ILiveLinkProvider > ILiveLinkProvider::CreateLiveLinkProvider ( const FString &  ProviderName )

static

CreateLiveLinkProvider() [2/2]

template<typename T >

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

inlinestatic

Create a Live Link Provider based on a class derived from ILiveLinkProvider instead of using the default Live Link Provider.

Parameters

ProviderName	The provider name.
EndpointBuilder	An endpoint builder that can be used to add additional message handlers.

Returns

Shared pointer to the ILiveLinkProvider-derived class. Use StaticCastSharedPtr to cast it back to child class type.

HasConnection()

virtual bool ILiveLinkProvider::HasConnection ( ) const

pure virtual

Is this provider currently connected to something.

Implemented in FLiveLinkProvider.

RegisterConnStatusChangedHandle()

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

pure virtual

Function for managing connection status changed delegate.

Implemented in FLiveLinkProvider.

RemoveSubject()

virtual void ILiveLinkProvider::RemoveSubject ( const FName  SubjectName )

pure virtual

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

Parameters

SubjectName

The name of the subject.

Implemented in FLiveLinkProvider.

UnregisterConnStatusChangedHandle()

virtual void ILiveLinkProvider::UnregisterConnStatusChangedHandle ( FDelegateHandle  Handle )

pure virtual

Function for managing connection status changed delegate.

Implemented in FLiveLinkProvider.

UpdateSubjectFrameData()

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

pure virtual

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

Implemented in FLiveLinkProvider.

UpdateSubjectStaticData()

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

pure virtual

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

Implemented in FLiveLinkProvider.

---

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

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