mirror of
				https://gitlab.freedesktop.org/pipewire/pipewire.git
				synced 2025-11-03 09:01:54 -05:00 
			
		
		
		
	modules: update docs
This commit is contained in:
		
							parent
							
								
									553bb3f5ed
								
							
						
					
					
						commit
						368dd51d04
					
				
					 3 changed files with 36 additions and 0 deletions
				
			
		| 
						 | 
					@ -23,6 +23,7 @@ module_sources = [
 | 
				
			||||||
  'module-pulse-tunnel.c',
 | 
					  'module-pulse-tunnel.c',
 | 
				
			||||||
  'module-rt.c',
 | 
					  'module-rt.c',
 | 
				
			||||||
  'module-raop-discover.c',
 | 
					  'module-raop-discover.c',
 | 
				
			||||||
 | 
					  'module-raop-sink.c',
 | 
				
			||||||
  'module-session-manager.c',
 | 
					  'module-session-manager.c',
 | 
				
			||||||
  'module-zeroconf-discover.c',
 | 
					  'module-zeroconf-discover.c',
 | 
				
			||||||
  'module-roc-source.c',
 | 
					  'module-roc-source.c',
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -48,6 +48,31 @@
 | 
				
			||||||
#include "module-zeroconf-discover/avahi-poll.h"
 | 
					#include "module-zeroconf-discover/avahi-poll.h"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/** \page page_module_raop_discover PipeWire Module: RAOP Discover
 | 
					/** \page page_module_raop_discover PipeWire Module: RAOP Discover
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * Automatically creates RAOP (Airplay) sink devices based on zeroconf
 | 
				
			||||||
 | 
					 * information.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * This module will load module-raop-sink for each discovered sink
 | 
				
			||||||
 | 
					 * with the right parameters.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## Module Options
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * This module has no options.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## Example configuration
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 *\code{.unparsed}
 | 
				
			||||||
 | 
					 * context.modules = [
 | 
				
			||||||
 | 
					 * {   name = libpipewire-raop-discover
 | 
				
			||||||
 | 
					 *     args = { }
 | 
				
			||||||
 | 
					 *     }
 | 
				
			||||||
 | 
					 * }
 | 
				
			||||||
 | 
					 * ]
 | 
				
			||||||
 | 
					 *\endcode
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## See also
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \ref page_module_raop_sink
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#define NAME "raop-discover"
 | 
					#define NAME "raop-discover"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -63,6 +63,16 @@
 | 
				
			||||||
#include "module-raop/rtsp-client.h"
 | 
					#include "module-raop/rtsp-client.h"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/** \page page_module_raop_sink PipeWire Module: AirPlay Sink
 | 
					/** \page page_module_raop_sink PipeWire Module: AirPlay Sink
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * Creates a new Sink to stream to an Airplay device.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## Module Options
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## Example configuration
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * ## See also
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \ref page_module_raop_discover
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#define NAME "raop-sink"
 | 
					#define NAME "raop-sink"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue