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_GetAudioDriver

Use this function to get the name of a built in audio driver.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

const char * SDL_GetAudioDriver(int index);

Function Parameters

int index the index of the audio driver; the value ranges from 0 to SDL_GetNumAudioDrivers() - 1.

Return Value

(const char *) Returns the name of the audio driver at the requested index, or NULL if an invalid index was specified.

Remarks

The list of audio drivers is given in the order that they are normally initialized by default; the drivers that seem more reasonable to choose first (as far as the SDL developers believe) are earlier in the list.

The names of drivers are all simple, low-ASCII identifiers, like "alsa", "coreaudio" or "wasapi". These never have Unicode characters, and are not meant to be proper names.

This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.

Code Examples

int i;

for (i = 0; i < SDL_GetNumAudioDrivers(); ++i) {
    printf("Audio driver %d: %s\n", i, SDL_GetAudioDriver(i));
}

See Also


CategoryAPI, CategoryAPIFunction, 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.