Wiki Page Content

Revision 3 as of 2009-11-15 02:21:41

Clear message

SDL_GetAudioDeviceName

Use this function to get the name of a specific audio device.

Syntax

const char * SDL_GetAudioDeviceName (int index,
                                     int iscapture)

Function Parameters

index

the index of the audio device; the value ranges from 0 to 1 - SDL_GetNumAudioDevices()

iscapture

non-0 to specify a device that has recording capability

Return Value

The name of the audio device at the requested index.

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. The values returned by this function reflect the latest call to SDL_GetNumAudioDevices(); re-call that function to re-detect available hardware.

The string returned by this function is UTF-8 encoded, read-only, and managed internally. You are not to free it. If you need to keep the string for any length of time, you should make your own copy of it, as it will be invalid next time any of several other SDL functions is called.

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