me/portaudio
Watch
1
0
Fork
You've already forked portaudio
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add FIXME comment about changing the name of Pa_GetAvailableHostApis

Browse source
This commit is contained in:
Ross Bencina 2016-09-03 16:20:52 +10:00
commit 196f025981
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
include/portaudio.h
View file

@ -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 );