logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_HINT_AUDIO_DEVICE_STREAM_ROLE - Specify an application role for an audio device.

Availability

       This hint is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10               SDL_HINT_AUDIO_DEVICE_STREAM_ROLE(3)

Description

       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.

Header File

       Defined in SDL3/SDL_hints.h

Name

       SDL_HINT_AUDIO_DEVICE_STREAM_ROLE - Specify an application role for an audio device.

Synopsis

#include"SDL3/SDL.h"#defineSDL_HINT_AUDIO_DEVICE_STREAM_ROLESDL_AUDIO_DEVICE_STREAM_ROLE"

See Also