Wiki Page Content

Differences between revisions 9 and 10
Revision 9 as of 2013-08-08 05:36:31
Size: 1703
Editor: RyanGordon
Comment: Updated.
Revision 10 as of 2013-08-08 05:37:23
Size: 1716
Editor: RyanGordon
Comment: tweaked
Deletions are marked like this. Additions are marked like this.
Line 15: Line 15:
||'''iscapture'''||non-zero to specify a device that has recording capability|| ||'''iscapture'''||zero to request playback devices, non-zero to request recording devices||

SDL_GetNumAudioDevices

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

Syntax

int SDL_GetNumAudioDevices(int iscapture)

Function Parameters

iscapture

zero to request playback devices, non-zero to request recording devices

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. A return value of -1 does not necessarily mean an error condition. 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.

Note that audio capture support is not implemented as of SDL 2.0.0, so the iscapture parameter is for future expansion and should always be zero for now.

This function will return -1 if an explicit list of devices can't be determined. 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

None: SDL_GetNumAudioDevices (last edited 2016-05-14 22:17:17 by PhilippWiesemann)

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