summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2014-10-02 23:36:04 +0200
committerChristian Pointner <equinox@spreadspace.org>2014-10-02 23:36:04 +0200
commite33207905014c96d19d304c28dd438a25a896ce6 (patch)
tree4b835d9e288f1493add7cb9a19edd393bf36c62b /README
parentfixed wrong handling of log_targets_ option (diff)
better distinction between sydra and sydra-rtp
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 16 insertions, 2 deletions
diff --git a/README b/README
index b8a6ccd..90b16e0 100644
--- a/README
+++ b/README
@@ -6,11 +6,25 @@ 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.
-Sydra is based on GStreamer and is written in C.
Sydra consists of several components:
- tba...
+sydra-rtp:
+ This is the basic utility for the task which is based on GStreamer and is
+ written in C.
+ The utility creates a gstreamer pipeline to send or receive RTP-based
+ Audio/Video streams. For a bidirectional connection 2 instances of sydra-rtp
+ are required on both sides of the communication. sydra-rtp 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
+ 'connections'. 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).
+
+tba...
Dependencies
============