diff options
Diffstat (limited to 'doc/sydra.8.txt')
| -rw-r--r-- | doc/sydra.8.txt | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/doc/sydra.8.txt b/doc/sydra.8.txt index 6330b71..532f6de 100644 --- a/doc/sydra.8.txt +++ b/doc/sydra.8.txt @@ -20,6 +20,32 @@ sydra [ -P|--write-pid <filename> ] [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ] [ -U|--debug ] + [ -n|--appname <name> ] + [ -m|--mode (sender|reciever) ] + [ --source <bin description> ] + [ --video-encoder <bin description> ] + [ --video-payloader <element> ] + [ --previewsink <bin description> ] + [ --audio-encoder <bin description> ] + [ --audio-payloader <element> ] + [ --video-caps <caps> ] + [ --video-depayloader <element> ] + [ --video-decoder <bin description> ] + [ --audio-caps <caps> ] + [ --audio-depayloader <element> ] + [ --audio-decoder <bin description> ] + [ --sink <bin description> ] + [ -a|--rtp-host <host> ] + [ -o|--rtp-port-base <port> ] + [ -A|--rtp-addr-local <address> ] + [ -O|--rtp-port-base-local <port> ] + [ -c|--no-auto-client ] + [ -t|--timeout <timeout> ] + [ -k|--keepalive-interval <interval> ] + [ --rec-video-encoder <bin description> ] + [ --rec-audio-encoder <bin description> ] + [ --rec-mux <element> ] + [ --rec-name-format <formatstring> ] .... @@ -38,6 +64,8 @@ OPTIONS The following options can be passed to the *sydra* daemon: +*global options* + *-D, --nodaemonize*:: This option instructs *sydra* to run in foreground instead of becoming a daemon which is the default. @@ -79,6 +107,132 @@ The following options can be passed to the *sydra* daemon: *stdout:5* (logging with maximum level). In future releases there might be additional output when this option is supplied. +*-n, --appname <name>*:: + This set the application name using 'g_set_prgname()'. It will be used for example + by xvimagesink for window title. + +*-m, --mode (sender|reciever)*:: + This sets the main mode of *sydra*. The sender will read raw video and audio + from the source bin and send it via RTP to one or more receivers. + + +*sender-mode only options* + +*--source <bin description>*:: + A gst-launch-style description for the raw video and audio bin. This bin must contain + an element called 'videosrc' and an element called 'audiosrc' which should each + contain a pad called 'src'. Theses pads will get connected to the encoder bins. + Example: + 'v4l2src ! videoconvert ! videoscale ! video/x-raw,format=I420,width=864,height=480 ! identity name="videosrc" + autoaudiosrc ! audio/x-raw,format=S16LE,channels=1,rate=48000 ! identity name="audiosrc"' + +*--video-encoder <bin description>*:: + Bin description for the video encoder. Example: 'videoconvert ! vp8enc' + +*--video-payloader <element>*:: + A RTP payloader element for the video codec in use. Example: 'rtpvp8pay' + +*--previewsink <bin description>*:: + A video sink element for local preview. Example: 'videoconvert ! textoverlay test="preview" ! xvimagesink' + +*--audio-encoder <bin description>*:: + Bin description for the audio encoder. Example: 'audioconveert ! opusenc' + +*--audio-payloader <element>*:: + A RTP payloader element for the audio codec in use. Example: 'rtpopuspay' + + +*receiver-mode only options* + +*--video-caps <caps>*:: + These caps will get assigned to incoming RTP packets for video. Example: + 'application/x-rtp,media=video,clock-rate=90000,encoding-name=VP8-DRAFT-IETF-01,caps="video/x-vp8"' + +*--video-depayloader <element>*:: + A RTP depayloader element for the video codec in use. Example: 'rtpvp8depay' + +*--video-decoder <bin description>*:: + Bin description for the video decoder. Example: 'vp8dec' + +*--audio-caps <caps>*:: + These caps will get assigned to incoming RTP packets for audio. Example: + 'application/x-rtp,media=audio,clock-rate=48000,payload=96,encoding-name=X-GST-OPUS-DRAFT-SPITTKA-00,caps="audio/x-opus"' + +*--audio-depayloader <element>*:: + A RTP depayloader element for the audio codec in use. Example: 'rtpopusdepay' + +*--audio-decoder <bin description>*:: + Bin description for the audio decoder. Example: 'opusdec' + +*--sink <bin description>*:: + A gst-launch-style description for the raw video and audio bin. This bin must contain + an element called 'videosink' and an element called 'audiosink' which should each + contain a pad called 'sink'. Theses pads will get connected to the decoder bins. + Example: + 'videoconvert name="videosink" ! videoscale add-borders=true ! xvimagesink + audioconvert name="audiosink" ! autoaudiosink' + +*options for RTP* + +*-a, --rtp-host <host>*:: + In 'sender' mode this sets the address or hostname of the remote RTP receiver. Please + mind that the remote RTP host is always added as a receiver and it shouldn't be + configured to send keepalives. This would re-add the receiver to the list of clients + and as a result duplicate packages will be sent. + Also the remote RTP host is excluded from client timeout handling and remove requests + from it will get ignored. + When you omit this in sender mode the automatic client detection will be used to add + receivers. + In 'receiver' mode keepalive messages will be sent to this host. Leave empty to disable + keepalive messages. + +*-o, --rtp-port-base <port>*:: + The base number for remote ports. *sydra* will send the RTP/RTCP packets using the following + mapping: + * rtp-port-base + 0: RTP Video + * rtp-port-base + 1: RTCP Video + * rtp-port-base + 2: RTP Audio + * rtp-port-base + 3: RTCP Audio + +*-A, --rtp-addr-local <address>*:: + The local address to wait for incoming UDP messages. Leave empty to listen on any address. + +*-O, --rtp-port-base-local <port>*:: + The base number for local ports to bind to. The same mapping as for the remote port-base is + used to map incoming RTP packets to the RTP bin. + +*-c, --no-auto-client*:: + This disables auto-detection for clients in 'sender' mode. Mind that if you disable the + automatic client detection and also omit the rtp-host option *sydra* won't send any RTP + messages. If configured recording will work but this is most probably not what you want. + +*-t, --timeout <timeout>*:: + This sets the client timeout in seconds in 'sender' mode. A value of 0 disables client + timeouts. This is not recommended. + +*-k, --keepalive-interval <interval>*:: + This sets the interval in seconds for sending out keepalive messages in 'receiver' mode. + A value of 0 disables keepalive messages and therefor the client auto detection won't + work for this client. + +*options for recording* + +*--rec-video-encoder <bin description>*:: + A bin description for the video encoder used for recording. If you leave this empty the + output from the RTP video encoder is used. Example: 'videoconvert ! jpegenc' + +*--rec-audio-encoder <bin description>*:: + A bin description for the audio encoder used for recording. If you leave this empty the + output from the RTP audio encoder is used. Example: 'audioconvert ! vorbisenc' + +*--rec-mux <element>*:: + A gstreamer muxer element used for recording. If you leave this empty recording will be + disabled. Example: 'matroskamux' + +*--rec-name-format <formatstring>*:: + A 'strftime' based format string which will be used to create the name for the + recorded file. Example: ./recordings/%Y-%m-%d_%H-%M-%S.mkv + BUGS ---- |