IAudioLinkFactory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "IAudioLink.h"
#include "Features/IModularFeatures.h"
#include "AudioDeviceManager.h"
#include "AudioLinkSettingsAbstract.h"
#include "Templates/SubclassOf.h"
#include "IBufferedAudioOutput.h"
 
// Forward declarations.
class USoundSubmix;
class UAudioLinkComponent;
 
class IAudioLinkFactory : public IModularFeature
{
protected:
    AUDIOLINKENGINE_API IAudioLinkFactory();
public:
    AUDIOLINKENGINE_API virtual ~IAudioLinkFactory();
 
    virtual FName GetFactoryName() const = 0;
 
    virtual TSubclassOf<UAudioLinkSettingsAbstract> GetSettingsClass() const = 0;
    
    struct FSourceBufferListenerCreateParams
    {
        int32 SizeOfBufferInFrames = 0;
        bool bShouldZeroBuffer = false;
        TWeakObjectPtr<UAudioComponent> AudioComponent;
        TWeakObjectPtr<USceneComponent> OwningComponent;
    };
    AUDIOLINKENGINE_API virtual FSharedBufferedOutputPtr CreateSourceBufferListener(const FSourceBufferListenerCreateParams&);
 
    struct FPushedBufferListenerCreateParams
    {
        int32 SizeOfBufferInFrames = INDEX_NONE;
        bool bShouldZeroBuffer = false;
    };
    AUDIOLINKENGINE_API virtual FSharedBufferedOutputPtr CreatePushableBufferListener(const FPushedBufferListenerCreateParams&);
 
    struct FSubmixBufferListenerCreateParams
    {
        int32 SizeOfBufferInFrames = 0;
        bool bShouldZeroBuffer = false;
    };
    AUDIOLINKENGINE_API virtual FSharedBufferedOutputPtr CreateSubmixBufferListener(const FSubmixBufferListenerCreateParams&);
            
    struct FAudioLinkSubmixCreateArgs
    {
        TWeakObjectPtr<const USoundSubmix> Submix;
        FAudioDevice* Device = nullptr;
        TWeakObjectPtr<const UAudioLinkSettingsAbstract> Settings;
    };
 
    virtual TUniquePtr<IAudioLink> CreateSubmixAudioLink(const FAudioLinkSubmixCreateArgs& InCreateArgs) = 0;
 
    struct FAudioLinkSourceCreateArgs
    {
        TWeakObjectPtr<UAudioComponent> AudioComponent;
        TWeakObjectPtr<USceneComponent> OwningComponent;
        TWeakObjectPtr<UAudioLinkSettingsAbstract> Settings;
    };
 
    virtual TUniquePtr<IAudioLink> CreateSourceAudioLink(const FAudioLinkSourceCreateArgs&) = 0;
    
    struct FAudioLinkSourcePushedCreateArgs
    {
        FName OwnerName;
        int32 NumChannels = INDEX_NONE;
        int32 SampleRate = INDEX_NONE;
        int32 NumFramesPerBuffer = INDEX_NONE;
        int32 TotalNumFramesInSource = INDEX_NONE;
        UAudioLinkSettingsAbstract::FSharedSettingsProxyPtr Settings;
    };  
    using FAudioLinkSourcePushedSharedPtr = TSharedPtr<IAudioLinkSourcePushed, ESPMode::ThreadSafe>;
    virtual FAudioLinkSourcePushedSharedPtr CreateSourcePushedAudioLink(const FAudioLinkSourcePushedCreateArgs&) = 0;
 
    using FAudioLinkSynchronizerSharedPtr = TSharedPtr<IAudioLinkSynchronizer, ESPMode::ThreadSafe>;
    virtual FAudioLinkSynchronizerSharedPtr CreateSynchronizerAudioLink() = 0;
        
    inline static FName GetModularFeatureName()
    {
        static FName FeatureName = FName(TEXT("AudioLink Factory"));
        return FeatureName;
    }
 
    static AUDIOLINKENGINE_API TArray<IAudioLinkFactory*> GetAllRegisteredFactories();
 
    static AUDIOLINKENGINE_API TArray<FName> GetAllRegisteredFactoryNames();
    
    static AUDIOLINKENGINE_API IAudioLinkFactory* FindFactory(const FName InFactoryName);
 
protected:  
};