From b5f1ff125e85c6ce1ab919138a3c0fb019f033ee Mon Sep 17 00:00:00 2001 From: David Reid Date: Sun, 23 Feb 2025 09:31:52 +1000 Subject: [PATCH] Update documentation for ma_context_get_devices(). --- miniaudio.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/miniaudio.h b/miniaudio.h index f2ab25cf..7872c88c 100644 --- a/miniaudio.h +++ b/miniaudio.h @@ -8409,6 +8409,10 @@ Retrieves basic information about every active playback and/or capture device. This function will allocate memory internally for the device lists and return a pointer to them through the `ppPlaybackDeviceInfos` and `ppCaptureDeviceInfos` parameters. If you do not want to incur the overhead of these allocations consider using `ma_context_enumerate_devices()` which will instead use a callback. +Note that this only retrieves the ID and name/description of the device. The reason for only retrieving basic information is that it would otherwise require +opening the backend device in order to probe it for more detailed information which can be inefficient. Consider using `ma_context_get_device_info()` for this, +but don't call it from within the enumeration callback. + Parameters ----------