WasapiDeviceEnumeration.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AudioCaptureCore.h"
 
#include "Windows/AllowWindowsPlatformTypes.h"
#include "Windows/AllowWindowsPlatformAtomics.h"
 
#include "Microsoft/COMPointer.h"
 
THIRD_PARTY_INCLUDES_START
#include <AudioClient.h>
#include <Mmdeviceapi.h>
THIRD_PARTY_INCLUDES_END
 
#include "Windows/HideWindowsPlatformAtomics.h"
#include "Windows/HideWindowsPlatformTypes.h"
 
 
namespace Audio
{
    class FWasapiDeviceEnumeration
    {
    public:
        struct FDeviceInfo
        {
            enum class EEndpointType { Unknown, Render, Capture };
 
            FString DeviceId;
            FString FriendlyName;
            uint32 NumInputChannels = 0;
            uint32 NumOutputChannels = 0;
            uint32 BitsPerSample = 0;
            uint32 PreferredSampleRate = 0;
            EEndpointType EndpointType = EEndpointType::Unknown;
        };
 
        FWasapiDeviceEnumeration() = default;
        ~FWasapiDeviceEnumeration() = default;
 
        void Initialize();
 
        FString GetDefaultInputDeviceId();
        FString GetDefaultOutputDeviceId();
 
        bool GetDeviceInfo(const FString& InDeviceId, FDeviceInfo& OutDeviceInfo);
 
        bool GetDeviceIdFromIndex(int32 InDeviceIndex, EDataFlow InDataFlow, FString& OutDeviceId);
        
        bool GetDeviceIndexFromId(const FString& InDeviceId, int32& OutDeviceIndex);
 
        bool GetInputDevicesAvailable(TArray<FDeviceInfo>& OutDevices);
 
        bool GetIMMDevice(const FString& InDeviceId, TComPtr<IMMDevice>& OutDevice);
 
    private:
        FString DefaultRenderId;
        FString DefaultCaptureId;
        TComPtr<IMMDeviceEnumerator> DeviceEnumerator;
 
        void EnumerateDefaults();
 
        bool GetDeviceProperties(TComPtr<IMMDevice> InDevice, FDeviceInfo& OutInfo);
 
        bool GetDeviceId(TComPtr<IMMDevice> InDevice, FString& OutString);
 
        bool GetDeviceFriendlyName(TComPtr<IMMDevice> InDevice, FString& OutString);
 
        FDeviceInfo::EEndpointType GetEndpointType(TComPtr<IMMDevice> InDevice);
 
        bool GetAudioClientMixFormat(TComPtr<IAudioClient3> AudioClient, WAVEFORMATEX** OutFormat);
    };
 
}