From 60528981c3853222c764bae7f0e01f265b0b37f1 Mon Sep 17 00:00:00 2001 From: boyska Date: Fri, 9 Sep 2016 11:35:05 +0200 Subject: [PATCH] FIX player/controller description --- doc/source/about.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/source/about.rst b/doc/source/about.rst index 0bece3c..161d682 100644 --- a/doc/source/about.rst +++ b/doc/source/about.rst @@ -43,17 +43,15 @@ action event An event is an alarm plus a list of actions. At given times, do those things -The main object is :class:`larigira.mpc.Player`; as the name says, it is the only object that sends messages -to MPD. How does it know what to do? there are two main flows: the continous playlist filling and the alarm +The main object is :class:`larigira.mpc.Controller`, which in turn uses :class:`larigira.mpc.Player` to control MPD. How does it know what to do? there are two main flows: the continous playlist filling and the alarm system. Continous playlist ~~~~~~~~~~~~~~~~~~ -:class:`larigira.mpc.Player` has a "child" called :class:`larigira.mpc.MpcWatcher`. It watches for events on -the playlist; when the playlist is changed it notifies Player, which in turn will check if the playlist has -enough songs. If that's the case, it will spawn an audiogenerator in a new greenlet; when the audio will be -ready, it will be added at the bottom of the playlist. +:class:`larigira.mpc.Controller` has a "child" called :class:`larigira.mpc.MpcWatcher`. It watches for events on +the playlist; when the playlist is changed it notifies Controller, which in turn will check if the playlist has +enough songs. If that's the case, it will run an audiogenerator, and add the resulting audio at the bottom of the playlist. Alarm system ~~~~~~~~~~~~