mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-12-22 08:56:59 -05:00
media-session: add stub docs for all media-session modules
Same basic approach as for the pipewire modules
This commit is contained in:
parent
6d7e90fca2
commit
310b4611c8
20 changed files with 72 additions and 0 deletions
|
|
@ -28,5 +28,24 @@ List of Media Session modules:
|
||||||
- \subpage page_media_session_module_access_flatpak
|
- \subpage page_media_session_module_access_flatpak
|
||||||
- \subpage page_media_session_module_access_portal
|
- \subpage page_media_session_module_access_portal
|
||||||
- \subpage page_media_session_module_alsa_endpoint
|
- \subpage page_media_session_module_alsa_endpoint
|
||||||
|
- \subpage page_media_session_module_alsa_midi
|
||||||
|
- \subpage page_media_session_module_alsa_monitor
|
||||||
|
- \subpage page_media_session_module_bluez_endpoint
|
||||||
|
- \subpage page_media_session_module_bluez_monitor
|
||||||
|
- \subpage page_media_session_module_default_nodes
|
||||||
|
- \subpage page_media_session_module_default_profile
|
||||||
|
- \subpage page_media_session_module_default_routes
|
||||||
|
- \subpage page_media_session_module_libcamera_monitor
|
||||||
|
- \subpage page_media_session_module_logind
|
||||||
|
- \subpage page_media_session_module_metadata
|
||||||
|
- \subpage page_media_session_module_policy_endpoint
|
||||||
|
- \subpage page_media_session_module_policy_node
|
||||||
|
- \subpage page_media_session_module_restore_stream
|
||||||
|
- \subpage page_media_session_module_session_manager
|
||||||
|
- \subpage page_media_session_module_stream_endpoint
|
||||||
|
- \subpage page_media_session_module_stream_follow_default
|
||||||
|
- \subpage page_media_session_module_suspend_node
|
||||||
|
- \subpage page_media_session_module_v4l2_endpoint
|
||||||
|
- \subpage page_media_session_module_v4l2_monitor
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,9 @@
|
||||||
#define SEQ_NAME "seq"
|
#define SEQ_NAME "seq"
|
||||||
#define SND_SEQ_PATH SND_PATH"/"SEQ_NAME
|
#define SND_SEQ_PATH SND_PATH"/"SEQ_NAME
|
||||||
|
|
||||||
|
/** \page page_media_session_module_alsa_midi Media Session Module: ALSA MIDI
|
||||||
|
*/
|
||||||
|
|
||||||
#define DEFAULT_NAME "Midi-Bridge"
|
#define DEFAULT_NAME "Midi-Bridge"
|
||||||
|
|
||||||
struct impl {
|
struct impl {
|
||||||
|
|
|
||||||
|
|
@ -58,6 +58,8 @@
|
||||||
|
|
||||||
#include "reserve.c"
|
#include "reserve.c"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_alsa_monitor Media Session Module: ALSA Monitor
|
||||||
|
*/
|
||||||
#define SESSION_CONF "alsa-monitor.conf"
|
#define SESSION_CONF "alsa-monitor.conf"
|
||||||
|
|
||||||
#define DEFAULT_JACK_SECONDS 1
|
#define DEFAULT_JACK_SECONDS 1
|
||||||
|
|
|
||||||
|
|
@ -47,6 +47,8 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_bluez_endpoint Media Session Module: BlueZ Endpoint
|
||||||
|
*/
|
||||||
#define NAME "bluez-endpoint"
|
#define NAME "bluez-endpoint"
|
||||||
#define SESSION_KEY "bluez-endpoint"
|
#define SESSION_KEY "bluez-endpoint"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -47,6 +47,9 @@
|
||||||
#include "pipewire/impl.h"
|
#include "pipewire/impl.h"
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_bluez_monitor Media Session Module: BlueZ Monitor
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "bluez5-monitor"
|
#define NAME "bluez5-monitor"
|
||||||
#define SESSION_CONF "bluez-monitor.conf"
|
#define SESSION_CONF "bluez-monitor.conf"
|
||||||
#define FEATURES_CONF "bluez-hardware.conf"
|
#define FEATURES_CONF "bluez-hardware.conf"
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_default_nodes Media Session Module: Default Nodes
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "default-nodes"
|
#define NAME "default-nodes"
|
||||||
#define SESSION_KEY "default-nodes"
|
#define SESSION_KEY "default-nodes"
|
||||||
#define PREFIX "default."
|
#define PREFIX "default."
|
||||||
|
|
|
||||||
|
|
@ -45,6 +45,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_default_profile Media Session Module: Default Profile
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "default-profile"
|
#define NAME "default-profile"
|
||||||
#define SESSION_KEY "default-profile"
|
#define SESSION_KEY "default-profile"
|
||||||
#define PREFIX "default.profile."
|
#define PREFIX "default.profile."
|
||||||
|
|
|
||||||
|
|
@ -45,6 +45,8 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_default_routes Media Session Module: Default Routes
|
||||||
|
*/
|
||||||
#define NAME "default-routes"
|
#define NAME "default-routes"
|
||||||
#define SESSION_KEY "default-routes"
|
#define SESSION_KEY "default-routes"
|
||||||
#define PREFIX "default.route."
|
#define PREFIX "default.route."
|
||||||
|
|
|
||||||
|
|
@ -44,6 +44,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_libcamera_monitor Media Session Module: libCamera Monitor
|
||||||
|
*/
|
||||||
|
|
||||||
struct device;
|
struct device;
|
||||||
|
|
||||||
struct node {
|
struct node {
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_logind Media Session Module: Logind
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "logind"
|
#define NAME "logind"
|
||||||
|
|
||||||
struct impl {
|
struct impl {
|
||||||
|
|
|
||||||
|
|
@ -31,6 +31,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_metadata Media Session Module: Metadata
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "metadata"
|
#define NAME "metadata"
|
||||||
|
|
||||||
struct metadata {
|
struct metadata {
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_policy_endpoint Media Session Module: Policy Endpoint
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "policy-ep"
|
#define NAME "policy-ep"
|
||||||
#define SESSION_KEY "policy-endpoint"
|
#define SESSION_KEY "policy-endpoint"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_policy_node Media Session Module: Policy Node
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "policy-node"
|
#define NAME "policy-node"
|
||||||
#define SESSION_KEY "policy-node"
|
#define SESSION_KEY "policy-node"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -45,6 +45,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_restore_stream Media Session Module: Restore Stream
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "restore-stream"
|
#define NAME "restore-stream"
|
||||||
#define SESSION_KEY "restore-stream"
|
#define SESSION_KEY "restore-stream"
|
||||||
#define PREFIX "restore.stream."
|
#define PREFIX "restore.stream."
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_session_manager Media Session Module: Session Manager
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "session-manager"
|
#define NAME "session-manager"
|
||||||
#define SESSION_KEY "session-manager"
|
#define SESSION_KEY "session-manager"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -43,6 +43,9 @@
|
||||||
#include "pipewire/extensions/session-manager.h"
|
#include "pipewire/extensions/session-manager.h"
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_stream_endpoint Media Session Module: Stream Endpoint
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "stream-endpoint"
|
#define NAME "stream-endpoint"
|
||||||
#define SESSION_KEY "stream-endpoint"
|
#define SESSION_KEY "stream-endpoint"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -37,6 +37,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_stream_follow_default Media Session Module: Stream Follow Default
|
||||||
|
*/
|
||||||
|
|
||||||
#define KEY_NAME "policy-node.streams-follow-default"
|
#define KEY_NAME "policy-node.streams-follow-default"
|
||||||
|
|
||||||
int sm_streams_follow_default_start(struct sm_media_session *session)
|
int sm_streams_follow_default_start(struct sm_media_session *session)
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_suspend_node Media Session Module: Suspend Node
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "suspend-node"
|
#define NAME "suspend-node"
|
||||||
#define SESSION_KEY "suspend-node"
|
#define SESSION_KEY "suspend-node"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,9 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_v4l2_endpoint Media Session Module: V4L2 Endpoint
|
||||||
|
*/
|
||||||
|
|
||||||
#define NAME "v4l2-endpoint"
|
#define NAME "v4l2-endpoint"
|
||||||
#define SESSION_KEY "v4l2-endpoint"
|
#define SESSION_KEY "v4l2-endpoint"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -44,6 +44,8 @@
|
||||||
|
|
||||||
#include "media-session.h"
|
#include "media-session.h"
|
||||||
|
|
||||||
|
/** \page page_media_session_module_v4l2_monitor Media Session Module: V4L2 Monitor
|
||||||
|
*/
|
||||||
#define SESSION_CONF "v4l2-monitor.conf"
|
#define SESSION_CONF "v4l2-monitor.conf"
|
||||||
|
|
||||||
struct device;
|
struct device;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue