diff options
author | Christopher Rosell <chrippa@tanuki.se> | 2012-08-24 02:28:42 +0200 |
---|---|---|
committer | Christopher Rosell <chrippa@tanuki.se> | 2012-08-24 02:28:42 +0200 |
commit | 93af278d6170cb38eeb189fe8deb957b98d20876 (patch) | |
tree | dac21fc404df9326cb44200ca7b365f8163d0684 /src/livestreamer/stream.py | |
parent | 2846ee256b11ec3e577fab35f0c063e6428951b3 (diff) |
Add some docs.
Diffstat (limited to 'src/livestreamer/stream.py')
-rw-r--r-- | src/livestreamer/stream.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/livestreamer/stream.py b/src/livestreamer/stream.py index 398bb6f..e71e3bc 100644 --- a/src/livestreamer/stream.py +++ b/src/livestreamer/stream.py @@ -10,11 +10,21 @@ class StreamError(Exception): pass class Stream(object): + """ + This is a base class that should be inherited when implementing + different stream types. Should only be used directly from plugins. + """ + def __init__(self, session): self.session = session def open(self): - raise NotImplementedError + """ + Opens a connection to the stream. + Returns a file-like object than can be used to read data. + Raises :exc:`StreamError` on failure. + """ + raise NotImplementedError class StreamProcess(Stream): def __init__(self, session, params={}): |