From: Ross Bencina <rossb@audiomulch.com>
Date: Sat, 3 Sep 2016 06:20:52 +0000 (+1000)
Subject: add FIXME comment about changing the name of Pa_GetAvailableHostApis
X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=196f0259814bee77567287603dc2fe419224f74e;p=portaudio

add FIXME comment about changing the name of Pa_GetAvailableHostApis
---

diff --git a/include/portaudio.h b/include/portaudio.h
index 5f98e15..0d72b52 100644
--- a/include/portaudio.h
+++ b/include/portaudio.h
@@ -320,7 +320,10 @@ PaError Pa_SelectHostApis( const PaHostApiTypeId *hostApiTypes, int count );
 */
 PaError Pa_GetSelectedHostApis( PaHostApiTypeId *hostApiTypes, int countAvailable, int *count );
 
-/** Returns the type ids of all available host APIs in initialization order.
+/** Returns the type ids of all compiled-in host APIs in initialization order.
+
+ Note that the compiled-in host APIs are not necessarily those that are
+ installed on the target system.
 
  @param hostApiTypes (IN/OUT) An array that will be filled with
  host API identifiers belonging to the PaHostApiTypeId enumeration.
@@ -329,6 +332,13 @@ PaError Pa_GetSelectedHostApis( PaHostApiTypeId *hostApiTypes, int countAvailabl
 
  @param countAvailable The number of available elements in the hostApiTypes array.
 
+ FIXME REVIEW: Consider a different name for this function, both "available"
+ and "supported" are ambiguous between what is available/supported on the
+ target platform and what is compiled into PA. Keep in mind that
+ Pa_IsFormatSupported refers to formats supported by a device.
+ Proposals:
+ GetConfiguredHostApis, GetCompiledHostApis
+
  @see Pa_SelectHostApis
 */
 PaError Pa_GetAvailableHostApis( PaHostApiTypeId *hostApiTypes, int countAvailable, int *count );