UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
Audio::FWasapiDeviceEnumeration Class Reference

#include <WasapiDeviceEnumeration.h>

Classes

struct  FDeviceInfo
 

Public Member Functions

 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)
 

Detailed Description

FWasapiDeviceEnumeration - Class which wraps Microsoft's IMM device enumeration API.

Constructor & Destructor Documentation

◆ FWasapiDeviceEnumeration()

Audio::FWasapiDeviceEnumeration::FWasapiDeviceEnumeration ( )
default

◆ ~FWasapiDeviceEnumeration()

Audio::FWasapiDeviceEnumeration::~FWasapiDeviceEnumeration ( )
default

Member Function Documentation

◆ GetDefaultInputDeviceId()

FString Audio::FWasapiDeviceEnumeration::GetDefaultInputDeviceId ( )

Returns the Id of the default input device.

◆ GetDefaultOutputDeviceId()

FString Audio::FWasapiDeviceEnumeration::GetDefaultOutputDeviceId ( )

Returns the Id of the default output device.

◆ GetDeviceIdFromIndex()

bool Audio::FWasapiDeviceEnumeration::GetDeviceIdFromIndex ( int32  InDeviceIndex,
EDataFlow  InDataFlow,
FString &  OutDeviceId 
)

GetDeviceIdFromIndex - Gets the device Id from a device index.

Parameters
InDeviceIndex- The index for the device to get the Id for.
InDataFlow- Indicates which device collection to search (render, capture or both).
OutDeviceId- Upon success, the Id of the device at the given index.
Returns
- Boolean indicating success or failure when looking up the device index.

◆ GetDeviceIndexFromId()

bool Audio::FWasapiDeviceEnumeration::GetDeviceIndexFromId ( const FString &  InDeviceId,
int32 &  OutDeviceIndex 
)

GetDeviceIndexFromId - Gets the index of a device with the given Id. Searches the collection of active devices for both capture and render data flows.

Parameters
InDeviceId- Device Id to get the index for.
OutDeviceIndex- Upon success, will contain the index for the device.
Returns
- Boolean indicating success or failure when looking up the device Id.

◆ GetDeviceInfo()

bool Audio::FWasapiDeviceEnumeration::GetDeviceInfo ( const FString &  InDeviceId,
FDeviceInfo &  OutDeviceInfo 
)

GetDeviceInfo - Gets the FDeviceInfo for the device with the given Id.

Parameters
InDeviceId- The Id of the device to fetch information for.
OutDeviceInfo- Upon success, the device info struct for the device. Untouched on failure.
Returns
- Boolean indicating success or failure when attempting to fetch the device info.

◆ GetIMMDevice()

bool Audio::FWasapiDeviceEnumeration::GetIMMDevice ( const FString &  InDeviceId,
TComPtr< IMMDevice > &  OutDevice 
)

GetIMMDevice - Gets a COM pointer to the IMMDevice for the give device Id.

Parameters
InDeviceId- Device Id of the device to get.
OutDevice- COM pointer to the device for the given Id.
Returns
- Boolean indicating success or failure when looking up the give Id.

◆ GetInputDevicesAvailable()

bool Audio::FWasapiDeviceEnumeration::GetInputDevicesAvailable ( TArray< FDeviceInfo > &  OutDevices)

GetInputDevicesAvailable - Gets the collection of currently active audio capture devices.

Parameters
OutDevices- TArray of FDeviceInfo objects for the currently available capture devices.
Returns
- Boolean indicating success or failure when access the collection of devices.

◆ Initialize()

void Audio::FWasapiDeviceEnumeration::Initialize ( )

Instantiates DeviceEnumerator and initializes the default input and output devices IDs.

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