Some audio backends (such as Pipewire) allow you to describe the role of
your audio stream. Among other things, this description might show up in a
system control panel or software for displaying and manipulating media
playback/recording graphs.
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 (Game, Music, Movie,
etc...).
Setting this to "" or leaving it unset will have SDL use a reasonable
default: "Game" 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.
Specify an application role for an audio device.
Some audio backends (such as Pipewire) allow you to describe the role of your audio stream. Among other things, this description might show up in a system control panel or software for displaying and manipulating media playback/recording graphs.
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 (Game, Music, Movie, etc...).
Setting this to "" or leaving it unset will have SDL use a reasonable default: "Game" 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.