NAME¶

SDL_IsAudioDevicePhysical - Determine if an audio device is physical (instead of logical).

HEADER FILE¶

Defined in SDL3/SDL_audio.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_IsAudioDevicePhysical(SDL_AudioDeviceID devid);

DESCRIPTION¶

An SDL_AudioDeviceID
that represents physical hardware is a physical device; there is one for each piece of hardware that SDL can see. Logical devices are created by calling

SDL_OpenAudioDevice
or

SDL_OpenAudioDeviceStream , and while each is associated with a physical device, there can be any number of logical devices on one physical device.

For the most part, logical and physical IDs are interchangeable--if you try to open a logical device, SDL understands to assign that effort to the underlying physical device, etc. However, it might be useful to know if an arbitrary device ID is physical or logical. This function reports which.

This function may return either true or false for invalid device IDs.

FUNCTION PARAMETERS¶

devid

the device ID to query.

RETURN VALUE¶

Returns true if devid is a physical device, false if it is logical.

THREAD SAFETY¶

It is safe to call this function from any thread.

AVAILABILITY¶

This function is available since SDL 3.2.0.