| ILiveLinkClient_Base_DEPRECATED
|
Module |
|
Header |
/Engine/Source/Runtime/LiveLinkInterface/Public/ILiveLinkClient.h |
Include |
#include "ILiveLinkClient.h" |
class ILiveLinkClient : public ILiveLinkClient_Base_DEPRECATED
Interface for streaming and consuming data from external sources into UE4. A LiveLinkSource, may stream multiple LiveLinkSubject. Pushing and evaluating data can be executed on any thread. The other functions must be executed on the Game Thread. Subject may shared name between sources, but only 1 of those subjects may be enabled.
Name | Description | |
---|---|---|
|
~ILiveLinkClient() |
Name | Description | ||
---|---|---|---|
|
AddSource ( |
Add a new live link source to the client |
|
|
AddVirtualSubject ( |
Add a new virtual subject to the client |
|
|
AddVirtualSubjectSource ( |
Add a new live link VirtualSubject source to the client |
|
|
ClearAllSubjectsFrames_AnyThread() |
Clear all subjects frames |
|
|
ClearSubjectsFrames_AnyThread ( |
Clear the stored frames associated with the subject |
|
|
ClearSubjectsFrames_AnyThread ( |
Clear the stored frames associated with the enabled subject |
|
|
CreateSource ( |
Create from the factory a new live link source and add it to the client. |
|
|
CreateSubject ( |
Create and add a new live link subject to the client |
|
|
DoesSubjectSupportsRole ( |
Whether a subject support a particular role, either directly or through a translator |
|
|
DoesSubjectSupportsRole ( |
Whether a subject support a particular role, either directly or through a translator |
|
|
EvaluateFrame_AnyThread ( |
Return the evaluated subject snapshot for a specific role. |
|
|
EvaluateFrameAtSceneTime_AnyThread ( |
Evaluates a subject for a specific role at a scene time. |
|
|
EvaluateFrameAtWorldTime_AnyThread ( |
Evaluates a subject for a specific role. |
|
|
EvaluateFrameFromSource_AnyThread ( |
Return the evaluated subject from a specific source snapshot for a specific role. |
|
|
ForceTick() |
Performs an internal Tick(). |
|
|
FLiveLinkSou... |
GetSourcePreset |
Get the source preset from the live link client. |
|
GetSources() |
Get a list of all the sources |
|
|
ULiveLinkSou... |
GetSourceSettings ( |
Get the Settings of this source. |
|
GetSourceType ( |
Get the type of a source |
|
|
GetSubjectFrameTimes ( |
Get the time of all the frames for a specific source. @note Use for debugging purposes. |
|
|
GetSubjectFrameTimes ( |
Get the time of all the frames for a source. @note Use for debugging purposes. |
|
|
FLiveLinkSub... |
GetSubjectPreset ( |
Get the subject preset from the live link client. |
|
TSubclassOf<... |
GetSubjectRole ( |
Get the role of a subject from a specific source |
|
TSubclassOf<... |
GetSubjectRole ( |
Get the role of the subject with this name |
|
GetSubjects |
Get a list of all subjects |
|
|
UObject *... |
GetSubjectSettings ( |
Get the Settings of this subject. |
|
GetSubjectsSupportingRole ( |
Get a list of name of subjects supporting a certain role |
|
|
GetVirtualSources() |
Get a list of all the VirtualSubjects sources |
|
|
HasSourceBeenAdded ( |
Is the source been added |
|
|
IsSubjectEnabled ( |
Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled. |
|
|
IsSubjectEnabled ( |
Whether or not a subject from the specific source is the enabled subject. |
|
|
IsSubjectTimeSynchronized ( |
Whether or not the subject's data is time synchronized or not |
|
|
IsSubjectTimeSynchronized ( |
Whether or not the subject's data, from a specific source, is time synchronized or not |
|
|
IsSubjectValid ( |
Whether or not the client has a subject with this name that is valid and has valid snapshot data |
|
|
IsSubjectValid ( |
Whether or not a subject from a specific source is valid and has valid snapshot data |
|
|
IsVirtualSubject ( |
Whether the subject key points to a virtual subject |
|
|
FOnLiveLinkS... |
OnLiveLinkSourceAdded() |
Notify when a new source has been added |
|
FOnLiveLinkS... |
OnLiveLinkSourceRemoved() |
Notify when a source has been removed |
|
FSimpleMulti... |
OnLiveLinkSourcesChanged() |
Notify when the list of sources has changed. |
|
FOnLiveLinkS... |
OnLiveLinkSubjectAdded() |
Notify when a new subject has been added |
|
FOnLiveLinkS... |
OnLiveLinkSubjectEvaluated() |
Notify the debug interface when a subject has been evaluated. |
|
FOnLiveLinkS... |
OnLiveLinkSubjectRemoved() |
Notify when a subject has been removed |
|
FSimpleMulti... |
OnLiveLinkSubjectsChanged() |
Notify when the list of subject has changed. |
|
FSimpleMulti... |
OnLiveLinkTicked() |
Notify when the LiveLinkClient has ticked. |
|
PushSubjectFrameData_AnyThread ( |
Push frame data for a specific subject for a certain role |
|
|
PushSubjectStaticData_AnyThread ( |
Push static data for a specific subject for a certain role. This will clear all buffered frames |
|
|
RegisterForFrameDataReceived ( |
Register for when a frame data was received. |
|
|
RegisterForSubjectFrames ( |
Register for when a frame has been validated, added and ready to be used. |
|
|
RemoveSource ( |
Remove the specified source from the live link client |
|
|
RemoveSource ( |
Remove the source specified by the source Id from the live link client |
|
|
RemoveSubject_AnyThread ( |
Clear the subject from the specific source |
|
|
RemoveVirtualSubject ( |
Removes a virtual subject from the client |
|
|
SetSubjectEnabled ( |
Set the subject's from a specific source to enabled, disabling the other in the process. |
|
|
UnregisterForFrameDataReceived ( |
Unregister delegate registered with RegisterForFrameDataReceived. |
|
|
UnregisterSubjectFramesHandle ( |
Unregister delegates registered with RegisterForSubjectFrames. |
Name |
Description |
---|---|
LIVELINK_VERSION |
|
ModularFeatureName |
Name | Description | ||
---|---|---|---|
|
EvaluateFrameAtSceneTime_AnyThread ( |
ILiveLinkClient::EvaluateFrameAtSceneTime_AnyThread is deprecated. Please use ILiveLinkClient::EvaluateFrameAtSceneTime_AnyThread with a QualifiedFrameTime instead! |