devela::_dep::sdl3::hint::names

Constant AUDIO_DEVICE_STREAM_NAME

pub const AUDIO_DEVICE_STREAM_NAME: &'static str;
Available on crate feature dep_sdl3 only.
Expand description

Specify an audio stream name for an audio device.

Some audio backends (such as PulseAudio) allow you to describe your audio stream. Among other things, this description might show up in a system control panel that lets the user adjust the volume on specific audio streams instead of using one giant master volume slider.

This hints lets you transmit that information to the OS. The contents of this hint are used while opening an audio device. You should use a string that describes your what your program is playing (“audio stream” is probably sufficient in many cases, but this could be useful for something like “team chat” if you have a headset playing VoIP audio separately).

Setting this to “” or leaving it unset will have SDL use a reasonable default: “audio stream” or something similar.

Note that while this talks about audio streams, this is an OS-level concept, so it applies to a physical audio device in this case, and not an [SDL_AudioStream], nor an SDL logical audio device.

This hint should be set before an audio device is opened.

§Availability

This hint is available since SDL 3.2.0.