From e81f683a1805871fa671485dc2a6327763ef1cf0 Mon Sep 17 00:00:00 2001
From: Romain Bignon <romain@peerfuse.org>
Date: Mon, 30 Mar 2009 00:01:02 +0200
Subject: implemented the 'consume' mode

Consume mode removes each song played
---
 doc/protocol.xml | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'doc')

diff --git a/doc/protocol.xml b/doc/protocol.xml
index 3dcfedeb5..0096ed672 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -222,6 +222,12 @@
                 <returnvalue>0 or 1</returnvalue>
                </para>
               </listitem>
+              <listitem>
+               <para>
+                <varname>consume</varname>:
+                <returnvalue>0 or 1</returnvalue>
+               </para>
+              </listitem>
               <listitem>
                 <para>
                   <varname>playlist</varname>:
@@ -352,6 +358,21 @@
     <section>
       <title>Playback options</title>
 
+        <varlistentry id="command_consume">
+          <term>
+            <cmdsynopsis>
+              <command>consume</command>
+              <arg choice="req"><replaceable>STATE</replaceable></arg>
+            </cmdsynopsis>
+          </term>
+          <listitem>
+            <para>
+              Sets consume state to <varname>STATE</varname>,
+              <varname>STATE</varname> should be 0 or 1.
+	      When consume is activated, each song played is removed from playlist.
+            </para>
+          </listitem>
+        </varlistentry>
       <variablelist>
         <varlistentry id="command_crossfade">
           <term>
-- 
cgit v1.2.3