LiveLinkInterface

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

FLiveLinkBaseBlueprintData

Base blueprint data structure for a subject frame Can be used to do blueprint facilitator per role

Public class

FLiveLinkBaseDataStruct

Wrapper around FStructOnScope to handle FLiveLinkBaseFrameData Can safely cast to the specific outer type

Public struct

FLiveLinkBaseFrameData

Base data structure for each frame coming in for a subject

Public struct

FLiveLinkBaseStaticData

Base static data structure for a subject Use to store information that is common to every frame

Public struct

FLiveLinkCurveConversionSettings

Public struct

FLiveLinkCurveElement

Public struct

FLiveLinkCurveIntegrationData

Helper struct for updating curve data across multiple frames of live link data.

Public struct

FLiveLinkCurveKey

Public struct

FLiveLinkCustomVersion

Custom serialization version for all packages containing LiveLink dependent asset types.

Public struct

FLiveLinkFrame

Store frame information for animation data

Public struct

FLiveLinkFrameData

Store animation frame data

Public struct

FLiveLinkFrameRate

Public struct

FLiveLinkInterpolationInfo

Information about the interpolation that was done Used to give some cues to the caller about what's happened

Public struct

FLiveLinkInterpolationSettings

Public class

FLiveLinkLog

This class represents a log of LiveLink output each of which can be a rich tokenized message

Public struct

FLiveLinkMetaData

Public struct

FLiveLinkRefSkeleton

Public class

FLiveLinkRoleTrait

Public struct

FLiveLinkSourceBufferManagementSettings

Public struct

FLiveLinkSourceDebugInfo

Public struct

FLiveLinkSourceHandle

A Blueprint handle to a specific LiveLink Source.

Public struct

FLiveLinkSourcePreset

Public struct

FLiveLinkSubjectFrame

Store a subject complete frame data.

Public struct

FLiveLinkSubjectFrameData

Wrapper around static and dynamic data to be used when fetching a subject complete data

Public struct

FLiveLinkSubjectKey

Structure that identifies an individual subject.

Public struct

FLiveLinkSubjectName

Public struct

FLiveLinkSubjectPreset

Public struct

FLiveLinkSubjectRepresentation

Public struct

FLiveLinkTime

Public struct

FLiveLinkTimeCode

A Qualified TimeCode associated with.

Public struct

FLiveLinkTimeCode_Base_DEPRECATED

Public struct

FLiveLinkTimeSynchronizationSettings

Public struct

FLiveLinkWorldTime

Public class

FOnLiveLinkSourceChangedDelegate

Public class

FOnLiveLinkSubjectChangedDelegate

Public class

FOnLiveLinkSubjectStaticDataReceived

Public struct

FOptionalCurveElement

Public class

ILiveLinkClient

Interface for streaming and consuming data from external sources into UE4.

Public class

ILiveLinkFrameInterpolationProcessorWorker

Basic object to interpolate live link frames Inherit from it to do custom blending for your data type

Public class

ILiveLinkFramePreProcessorWorker

Basic object to apply preprocessing to a live link frame.

Public class

ILiveLinkFrameTranslatorWorker

Basic object to translate data from one role to another

It can be called from any thread

Public class

ILiveLinkSource

Public class

ILiveLinkSubject

The base class of a LiveLink subject.

Public class

ULiveLinkController

Basic object to control a UObject live link frames

Public class

ULiveLinkCurveRemapSettings

Public class

ULiveLinkFrameInterpolationProcessor

Basic object to interpolate live link frames Inherit from it to do custom blending for your data type

Public class

ULiveLinkFramePreProcessor

Basic object to apply preprocessing to a live link frame.

Public class

ULiveLinkFrameTranslator

Basic object to translate data from one role to another

Public class

ULiveLinkRole

Basic object to extend the meaning of incoming live link frames.

Public class

ULiveLinkSourceFactory

Base class of factory that creates Source.

Public class

ULiveLinkSourceSettings

Base class for live link source settings (can be replaced by sources themselves)

Public class

ULiveLinkSubjectSettings

Base class for live link subject settings.

Public class

ULiveLinkVirtualSubject

A Virtual subject is made up of one or more real subjects from a source.

Typedefs

Name

Description

FLiveLinkBlueprintDataStruct

Specialization of our wrapped struct for FLiveLinkBaseBlueprintData

FLiveLinkFrameDataStruct

Specialization of our wrapped struct for FLiveLinkBaseFrameData

FLiveLinkFrameIdentifier

Identifier assigned to each incoming frame once in the pipeline.

FLiveLinkStaticDataStruct

Specialization of our wrapped struct for FLiveLinkBaseStaticData

Enums

Name

Description

Public enum

ELiveLinkSourceMode

Functions

Name Description

Public function Virtual

void

 

AddSourceToSubjectWhiteList

(
    FName SubjectName,
    FGuid SourceGuid
)

ILiveLinkClient::AddSourceToSubjectWhiteList is deprecated. Please register using SetSubjectEnabled to enabled a subject instead!

Public function Virtual

void

 

ClearAllSubjectsFrames()

ILiveLinkClient::ClearAllSubjectsFrames is deprecated. Please use ILiveLinkClient::ClearAllSubjectsFrames_AnyThread with the desired LiveLinkRole instead!

Public function Virtual

void

 

ClearSourceWhiteLists()

ILiveLinkClient::ClearSourceWhiteLists is deprecated. Please register using SetSubjectEnabled to disable a subject instead!

Public function Virtual

void

 

ClearSubject

(
    FName SubjectName
)

ILiveLinkClient::ClearSubject is deprecated. Please use ILiveLinkClient::RemoveSubject instead!

Public function Virtual

void

 

ClearSubjectsFrames

(
    FName SubjectName
)

ILiveLinkClient::ClearSubjectsFrames is deprecated. Please use ILiveLinkClient::ClearSubjectsFrames_AnyThread with the desired LiveLinkRole instead!

Public function Virtual

TArray < FLiv ...

 

GetActiveSubjects()

ILiveLinkClient::GetActiveSubjects is deprecated. Please use ILiveLinkClient::GetSubjects instead!

Public function Virtual

void

 

GetAndFreeLastRecordedFrames

(
    const FGuid & InHandlerGuid,
    FName SubjectName,
    TArray < FLiveLinkFrame >& OutFrame...
)

ILiveLinkClient::GetAndFreeLastRecordedFrames is deprecated. Please register using RegisterForSubjectFrames to receive subject frames instead!

Public function Virtual Const

bool

 

GetSaveFrames()

ILiveLinkClient::GetSaveFrames is deprecated. Please register using RegisterForSubjectFrames to start receiving subject frames instead!

Public function Virtual

const FLiveL ...

 

GetSubjectData

(
    FName SubjectName
)

ILiveLinkClient::GetSubjectData is deprecated. Please use ILiveLinkClient::EvaluateFrame with the desired LiveLinkRole instead!

Public function Virtual

const FLiveL ...

 

GetSubjectDataAtSceneTime

(
    FName SubjectName,
    const FTimecode & SceneTime
)

ILiveLinkClient::GetSubjectDataAtSceneTime is deprecated. Please use ILiveLinkClient::EvaluateFrameAtSceneTime with the desired LiveLinkRole instead!

Public function Virtual

const FLiveL ...

 

GetSubjectDataAtWorldTime

(
    FName SubjectName,
    double WorldTime
)

ILiveLinkClient::GetSubjectDataAtWorldTime is deprecated. Please use ILiveLinkClient::EvaluateFrameAtWorldTime with the desired LiveLinkRole instead!

Public function Virtual

void

 

GetSubjectNames

(
    TArray < FName >& SubjectNames
)

ILiveLinkClient::GetSubjectNames is deprecated. Please use ILiveLinkClient::GetSubjects instead!

Public function Virtual

const TArray ...

 

GetSubjectRawFrames

(
    FName SubjectName
)

ILiveLinkClient::GetSubjectRawFrames is deprecated. It is no longer supported.

Public function Virtual

void

 

PushSubjectData

(
    FGuid SourceGuid,
    FName SubjectName,
    const FLiveLinkFrameData & FrameDat...
)

ILiveLinkClient::PushSubjectData is deprecated. Please use ILiveLinkClient::PushSubjectFrameData with the proper LiveLinkRole's frame data structure instead!

Public function

FOnLiveLinkS ...

 

PushSubjectSkeleton

(
    FGuid SourceGuid,
    FName SubjectName,
    const FLiveLinkRefSkeleton & RefSke...
)

ILiveLinkClient::PushSubjectSkeleton is deprecated. Please use ILiveLinkClient::PushSubjectStaticData with the proper LiveLinkRole's static data structure instead!

Public function Virtual

FDelegateHan ...

 

RegisterSubjectsChangedHandle

(
    const FSimpleMulticastDelegate::FDe...
)

ILiveLinkClient::RegisterSubjectsChangedHandle is deprecated. Please register using OnLiveLinkSubjectAdded and OnLiveLinkSubjectRemoved instead!

Public function Virtual

void

 

RemoveSourceFromSubjectWhiteList

(
    FName SubjectName,
    FGuid SourceGuid
)

ILiveLinkClient::RemoveSourceFromSubjectWhiteList is deprecated. Please register using SetSubjectEnabled to disable a subject instead!

Public function Virtual

bool

 

SetSaveFrames

(
    bool InSave
)

ILiveLinkClient::SetSaveFrames is deprecated. Please register using RegisterForSubjectFrames to start receiving subject frames instead!

Public function Virtual

FGuid

 

StartRecordingLiveLink

(
    const TArray < FName >& SubjectName...
)

ILiveLinkClient::StartRecordingLiveLink is deprecated. Please register using RegisterForSubjectFrames to start receiving subject frames instead!

Public function Virtual

FGuid

 

StartRecordingLiveLink

(
    const FName & SubjectName
)

ILiveLinkClient::StartRecordingLiveLink is deprecated. Please register using RegisterForSubjectFrames to start receiving subject frames instead!

Public function Virtual

void

 

StopRecordingLiveLinkData

(
    const FGuid & InGuid,
    const TArray < FName >& SubjectName...
)

ILiveLinkClient::StopRecordingLiveLinkData is deprecated. Please unregister using UnregisterSubjectFramesHandle to stop receiving subject frames instead!

Public function Virtual

void

 

StopRecordingLiveLinkData

(
    const FGuid & InGuid,
    const FName & SubjectName
)

ILiveLinkClient::StopRecordingLiveLinkData is deprecated. Please unregister using UnregisterSubjectFramesHandle to stop receiving subject frames instead!

Public function Virtual

void

 

UnregisterSubjectsChangedHandle

(
    FDelegateHandle Handle
)

ILiveLinkClient::UnregisterSubjectsChangedHandle is deprecated. Please unregister using OnLiveLinkSubjectAdded and OnLiveLinkSubjectRemoved instead!

Variables

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback