Grundsätzliches
Grundsätzlich werden zwei Arten von Kommandos unterschieden.
Normale Kommandos werden stets im Root des Webverzeichnis aufgerufen.
Administrationskommandos werden im Root des Administrationsverzeichnisses aufgerufen.
Die Kommandos im Administrationsbereich entsprechen im Wesentlichen den Spezialkommandos, nur dass (da schon der gesamte Bereich per Passwort gesichert ist) hier die Eingabe von Extrapassworten als Parameter entfällt.
Für Beispiele empfiehlt sich (wie auch sonst) die Einsicht der mitgelieferten Dateien.
Im Folgenden nun die Kommandos, die nicht als Spezialkommandos verfügbar sind.
Das Kommando liefert im Wesentlichen den Inhalt der per Parameter "page" übergebenen Datei zurück.
Es wird dabei angenommen, dass es sich bei der Datei um eine Textdatei handelt, da der Inhalt der Datei auf Platzhalter untersucht wird und diese ersetzt werden.
Die Datei wird dabei ausgehend vom Root des Webverzeichnisses als Parameter angegeben.
Beispiel: "/showpage.do?page=homepage.tpl"
Das Kommando pausiert (bzw. startet danach wieder) die Wiedergabe des Players.
Wenn diese Funktion per Setup unterbunden wurde (PauseButton ist nicht aktiviert), so wird die Funktion nicht ausgeführt und eine Fehlermeldung wird als Popup angezeigt.
Soll dies nicht geschehen, so kann der optionale Parameter "silent" mit Wert "yes" mitgegeben werden.
Beispiel: "/pause.do" oder "/pause.do?silent=yes"
Das Kommando versucht einen per Parameter "filename" übergebenen Titel in die Playliste einzureihen.
Als Wert für den Parameter wird der möglichst genaue Dateiname (also inklusive Pfad) verwendet.
Je genauer der Dateiname angegeben wird, desto höher ist die Wahrscheinlichkeit, dass auch der beabsichtigte Titel gespielt wird.
Weiterhin sollte der Dateiname URL-enkodiert sein, um Fehler mit Sonderzeichen zu vermeiden.
Das Einreihen in die Playlist kann aus bekannten Gründen (Liste voll, Titel bereits gespielt etc.) fehlschlagen.
In einem solchen Fall wird eine Fehlermeldung zurückgegeben. Soll dies nicht geschehen, so kann der optionale Parameter "silent" mit Wert "yes" Abhilfe schaffen.
Beispiel: "/Play.Do?filename=D%3A%5CPop%5C%5BShaft%5D%20%28Mucho%20Mambo%29%20Sway%2EMp3"
Analog wie über das "Info"-Fenster möglich kann über dieses Kommando für den aktuell spielenden sowie für den aktuell selektierten Titel ein Kommentar abgegeben werden.
Der Parameter "text" nimmt hierbei den eigentlichen Kommentar auf.
Beispiel: "/comment.do?text=ich%20bin%20ein%20Kommentar"
Über diese Kommando kann der aktuell spielende Titel bewertet werden.
Der Wert des Parameters "count" in den Grenzen von 0 (schlecht) bis 10 (sehr gut) entscheidet über die Bewertung.
Wird die Bewertung nicht akzeptiert (weil außerhalb der Grenzen), dann wird eine Fehlermeldung zurückgegeben.
Über den Optionalen Parameter "silent" mit Wert "yes" kann diese Meldung unterbunden werden.
Beispiel: "/rate.do?count=8"
Das Kommando für die Suche nach Titeln in der Datenbank ist recht komplex.
Zentraler Parameter ist "text", über welchen der eigentliche Suchbegriff übergeben wird.
Analog zur Suche über die Programmoberfläche wird Volltext gesucht und es ist keine Angabe mehrer Begriffe zur Einschränkung möglich. Dafür kann mit den Wildcards * (beliebige Zeichen) und ? (ein einzelnes beliebiges Zeichen) gesucht werden.
Über den Parameter "genre" kann die Suche auf eine bestimmte Musikart eingeschränkt werden.
Die Parameter "count" für die Anzahl der anzuzeigenden Treffer pro Seite (falls geblättert werden soll) und "position" (ab welcher Position der Liste die Suche begonnen werden soll) steuern die Menge der zurückzuliefernden Treffer.
Die Liste der Treffer wird in einem Array zurückgegeben, um der Designschicht alle Titelinformationen anbieten zu können.
In der Regel wird daraus nur eine Auswahl dargestellt werden (z.B. Titel, Interpret und Musikart).
Dieser Array wird nachträglich innerhalb der Resultatseite, die über den Parameter "page" angegeben wird, weiter aufbereitet werden müssen.
Bei Verwendung dieses Kommandos werden weitere Platzhalter beachtet, welche die Navigation durch die Suchergebnisse beeinflussen können.
Ein generelles Beispiel ist zwar möglich, aber wenig sinnvoll.
Am besten ist die Einsicht in die mitgelieferten Beispieldateien (z.B. searchpage.tpl).
Beispiel: "/search.do?text=madonna&page=searchpage.tpl&count=20"
Das Kommando ist dem Suche-Kommando in Aufruf und Funktion sehr ähnlich.
Man könnte mit Recht sagen, dass es eine Suche ist, die jeden Eintrag als Treffer betrachtet.
Der Parameter "count" gibt an, wie viele Einträge zurückgeliefert werden sollen, der Parameter "position" gibt an, ab welcher Position in der Liste die Einträge aufbereitet werden sollen.
Der Parameter "page" gibt das zu verwendende Template für die Resultatseite an.
Neu gegenüber dem Suche-Kommando ist der Parameter "percent", der die prozentuale Angabe der Startposition (analog zu Parameter "position") ist und eine schnellere Navigation ermöglicht.
Ebenfalls werden bei Verwendung dieses Kommandos spezielle Platzhalter zur Navigation beachtet.
Das Ergebnis wird in Form eines Javascript-Arrays zurückgegeben, welches in der anzeigenden Seite noch aufbereitet werden muss.
Auch bei diesem Kommando empfiehlt sich die Einsicht in eine der mitgelieferten Beispieldateien (z.B. browsepage.tpl).
Beispiel: "/Browse.do?count=100&page=browsepage.tpl"
Das Kommando liefert (im Gegensatz zu den vorher genannten) keine Textinformationen zurück, sondern direkt das Bild (sofern vorhanden) als Jpeg-Binärdaten. Das Kommando ist dafür gedacht, innerhalb eines IMG-Htmltags eingesetzt zu werden.
Über den Parameter "default" kann ein Dateiname übergeben werden, der im Falle des nicht-Vorhandenseins eines Covers als Bild zurück gegeben wird.
In der Regel wird es sich hierbei um ein Dummybild handeln.
Beispiel: img src="/SongCover.do?default=space.gif"
Im Coin- oder PlaylPIN-Modus kann es hilfreich sein, per Remote (eben über das Web-Interface) Titel freizugeben.
Dazu ist das CoinCoint-Kommando gedacht.
Über den Parameter "count" wird die Anzahl der freizugebenden Titel mitgegeben, der Parameter "password" steuert die Berechtigung.
Die Anzahl der freizugebenden Titel ist dabei an 1 bis 10 gebunden.
Beispiel: "/CoinCount.do?count=3&password=1234567"
Das Kommando kennt lediglich einen Parameter "password", über welchen die Ausführungsberechtigung gesteuert wird.
Das Kommando bewirkt einen Wechsel des Skins der Jukebox im "Round-Robin" Verfahren.
Beispiel: "/SkinChange.do?password=1234567"
Das Kommando setzt den angeschlossenen Monitor der Jukebox in den Standby-Modus (sofern möglich) bzw. reaktiviert ihn.
Als einziger Parameter ist "password" nötig.
Beispiel: "/MonitorStandby.do?password=1234567"
Das Kommando veranlasst einen Rescan der Einträge in der Datenbank.
Dieser Rescan wird mir niedriger Priorität (unsichtbar) im Hintergrund ausgeführt, um den Betrieb des Programms nicht zu stören.
Der einzige Parameter "password" steuert die Berechtigung.
Das Kommando ist dazu geeignet, auch periodisch einen Rescan zu veranlassen, wenn es entsprechend getriggert (z.B. 2x am Tag) aufgerufen wird.
Beispiel: "/Rescan.do?password=1234567"
Der interne UpdateCheck der Jukebox sucht nach einer Datei "jukebox_update.exe" und veranlasst bei Vorhandensein einen Neustart des Programms mit der neuen Version.
Nötig zur Ausführung ist der Parameter "password".
Beispiel: "/UpdateCheck.do?password=1234567"
Über das Kommando kann die Jukebox angeregt werden, einen Jingle abzuspielen.
Hierbei kann der Parameter "filename" einen externen (aber im Jukebox-Verzeichnis gelegenen) Dateinamen zu einer WAV-Datei zu bestimmen, die anstelle des vordefinierten Jingles abgespielt werden soll.
Diese Funktion ist vor Allem bei Internetradiostationen beliebt.
Der zweite Parameter "password" steuert, ob der Jingle überhaupt abgespielt werden darf.
Beispiel: "/PlayJingle.do?filename=besonders.wav&password=1234567"
Das Kommando leert die gesamte Playlist der Jukebox und sollte daher mit Bedacht verwendet werden.
Der Parameter "password" teuert die Berechtigung.
Beispiel: "/ClearPlaylist.do?password=1234567"
Dieses Kommando führt zu einer "Not-Abschaltung" der Jukebox.
Über das korrekte Passwort im Parameter "password" wird das Programm beendet.
Beispiel: "/ShutDown.do?password=1234567"
Das Kommando steuert das Setzen der Wiedergabelautstärke des Players.
Der Parameter "value" als Prozentangabe (von 0 bis 100) in Kombination mit dem richtigen Passwort in Parameter "password" verändert die Lautstärke unmittelbar.
Beispiel: "/MasterVolume.do?value=90&password=1234567"
Das Kommando veranllst die Jukebox, direkt zum nächsten Titel der Playlist überzugehen.
Ist kein nächster Titel vorhanden, wird kurzerhand einer per Zufallsgenerator bestimmt und erst dann übergeblendet.
Über den Parameter "password" wird die Berechtigung zur Ausführung dieses Kommandos gesteuert.
Beispiel: "/Next.do?password=1234567"
Dieses Kommando versetzt das Programm in einen Wartungsmodus.
Dieser Modus ist dafür gedacht, im Hintergrund (remote) Veränderungen vorzunehmen.
Der Wartungsmodus blendet ein Fenster zur Information ein und deaktiviert alle Maus- und Tastatureingaben der Oberfläche.
Dieses Kommando sollte folglich mit Vorsicht verwendet werden.
Der Parameter "password" steuert die Berechtigung.
Beispiel: "/Maintenance.do?password=1234567"
Das komplette (vorhandene) Logfile kann über diesen Parameter zurückgegeben werden.
Je nach Anzahl der Einträge im Logfile kann dabei ein wenig Zeit vergehen.
Der Parameter "password" autorisiert die Ausführung.
Beispiel: "/DebugLog.do?password=1234567"
Über dieses Kommando kann eine Playlist (in Form einer M3U-Datei) hinzugeladen werden.
Die Funktionalität entspricht exakt der des Buttons im Adminbereich auf der Oberfläche der Jukebox.
Der Dateiname wird über Parameter "filename" angegeben, wobei die Datei im Jukebox-Verzeichnis (oder einem Unterverzeichnis davon) liegen muss.
Der Parameter "password" entscheidet über die Ausführung.
Beispiel: "/LoadPlaylist.do?filename=playlist/Playlist_2003-06-29.M3U&password=1234567"
Das Kommando liefert direkt ein Bild (im Binärformat) zurück und muss daher in ein IMG-Tag eingebunden werden.
Im Fall einer angeschlossenen und eingebundenen WebCam kann über das Kommando ein Bild abgerufen werden.
Dies ist immer dann sinnvoll, wenn z.B. alle X Sekunden automatisch ein Bild veröffentlicht oder der Raum direkt vor der Jukebox überwacht werden soll.
Der Parameter "default" gibt ein Standardbild an, welches immer dann gesendet wird, wenn keine WebCam angeschlossen war oder ein Bild nicht erzeugt werden konnte.
Beispiel: "img src=/admin/CamCapture.do?default=/admin/locked.gif"
Das Kommando liefert direkt ein Bild (im Binärformat) zurück und muss daher in ein IMG-Tag eingebunden werden.
Es wird ein Screenshot des aktuellen Bildschirms gemacht in den Dimensionen des Hauptfensters der Jukebox.
Es wird nicht unbedingt das Bild des Programms geliefert, sondern auch das eventueller Fehlermeldungen.
Das Kommando kann immer dann als Fernwartungsdiagnose hilfreich sein, wenn unvorhergesehene Windows-Meldungen auftauchen und den Betrieb stören.
Ebenfalls ist es möglich, per Ferndiagnose oder -hilfe direkt auf z.B. Fragen eines Benutzers einzugehen, auch wenn man selbst nicht unmittelbar auf den Bildschirm sehen kann.
Der Parameter "default" gibt ein Standardbild an, welches im Fehlerfalle zurückgegeben wird, oder wenn kein Bild erzeugt werden konnte.
Beispiel: "img src=/admin/ScreenCapture.do?default=/admin/locked.gif"