[vlma-devel] commit: More documentation. (Adrien Grand )

[git version control]

vlma | branch: master | Adrien Grand <jpountz at videolan.org> | Sun Dec 20 15:38:11 2009 +0100| [bba9f9b8f196c83c5bf207d0cfca491a2616fa35] | committer: Adrien Grand 

More documentation.

> http://git.videolan.org/gitweb.cgi/vlma.git/?a=commit;h=bba9f9b8f196c83c5bf207d0cfca491a2616fa35
---

 vlma-watchdog/src/streamer/api.py |   17 ++++++++++++++++-
 1 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/vlma-watchdog/src/streamer/api.py b/vlma-watchdog/src/streamer/api.py
index 066c07d..c8b6937 100644
--- a/vlma-watchdog/src/streamer/api.py
+++ b/vlma-watchdog/src/streamer/api.py
@@ -103,12 +103,15 @@ class Streamer:
     self.__lock.release()
 
   def can_stream(self, order):
+    """Return whether this streamer can stream the provided order"""
     return False
 
   def start_streaming(self, order):
+    """Start streaming the provided order"""
     pass
 
   def stop_streaming(self, order):
+    """Stop streaming the provided order"""
     pass
 
 
@@ -188,6 +191,8 @@ class StreamerRunner(threading.Thread):
 
 
 class LogReader(threading.Thread):
+  """A thread which consumes the running program logs in order to make them
+  available from the Web interface"""
 
   def __init__(self, sid, size, input, files, output_queue, output_lock):
     threading.Thread.__init__(self)
@@ -292,6 +297,7 @@ class StreamerMonitor(threading.Thread):
 
 
 class Order:
+  """Base class for streaming orders"""
 
   def __init__(self, id):
     self.id = id
@@ -301,6 +307,8 @@ class Order:
 
 
 class Dest:
+   """A destination. Describes what to do with the stream (how and where to
+   stream, transcoding, etc.)"""
 
   def __init__(self):
     self.streaming = Streaming()
@@ -308,6 +316,7 @@ class Dest:
 
 
 class Streaming:
+  """Describes where and how to stream."""
 
   def __init__(self, type="broadcast", protocol="udp", mux="raw", ip="0.0.0.0", port=1234):
     self.type = type
@@ -319,6 +328,7 @@ class Streaming:
 
 
 class Transcoding:
+  """Describes how to transcode the stream."""
 
   def __init__(self):
     self.vcodec = "mp2v"
@@ -330,6 +340,7 @@ class Transcoding:
 
 
 class DVBOrder(Order):
+  """Base class for DVB orders"""
 
   def __init__(self, id):
     Order.__init__(self, id)
@@ -338,28 +349,32 @@ class DVBOrder(Order):
 
 
 class DVBTOrder(DVBOrder):
+  """A DVB-T order"""
 
   def __init__(self, id):
     DVBOrder.__init__(self, id)
 
 
 class DVBSOrder(DVBOrder):
+  """A DVB-S order"""
 
   def __init__(self, id):
     DVBOrder.__init__(self, id)
-    self.fec = 9
+    self.fec = 9        # the error correction
     self.voltage = 13   # 13 for vertical polarization, 18 for horizontal
     self.srate = 0      # symbol rate
     self.bandwidth = 8  # DVB bandwidth
 
 
 class StreamOrder(Order):
+  """A stream order"""
 
   def __init__(self, id):
     Order.__init__(self, id)
 
 
 class FilesOrder(Order):
+  """A files order"""
 
   def __init__(self, id):
     Order.__init__(self, id)