Wiki Page Content

Revision 6 as of 2010-09-21 20:25:07

Clear message

DRAFT

SDL_GetNumAudioDevices

Use this function to return the number of built in audio devices.

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


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 for details.

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.

green

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()).


CategoryAPI, CategoryAudio

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit