IAudioLinkFactory Class Reference

#include <IAudioLinkFactory.h>

Inheritance diagram for IAudioLinkFactory:

Classes
struct	FAudioLinkSourceCreateArgs
struct	FAudioLinkSourcePushedCreateArgs
struct	FAudioLinkSubmixCreateArgs
struct	FPushedBufferListenerCreateParams
struct	FSourceBufferListenerCreateParams
struct	FSubmixBufferListenerCreateParams

Public Types
using	FAudioLinkSourcePushedSharedPtr = TSharedPtr< IAudioLinkSourcePushed, ESPMode::ThreadSafe >
using	FAudioLinkSynchronizerSharedPtr = TSharedPtr< IAudioLinkSynchronizer, ESPMode::ThreadSafe >

Public Member Functions
virtual AUDIOLINKENGINE_API	~IAudioLinkFactory ()
virtual FName	GetFactoryName () const =0
virtual TSubclassOf< UAudioLinkSettingsAbstract >	GetSettingsClass () const =0
virtual AUDIOLINKENGINE_API FSharedBufferedOutputPtr	CreateSourceBufferListener (const FSourceBufferListenerCreateParams &)
virtual AUDIOLINKENGINE_API FSharedBufferedOutputPtr	CreatePushableBufferListener (const FPushedBufferListenerCreateParams &)
virtual AUDIOLINKENGINE_API FSharedBufferedOutputPtr	CreateSubmixBufferListener (const FSubmixBufferListenerCreateParams &)
virtual TUniquePtr< IAudioLink >	CreateSubmixAudioLink (const FAudioLinkSubmixCreateArgs &InCreateArgs)=0
virtual TUniquePtr< IAudioLink >	CreateSourceAudioLink (const FAudioLinkSourceCreateArgs &)=0
virtual FAudioLinkSourcePushedSharedPtr	CreateSourcePushedAudioLink (const FAudioLinkSourcePushedCreateArgs &)=0
virtual FAudioLinkSynchronizerSharedPtr	CreateSynchronizerAudioLink ()=0

Static Public Member Functions
static FName	GetModularFeatureName ()
static AUDIOLINKENGINE_API TArray< IAudioLinkFactory * >	GetAllRegisteredFactories ()
static AUDIOLINKENGINE_API TArray< FName >	GetAllRegisteredFactoryNames ()
static AUDIOLINKENGINE_API IAudioLinkFactory *	FindFactory (const FName InFactoryName)

Protected Member Functions
AUDIOLINKENGINE_API	IAudioLinkFactory ()

Detailed Description

IAudioLinkFactory Abstract interface for AudioLink factory objects.

Member Typedef Documentation

FAudioLinkSourcePushedSharedPtr

using IAudioLinkFactory::FAudioLinkSourcePushedSharedPtr = TSharedPtr<IAudioLinkSourcePushed, ESPMode::ThreadSafe>

FAudioLinkSynchronizerSharedPtr

using IAudioLinkFactory::FAudioLinkSynchronizerSharedPtr = TSharedPtr<IAudioLinkSynchronizer, ESPMode::ThreadSafe>

Create a AudioLinkSynchronizer callback

Returns

The newly created Link instance (if successful).

Constructor & Destructor Documentation

IAudioLinkFactory()

IAudioLinkFactory::IAudioLinkFactory ( )

protected

Constructor will auto register this instance.

~IAudioLinkFactory()

IAudioLinkFactory::~IAudioLinkFactory ( )

virtual

Destructor will auto unregister this instance.

Member Function Documentation

CreatePushableBufferListener()

FSharedBufferedOutputPtr IAudioLinkFactory::CreatePushableBufferListener ( const FPushedBufferListenerCreateParams &  InPushableCreateParams )

virtual

CreateSourceAudioLink()

virtual TUniquePtr< IAudioLink > IAudioLinkFactory::CreateSourceAudioLink ( const FAudioLinkSourceCreateArgs &  )

pure virtual

Create a Source Audio Link.

Parameters

InCreateArgs

Arguments used to create the AudioLink instance

Returns

The newly created Link instance (if successful).

CreateSourceBufferListener()

FSharedBufferedOutputPtr IAudioLinkFactory::CreateSourceBufferListener ( const FSourceBufferListenerCreateParams &  InSourceCreateParams )

virtual

CreateSourcePushedAudioLink()

virtual FAudioLinkSourcePushedSharedPtr IAudioLinkFactory::CreateSourcePushedAudioLink ( const FAudioLinkSourcePushedCreateArgs &  )

pure virtual

CreateSubmixAudioLink()

virtual TUniquePtr< IAudioLink > IAudioLinkFactory::CreateSubmixAudioLink ( const FAudioLinkSubmixCreateArgs &  InCreateArgs )

pure virtual

Create a Submix Audio Link.

Parameters

InCreateArgs

Arguments used to create the AudioLink instance

Returns

The newly created Link instance (if successful).

CreateSubmixBufferListener()

FSharedBufferedOutputPtr IAudioLinkFactory::CreateSubmixBufferListener ( const FSubmixBufferListenerCreateParams &  InSubmixCreateParams )

virtual

CreateSynchronizerAudioLink()

virtual FAudioLinkSynchronizerSharedPtr IAudioLinkFactory::CreateSynchronizerAudioLink ( )

pure virtual

FindFactory()

IAudioLinkFactory * IAudioLinkFactory::FindFactory ( const FName  InFactoryName )

static

Gets all registered factory names

Returns

Array of all factory names

GetAllRegisteredFactories()

TArray< IAudioLinkFactory * > IAudioLinkFactory::GetAllRegisteredFactories ( )

static

Gets all registered factory instances.

Returns

Array of all factories.

GetAllRegisteredFactoryNames()

TArray< FName > IAudioLinkFactory::GetAllRegisteredFactoryNames ( )

static

Gets all registered factory names

Returns

Array of all factory names

GetFactoryName()

virtual FName IAudioLinkFactory::GetFactoryName ( ) const

pure virtual

Gets the name of this factory type. This will uniquely identity itself, so it can be found by the FindFactory call below

Returns

Name of factory

GetModularFeatureName()

static FName IAudioLinkFactory::GetModularFeatureName ( )

inlinestatic

Get the name of all AudioLink factories in the Modular Features registry.

Returns

"AudioLink Factory"

GetSettingsClass()

virtual TSubclassOf< UAudioLinkSettingsAbstract > IAudioLinkFactory::GetSettingsClass ( ) const

pure virtual

Gets the type of of the settings object that this factory uses to define its specific settings. All settings for each AudioLink factory will derive from UAudioLinkSettingsAbstract

Returns

Class of the Settings Object

---

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

• Engine/Source/Runtime/AudioLink/AudioLinkEngine/Public/IAudioLinkFactory.h
• Engine/Source/Runtime/AudioLink/AudioLinkEngine/Private/IAudioLinkFactory.cpp