AudioDeviceNotificationSubsystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Subsystems/EngineSubsystem.h"
#include "Engine/Engine.h"
#include "AudioMixer.h"
#include "Delegates/Delegate.h"
#include "AudioDeviceNotificationSubsystem.generated.h"
 
UENUM(BlueprintType)
enum class EAudioDeviceChangedRole : uint8
{
    Invalid,
    Console,
    Multimedia,
    Communications,
    Count UMETA(Hidden)
};
 
UENUM(BlueprintType)
enum class EAudioDeviceChangedState : uint8
{
    Invalid,
    Active,
    Disabled,
    NotPresent,
    Unplugged,
    Count UMETA(Hidden)
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnAudioDefaultDeviceChanged, EAudioDeviceChangedRole, AudioDeviceRole, FString, DeviceId);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnAudioDeviceStateChanged, FString, DeviceId, EAudioDeviceChangedState, NewState);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnAudioDeviceChange, FString, DeviceId);
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnAudioDefaultDeviceChangedNative, EAudioDeviceChangedRole, FString);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnAudioDeviceStateChangedNative, FString, EAudioDeviceChangedState);
DECLARE_MULTICAST_DELEGATE_OneParam(FOnAudioDeviceChangeNative, FString);
 
UCLASS(MinimalAPI)
class UAudioDeviceNotificationSubsystem : public UEngineSubsystem
                                                       , public Audio::IAudioMixerDeviceChangedListener
{
    GENERATED_BODY()
 
public: 
 
    virtual ~UAudioDeviceNotificationSubsystem() = default;
 
    static UAudioDeviceNotificationSubsystem* Get() { return GEngine->GetEngineSubsystem<UAudioDeviceNotificationSubsystem>(); }
 
    //~ Begin UEngineSubsystem Interface
    AUDIOMIXER_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    AUDIOMIXER_API virtual void Deinitialize() override;
    //~ End UEngineSubsystem Interface
 
    //~ Begin IAudioMixerDeviceChangedListener Interface
    AUDIOMIXER_API virtual void OnDefaultCaptureDeviceChanged(const Audio::EAudioDeviceRole InAudioDeviceRole, const FString& DeviceId) override;
    AUDIOMIXER_API virtual void OnDefaultRenderDeviceChanged(const Audio::EAudioDeviceRole InAudioDeviceRole, const FString& DeviceId) override;
    AUDIOMIXER_API virtual void OnDeviceAdded(const FString& DeviceId, bool bIsRenderDevice) override;
    AUDIOMIXER_API virtual void OnDeviceRemoved(const FString& DeviceId, bool bIsRenderDevice) override;
    AUDIOMIXER_API virtual void OnDeviceStateChanged(const FString& DeviceId, const Audio::EAudioDeviceState InState, bool bIsRenderDevice) override;
    //~ End IAudioMixerDeviceChangedListener Interface
 
    AUDIOMIXER_API virtual void OnDeviceSwitched(const FString& DeviceId);
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDefaultDeviceChanged DefaultCaptureDeviceChanged;
    FOnAudioDefaultDeviceChangedNative DefaultCaptureDeviceChangedNative;
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDefaultDeviceChanged DefaultRenderDeviceChanged;
    FOnAudioDefaultDeviceChangedNative DefaultRenderDeviceChangedNative;
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDeviceChange DeviceAdded;
    FOnAudioDeviceChangeNative DeviceAddedNative;
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDeviceChange DeviceRemoved;
    FOnAudioDeviceChangeNative DeviceRemovedNative;
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDeviceStateChanged DeviceStateChanged;
    FOnAudioDeviceStateChangedNative DeviceStateChangedNative;
 
    UPROPERTY(BlueprintAssignable, Category = "Audio Delegates")
    FOnAudioDeviceChange DeviceSwitched;
    FOnAudioDeviceChangeNative DeviceSwitchedNative;
 
protected:
 
    AUDIOMIXER_API EAudioDeviceChangedRole GetDeviceChangedRole(Audio::EAudioDeviceRole InRole) const;
    AUDIOMIXER_API EAudioDeviceChangedState GetDeviceChangedState(Audio::EAudioDeviceState InState) const;
};