SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetAudioDeviceName

Get the human-readable name of a specific audio device.

Syntax

const char* SDL_GetAudioDeviceName(int index,
                                   int iscapture);

Function Parameters

index

the index of the audio device; valid values range from 0 to SDL_GetNumAudioDevices() - 1

iscapture

non-zero to query the list of recording devices, zero to query the list of output devices.

Return Value

Returns the name of the audio device at the requested index, or NULL on error.

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 redetect 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 are called.

Version

This function is available since SDL 3.0.0.

Code Examples

int i, count = SDL_GetNumAudioDevices(0);

for (i = 0; i < count; ++i) {
    SDL_Log("Audio device %d: %s", i, SDL_GetAudioDeviceName(i, 0));
}
SDL_GetNumAudioDevices
SDL_GetDefaultAudioInfo

CategoryAPI, CategoryAudio


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.