mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-02 09:01:50 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

module-raop-sink: add more docs

Browse source
This commit is contained in:
Wim Taymans 2022-09-13 12:10:48 +02:00
parent 3b89e6f369
commit 4b16eee27a
1 changed files with 60 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

61
src/modules/module-raop-sink.c
View file

@ -66,10 +66,63 @@
*
* Creates a new Sink to stream to an Airplay device.
*
* Normally this sink is automatically created with \ref page_module_raop_discover
* with the right parameters but it is possible to manually create a RAOP sink
* as well.
*
* ## Module Options
*
* Options specific to the behavior of this module
*
* - `raop.hostname`: The hostname of the remote end.
* - `raop.port`: The port of the remote end.
* - `raop.transport`: The data transport to use, one of "udp" or "tcp". Defaults
* to "udp".
* - `raop.encryption.type`: The encryption type to use. One of "none", "RSA" or
* "auth_setup". Default is "none".
* - `raop.audio.codec`: The audio codec to use. Needs to be "PCM". Defaults to "PCM".
* - `raop.password`: The password to use.
* - `stream.props = {}`: properties to be passed to the sink stream
*
* Options with well-known behavior.
*
* - \ref PW_KEY_REMOTE_NAME
* - \ref PW_KEY_AUDIO_FORMAT
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION
* - \ref PW_KEY_NODE_NAME
* - \ref PW_KEY_NODE_DESCRIPTION
* - \ref PW_KEY_NODE_GROUP
* - \ref PW_KEY_NODE_LATENCY
* - \ref PW_KEY_NODE_VIRTUAL
* - \ref PW_KEY_MEDIA_CLASS
*
* ## Example configuration
*
*\code{.unparsed}
* context.modules = [
* { name = libpipewire-module-raop-sink
* args = {
* # Set the remote address to tunnel to
* raop.hostname = "my-raop-device"
* raop.port = 8190
* #raop.transport = "udp"
* raop.encryption = "RSA"
* #raop.audio.codec = "PCM"
* #raop.password = "****"
* #audio.format = "S16"
* #audio.rate = 44100
* #audio.channels = 22
* #audio.position = [ FL FR ]
* stream.props = {
* # extra sink properties
* }
* }
* }
* ]
*\endcode
*
* ## See also
*
* \ref page_module_raop_discover
@ -106,7 +159,13 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_LATENCY (DEFAULT_RATE*2)
#define MODULE_USAGE "[ node.latency=<latency as fraction> ] " \
#define MODULE_USAGE "[ raop.hostname=<name of host> ] " \
"[ raop.port=<remote port> ] " \
"[ raop.transport=<transport, default:udp> ] " \
"[ raop.encryption.type=<encryption, default:none> ] " \
"[ raop.audio.codec=PCM ] " \
"[ raop.password=<password for auth> ] " \
"[ node.latency=<latency as fraction> ] " \
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \