Wiki Page Content

Differences between revisions 8 and 9
Revision 8 as of 2010-09-23 20:07:42
Size: 1508
Editor: SheenaSmith
Comment: minor change
Revision 9 as of 2011-01-13 05:06:21
Size: 1511
Editor: SheenaSmith
Comment: update content for consistency - non-zero
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
||'''iscapture'''||non-0 to specify a device that has recording capability|| ||'''iscapture'''||non-zero to specify a device that has recording capability||

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-zero to specify a device that has recording capability

Return Value

Returns the name of the audio device at the requested index.

green

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.


CategoryAPI, CategoryAudio

None: SDL_GetAudioDeviceName (last edited 2016-04-15 22:07:37 by PhilippWiesemann)

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