From af8ee57cd2852249da4dbd0082b6cf6d32eacffe Mon Sep 17 00:00:00 2001
From: Uriziel <urizieli@gmail.com>
Date: Wed, 9 Jan 2013 21:27:59 +0100
Subject: [PATCH] Documented basePlayer interface a bit

---
 syncplay/players/basePlayer.py | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/syncplay/players/basePlayer.py b/syncplay/players/basePlayer.py
index 664a9ff..327850b 100644
--- a/syncplay/players/basePlayer.py
+++ b/syncplay/players/basePlayer.py
@@ -1,23 +1,47 @@
 from syncplay import constants
 class BasePlayer(object):
+  
+    '''
+    This method is supposed to 
+    execute updatePlayerStatus(paused, position) on client
+    Given the arguments: boolean paused and float position in seconds 
+    '''
     def askForStatus(self):
         raise NotImplementedError()
 
+    '''
+    Display given message on player's OSD or similar means
+    '''
     def displayMessage(self, message, duration = constants.OSD_DURATION):
         raise NotImplementedError()
 
+    '''
+    Cleanup connection with player before syncplay will close down
+    '''
     def drop(self):
         raise NotImplementedError()
 
+    '''
+    Start up the player, returns its instance
+    '''
     @staticmethod
     def run(client, playerPath, filePath, args):
         raise NotImplementedError()
 
+    '''
+    @type value: boolean 
+    '''
     def setPaused(self, value):
         raise NotImplementedError()
 
+    '''
+    @type value: float 
+    '''
     def setPosition(self, value):
         raise NotImplementedError()
 
+    '''
+    @type value: float 
+    '''
     def setSpeed(self, value):
         raise NotImplementedError()