Changeset 1479:35d67ead94bf

Timestamp:

11/12/09 23:20:37 (4 months ago)

Author:

Mickael Royer <mickael.royer@…>

Branch:

default

convert_revision:

a1af50176df93e47f1c2a34262740dae9766062a

Message:

[docs] update protocol documentation

Ignore-this: 98e1a3e25be9e665e4ae70b3a54d9984

darcs-hash:20091112222037-b0006-c55e9d34768e9a38d27c0e23163dfd284dd125f0.gz

committer: Mickael Royer <mickael.royer@…>

Files:

• doc/deejayd_rpc_protocol (modified) (28 diffs)

doc/deejayd_rpc_protocol

@@ -127 +127 @@
   * webradio : _int_ id of the current webradio list
   * webradiolength : _int_ number of recorded webradio
+  * webradiosource : _str_ current source for webradio streams
+  * webradiosourcecat : _str_ current categorie for webradio
   * queue : _int_ id of the current queue
   * queuelength : _int_ length of the current queue
@@ -140 +142 @@
   * volume : `[0-100]` current volume value
   * state : [play-pause-stop] the current state of the player
-  * current : _int_:_int_:_str_ current media pos : current media file id :
-                                playing source name
+  * current : _int_:_int_:_str_ current media pos : current media file id : playing source name
   * time : _int_:_int_ position:length of the current media file
   * mode : [playlist-webradio-video] the current mode
-  * audio_updating_db : _int_ show when a audio library update
-                        is in progress
-  * audio_updating_error : _string_ error message that apppears when the
-                           audio library update has failed
-  * video_updating_db : _int_ show when a video library update
-                        is in progress
-  * video_updating_error : _string_ error message that apppears when the
-                           video library update has failed
+  * audio_updating_db : _int_ show when a audio library update is in progress
+  * audio_updating_error : _string_ error message that apppears when the audio library update has failed
+  * video_updating_db : _int_ show when a video library update is in progress
+  * video_updating_error : _string_ error message that apppears when the video library update has failed
 
 Arguments :
@@ -179 +176 @@
 ==== `setOption` ====
 
-Set player options "name" to "value" for mode "source",
-           Available options are :
-           * playorder (inorder, onemedia, random or random-weighted)
-           * repeat (0 or 1) 
+Set player options "name" to "value" for mode "source", Available options are :
+  * playorder (inorder, onemedia, random or random-weighted)
+  * repeat (0 or 1)
 
 Arguments :
@@ -207 +203 @@
 ==== `setRating` ====
 
-Set rating of media file with ids equal to media_id
-        for library 'type' 
+Set rating of media file with ids equal to media_id for library 'type' 
 
 Arguments :
@@ -222 +217 @@
 
 Change the player mode. Possible values are :
-  * playlist : to manage and listen songs
+  * playlist : to manage and listen songs in playlist
+  * panel : to manage and listen songs in panel mode (like itunes)
   * video : to manage and wath video file
   * dvd : to wath dvd
@@ -238 +234 @@
 For each available source, shows if it is activated or not.
    The answer consists in :
-  * playlist : 0 or 1 (actually always 1 because it does not need optionnal
-               dependencies)
-  * queue : 0 or 1 (actually always 1 because it does not need optionnal
-               dependencies)
-  * webradio : 0 or 1 (needs gst-plugins-gnomevfs to be activated)
-  * video : 0 or 1 (needs video dependencies, X display and needs to be
-            activated in configuration)
+  * playlist : 0 or 1
+  * panel : 0 or 1
+  * webradio : 0 or 1 (media backend has to be abble to read url streams)
+  * video : 0 or 1 (needs video dependencies, X display and needs to be activated in configuration)
   * dvd : 0 or 1 (media backend has to be able to read dvd)
 
@@ -260 +253 @@
 ==== `player.setPlayerOption` ====
 
-Set player option for the current media
-       Possible options are :
-         * zoom : set zoom (video only), min=-85, max=400
-         * audio_lang : select audio channel (video only)
-         * sub_lang : select subtitle channel (video only)
-         * av_offset : set audio/video offset (video only)
-         * sub_offset : set subtitle/video offset (video only)
-         * aspect_ratio : set video aspect ratio (video only)
-           available value are :
-               * auto
-               * 1:1
-               * 16:9
-               * 4:3
-               * 2.11:1 (for DVB)
+Set player option for the current media. Possible options are :
+  * zoom : set zoom (video only), min=-85, max=400
+  * audio_lang : select audio channel (video only)
+  * sub_lang : select subtitle channel (video only)
+  * av_offset : set audio/video offset (video only)
+  * sub_offset : set subtitle/video offset (video only)
+  * aspect_ratio : set video aspect ratio (video only), available values are :
+    * auto
+    * 1:1
+    * 16:9
+    * 4:3
+    * 2.11:1 (for DVB)
 
 Arguments :
@@ -353 +344 @@
 ==== `player.seek` ====
 
-Seeks to the position "pos" (in seconds) of the current media
-           set relative argument to true to set new pos in relative way
+Seeks to the position "pos" (in seconds) of the current media set relative argument to true to set new pos in relative way
 
 Arguments :
@@ -393 +383 @@
 ==== `audiolib.taglist` ====
 
-List all the possible values for a tag according to the optional
-        filter argument.
+List all the possible values for a tag according to the optional filter argument.
 
 Arguments :
@@ -407 +396 @@
 
 Update the library.
-  * 'type'_updating_db : the id of this task.
-    It appears in the status until the update are completed.
+  * 'type'_updating_db : the id of this task. It appears in the status until the update are completed.
 
 Arguments :
@@ -447 +435 @@
 
 Update the library.
-  * 'type'_updating_db : the id of this task.
-    It appears in the status until the update are completed.
+  * 'type'_updating_db : the id of this task. It appears in the status until the update are completed.
 
 Arguments :
@@ -486 +473 @@
 ==== `playlist.addPath` ====
 
-Load files or directories passed as arguments ("paths")
-        at the position "pos" in the current playlist.
+Load files or directories passed as arguments ("paths") at the position "pos" in the current playlist.
 
 Arguments :
@@ -533 +519 @@
 ==== `playlist.addIds` ====
 
-Load files with id passed as arguments ("ids")
-        at the position "pos" in the current playlist.
+Load files with id passed as arguments ("ids") at the position "pos" in the current playlist.
 
 Arguments :
@@ -546 +531 @@
 ==== `playlist.remove` ====
 
-Remove songs with ids passed as argument ("ids"),
-           from the current playlist
+Remove songs with ids passed as argument ("ids") from the current playlist
 
 Arguments :
@@ -610 +594 @@
 
 Return active list in panel mode
-         * type : 'playlist' if playlist is choosen as active medialist
-                  'panel' if panel navigation is active
+         * type : 'playlist' if playlist is choosen as active medialist 'panel' if panel navigation is active
          * value : if 'playlist' is selected, return used playlist id
 
@@ -755 +738 @@
 === `Webradio Mode Commands` ===
 
-==== `webradio.add` ====
-
-Add a webradio. Its name is "name" and the url of the webradio is
-        "url". You can pass a playlist for "url" argument (.pls and .m3u format
-        are supported).
+==== `webradio.getSourceCategories` ====
+
+Return list of categories for webradio source 'source_name'
+
+Arguments :
+  * {{{source_name}}} (Mandatory) : string
+
+Expected return value : ''`['list']`''
+
+
+
+==== `webradio.localAdd` ====
+
+Add a webradio in 'local' source. Its name is "name" and the url of the webradio is "url". You can pass a playlist for "url" argument (.pls and .m3u format are supported).
 
 Arguments :
   * {{{name}}} (Mandatory) : string
-  * {{{url}}} (Mandatory) : string
-
-Expected return value : ''`['ack']`''
-
-
-
-==== `webradio.clear` ====
-
-Remove all recorded webradios.
-
-Arguments :
-  * ''This command does not accept any argument.''
-
-Expected return value : ''`['ack']`''
-
-
-
-==== `webradio.remove` ====
-
-Remove webradios with id in "ids".
+  * {{{url}}} (Mandatory) : list
+
+Expected return value : ''`['ack']`''
+
+
+
+==== `webradio.localRemove` ====
+
+Remove webradios with id in "ids" from the 'local' source.
 
 Arguments :
   * {{{ids}}} (Mandatory) : int-list
+
+Expected return value : ''`['ack']`''
+
+
+
+==== `webradio.localClear` ====
+
+Remove all recorded webradios from the 'local' source.
+
+Arguments :
+  * ''This command does not accept any argument.''
 
 Expected return value : ''`['ack']`''
