(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetAudioDeviceChannelMap

Get the current channel map of an audio device.

Header File

Syntax

int * SDL_GetAudioDeviceChannelMap(SDL_AudioDeviceID devid, int *count);

Function Parameters

SDL_AudioDeviceID	devid	the instance ID of the device to query.
int *	count	On output, set to number of channels in the map. Can be NULL.

Return Value

(int *) Returns an array of the current channel mapping, with as many elements as the current output spec's channels, or NULL if default. This should be freed with SDL_free() when it is no longer needed.

Remarks

Channel maps are optional; most things do not need them, instead passing data in the order that SDL expects.

Audio devices usually have no remapping applied. This is represented by returning NULL, and does not signify an error.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.