mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-01 22:58:50 -04:00
doc: add minimal documentation for the alsa endpoint SM module
This commit is contained in:
parent
c2fef6caa2
commit
602bed7a98
2 changed files with 10 additions and 1 deletions
|
|
@ -49,6 +49,15 @@
|
|||
|
||||
#include "media-session.h"
|
||||
|
||||
/** \page page_media_session_module_alsa_endpoint Media Session Module: ALSA Endpoint
|
||||
*
|
||||
* The ALSA endpoint module creates an endpoint and corresponding endpoint
|
||||
* stream for each Node on ALSA devices.
|
||||
*
|
||||
* ALSA devices are defined as devices with a \ref PW_KEY_MEDIA_CLASS
|
||||
* starting with `"Audio/"` and a \ref PW_KEY_DEVICE_API of `"alsa"`.
|
||||
*/
|
||||
|
||||
#define NAME "alsa-endpoint"
|
||||
#define SESSION_KEY "alsa-endpoint"
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue