mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add minimal documentation for the alsa endpoint SM module

Browse source
This commit is contained in:
Peter Hutterer 2021-08-02 13:51:53 +10:00 • committed by Wim Taymans
parent c2fef6caa2
commit 602bed7a98
2 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/media-session.dox
View file

@ -27,6 +27,6 @@ List of Media Session modules:
- \subpage page_media_session_module_access_flatpak
- \subpage page_media_session_module_access_portal
- \subpage page_media_session_module_alsa_endpoint
*/

9
src/examples/media-session/alsa-endpoint.c
View file

@ -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"