From: Guillaume Pellerin <yomguy@parisson.com>
Date: Sun, 28 Jul 2013 09:21:10 +0000 (+0200)
Subject: add option doc
X-Git-Tag: 0.3~1^2~1
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=fe84a4ee00c49394de9650bd0910b7ac4400c2eb;p=piplayer.git

add option doc
---

diff --git a/README.md b/README.md
index 817007f..f74b160 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 PiPlayer : audio sample player for the Rpi
 ---------------------------------------------
 
-a gstreamer based media sample player for the Raspberry Pi trigerred by GPIO or OSC callbacks.
+a minimalistic gstreamer based media sample player for the Raspberry Pi trigerred by GPIO or OSC callbacks.
   
 
 Usage
@@ -52,3 +52,22 @@ DAEMON
  $ cp -ra etc/* /etc/
  $ update-rc.d piplayer defaults 5 1
 ```
+
+OPTIONS
+--------
+
+Some properties and options (like "auto next" and "looping") are tunable in the PiPlayer class:
+
+```
+class PiPlayer(object):
+    
+    osc_port = 12345
+    gpio_channel_play = 22
+    gpio_channel_stop = 24
+    playing = False
+    looping = False
+    auto_next = False
+    alsa_device = 'hw:0'
+
+    ...
+```
diff --git a/piplayer/player.py b/piplayer/player.py
index c46c381..b906a71 100644
--- a/piplayer/player.py
+++ b/piplayer/player.py
@@ -21,6 +21,8 @@
 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 # Boston, MA 02111-1307, USA.
 
+# Doc : https://code.google.com/p/raspberry-gpio-python/wiki/Inputs
+
 
 DEBUG = False