From bbfdb373937287b6f4e08bf97564dbee0999b53b Mon Sep 17 00:00:00 2001 From: David Reid Date: Sun, 10 Sep 2017 22:06:21 +1000 Subject: [PATCH] Update documentation. --- mini_al.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/mini_al.h b/mini_al.h index 18c5fc0c..a24fc62f 100644 --- a/mini_al.h +++ b/mini_al.h @@ -116,6 +116,8 @@ // - DirectSound currently supports a maximum of 4 periods. // - To capture audio on Android, remember to add the RECORD_AUDIO permission to your manifest: // +// - UWP is only supported when compiling as C++. +// - UWP only supports default playback and capture devices. // // // @@ -912,6 +914,8 @@ mal_result mal_context_uninit(mal_context* pContext); // // It is _not_ safe to assume the first enumerated device is the default device. // +// Some backends and platforms may only support default playback and capture devices. +// // Return Value: // - MAL_SUCCESS if successful. // - MAL_INVALID_ARGS @@ -948,6 +952,10 @@ mal_result mal_enumerate_devices(mal_context* pContext, mal_device_type type, ma // Consider using mal_device_config_init(), mal_device_config_init_playback(), etc. to make it easier // to initialize a mal_device_config object. // +// When compiling for UWP you must ensure you call this function on the main UI thread because the +// operating system may need to present the user with a message asking for permissions. Please refer +// to the official documentation for ActivateAudioInterfaceAsync() for more information. +// // Return Value: // - MAL_SUCCESS if successful. // - MAL_INVALID_ARGS @@ -9135,6 +9143,7 @@ void mal_pcm_f32_to_s32(int* pOut, const float* pIn, unsigned int count) // v0.4 - TBD // - Added support for OSS which enables support on BSD platforms. // - Added support for WinMM (waveOut/waveIn). +// - Added support for UWP (Universal Windows Platform) applications. Currently C++ only. // // v0.3 - 2017-06-19 // - API CHANGE: Introduced the notion of a context. The context is the highest level object and is required for @@ -9184,7 +9193,6 @@ void mal_pcm_f32_to_s32(int* pOut, const float* pIn, unsigned int count) // ------ // - Add support for exclusive mode? // - Look into event callbacks: AUDCLNT_STREAMFLAGS_EVENTCALLBACK -// - Clean up that terrible "__cplusplus" mess by implementing wrapper functions. // // // ALSA