Basic docstrings for new helpers

This commit is contained in:
Thomas Adamcik 2011-05-05 20:21:17 +02:00
parent e1cc1dfe48
commit b966c0fd1b

View File

@ -184,15 +184,24 @@ class GStreamer(ThreadingActor):
return handeled return handeled
def start_playback(self): def start_playback(self):
"""Notify GStreamer that it should start playback"""
return self._set_state(gst.STATE_PLAYING) return self._set_state(gst.STATE_PLAYING)
def pause_playback(self): def pause_playback(self):
"""Notify GStreamer that it should pause playback"""
return self._set_state(gst.STATE_PAUSED) return self._set_state(gst.STATE_PAUSED)
def prepare_change(self): def prepare_change(self):
"""
Notify GStreamer that we are about to change state of playback.
This function always needs to be called before changing URIS or doing
changes like updating data that is being pushed.
"""
return self._set_state(gst.STATE_READY) return self._set_state(gst.STATE_READY)
def stop_playback(self): def stop_playback(self):
"""Notify GStreamer that is should stop playback"""
return self._set_state(gst.STATE_NULL) return self._set_state(gst.STATE_NULL)
def _set_state(self, state): def _set_state(self, state):