diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 1 | ||||
| -rw-r--r-- | doc/sydra-rtp.8 | 4 | ||||
| -rw-r--r-- | doc/sydra-rtp.8.txt | 1 |
3 files changed, 4 insertions, 2 deletions
diff --git a/doc/Makefile b/doc/Makefile index 09e6b49..185a01b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,7 +6,6 @@ ## sydra has been written to be used for the Elevate Festival in Graz ## Austria in order to involve external locations to present themselves ## at the festival. -## Sydra is based on GStreamer and is written in C. ## ## ## Copyright (C) 2014 Christian Pointner <equinox@spreadspace.org> diff --git a/doc/sydra-rtp.8 b/doc/sydra-rtp.8 index 48a739f..a768495 100644 --- a/doc/sydra-rtp.8 +++ b/doc/sydra-rtp.8 @@ -70,7 +70,9 @@ sydra\-rtp .fi .SH "DESCRIPTION" .sp -\fBsydra\fR is a toolbox which allows you to set up multiple bidirectional Video/Audio streams from external locations\&. \fBsydra\fR has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival\&. This manpage describes \fBsydra\-rtp\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\-rtp\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\-rtp\fR are required on both sides of the communication\&. \fBsydra\-rtp\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. +\fBsydra\fR is a toolbox which allows you to set up multiple bidirectional Video/Audio streams from external locations\&. \fBsydra\fR has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival\&. +.sp +This manpage describes \fBsydra\-rtp\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\-rtp\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\-rtp\fR are required on both sides of the communication\&. \fBsydra\-rtp\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. .SH "OPTIONS" .sp The following options can be passed to the \fBsydra\-rtp\fR daemon: diff --git a/doc/sydra-rtp.8.txt b/doc/sydra-rtp.8.txt index 4fd87b0..31c1585 100644 --- a/doc/sydra-rtp.8.txt +++ b/doc/sydra-rtp.8.txt @@ -57,6 +57,7 @@ Video/Audio streams from external locations. *sydra* has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival. + This manpage describes *sydra-rtp* the basic utility for the task which is based on GStreamer and is written in C. The *sydra-rtp* utility creates a gstreamer pipeline to send or receive |