SDL_GetAudioFormatName(3)

SDL_GetAudioFormatName3

Get the human readable name of an audio format.

Usage

#include "SDL3/SDL.h"

const char * SDL_GetAudioFormatName(SDL_AudioFormat format);

Header file

Defined in SDL3/SDL_audio.h

Function parameters

format

the audio format to query.

Return value

Returns the human readable name of the specified audio format or " SDL_AUDIO_UNKNOWN " if the format isn't recognized.

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.