ILiveLinkSource

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

LiveLinkInterface

Header

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

Include

#include "ILiveLinkSource.h"

Syntax

class ILiveLinkSource

Destructors

Name Description

Public function Virtual

~ILiveLinkSource()

Functions

Name Description

Public function Virtual Const

bool

 

CanBeDisplayedInUI()

Can this source be displayed in the Source UI list

Public function Virtual Const

TSubclassOf<...

 

GetSettingsClass()

Setting class to display and used by the Source.

Public function Const

FText

 

GetSourceMachineName()

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

Public function Const

FText

 

GetSourceStatus()

For UI, what is the status of the source.

Public function Const

FText

 

GetSourceType()

For UI, what is the identifier of the source.

Public function Virtual

void

 

InitializeSettings

(
    ULiveLinkSourceSettings* Setti...
)

The setting class has been created. Called after ReceiveClient.

Public function Const

bool

 

IsSourceStillValid()

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

Public function Virtual

void

 

OnSettingsChanged

(
    ULiveLinkSourceSettings* Setti...,
    const FPropertyChangedEvent& Prope...
)

Notification when a setting value has changed via the UI.

Public function

void

 

ReceiveClient

(
    ILiveLinkClient* InClient,
    FGuid InSourceGuid
)

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

Public function

bool

 

RequestSourceShutdown()

Request the source to shutdown.

Public function Virtual

void

 

Update()

Update the source.

Deprecated Functions

Name Description

Public function Virtual Const

UClass *

 

GetCustomSettingsClass()

ILiveLinkClient::GetCustomSettingsClass is deprecated. Please use GetSettingsClass instead!