root object name playlist method name list static doc List the existin

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
<root>
<object name="playlist">
<method name="list">
<static/>
<doc>
List the existing playlists.
</doc>
<returns><list type="string"/></returns>
<code type="ipc-message">
<object>collection</object><!-- XMMS_IPC_OBJECT_COLLECTION -->
<method>list</method><!-- XMMS_IPC_CMD_COLLECTION_LIST -->
<string>Playlists</string><!-- XMMS_COLLECTION_NS_PLAYLISTS -->
</code>
</method>
<!-- if there is no <returns> tag then function returns void-like value,
so it can return nothing by error (or exception) -->
<method name="create">
<constructor/>
<doc>
Create a new empty playlist.
</doc>
<args>
<string name="playlist"/>
</args>
<code type="ipc-message">
<object>collection</object><!-- XMMS_IPC_OBJECT_COLLECTION -->
<method>save</method><!-- XMMS_IPC_CMD_COLLECTION_SAVE -->
<string var="playlist"/>
<string>Playlists</string><!-- XMMS_COLLECTION_NS_PLAYLISTS -->
<collection>
<type>XMMS_COLLECTION_TYPE_IDLIST</type>
</collection>
</code>
</method>
<!-- all usual methods have playlist name as their argument,
playlist name defaults to _active
-->
<method name="shuffle">
<doc>
Shuffles the current playlist.
</doc>
<code type="ipc-message">
<object>playlist</object><!-- XMMS_IPC_OBJECT_PLAYLIST -->
<method>shuffle</method><!-- XMMS_IPC_CMD_SHUFFLE -->
<string var="playlist"/>
</code>
</method>
<method name="add_url">
<doc>
Add the url to the playlist with optinal arguments.
The url should be absolute to the server-side.
Note that you will have to include the protocol for the url to.
ie: file://mp3/my_mp3s/first.mp3.
</doc>
<args>
<string name="url"/><!-- non-encoded URL -->
<optional>
<!--
encoded (sic!) args, xmmsc_playlist_add_args & _xmmsc_playlist_add_encoded
Example: ["foo=bar", "bar=baz"]
-->
<list type="string" name="args"/>
</optional>
</args>
<mangling>
<args number="1" name="add_args"/>
</mangling>
<code type="ipc-message">
<call>
<method name="add_encoded"/>
<string name="playlist"/>
<string name="urlencoded-url"/><!-- FIXME -->
</call>
</code>
</method>
<method name="add_id">
<doc>Add a medialib id to the playlist.</doc>
<args>
<uint32 name="lib_id"/>
</args>
<code type="ipc-message">
<object>playlist</object>
<method>add_id</method><!-- XMMS_IPC_CMD_ADD_ID -->
<string var="playlist"/>
<uint32 var="lib_id"/>
</code>
</method>
<method name="add_encoded">
<doc>Add the url to the playlist. The url should be absolute to the server-side AND encoded.</doc>
<args>
<string name="url"/>
</args>
<code type="ipc-message">
<object>playlist</object>
<method>add_url</method><!-- XMMS_IPC_CMD_ADD_URL -->
<string var="playlist"/>
<string var="url"/>
</code>
</method>
<method name="add_idlist">
<doc>Adds media in idlist (FIXME: WTF?) to a playlist.</doc>
<args>
<collection name="coll"/>
</args>
<returns>FIXME</returns>
<code type="ipc-message">
<object>playlist</object>
<method>add_idlist</method><!-- XMMS_IPC_CMD_ADD_IDLIST -->
<string var="playlist"/>
<collection var="coll"/>
</code>
</method>
<method name="add_collection">
<doc>
Add the content of the given collection to a playlist.
The list of ordering properties defines how the set of matching media is added.
</doc>
<args>
<collection name="coll"/>
<list type="string" name="order"/><!-- FIXME: improve that? -->
</args>
<code type="ipc-message">
<object>playlist</object>
<method>add_collection</method><!-- XMMS_IPC_CMD_ADD_COLL -->
<string var="playlist"/>
<collection var="coll"/>
<list type="string" var="order"/>
</code>
</method>
<method name="remove_entry">
<doc>Remove an entry from the playlist.</doc>
<args>
<uint32 name="pos"/><!-- The position that should be removed from the playlist. -->
</args>
<code type="ipc-message">
<object>playlist</object>
<method>remove_entry</method><!-- XMMS_IPC_CMD_REMOVE_ENTRY -->
<string var="playlist"/>
<uint32 var="pos"/>
</code>
</method>
<method name="clear">
<doc>Clears a playlist.</doc>
<code type="ipc-message">
<object>playlist</object>
<method>clear</method><!-- XMMS_IPC_CMD_CLEAR -->
<string var="playlist"/>
</code>
</method>
<method name="remove">
<doc>Remove the given playlist.</doc>
<code type="ipc-message">
<object>collection</object><!-- XMMS_IPC_OBJECT_COLLECTION -->
<method>remove</method><!-- XMMS_IPC_CMD_COLLECTION_REMOVE -->
<string var="playlist"/>
<string>Playlists</string><!-- XMMS_COLLECTION_NS_PLAYLISTS -->
</code>
</method>
<method name="list_entries">
<doc>Retrieve the entries in a playlist. </doc>
<returns><list type="uint32"/></returns>
<code type="ipc-message">
<object>playlist</object><!-- XMMS_IPC_OBJECT_PLAYLIST -->
<method>list_entries</method><!-- XMMS_IPC_CMD_LIST -->
<string var="playlist"/>
</code>
</method>
<method name="sort">
<doc>Sorts a playlist according to a list of properties.</doc>
<args><list type="string" name="properties"/></args>
<returns><list type="string"/></returns>
<code type="ipc-message">
<object>playlist</object><!-- XMMS_IPC_OBJECT_PLAYLIST -->
<method>sort</method><!-- XMMS_IPC_CMD_SORT -->
<string var="playlist"/>
<list type="string" var="properties"/>
</code>
</method>
<method name="set_next">
<static/>
<doc>Set next entry in the playlist. Alter the position pointer.</doc>
<returns><uint32/><doc>Some ID of collection entry</doc></returns>
<args><uint32 name="position"/></args>
<code type="ipc-message">
<object>playlist</object>
<method>set_next</method><!-- XMMS_IPC_CMD_SET_POS -->
<uint32 var="position"/>
</code>
</method>
<method name="set_next_rel">
<static/>
<doc>Set next entry in the playlist. Alter the position pointer.</doc>
<returns><uint32/><doc>Some ID of collection entry</doc></returns>
<args><int32 name="position"/></args>
<code type="ipc-message">
<object>playlist</object>
<method>set_next_rel</method><!-- XMMS_IPC_CMD_SET_POS_REL -->
<int32 var="position"/>
</code>
</method>
<method name="move_entry">
<doc>Move a playlist entry to a new position (absolute move)</doc>
<args>
<uint32 name="cur_pos"/>
<uint32 name="new_pos"/>
</args>
<code type="ipc-message">
<object>playlist</object>
<method>move_entry</method><!-- XMMS_IPC_CMD_MOVE_ENTRY -->
<string var="playlist"/>
<uint32 var="cur_pos"/>
<uint32 var="new_pos"/>
</code>
</method>
<method name="">
<doc></doc>
<args>
</args>
<code type="ipc-message">
<object>playlist</object>
<method></method><!-- -->
</code>
</method>
</object>
</root>