ILiveLinkSource Class Reference

#include <ILiveLinkSource.h>

Public Member Functions
virtual	~ILiveLinkSource ()
virtual void	ReceiveClient (ILiveLinkClient *InClient, FGuid InSourceGuid)=0
virtual void	InitializeSettings (ULiveLinkSourceSettings *Settings)
virtual void	Update ()
virtual bool	CanBeDisplayedInUI () const
virtual bool	IsSourceStillValid () const =0
virtual bool	RequestSourceShutdown ()=0
virtual FText	GetSourceType () const =0
virtual FText	GetSourceMachineName () const =0
virtual FText	GetSourceStatus () const =0
virtual FText	GetSourceToolTip () const
virtual TSubclassOf< ULiveLinkSourceSettings >	GetSettingsClass () const
virtual UClass *	GetCustomSettingsClass () const
virtual void	OnSettingsChanged (ULiveLinkSourceSettings *Settings, const FPropertyChangedEvent &PropertyChangedEvent)

Constructor & Destructor Documentation

~ILiveLinkSource()

virtual ILiveLinkSource::~ILiveLinkSource ( )

inlinevirtual

Member Function Documentation

CanBeDisplayedInUI()

virtual bool ILiveLinkSource::CanBeDisplayedInUI ( ) const

inlinevirtual

Can this source be displayed in the Source UI list

GetCustomSettingsClass()

virtual UClass * ILiveLinkSource::GetCustomSettingsClass ( ) const

inlinevirtual

GetSettingsClass()

virtual TSubclassOf< ULiveLinkSourceSettings > ILiveLinkSource::GetSettingsClass ( ) const

inlinevirtual

Setting class to display and used by the Source. An instance of that class will be constructed when the source is added to the Client. Then InitializeSettings will be called.

GetSourceMachineName()

virtual FText ILiveLinkSource::GetSourceMachineName ( ) const

pure virtual

For UI, from where the source data is coming from.

GetSourceStatus()

virtual FText ILiveLinkSource::GetSourceStatus ( ) const

pure virtual

For UI, what is the status of the source. Should be: "Active", "Not responding", "Connecting" or any short message that makes sense for the source.

GetSourceToolTip()

virtual FText ILiveLinkSource::GetSourceToolTip ( ) const

inlinevirtual

For UI, what should be shown in the source list when hovering this source.

GetSourceType()

virtual FText ILiveLinkSource::GetSourceType ( ) const

pure virtual

For UI, what is the identifier of the source.

InitializeSettings()

virtual void ILiveLinkSource::InitializeSettings ( ULiveLinkSourceSettings *  Settings )

inlinevirtual

The setting class has been created. Called after ReceiveClient.

See also

GetSettingsClass

IsSourceStillValid()

virtual bool ILiveLinkSource::IsSourceStillValid ( ) const

pure virtual

Returns whether the Source is connected to its data provider and can still push valid data.

OnSettingsChanged()

virtual void ILiveLinkSource::OnSettingsChanged ( ULiveLinkSourceSettings *  Settings, const FPropertyChangedEvent &  PropertyChangedEvent  )

inlinevirtual

Notification when a setting value has changed via the UI.

ReceiveClient()

virtual void ILiveLinkSource::ReceiveClient ( ILiveLinkClient *  InClient, FGuid  InSourceGuid  )

pure virtual

The source has been added to the Client and a Guid has been associated.

RequestSourceShutdown()

virtual bool ILiveLinkSource::RequestSourceShutdown ( )

pure virtual

Request the source to shutdown. This may be called multiple times. Should return true, when the source can be destroyed. RequestSourceShutdown will be called multiple times until it returns true. If the source is multithreaded, the source should test if it can be shutdown, set a flag and return immediately.

Update()

virtual void ILiveLinkSource::Update ( )

inlinevirtual

Update the source. This is called in a critical path on the game thread. The user is expected to return quickly.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/LiveLinkInterface/Public/ILiveLinkSource.h