Version
menu

Microphone Selection API

The following APIs are for input device selection.

This is a Windows-only feature. It returns 0 on other platforms.

/**
 * @brief Retrieves the number of available microphone devices.
 * 
 * @return int The number of available microphone devices.
 */
int GMEPlugin_API_CALL GMEWWisePlugin_GetMicCount();
        
/**
 * @brief Populates a list with information about available microphone devices.
 * @param mic_list The pointer to the array of DEV_INFO structure to be filled with microphone information.
 * @param count The number of microphone devices to retrieve information for. This cannot exceed the size of the mic_list array.
 */
void GMEPlugin_API_CALL GMEWWisePlugin_GetMicList(DEV_INFO* mic_list , int count);
        
/**
 * @brief Selects a microphone device to be used.
 * 
 * @param micId The ID of the microphone device to select.
 */
void GMEPlugin_API_CALL GMEWWisePlugin_SelectMicDevice(int micId);
        
/**
* @brief Get information about the currently selected microphone device
* @param[out] pInfo Pointer to DEV_INFO structure that receives the microphone device information.
*	The structure contains two fields:
*	- strDevNameUTF8: Device name in UTF-8 encoding
*	- strDevIdUTF8: Device ID in UTF-8 encoding
*	Caller must ensure the pointer is valid and the structure has sufficient memory allocated 
*	(at least 512 bytes for each field).
* @return Operation result code:
*	0: Successfully retrieved device information
*	Non-zero: Failed to get device information. See the SDK documentation for error codes.
*/
int GMEPlugin_API_CALL GMEWWisePlugin_GetCurrentMicDeviceInfo(DEV_INFO* pInfo);
        

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise