1. Epic GamesDeveloper
  3. FLiveLinkSourceCollection

FLiveLinkSourceCollection

API > API/Plugins > API/Plugins/LiveLink

   
Name FLiveLinkSourceCollection
Type class
Header File /Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkSourceCollection.h
Include Path #include "LiveLinkSourceCollection.h"

Syntax

class FLiveLinkSourceCollection

Constructors

Name Remarks Include Path Unreal Specifiers
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  

Constants

Name Type Remarks Include Path
DefaultVirtualSubjectGuid const FGuid "source guid" for virtual subjects LiveLinkSourceCollection.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OnLiveLinkSourceAddedDelegate FOnLiveLinkSourceChangedDelegate Notify when a client source's is added LiveLinkSourceCollection.h  
OnLiveLinkSourceRemovedDelegate FOnLiveLinkSourceChangedDelegate Notify when a client source's is removed LiveLinkSourceCollection.h  
OnLiveLinkSourcesChangedDelegate FSimpleMulticastDelegate Notify when the client sources list has changed LiveLinkSourceCollection.h  
OnLiveLinkSubjectAddedDelegate FOnLiveLinkSubjectChangedDelegate Notify when a client subject's is added LiveLinkSourceCollection.h  
OnLiveLinkSubjectEnabledDelegate FOnLiveLinkSubjectEnabledDelegate Notify when a client subject's state of enabled has changed. LiveLinkSourceCollection.h  
OnLiveLinkSubjectRemovedDelegate FOnLiveLinkSubjectChangedDelegate Notify when a client subject's is removed LiveLinkSourceCollection.h  
OnLiveLinkSubjectsChangedDelegate FSimpleMulticastDelegate Notify when a client subjects list has changed LiveLinkSourceCollection.h  
OnLiveLinkSubjectStateChangedDelegate FOnLiveLinkSubjectStateChanged Notify when a client subject's state has changed. (ie. it became stale) LiveLinkSourceCollection.h  
Sources TArray< FLiveLinkCollectionSourceItem >   LiveLinkSourceCollection.h  
SourcesLock UE::FTransactionallySafeRecursiveMutex Lock to stop multiple threads accessing the Sources from the collection at the same time LiveLinkSourceCollection.h  
Subjects TArray< FLiveLinkCollectionSubjectItem >   LiveLinkSourceCollection.h  
SubjectsLock UE::FTransactionallySafeRecursiveMutex Lock to stop multiple threads accessing the Subjects from the collection at the same time LiveLinkSourceCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSource ( FLiveLinkCollectionSourceItem Source
)

   LiveLinkSourceCollection.h  

void AddSubject ( FLiveLinkCollectionSubjectItem Subject
)

   LiveLinkSourceCollection.h  

void ApplyToSubject ( const FLiveLinkSubjectKey& InSubjectKey,
TFunctionRef< void(FLiveLinkCollectionSubjectItem&)> VisitorFunc
)

 Thread safe way to apply a method over a subject. LiveLinkSourceCollection.h  

void BroadcastOnGameThread ( DelegateType& InDelegate,
ArgTypes&&... InArgs
)

 Utility method used to broadcast delegates on the game thread if this function is called on a different thread. LiveLinkSourceCollection.h  

const FLiveLinkCollectionSubjectItem * FindEnabledSubject ( FLiveLinkSubjectName SubjectName
) const

   LiveLinkSourceCollection.h  

const FLiveLinkCollectionSourceItem * FindSource ( FGuid SourceGuid
) const

   LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  

const FLiveLinkCollectionSourceItem * FindVirtualSource ( FName VirtualSourceName
) const

   LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  

void ForEachSource ( TFunctionRef< void(const FLiveLinkCollectionSourceItem&)> VisitorFunc
) const

 Thread safe way to apply a method over every source. LiveLinkSourceCollection.h  
Thread safe way to apply a method over every source. LiveLinkSourceCollection.h  
Thread safe way to apply a method over every subject. LiveLinkSourceCollection.h  
Thread safe way to apply a method over every subject. LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  

const TArray< FLiveLinkCollectionSubjectItem > & GetSubjects()

   LiveLinkSourceCollection.h  

bool IsSubjectEnabled ( FLiveLinkSubjectKey SubjectKey
) const

   LiveLinkSourceCollection.h  

int32 NumSources()

 Get the number of sources in the collection. LiveLinkSourceCollection.h  

int32 NumSubjects()

 Get the number of subjects in the collection. LiveLinkSourceCollection.h  

FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceAdded()

   LiveLinkSourceCollection.h  

FOnLiveLinkSourceChangedDelegate & OnLiveLinkSourceRemoved()

   LiveLinkSourceCollection.h  

FSimpleMulticastDelegate & OnLiveLinkSourcesChanged()

   LiveLinkSourceCollection.h  

FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectAdded()

   LiveLinkSourceCollection.h  

FOnLiveLinkSubjectEnabledDelegate & OnLiveLinkSubjectEnabledChanged()

   LiveLinkSourceCollection.h  

FOnLiveLinkSubjectChangedDelegate & OnLiveLinkSubjectRemoved()

   LiveLinkSourceCollection.h  

FSimpleMulticastDelegate & OnLiveLinkSubjectsChanged()

   LiveLinkSourceCollection.h  

FOnLiveLinkSubjectStateChanged & OnLiveLinkSubjectStateChanged()

   LiveLinkSourceCollection.h  

void RemoveAllSources()

   LiveLinkSourceCollection.h  

void RemovePendingKill()

   LiveLinkSourceCollection.h  

void RemoveSource ( FGuid SourceGuid
)

   LiveLinkSourceCollection.h  

void RemoveSubject ( FLiveLinkSubjectKey SubjectKey
)

   LiveLinkSourceCollection.h  

bool RequestShutdown()

   LiveLinkSourceCollection.h  

void SetSubjectEnabled ( FLiveLinkSubjectKey SubjectKey,
bool bEnabled
)

   LiveLinkSourceCollection.h  

Operators

Name Remarks Include Path Unreal Specifiers
  LiveLinkSourceCollection.h  
  LiveLinkSourceCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page