|
Size: 1752
Comment: update content - standard return value
|
Size: 1769
Comment: minor change
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| <<Color2(green,Alternate text suggestion here and in Remarks:)>><<BR>> Returns the number of available devices exposed by the current driver or a negative error code on failure; call [[SDL_GetError]]() for more information. See [[#Remarks|Remarks]] for details. |
<<Color2(green,Suggested alternate text here and in Remarks:)>><<BR>><<Color2(purple,Returns the number of available devices exposed by the current driver or a negative error code on failure; call [[SDL_GetError]]() for more information. See [[#Remarks|Remarks]] for details.)>> |
| Line 36: | Line 35: |
| <<Color2(green,This function will return -1 if an explicit list of devices can't be determined.)>> | <<Color2(purple,This function will return -1 if an explicit list of devices can't be determined.)>> |
DRAFT |
SDL_GetNumAudioDevices
Use this function to return the number of built in audio devices.
Contents
Syntax
int SDL_GetNumAudioDevices(int iscapture)
Function Parameters
iscapture |
non-0 to specify a device that has recording capability |
Return Value
Returns the number of available devices exposed by the current driver or -1 if an explicit list of devices can't be determined.
green
purple
Code Examples
int i, count = SDL_GetNumAudioDevices(0);
for ( i = 0; i < count; ++i ) {
printf("Audio device %d: %s\n", i, SDL_GetAudioDeviceName(i, 0));
}
Remarks
This function is only valid after successfully initializing the audio subsystem.
purple
Returning -1 is not an error. For example, if SDL is set up to talk to a remote audio server, it can't list every one available on the Internet, but it will still allow a specific host to be specified in SDL_OpenAudioDevice().
In many common cases, when this function returns a value <= 0, it can still successfully open the default device (NULL for first argument of SDL_OpenAudioDevice()).
