vmpserverd: Mountpoint documentation

TUM-Dev · Mar 4, 2024 · bd10fd7 · bd10fd7
1 parent 34ffefb
commit bd10fd7
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 14 deletions.
diff --git a/Daemons/vmpserverd/profiles/com.hugomelder.software.plist b/Daemons/vmpserverd/profiles/com.hugomelder.software.plist
@@ -19,13 +19,14 @@
         Mountpoints and the underlying GStreamer pipelines are managed
         by the GStreamer RTSP server.
         
-        By default, a 1080p preset is used for both the single, and combined
-        mountpoints. As we only use "channels" in the context of video streams,
-        the additional key "audioProviders" specifies pipeline templates for
-        the audio channel.
+        You can choose between various types of mountpoints in the config.plist
+        (currently single, and combined), but every mountpoint needs a GStreamer
+        pipeline description.
         
-        Pipeline configurations for mountpoints should contain rtp payloaders
-        in the format pay%d, where %d is a non-negative integer.
+        Pipeline configurations for mountpoints must contain rtp payloaders as
+        sink elements in the format pay%d, where %d is a non-negative integer
+        (Further information can be found in the GStreamer RTSP Server
+        documentation).
         
         We use variables enclosed in '{}' for values that are populated during pipelines
         construction.

diff --git a/Daemons/vmpserverd/profiles/com.hugomelder.vaapi.plist b/Daemons/vmpserverd/profiles/com.hugomelder.vaapi.plist
@@ -16,14 +16,30 @@
         </array>
 
         <!--
-            A mountpoint is a single RTSP stream. Each mountpoint is configured in the
-            vmpserverd config.plist and receives a unique name.
-
-            You can choose between various types of mountpoints in the config.plist (currently single, and combined),
-            but every mountpoint needs a GStreamer pipeline description.
-
-            The sink of this pipeline must be a rtp payloader with the correct payload type (pt) and name
-            (See GStreamer RTSP Server for more information about the naming convention).
+        Mountpoints and the underlying GStreamer pipelines are managed
+        by the GStreamer RTSP server.
+            
+        You can choose between various types of mountpoints in the config.plist
+        (currently single, and combined), but every mountpoint needs a GStreamer
+        pipeline description.
+        
+        Pipeline configurations for mountpoints must contain rtp payloaders as
+        sink elements in the format pay%d, where %d is a non-negative integer
+        (Further information can be found in the GStreamer RTSP Server
+        documentation).
+        
+        We use variables enclosed in '{}' for values that are populated during pipelines
+        construction.
+        
+        Currently, the following variables are available:
+        - {VIDEOCHANNEL.%u}: The video channel name. Enumerated using unsigned
+        integers, starting at 0 (e.g. {VIDEOCHANNEL.0})
+        - {PULSEDEV}: The pulse audio device name
+        (e.g. alsa_input.pci-0000_00_03.0.analog-stereo)
+        
+        'pactl list sources short' lists all availables sources. The second column
+        in the table is the pulseaudio device name.
+        Replace 'sources' with 'sinks' to get a list of all available sinks.
         -->
         <key>mountpoints</key>
         <dict>