SDL_GetNumAudioDrivers(3)

SDL_GetNumAudioDrivers3

Use this function to get the number of built-in audio drivers.

Usage

#include "SDL3/SDL.h"

int SDL_GetNumAudioDrivers(void);

Header file

Defined in SDL3/SDL_audio.h

Overview

This function returns a hardcoded number. This never returns a negative value; if there are no drivers compiled into this build of SDL, this function returns zero. The presence of a driver in this list does not mean it will function, it just means SDL is capable of interacting with that interface. For example, a build of SDL might have esound support, but if there's no esound server available, SDL's esound driver would fail if used.

By default, SDL tries all drivers, in its preferred order, until one is found to be usable.

Return value

Returns the number of built-in audio drivers.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.