@@ -803 +795 @@
 
 
+==== `webradio.setSourceCategorie` ====
+
+Set categorie to 'categorie' for current source
+
+Arguments :
+  * {{{categorie}}} (Mandatory) : string
+
+Expected return value : ''`['ack']`''
+
+
+
+==== `webradio.getAvailableSources` ====
+
+Return list of available sources for webradio mode as source_name: has_categories
+
+Arguments :
+  * ''This command does not accept any argument.''
+
+Expected return value : ''`['dict']`''
+
+
+
+==== `webradio.setSource` ====
+
+Set current source to 'source_name'
+
+Arguments :
+  * {{{source_name}}} (Mandatory) : string
+
+Expected return value : ''`['ack']`''
+
+
+
 
 
@@ -847 +872 @@
 ==== `queue.addIds` ====
 
-Load files with id passed as arguments ("ids")
-        at the position "pos" in the queue.
+Load files with id passed as arguments ("ids") at the position "pos" in the queue.
 
 Arguments :
@@ -883 +907 @@
 ==== `queue.addPath` ====
 
-Load files or directories passed as arguments ("paths")
-        at the position "pos" in the queue.
+Load files or directories passed as arguments ("paths") at the position "pos" in the queue.
 
 Arguments :
@@ -896 +919 @@
 ==== `queue.remove` ====
 
-Remove songs with ids passed as argument ("ids"),
-           from the queue
+Remove songs with ids passed as argument ("ids") from the queue
 
 Arguments :
@@ -937 +959 @@
 ==== `queue.addIds` ====
 
-Load files with id passed as arguments ("ids")
-        at the position "pos" in the queue.
+Load files with id passed as arguments ("ids") at the position "pos" in the queue.
 
 Arguments :
@@ -973 +994 @@
 ==== `queue.addPath` ====
 
-Load files or directories passed as arguments ("paths")
-        at the position "pos" in the queue.
+Load files or directories passed as arguments ("paths") at the position "pos" in the queue.
 
 Arguments :
@@ -986 +1006 @@
 ==== `queue.remove` ====
 
-Remove songs with ids passed as argument ("ids"),
-           from the queue
+Remove songs with ids passed as argument ("ids") from the queue
 
 Arguments :
@@ -1029 +1048 @@
 
 Create recorded playlist. The answer consist on
-          * pl_id : id of the created playlist
-          * name : name of the created playlist
-          * type : type of the created playlist
-          
+  * pl_id : id of the created playlist
+  * name : name of the created playlist
+  * type : type of the created playlist
 
 Arguments :
@@ -1055 +1073 @@
 ==== `recpls.staticAdd` ====
 
-Add songs in a recorded static playlist.
-           Argument 'type' has to be 'path' (default) or 'id'
+Add songs in a recorded static playlist. Argument 'type' has to be 'path' (default) or 'id'
 
 Arguments :
@@ -1106 +1123 @@
 
 Get properties of a magic playlist
-          * use-or-filter: if equal to 1, use "Or" filter
-            instead of "And" (0 or 1)
-          * use-limit: limit or not number of songs in the playlist (0 or 1)
-          * limit-value: number of songs for this playlist (integer)
-          * limit-sort-value: when limit is active sort playlist with this tag
-          * limit-sort-direction: sort direction for limit
-            (ascending or descending)
-          
+  * use-or-filter: if equal to 1, use "Or" filter instead of "And" (0 or 1)
+  * use-limit: limit or not number of songs in the playlist (0 or 1)
+  * limit-value: number of songs for this playlist (integer)
+  * limit-sort-value: when limit is active sort playlist with this tag
+  * limit-sort-direction: sort direction for limit (ascending or descending)
 
 Arguments :
@@ -1190 +1204 @@
 ==== `web.buildSourceRDF` ====
 
- Build rdf file with current medialist of the specified mode
-            return dict with specific informations (like a description)
+ Build rdf file with current medialist of the specified mode return dict with specific informations (like a description)
 
 Arguments :
@@ -1221 +1234 @@
 ==== `signal.setSubscription` ====
 
-Set subscribtion to "signal" signal notifications to "value"
-        which should be 0 or 1.
+Set subscribtion to "signal" signal notifications to "value" which should be 0 or 1.
 
 Arguments :