· 6 years ago · Nov 02, 2019, 06:56 AM
1 List of functions
2
3 Alive
4 Simple query to ensure the server is running and to check versions.
5 Response:
6 RuntimeGUID: The runtime GUID of this web service.
7 LibraryVersion: The version number of the library.
8 ProgramName: The name of the program.
9 ProgramVersion: The version number of the program.
10 FriendlyName: The friendly name of this server.
11 AccessKey: The access key of this server.
12 ProductVersion: The product version.
13 Platform: The computer platform, either Windows, Mac, or Linux.
14 Examples:
15 Click here
16
17 Authenticate
18 Simple query to test and establish authentication.
19 Response:
20 Token: The token that can be appended to calls in place of HTTP authentication.
21 ReadOnly: Whether the token is for read-only access. If not present or false, the token has full rights.
22 PreLicensed: True if MC is running in restricted mode
23 Examples:
24 Click here
25
26 Playback
27
28 Play
29 Start playback (does nothing if already playing).
30 Parameters:
31 Zone: The zone the command is targetted for. (default: -1)
32 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
33 Response:
34 Examples:
35 Click here
36
37 PlayPause
38 Start playback or toggle the pause state.
39 Parameters:
40 Zone: The zone the command is targetted for. (default: -1)
41 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
42 Response:
43 Examples:
44 Click here
45
46 Pause
47 Set the pause state.
48 Parameters:
49 State: The new pause state (0: unpaused, 1: paused, -1: toggle). (default: -1)
50 Zone: The zone the command is targetted for. (default: -1)
51 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
52 Response:
53 Examples:
54 Click here
55
56 Next
57 Advance to the next track.
58 Parameters:
59 Zone: The zone the command is targetted for. (default: -1)
60 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
61 Block: Set to one to block the call from returning until the next has finished. (default: )
62 Response:
63 Examples:
64 Click here
65
66 Previous
67 Advance to the previous track.
68 Parameters:
69 Zone: The zone the command is targetted for. (default: -1)
70 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
71 Block: Set to one to block the call from returning until the previous has finished. (default: )
72 Response:
73 Examples:
74 Click here
75
76 Stop
77 Stops playback.
78 Parameters:
79 Zone: The zone the command is targetted for. (default: -1)
80 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
81 Response:
82 Examples:
83 Click here
84
85 StopAll
86 Stops playback in all zones.
87 Response:
88 Examples:
89 Click here
90
91 Position
92 Get / set the position.
93 Parameters:
94 Position: The position to seek to, in milliseconds. (default: )
95 Relative: When set to 1, 'Position' will be added to the current position to allow jumping forward. When set to -1, 'Position' will be subtracted from the current position to allow jumping backwards. Use a 'Position' of -1 to jump the default amount based on the media type. (default: )
96 Zone: The zone the command is targetted for. (default: -1)
97 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
98 Response:
99 Position: The position in milliseconds (after applying changes, if any).
100 Examples:
101 Get current position
102 Seek 10 seconds into playing file
103 Jump backward (default amount)
104 Jump forward (default amount)
105 Jump forward 60 seconds
106
107 Volume
108 Get / set the volume.
109 Parameters:
110 Level: Level to change the volume to as a decimal from 0 to 1. Leave this blank to leave the volume unchanged and query for the current volume. (default: )
111 Relative: When set to 1, 'Level' will be added to the current volume to allow increasing or descreasing the volume by some amount. (default: )
112 Zone: The zone the command is targetted for. (default: -1)
113 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
114 Response:
115 Level: The volume as a decimal between 0 and 1 (after applying changes, if any).
116 Display: The volume as a display string (after applying changes, if any).
117 Examples:
118 Get current volume
119 Set volume to 75%
120 Increase volume 10%
121 Decrease volume 10%
122
123 Mute
124 Set the mute.
125 Parameters:
126 Set: When set to 1, playback will mute. When set to 0, playback will unmute. (default: )
127 Zone: The zone the command is targetted for. (default: -1)
128 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
129 Response:
130 State: The mute state after the setting.
131 Examples:
132 Mute playback
133
134 Repeat
135 Get / set the repeat state (Modes: Off, Playlist, Track, Stop, Toggle).
136 Parameters:
137 Mode: The new repeat mode. Leave this blank to query for the current mode. (default: )
138 Zone: The zone the command is targetted for. (default: -1)
139 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
140 Response:
141 Mode: The repeat mode (after applying changes, if any).
142 Examples:
143 Get current repeat mode
144 Set repeat mode to off
145 Set repeat mode to repeat playlist
146 Toggle the repeat mode
147
148 Shuffle
149 Get / set the shuffle state (Modes: Off, On, Automatic, Toggle, Reshuffle).
150 Parameters:
151 Mode: The new shuffle mode. Leave this blank to query for the current mode. (default: )
152 Zone: The zone the command is targetted for. (default: -1)
153 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
154 Response:
155 Mode: The shuffle mode (after applying changes, if any).
156 Examples:
157 Get current shuffle mode
158 Set shuffle mode to off
159 Set shuffle mode to on
160 Reshuffle the current playlist
161
162 Info
163 Get information about the current playback.
164 Parameters:
165 Zone: The zone the command is targetted for. (default: -1)
166 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
167 Response:
168 ZoneID: The zone ID of this zone.
169 ZoneName: The display name of this zone.
170 State: The playback state of the player.
171 FileKey: The database key of the playing file.
172 NextFileKey: The database key of the next file to play.
173 PositionMS: The position of the playback in milliseconds.
174 DurationMS: The duration of the playing file in milliseconds.
175 ElapsedTimeDisplay: The elapsed playback time as a display friendly string.
176 RemainingTimeDisplay: The remaining playback time as a display friendly string.
177 TotalTimeDisplay: The total playback time as a display friendly string.
178 PositionDisplay: The playback position as a display friendly string.
179 PlayingNowPosition: The index of the current track in Playing Now.
180 PlayingNowTracks: The number of files in Playing Now.
181 PlayingNowPositionDisplay: The current Playing Now position formatted for display.
182 PlayingNowChangeCounter: A counter that increments any time the playlist is changed.
183 Bitrate: The current bitrate, in kbps.
184 Bitdepth: The current bitdepth.
185 SampleRate: The current sample rate in Hz.
186 Channels: The number of audio channels in the current output.
187 Chapter: The current playback chapter.
188 Volume: The current volume.
189 VolumeDisplay: A display friendly string version of the current volume.
190 ImageURL: An image URL for the current file.
191 Artist: Artist of current file.
192 Album: Album of current file.
193 Name: Name of current file.
194 Rating: Rating of current file.
195 Status: Playback status as a displayable string.
196 LinkedZones: Semicolon delimited list of zone names in the link (only provided if this zone is part of a link).
197 Examples:
198 Get information
199
200 Playlist
201 Get the current playlist.
202 Parameters:
203 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
204 Shuffle: Set to 1 to shuffle the files. (default: )
205 ActiveFile: A file key to set as active (used as the file that playback starts with, etc.). (default: -1)
206 ActiveFileOnly: Set to 1 to trim the returned files to only contain the active file. (default: )
207 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
208 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
209 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
210 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
211 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
212 SaveName: A backslash delimited path used with the action 'Save'. (default: )
213 NoUI: Set to one to put the player in no UI mode. (default: )
214 Zone: The zone the command is targetted for. (default: -1)
215 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
216 Response:
217 Examples:
218 Get playlist
219
220 Zones
221 Get information about all zones.
222 Parameters:
223 Hidden: Set to 1 to see hidden zones. (default: )
224 Response:
225 NumberZones: The number of zones.
226 CurrentZoneID: The current zone ID.
227 CurrentZoneIndex: The current zone index.
228 ZoneName#: The name of the zone at index #.
229 ZoneID#: The ID of the zone at index #.
230 ZoneGUID#: The GUID of the zone at index #.
231 ZoneDLNA#: Whether the zone at index # is a DLNA zone.
232 Examples:
233 Get zone information
234
235 SetZone
236 Set the active zone.
237 Parameters:
238 Zone: The zone the command is targetted for. (default: -1)
239 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
240 Response:
241 Examples:
242 Click here
243
244 LinkZones
245 Links the specified zones.
246 Parameters:
247 Zone1: The zone the command is targetted for. (default: -1)
248 ZoneType1: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
249 Zone2: The zone the command is targetted for. (default: -1)
250 ZoneType2: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
251 Response:
252 Examples:
253 Click here
254
255 UnlinkZones
256 Unlinks the specified zone.
257 Parameters:
258 Zone: The zone the command is targetted for. (default: -1)
259 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
260 Response:
261 Examples:
262 Click here
263
264 PlayByIndex
265 Play a file in Playing Now.
266 Parameters:
267 Index: The index of the file to play (0 based). (default: 0)
268 NoUI: Set to one to put the player in no UI mode. (default: )
269 Zone: The zone the command is targetted for. (default: -1)
270 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
271 Response:
272 Examples:
273 Play the first file
274
275 PlayByKey
276 Play a file (or files) by database key.
277 Parameters:
278 Key: The list of keys of the files to play (seperated by comma). (default: -1)
279 Location: The location of the file. Use 'End' to add to the end of the current playlist, 'Next' to play next, or a number to insert at a specific index. (default: )
280 Album: Set to 1 to play the entire album starting at this file. (default: )
281 Zone: The zone the command is targetted for. (default: -1)
282 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
283 Response:
284 Examples:
285 Click here
286
287 PlayDoctor
288 Plays using Play Doctor.
289 Parameters:
290 Seed: The Play Doctor seed. (default: )
291 Zone: The zone the command is targetted for. (default: -1)
292 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
293 Response:
294 Examples:
295 Click here
296
297 PlayLive
298 Play from a live source.
299 Parameters:
300 Mode: The mode of live playback. (default: )
301 Zone: The zone the command is targetted for. (default: -1)
302 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
303 Response:
304 Examples:
305 Click here
306
307 LoadDSPPreset
308 Loads a DSP preset.
309 Parameters:
310 Name: The name of the preset to load. (default: )
311 Zone: The zone the command is targetted for. (default: -1)
312 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
313 Response:
314 Examples:
315 Click here
316
317 SetPlaylist
318 Set the current playlist.
319 Parameters:
320 Zone: The zone the command is targetted for. (default: -1)
321 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
322 Playlist: A serialized playlist. (default: )
323 Response:
324 Examples:
325 Click here
326
327 ClearPlaylist
328 Clear the current playlist and stop playback.
329 Parameters:
330 Zone: The zone the command is targetted for. (default: -1)
331 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
332 Response:
333 Examples:
334 Clear Playing Now
335
336 EditPlaylist
337 Edit the current playlist (move, remove, etc.)
338 Parameters:
339 Zone: The zone the command is targetted for. (default: -1)
340 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
341 Action: The edit action (Move, Remove). (default: )
342 Source: The source file index (0-based). (default: )
343 Target: The target index when moving (0-based). (default: )
344 Response:
345 Examples:
346 Remove the first file
347 Move a track to the first position
348
349 PlayAdvanced
350 Plays files using a PLAY_COMMAND object (for internal use).
351 Parameters:
352 PlayCommand: Serialized PLAY_COMMAND object (for internal use only). (default: )
353 Zone: The zone the command is targetted for. (default: -1)
354 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
355 Response:
356 Examples:
357 Click here
358
359 UpdatePlayStats
360 Update the play stats.
361 Parameters:
362 File: The file to update play stats for. (default: )
363 Response:
364 Examples:
365 Click here
366
367 PlayByFilename
368 Play a set of files by filename.
369 Parameters:
370 Filenames: A pipe delimited list of filenames to play. (default: )
371 Location: The location of the file. Use 'End' to add to the end of the current playlist, 'Next' to play next, or a number to insert at a specific index. (default: End)
372 Zone: The zone the command is targetted for. (default: -1)
373 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
374 Response:
375 Examples:
376 Click here
377
378 AudioPath
379 Gets the audio path information for the current playback.
380 Parameters:
381 Zone: The zone the command is targetted for. (default: -1)
382 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
383 Response:
384 AudioPath: The list of changes being made.
385 Direct: Whether we're in direct mode.
386 Examples:
387 Click here
388
389 PlayPlaylist
390 Plays a playlist.
391 Parameters:
392 Zone: The zone the command is targetted for. (default: -1)
393 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
394 Playlist: The ID of the playlist to play or the path. (default: )
395 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
396 Response:
397 Examples:
398 Click here
399
400 PlayRadioParadise
401 Plays Radio Paradise.
402 Parameters:
403 Zone: The zone the command is targetted for. (default: -1)
404 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
405 PlaylistOnly: Set to one to generate the playlist only. (default: )
406 Channel: The channel to play (defaults to zero). (default: )
407 Response:
408 PlaylistID: The playlist ID of the Radio Paradise stream.
409 Examples:
410 Click here
411
412 PlayRadioJRiver
413 Plays Radio JRiver.
414 Parameters:
415 Zone: The zone the command is targetted for. (default: -1)
416 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
417 Station: The name of the station. (default: )
418 Response:
419 Examples:
420 Click here
421
422 Library
423
424 List
425 Gets a list of libraries.
426 Response:
427 NumberOfLibraries: The number of libraries.
428 DefaultLibrary: The index of the default library.
429 Examples:
430 Click here
431
432 Load
433 Loads a library.
434 Parameters:
435 Library: The index of the library to load (from Library/List). (default: )
436 Response:
437 Examples:
438 Click here
439
440 Get
441 Get a copy of the library.
442 Parameters:
443 Settings: Whether settings should be included with the library. (default: 0)
444 IncrementalFileSignaturesXML: A block of XML containing file signatures. When this is provided, only changed files will be returned. (default: )
445 Response:
446 Examples:
447 Click here
448
449 GetStats
450 Get some stats about the library.
451 Response:
452 Files: The number of files in the library.
453 AudioFiles: The number of audio files in the library.
454 ImageFiles: The number of image files in the library.
455 VideoFiles: The number of video files in the library.
456 OtherFiles: The number of other files in the library.
457 Artists: The number of artists in the library.
458 Albums: The number of albums in the library.
459 Examples:
460 Click here
461
462 Merge
463 Merge changes into the library.
464 Parameters:
465 Delta: A binary package describing the changes. (default: )
466 Response:
467 MasterRevision: Library 'Master' revision number after changes have been applied.
468 SyncRevision: Library 'Sync' revision number after changes have been applied.
469 NewFiles: A semicolon delimited list of new files in the form: client key;server key;client key;server key;etc.
470 Examples:
471 Click here
472
473 GetRevision
474 Get the revision number of the library.
475 Response:
476 Master: The master revision number of the database.
477 Sync: The revision number of the database (only included sync-worthy revisions).
478 LibraryStartup: Timestamp of the Library Startup (ie. the last reset of the revision counter).
479 Examples:
480 Click here
481
482 Fields
483 Gets the fields in the library.
484 Response:
485 Examples:
486 Click here
487
488 CreateField
489 Creates a library field.
490 Parameters:
491 Name: The name of the field. (default: )
492 Type: The data type of the field (string or integer). (default: string)
493 Response:
494 Field: The name of the updated or created field.
495 Examples:
496 Click here
497
498 CreateFile
499 Creates a library file.
500 Response:
501 Key: The key of the new file.
502 Examples:
503 Click here
504
505 Connect
506 Connects to a remote library.
507 Parameters:
508 URL: A URL for connecting to a library server. (default: )
509 Response:
510 Examples:
511 Click here
512
513 Values
514 Get a list of values from the database (artists, albums, etc.).
515 Parameters:
516 Filter: Empty to get all values for a particular field, or some search to get matching values from any number of fields. (default: )
517 Field: A comma-delimited list of fields to get values from (leave blank when searching to search default fields). (default: )
518 Files: A search to use to get the files to retrieve values from (use empty to use all imported files). (default: )
519 Limit: Maximum number of values to return. (default: )
520 Version: The version of the data used for results (2 is the newest version). (default: 1)
521 Response:
522 Examples:
523 All artists
524 Image keywords
525 Search values for 'Dylan'
526 Search specific audio values for 'Rock'
527
528 Import
529 Imports files from a folder.
530 Parameters:
531 Path: The path to search for files. (default: )
532 Block: Whether the import should finish before the function returns. (default: 0)
533 Response:
534 Examples:
535 Click here
536
537 Playlists
538
539 List
540 Gets a list of all playlists.
541 Parameters:
542 Group: Only return playlists within this group. (default: )
543 IncludeMediaTypes: Return the media types of files in the playlist (comma separated list). Only valid for regular playlists, not smartlists. (default: )
544 Response:
545 Examples:
546 Get list of all playlists.
547 Get list of all playlists within the 'Smartlists' group.
548 Get list of all playlists and return the media types.
549
550 Add
551 Add a new playlist.
552 Parameters:
553 Type: The type of playlist to create (Playlist, Smartlist, Playlist Group). (default: )
554 Path: The full path to the new playlist. (default: )
555 Search: The search string to use to get the files to retrieve values from (use empty to use all imported files). (default: )
556 CreateMode: The creation mode (Overwite: overwrite the existing playlist at the path; Rename: rename the new playlist if a playlist already exists at the path). (default: )
557 Response:
558 PlaylistID: The ID of the newly created playlist.
559 Examples:
560 Create 'One Random Album' Smartlist
561
562 Playlist
563
564 Files
565 Gets the files of a playlist.
566 Parameters:
567 Playlist: The playlist the command is targetted for. (default: )
568 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
569 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
570 Shuffle: Set to 1 to shuffle the files. (default: )
571 ActiveFile: A file key to set as active (used as the file that playback starts with, etc.). (default: -1)
572 ActiveFileOnly: Set to 1 to trim the returned files to only contain the active file. (default: )
573 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
574 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
575 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
576 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
577 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
578 SaveName: A backslash delimited path used with the action 'Save'. (default: )
579 NoUI: Set to one to put the player in no UI mode. (default: )
580 Zone: The zone the command is targetted for. (default: -1)
581 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
582 Response:
583 Examples:
584 Click here
585
586 Delete
587 Deletes the playlist.
588 Parameters:
589 Playlist: The playlist the command is targetted for. (default: )
590 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
591 Response:
592 Examples:
593 Click here
594
595 AddFile
596 Add a file to a playlist.
597 Parameters:
598 Playlist: The playlist the command is targetted for. (default: )
599 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
600 File: The key of the file. (default: -1)
601 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
602 Response:
603 Examples:
604 Click here
605
606 RemoveFile
607 Remove a file from a playlist.
608 Parameters:
609 Playlist: The playlist the command is targetted for. (default: )
610 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
611 File: The key of the file. (default: -1)
612 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
613 Response:
614 Examples:
615 Click here
616
617 MoveFile
618 Moves a file in a playlist.
619 Parameters:
620 Playlist: The playlist the command is targetted for. (default: )
621 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
622 File: The key of the file. (default: -1)
623 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
624 NewIndex: The new index of the file (default: 0)
625 Response:
626 Examples:
627 Click here
628
629 Build
630 Builds a playlist.
631 Parameters:
632 Keys: A comma seperated list of keys. (default: )
633 Playlist: The name of the playlist. (default: )
634 Response:
635 Examples:
636 Click here
637
638 Rename
639 Renames a playlist.
640 Parameters:
641 Playlist: The playlist the command is targetted for. (default: )
642 PlaylistType: The type of value provided in 'Playlist' (ID: playlist id; Path: playlist path). (default: ID)
643 NewName: The new name of the playlist. (default: )
644 Response:
645 Examples:
646 Click here
647
648 Files
649
650 Search
651 Perform a database search for files.
652 Parameters:
653 Query: The search string (empty returns full library) (default: )
654 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
655 Shuffle: Set to 1 to shuffle the files. (default: )
656 ActiveFile: A file key to set as active (used as the file that playback starts with, etc.). (default: -1)
657 ActiveFileOnly: Set to 1 to trim the returned files to only contain the active file. (default: )
658 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
659 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
660 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
661 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
662 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
663 SaveName: A backslash delimited path used with the action 'Save'. (default: )
664 NoUI: Set to one to put the player in no UI mode. (default: )
665 Zone: The zone the command is targetted for. (default: -1)
666 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
667 Response:
668 Examples:
669 Click here
670
671 Current
672 Get the currently selected files.
673 Parameters:
674 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
675 Shuffle: Set to 1 to shuffle the files. (default: )
676 ActiveFile: A file key to set as active (used as the file that playback starts with, etc.). (default: -1)
677 ActiveFileOnly: Set to 1 to trim the returned files to only contain the active file. (default: )
678 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
679 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
680 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
681 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
682 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
683 SaveName: A backslash delimited path used with the action 'Save'. (default: )
684 NoUI: Set to one to put the player in no UI mode. (default: )
685 Zone: The zone the command is targetted for. (default: -1)
686 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
687 Response:
688 Examples:
689 Click here
690
691 File
692
693 GetFile
694 Get the contents of a file in the database.
695 Parameters:
696 File: The key of the file. (default: -1)
697 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
698 Helper: Allows getting sidecar / helper files (used internally). (default: )
699 Conversion: The conversion settings to use. (default: )
700 Quality: The conversion quality to use (low, medium, high, etc.). (default: )
701 Resolution: The resolution of the target device (allows making better conversion decisions). (default: )
702 AndroidVersion: The Android version of the target device (if applicable). (default: )
703 Prepare: Set to 1 to prepare the file (useful when waiting for video conversion, etc.). (default: )
704 Playback: 0: Downloading (not real-time playback); 1: Real-time playback with update of playback statistics, Scrobbling, etc.; 2: Real-time playback, no playback statistics handling. (default: )
705 Start: The start position for playback. This is normally seconds (decimal supported), but usage can vary based on playback type. (default: )
706 MimeType: The mime type to use in the response (leave blank for default mime type). (default: )
707 HLS: Use HTTP Live Streaming. (default: )
708 Context: The context used to access the file (used for HTTP Live Streaming). (default: )
709 Response:
710 PercentPrepared: The integer progress percentage of a file preparation operation, such as transcoding.
711 Examples:
712 Click here
713
714 GetImage
715 Get an image for a file in the database.
716 Parameters:
717 File: The key of the file. (default: -1)
718 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
719 Type: The type of image to get: Thumbnail (default), Full, ThumbnailsBinary (default: Thumbnail)
720 ThumbnailSize: The size of the thumbnail (if type is thumbnail): Small, Medium, Large (default) (default: )
721 Width: The width for the returned image. (default: )
722 Height: The height for the returned image. (default: )
723 FillTransparency: A color to fill image transparency with (hex number). (default: )
724 Square: Set to 1 to crop the image to a square aspect ratio. (default: )
725 Pad: Set to 1 to pad around the image with transparency to fullfill the requested size. (default: )
726 Format: The preferred image format (jpg or png). (default: jpg)
727 Response:
728 Examples:
729 Click here
730
731 SetImage
732 Set the image for a file in the database.
733 Parameters:
734 File: The key of the file. (default: -1)
735 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
736 Type: The type of image (jpg, gif, etc.). (default: jpg)
737 Image: The image (as base 64 encoded). (default: )
738 Response:
739 Examples:
740 Click here
741
742 GetInfo
743 Get information or play a file object.
744 Parameters:
745 File: The key of the file. (default: -1)
746 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
747 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
748 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
749 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
750 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
751 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
752 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
753 SaveName: A backslash delimited path used with the action 'Save'. (default: )
754 NoUI: Set to one to put the player in no UI mode. (default: )
755 Zone: The zone the command is targetted for. (default: -1)
756 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
757 Response:
758 Examples:
759 Show file information for file key
760 Show file information for filename
761 Play file key
762
763 SetInfo
764 Set information about a file object.
765 Parameters:
766 File: The key of the file. (default: -1)
767 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
768 Field: The field to set. (default: )
769 Value: The value to set the field to. (default: )
770 List: Set to 'CSV' and comma delimit (RFC 4180) the field and value to set multiple values in one call. (default: )
771 Formatted: Set to 1 if you're passing a formatted value (like a formatted date). (default: 1)
772 Response:
773 Examples:
774 Click here
775
776 Rotate
777 Rotate an image file.
778 Parameters:
779 File: The key of the file. (default: -1)
780 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
781 Degrees: The degrees to rotate the image. (default: )
782 Response:
783 Examples:
784 Click here
785
786 Played
787 Update the play stats after a file has been played.
788 Parameters:
789 File: The key of the file. (default: -1)
790 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
791 Response:
792 Examples:
793 Click here
794
795 CreateParticle
796 Create particles.
797 Parameters:
798 File: The key of the file. (default: -1)
799 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
800 Count: The number of particles to create. (default: )
801 Response:
802 Keys: The keys of the created particles.
803 Examples:
804 Click here
805
806 Delete
807 Deletes a file.
808 Parameters:
809 File: The key of the file. (default: -1)
810 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
811 Mode: The delete mode (empty for default, 'Disk' for delete from disk, 'Recycle' for recycling. (default: )
812 Response:
813 Examples:
814 Click here
815
816 Bookmark
817 Gets and sets the bookmark.
818 Parameters:
819 File: The key of the file. (default: -1)
820 FileType: The type of value provided in 'File' (Key: file key; Filename: filename of file). (default: Key)
821 Set: The value in milliseconds to set (leave empty to not set and only get) (set to empty to remove) (default: )
822 Response:
823 Bookmark: The value of the bookmark.
824 Examples:
825 Click here
826
827 Browse
828
829 Children
830 Returns child browse items for a location, enabling traversal of the browse hierarchy.
831 Parameters:
832 ID: The parent ID (empty or -1 to start at root). (default: )
833 Skip: Set to 1 to skip browse levels that contain only one choice. (default: )
834 Version: The version of the data used for results (2 is the newest version). (default: 1)
835 ErrorOnMissing: Return on error when the parent node was not found, otherwise returns the root node (disabled by default, set to 1 to enable) (default: 0)
836 Response:
837 Examples:
838 Click here
839
840 Image
841 Gets the image for a browse item.
842 Parameters:
843 ID: The ID of the browse item. (default: )
844 Fallback: The name of the fallback image to use if ID is invalid. (default: )
845 FallbackColor: If no image found for ID or fallback, generate an image filled with this color. Use RGBA values (0-255) separated by commas, e.g. FallbackColor=128,240,169[,255], the 4th value is for Alpha and is optional - default is 255. (default: )
846 UseStackedImages: If 1, display a group of items with a stack of fanned thumbnails, if 0 use a single thumbnail. (default: 1)
847 Width: The width for the returned image. (default: )
848 Height: The height for the returned image. (default: )
849 FillTransparency: A color to fill image transparency with (hex number). (default: )
850 Square: Set to 1 to crop the image to a square aspect ratio. (default: )
851 Pad: Set to 1 to pad around the image with transparency to fullfill the requested size. (default: )
852 Format: The preferred image format (jpg or png). (default: jpg)
853 Response:
854 Examples:
855 Click here
856
857 Files
858 Gets files for a browse item.
859 Parameters:
860 ID: The ID of the browse item. (default: )
861 Action: The action to perform with the files (MPL: return MPL playlist; Play: plays files; Save: saves the files (as a playlist in the library, etc.); Serialize: return serialized file array (basically a list of file keys); M3U: saves the list as an m3u). (default: mpl)
862 Shuffle: Set to 1 to shuffle the files. (default: )
863 ActiveFile: A file key to set as active (used as the file that playback starts with, etc.). (default: -1)
864 ActiveFileOnly: Set to 1 to trim the returned files to only contain the active file. (default: )
865 PlayMode: Play mode flags delimited by commas (Add: adds to end of playlist; NextToPlay: adds files in the next to play position). (default: )
866 Fields: The fields to include in an MPL (use empty to include all fields) (set to Calculated to include calculated fields). (default: )
867 NoLocalFilenames: Set to 1 to filter out local filenames from MPL output (since they might be meaningless to a server). (default: )
868 PlayDoctor: Set to 1 to change the files to a Play Doctor generated playlist using these files as a seed. (default: )
869 SaveMode: Playlist: playlist (overwrites existing; returns ID) (default: )
870 SaveName: A backslash delimited path used with the action 'Save'. (default: )
871 NoUI: Set to one to put the player in no UI mode. (default: )
872 Zone: The zone the command is targetted for. (default: -1)
873 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
874 Response:
875 Examples:
876 Click here
877
878 Control
879
880 MCC
881 Perform a Media Core Command (MCC).
882 Parameters:
883 Command: The command (an integer value from the MC_COMMANDS enumeration; visit DevZone for the command list). (default: )
884 Parameter: The parameter to the command. (default: 0)
885 Block: 0: return immediately (command is posted and processed asynchronously); 1: wait for the command to finish before returning. (default: 0)
886 Zone: The zone the command is targetted for. (default: -1)
887 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
888 Response:
889 Examples:
890 Play / pause
891 Shuffle Playing Now
892
893 CommandLine
894 Run a command line.
895 Parameters:
896 Arguments: The command line arguments (default: )
897 Target: The target for the command line (uses launcher when empty) (default: )
898 Response:
899 Examples:
900 Toggle pause
901
902 Key
903 Simulate the press of a keyboard key.
904 Parameters:
905 Key: The key sequence to simulate, separated by semicolons. Keys can be a single letter or any of the following special keys: Insert, Menu, Delete, +, -, Left, Right, Up, Down, Backspace, Enter, Escape, Apps, Page Up, Page Down, Home, End, Space, Print Screen, Tab, NumPad0...NumPad9, F1...F24 (default: )
906 Focus: Brings the program to the front and takes focus if set to 1. (default: )
907 Response:
908 Examples:
909 Up
910 Right
911 Enter
912 Ctrl+C (Copy)
913 Ctrl+Shift+Left (Jump Back)
914 Win+E (Windows Explorer)
915
916 SharedPlaylists
917 Execute Cloudplay shared playlist functions.
918 Parameters:
919 Function: The function to execute, one of: Download, SignedIn, SignedOut, PlayDoctor (default: )
920 DownloadType: The type of item to download. One of 'Playlist', 'Smartlist', or 'Viewscheme' (default: )
921 ID: The ID of the playlist, smartlist, or viewscheme to download, or API token for SignedIn function. (default: )
922 Seed: A seed for a PlayDoctor playlist if Function is 'PlayDoctor'. (default: )
923 Response:
924 Examples:
925 Click here
926
927 Handheld
928
929 Sync
930 Run a sync of an attached handheld.
931 Parameters:
932 Device: The device to sync. (default: )
933 DeviceType: The type of value provided in 'Device' (Name: device name; ID: session id). (default: Name)
934 ShowWarnings: If warnings are allowed. (default: 1)
935 Response:
936 Examples:
937 Click here
938
939 Television
940
941 SeekInformation
942 Gets seek information for television playback.
943 Parameters:
944 File: The base file of the television program. (default: )
945 Time: The time to get seeking information for. (default: )
946 Response:
947 AudioSeekByte: The seek byte for the audio stream.
948 VideoSeekByte: The seek byte for the video stream.
949 Examples:
950 Click here
951
952 PlayChannel
953 Requests the player to find a TV control and start buffering a TV channel for the client.
954 Parameters:
955 Channel: The key of the TV channel to play. (default: -1)
956 Zone: The zone the command is targetted for. (default: -1)
957 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
958 Response:
959 Examples:
960 Click here
961
962 GetPlayerServingChannel
963 Get the player that was previously started serving the given channel.
964 Parameters:
965 Channel: The key of the TV channel to play. (default: -1)
966 Zone: The zone the command is targetted for. (default: -1)
967 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
968 Response:
969 TVPlayer: The pointer to CTVPlayer object that serves the channel.
970 Examples:
971 Click here
972
973 GetJTVFile
974 Get the jtv file from the given TVPlayer for the client to play.
975 Parameters:
976 Channel: The key of the TV channel to play. (default: -1)
977 TVPlayer: The pointer to the CTVPlayer object that started the TV control on the given channel (default: 0)
978 Zone: The zone the command is targetted for. (default: -1)
979 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
980 Response:
981 JTVFilename: The jtv file the server serves.
982 JTVFileKey: The key of the jtv file the server serves
983 Examples:
984 Click here
985
986 StopChannel
987 Informs TV control that a client has stopped playing the given TV channel
988 Parameters:
989 TVPlayer: The pointer to the CTVPlayer object that started the TV control on the given channel (default: 0)
990 File: The jtv file key that has been played by client (default: )
991 Channel: The key of the TV channel to play. (default: -1)
992 Zone: The zone the command is targetted for. (default: -1)
993 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
994 Response:
995 Examples:
996 Click here
997
998 ClientCallback
999 Informs TV control that a client is still alive playing a TV channel
1000 Parameters:
1001 TVPlayer: The pointer to the CTVPlayer object that started the TV control on the given channel (default: 0)
1002 File: The jtv file key that has been played by client (default: )
1003 Channel: The key of the TV channel to play. (default: -1)
1004 Zone: The zone the command is targetted for. (default: -1)
1005 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
1006 Response:
1007 Examples:
1008 Click here
1009
1010 GetRecordingRuleConflict
1011 Query TV recording database whether a given recording rule has any conflicts
1012 Parameters:
1013 RuleID: RecordingRule ID (default: 0)
1014 ParentRuleID: The parent ID of the recording rule (default: 0)
1015 Name: The name of the recording rule (default: )
1016 Properties: The recording rule properties (default: )
1017 Response:
1018 HasConflicts: Returns true or false
1019 Messages: String messages to be displayed to user
1020 Examples:
1021 Click here
1022
1023 GetRecordingActionConflicts
1024 Query TV recording database whether a given recording rule has any conflicts
1025 Parameters:
1026 ProgramKey: Program key (default: -1)
1027 Response:
1028 HasConflicts: Returns true or false
1029 Messages: String messages to be displayed to user
1030 Examples:
1031 Click here
1032
1033 GetPlayerRecordingFile
1034 Get the player that is currently recording a given file.
1035 Parameters:
1036 File: The key of the file that is being recorded. (default: -1)
1037 Zone: The zone the command is targetted for. (default: -1)
1038 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
1039 Response:
1040 TVPlayer: The pointer to CTVPlayer object that serves the channel.
1041 ChannelKey: The television channel being recorded.
1042 Examples:
1043 Click here
1044
1045 GetRecordingSchedule
1046 Get a list of recordings scheduled for the next specified number of hours.
1047 Parameters:
1048 RangeInHours: The number of hours of schedules to report starting from current hour. (default: -1)
1049 Response:
1050 NumberRecordings: The number of recordings in the specified period.
1051 ProgKey#: The program key of the recording at index #.
1052 ChannelKey#: The channel key of the recording at index #.
1053 RecordingID#: The recording rule ID of the recording at index #.
1054 StartTime#: The start time of the recording at index #.
1055 Duration#: The duration of the recording at index #.
1056 ProgName#: The program name of the recording at index #.
1057 Description#: The description of the recording at index #.
1058 Status#: The status of the recording at index #.
1059 TypeOfRecording#: The type of recording at index #.
1060 IsRecordingNow#: Boolean indicating whether the recording at index # has started.
1061 Examples:
1062 Click here
1063
1064 GetOrderedListOfTVChannels
1065 Get television channel custom ordering
1066 Response:
1067 OrderedList: Returns an ordered list of television channels
1068 Examples:
1069 Click here
1070
1071 SetOrderedListOfTVChannels
1072 Set television channel custom ordering
1073 Parameters:
1074 OrderedList: Ordered list of television channels (default: )
1075 Response:
1076 Examples:
1077 Click here
1078
1079 ResetChannelOrderSetting
1080 Reset television channel ordering
1081 Response:
1082 Examples:
1083 Click here
1084
1085 GetChannelKeyPlayingInZone
1086 Get television channel key that is being served to the client
1087 Parameters:
1088 Zone: The zone the command is targetted for. (default: -1)
1089 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
1090 Response:
1091 ChannelKey: Returns a channel key
1092 Examples:
1093 Click here
1094
1095 GetPlayingChannelAndRecordingProgramKeys
1096 Get television channel key that is being served to the client and all program keys currently being recorded
1097 Parameters:
1098 Zone: The zone the command is targetted for. (default: -1)
1099 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name (default: ID)
1100 Response:
1101 ChannelKey: Returns a channel key
1102 ProgramKeys: Returns a comma separated list of program keys
1103 Examples:
1104 Click here
1105
1106 GetAllRecordingProgramKeys
1107 Get all television program keys currently being recorded
1108 Response:
1109 ChannelKey: Returns a channel key
1110 ProgramKeys: Returns a comma separated list of program keys
1111 Examples:
1112 Click here
1113
1114 GetTelevisionStatus
1115 Get Standard View television status text line
1116 Response:
1117 TVStatus: Returns status text
1118 Examples:
1119 Click here
1120
1121 ReadRecordingFolderTestFile
1122 Set television channel custom ordering
1123 Parameters:
1124 TestFile: The file path and name of a client created file (default: )
1125 Response:
1126 FileContent: Returns a string read from the test file
1127 Examples:
1128 Click here
1129
1130 UserInterface
1131
1132 Info
1133 Gets information about the state of the user interface.
1134 Response:
1135 Mode: The user interface mode expressed as a UI_MODES integer (defined in MCCommands.h).
1136 InternalMode: The internal user interface mode as a UI_MODES integer (will be in the UI_MODE_INTERNAL_* block).
1137 ViewDisplayName: The display name of the current view.
1138 SelectionDisplayName: The display name of the current selection.
1139 Examples:
1140 Click here
1141
1142 Show
1143 Shows a view in the user interface.
1144 Parameters:
1145 View: The view to show. (default: )
1146 Response:
1147 Examples:
1148 Click here
1149
1150 GetStreaming
1151 Gets the streaming choices in the tree.
1152 Response:
1153 Streaming: The list of streaming choices semi-colon delimited.
1154 Stations: The list of Radio JRiver sites.
1155 Examples:
1156 Click here
1157
1158 GetRadioJRiver
1159 Plays the JRiver Radio station.
1160 Parameters:
1161 Site: The site to play. (default: )
1162 Response:
1163 Keys: The list of file keys, sepearted by comma.
1164 Examples:
1165 Click here
1166
1167 Configuration
1168
1169 Audio
1170
1171 ListDevices
1172 List the available audio output devices.
1173 Response:
1174 NumberDevices: The number of available devices.
1175 DeviceName#: The name of the device at index #.
1176 DevicePlugin#: The Name of the plugin of the device at index #.
1177 Examples:
1178 Click here
1179
1180 SetDevice
1181 Set the audio output device.
1182 Parameters:
1183 Zone: The zone the command is targetted for. (default: -1)
1184 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1185 DeviceIndex: The index of the device to set as the active device. (default: -1)
1186 Response:
1187 Examples:
1188 Click here
1189
1190 GetDevice
1191 Get the audio output device.
1192 Parameters:
1193 Zone: The zone the command is targetted for. (default: -1)
1194 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1195 Response:
1196 DeviceIndex: The index of the active audio device.
1197 DeviceName: The name of the active audio device.
1198 DevicePlugin: The plugin of the active audio device.
1199 Examples:
1200 Click here
1201
1202 ErrorFreeMode
1203 Set the error free mode. (optional -- omit to query only)
1204 Parameters:
1205 ErrorFree: The state of the error free mode (0 or 1). (default: )
1206 Response:
1207 ErrorFree: The new state of the error free mode.
1208 Examples:
1209 Click here
1210
1211 Time
1212 Returns current system time for use in zone link sync operations.
1213 Response:
1214 SystemTime: The current system time in a 64 bit unsigned integer compatible with the unix timeval struct and our own CZoneLinkTime object. The top 32 bits are seconds since Jan 1 1970, the bottom 32 bits are micro-seconds.
1215 Examples:
1216 Click here
1217
1218 Articles
1219 Returns current list of articles.
1220 Parameters:
1221 SortIgnoreState: The new state of whether to ignore for sorting (0: off, 1: on). (default: -1)
1222 Response:
1223 Articles: The list of articles.
1224 Ignore: Whether to ignore articles.
1225 Examples:
1226 Click here
1227
1228 DSP
1229
1230 Set
1231 Set whether a DSP is on or off.
1232 Parameters:
1233 DSP: The name of the DSP. (default: )
1234 On: 1 for on and 0 for off. (default: )
1235 Zone: The zone the command is targetted for. (default: -1)
1236 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1237 Response:
1238 Examples:
1239 Turn equalizer on
1240
1241 SetEqualizer
1242 Set the level of an EQ slider.
1243 Parameters:
1244 Slider: The number of the slider. (default: )
1245 Level: The level of the slider. (default: )
1246 On: Set to one to turn on the equalizer. (default: )
1247 Zone: The zone the command is targetted for. (default: -1)
1248 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1249 Response:
1250 Examples:
1251 Click here
1252
1253 SetTempo
1254 Set the tempo.
1255 Parameters:
1256 Tempo: The tempo. (default: )
1257 Relative: Set to 1 to set the tempo relative to the current tempo. (default: )
1258 Zone: The zone the command is targetted for. (default: -1)
1259 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1260 Response:
1261 Examples:
1262 Click here
1263
1264 Loudness
1265 Get and set the loudness.
1266 Parameters:
1267 Set: Set to 0 for off, 1 for on, and -1 to toggle. (default: )
1268 Zone: The zone the command is targetted for. (default: -1)
1269 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1270 Response:
1271 Current: The current value of the Loudness after the setting.
1272 Examples:
1273 Click here
1274
1275 SetAdaptiveVolume
1276 Set the adaptive volume setting.
1277 Parameters:
1278 Strength: The strength (1, 2, or 3 or 0 for off). (default: )
1279 Zone: The zone the command is targetted for. (default: -1)
1280 ZoneType: The type of value provided in 'Zone' (ID: zone id; Index: zone index; Name: zone name). (default: ID)
1281 Response:
1282 Examples:
1283 Set to night mode.
1284
1285 Podcast
1286
1287 Delete
1288 Delete a podcast.
1289 Parameters:
1290 Name: The name of the podcast to delete. (default: )
1291 Response:
1292 Examples:
1293 Click here
1294
1295 Settings
1296
1297 ShowNetworkInfo
1298 Show the network information for the device.
1299 Response:
1300 IPConfig: Displays the IP configuration.
1301 Netstat: The routing table information.
1302 Examples:
1303 Click here
1304
1305 ShowWirelessNetworks
1306 Lists the avialable wireless networks.
1307 Response:
1308 WirelessNetworks: A list of the available wireless networks.
1309 Examples:
1310 Click here
1311
1312 Engen
1313
1314 ServerLocation
1315 Returns the URL of a JRiver Engen IoT Server. If it hasn't been configured in Media Center, it will be the default value.
1316 Parameters:
1317 CheckAlive: Set to 1 to verify that the Engen server is alive and running. (default: )
1318 Response:
1319 ServerLocation: The URL of a JRiver Engen IoT Server.
1320 Alive: If CheckAlive is set to 1, test if the Engen server is running. Return value will be 'Alive=1' (running) or 'Alive=0'
1321 Examples:
1322 Click here
1323
1324 Settings
1325
1326 ReenterLicenseKey
1327 Allows the user to re-install the Id license
1328 Parameters:
1329 License: The license for the Id. Also referred to as a registration code. In this format: DCJD8-CPYN6-X1CO0-4B7O9-AZON1-C8X50 (default: )
1330 Email: This should only be included when installing a newly purchased license. It's the email address entered when purchasing the license. This MUST NOT be included when simply restoring an existing license. (default: )
1331 Response:
1332 Examples:
1333 Click here
1334
1335 Reboot
1336 Reboots the system.
1337 Response:
1338 Status: Displays the status of the system.
1339 Examples:
1340 Click here
1341
1342 Shutdown
1343 Shutdown the system.
1344 Response:
1345 Examples:
1346 Click here
1347
1348 AbortShutdown
1349 Cancel a system power command.
1350 Response:
1351 Examples:
1352 Click here
1353
1354
1355Copyright (C) JRiver, Inc. 1998-2019