]> git.parisson.com Git - piplayer.git/commitdiff
add option doc
authorGuillaume Pellerin <yomguy@parisson.com>
Sun, 28 Jul 2013 09:21:10 +0000 (11:21 +0200)
committerGuillaume Pellerin <yomguy@parisson.com>
Sun, 28 Jul 2013 09:21:10 +0000 (11:21 +0200)
README.md
piplayer/player.py

index 817007fd891c3f10d57d9c6526a80a3547b9081c..f74b16008bc2c288b565971cb9128221bc00c57a 100644 (file)
--- 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'
+
+    ...
+```
index c46c381d6a1ccc5667d5b5ee44a2244475c13889..b906a714a967a2b3af101165e1099f79b200ae60 100644 (file)
@@ -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