ISoundHandleSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Features/IModularFeatures.h"
 
class ISoundHandleOwner;
class USoundBase;
 
namespace Audio
{
    using FSoundHandleID = uint32;
 
    enum class EResult : uint8
    {
        Success = 0,
        Failure = 1,
        NotImplemented = 2
    };
}
 
class ISoundHandleSystem : public IModularFeature
{
public:
    static FName GetModularFeatureName()
    {
        static FName FeatureName = FName(TEXT("SoundHandles"));
        return FeatureName;
    }
 
    virtual ~ISoundHandleSystem() = default;
 
    virtual Audio::FSoundHandleID CreateSoundHandle(USoundBase* Sound, ISoundHandleOwner* Owner) { return INDEX_NONE; }
 
    virtual void SetTransform(Audio::FSoundHandleID ID, const FTransform& Transform) {}
 
    virtual Audio::EResult Play(Audio::FSoundHandleID ID) { return Audio::EResult::NotImplemented; }
 
    virtual void Stop(Audio::FSoundHandleID ID) {}
 
    static TArray<ISoundHandleSystem*> GetRegisteredInterfaces()
    {
        // Get all IAudioHandleInterface implementations
        IModularFeatures::Get().LockModularFeatureList();
        TArray<ISoundHandleSystem*> RegisteredInterfaces = IModularFeatures::Get().GetModularFeatureImplementations<ISoundHandleSystem>(GetModularFeatureName());
        IModularFeatures::Get().UnlockModularFeatureList();
        return RegisteredInterfaces;
    }
};