mirror of
https://github.com/Syncplay/syncplay
synced 2025-02-17 11:26:52 +00:00
Documented basePlayer interface a bit
This commit is contained in:
parent
0f824d2136
commit
af8ee57cd2
@ -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()
|
||||
|
Loading…
Reference in New Issue
Block a user