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.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

const char* SDL_GetAudioDeviceName(SDL_AudioDeviceID devid);

Function Parameters

SDL_AudioDeviceID devid the instance ID of the device to query.

Return Value

(const char *) Returns the name of the audio device, or NULL on error.

Remarks

The returned string follows the SDL_GetStringRule.

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 count;
SDL_AudioDeviceID *devices;
devices = SDL_GetAudioOutputDevices(&count);

for (int i = 0; i < count; ++i) {
    SDL_Log("Audio device %d: %s", i, SDL_GetAudioDeviceName(devices[i]));
}

SDL_free(devices);

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.