advanced.docbook

Amarok是一款在LINUX或其他类UNIX操作系统中运行的音频播放器软件。 经过两年开发后

</row>

<row>
<entry
>void enableRepeatTrack(bool enable)</entry>
<entry
>Schaltet die Wiederholung eines Stücks ein/aus.</entry>
</row>

<row>
<entry
>void mediaDeviceMount()</entry>
<entry
>Legt den Befehl zum Einbinden eines Audio-Players fest.</entry>
</row>

<row>
<entry
>void mediaDeviceUmount()</entry>
<entry
>Legt den Befehl zum Lösen der Einbindung eines Audio-Players fest.</entry>
</row>

<row>
<entry
>void mute()</entry>
<entry
>Schaltet die Stummschaltung ein/aus.</entry>
</row>

<row>
<entry
>void next()</entry>
<entry
>Hat die gleiche Wirkung wie der Knopf <quote
>Nächstes Stück</quote
>.</entry>
</row>

<row>
<entry
>void pause()</entry>
<entry
>Hat die gleiche Wirkung wie der Knopf <quote
>Pause</quote
>.</entry>
</row>

<row>
<entry
>void play()</entry>
<entry
>Hat die gleiche Wirkung wie der Knopf <quote
>Wiedergabe</quote
>.</entry>
</row>

<row>
<entry
>void playPause()</entry>
<entry
>Schaltet um zwischen Wiedergabe/Pause (nützlich für Besitzer von Multimedia-Tastaturen). </entry>
</row>

<row>
<entry
>void prev()</entry>
<entry
>Hat die gleiche Wirkung wie der Knopf <quote
>Vorheriges Stück</quote
>.</entry>
</row>

<row>
<entry
>void queueForTransfer( KURL url )</entry>
<entry
>Stellt eine Datei in die Warteschlange zur Übertragung auf den Media-Player ein.</entry>
</row>

<row>
<entry
>void seek(int s)</entry>
<entry
>Spult im Stück an die Position in Sekunden.</entry>
</row>

<row>
<entry
>void seekRelative(int s)</entry>
<entry
>Spult zu einer Position relativ zur aktuellen Position.</entry>
</row>

<row>
<entry
>void setEqualizer(int, int, int, int, int, int, int, int, int, int, int)</entry>
<entry
>Legt die Equalizer-Einstellungen fest. </entry>
</row>

<row>
<entry
>void setEqualizerEnabled( bool active )</entry>
<entry
>Schaltet den Equalizer ein/aus.</entry>
</row>

<row>
<entry
>void setEqualizerPreset( QString name )</entry>
<entry
>Legt die Equalizer-Voreinstellung fest. </entry>
</row>

<row>
<entry
>void setLyricsByPath( QString url, QString lyrics )</entry>
<entry
>Legt den Text eines Stücks unter der angegebenen Adresse fest.</entry>
</row>

<row>
<entry
>void setScore( int score )</entry>
<entry
>Legt die Punkte für das aktuell laufende Stück fest.</entry>
</row>

<row>
<entry
>void setScoreByPath( QString url, int score )</entry>
<entry
>Legt die Punkte für das mit dem Pfad angegebenen Stück fest.</entry>
</row>

<row>
<entry
>void setVolume(int volume)</entry>
<entry
>Legt die Lautstärke im Bereich zwischen 0-100% fest.</entry>
</row>

<row>
<entry
>void showBrowser( QString browser )</entry>
<entry
>Zeigt die Browser im Wiedergabelistenfenster an.</entry>
</row>

<row>
<entry
>void showOSD()</entry>
<entry
>Zeigt das OSD an.</entry>
</row>

<row>
<entry
>void stop()</entry>
<entry
>Hat die gleiche Wirkung wie der Knopf <quote
>Stopp</quote
>.</entry>
</row>

<row>
<entry
>void transferDeviceFiles()</entry>
<entry
>Überträgt Dateien auf den Media-Player.</entry>
</row>

<row>
<entry
>void volumeDown()</entry>
<entry
>Senkt die Lautstärke merklich ab.</entry>
</row>

<row>
<entry
>void volumeUp()</entry>
<entry
>Hebt die Lautstärke merklich an.</entry>
</row>

</tbody>
</tgroup>
</informaltable>

</sect2>

<sect2 id="dcop-playlist">
<title
>dcop amarok playlist</title>

<informaltable>
<tgroup cols="2">
<thead>

<row>
<entry
>DCOP-Aufruf</entry>
<entry
>Funktion</entry>
</row>
</thead>
<tbody>

<row>
<entry
>int getActiveIndex()</entry>
<entry
>Gibt den Index des aktuellen Stücks zurück, oder -1, wenn es keinen Index gibt.</entry>
</row>

<row>
<entry
>int getTotalTrackCount()</entry>
<entry
>Gibt die Anzahl der Stücke in der Wiedergabeliste zurück. Der Rückgabewert ist 0, wenn die Wiedergabeliste leer ist.</entry>
</row>

<row>
<entry
>QString saveCurrentPlaylist()</entry>
<entry
>Speichert die aktuelle Wiedergabeliste in current.xml und gibt den Pfad zurück.</entry>
</row>

<row>
<entry
>void addMedia( KURL )</entry>
<entry
>Fügt eine Audio-Datei anhand der Adresse ein.</entry>
</row>

<row>
<entry
>void addMediaList( KURL::List )</entry>
<entry
>Fügt mehrere Audio-Dateien anhand der Adresse ein.</entry>
</row>

<row>
<entry
>void clearPlaylist()</entry>
<entry
>Leert die Wiedergabeliste.</entry>
</row>

<row>
<entry
>void playByIndex(int)</entry>
<entry
>Startet die Wiedergabe eines Stücks am angegebenen Index.</entry>
</row>

<row>
<entry
>void playMedia( KURL )</entry>
<entry
>Fügt eine Audio-Datei anhand der Adresse ein.</entry>
</row>

<row>
<entry
>void popupMessage( QString)</entry>
<entry
>Zeigt eine temporäre Meldung an.</entry>
</row>

<row>
<entry
>void removeCurrentTrack()</entry>
<entry
>Entfernt das aktuelle Stück aus der Wiedergabeliste.</entry>
</row>

<row>
<entry
>void repopulate()</entry>
<entry
>Füllt die Wiedergabeliste erneut mit zufälligen Stücken.</entry>
</row>

<row>
<entry
>void saveM3u( QString path, bool relativePaths)</entry>
<entry
>Speichert die aktuelle Wiedergabeliste als m3u-Datei.</entry>
</row>

<row>
<entry
>void setStopAfterCurrent( bool )</entry>
<entry
>Aktiviert/Deaktiviert die Funktion "Wiedergabe nach aktuellem Stück anhalten".</entry>
</row>

<row>
<entry
>void shortStatusMessage( QString)</entry>
<entry
>Zeigt eine temporäre Meldung in der Statusleiste an.</entry>
</row>

<row>
<entry
>void shufflePlaylist()</entry>
<entry
>Mischt die Wiedergabeliste.</entry>
</row>

<row>
<entry
>void togglePlaylist()</entry>
<entry
>Zeigt das Wiedergabelisten-Fenster an bzw. blendet es aus.</entry>
</row>

</tbody>
</tgroup>
</informaltable>

</sect2>

<sect2 id="dcop-playlistbrowser">
<title
>dcop amarok playlistbrowser</title>

<informaltable>
<tgroup cols="2">
<thead>

<row>
<entry
>DCOP-Aufruf</entry>
<entry
>Funktion</entry>
</row>
</thead>
<tbody>

<row>
<entry
>void addPodcast( QString )</entry>
<entry
>Fügt dem Wiedergabelisten-Browser einen Podcast-Eintrag hinzu.</entry>
</row>

<row>
<entry
>void scanPodcasts()</entry>
<entry
>Sucht für alle Podcasts nach Aktualisierungen.</entry>
</row>

<row>
<entry
>void addPlaylist( QString )</entry>
<entry
>Fügt dem Wiedergabelisten-Browser einen neuen Eintrag hinzu.</entry>
</row>

</tbody>
</tgroup>
</informaltable>

</sect2>

<sect2 id="dcop-script">
<title
>dcop amarok script</title>


<informaltable>
<tgroup cols="2">
<thead>

<row>
<entry
>DCOP-Aufruf</entry>
<entry
>Funktion</entry>
</row>
</thead>
<tbody>

<row>
<entry
>bool runScript( QString name)</entry>
<entry
>Startet das Skript mit dem übergebenen Namen. Bei Erfolg wird true zurückgegeben.</entry>
</row>

<row>
<entry
>bool stopScript( QString name)</entry>
<entry
>Stoppt das Skript mit dem übergebenen Namen. Bei Erfolg wird wird true zurückgegeben.</entry>
</row>

<row>
<entry
>QStringList listRunningScripts()</entry>
<entry
>Gibt eine Liste aller laufenden Skripte zurück.</entry>
</row>

<row>
<entry
>void addCustomMenuItem(QString submenu, QString itemTitle )</entry>
<entry
>Aktiviert ein benutzerdefiniertes Menü und legt den Namen fest.</entry>
</row>

<row>
<entry
>void removeCustomMenuItem(QString submenu, QString itemTitle )</entry>
<entry
>Entfernt den benutzerdefinierten Menüeintrag.</entry>
</row>

<row>
<entry
>QString readConfig( QString key)</entry>
<entry
>Gibt einen Amarok-Konfigurationseintrag des angegebenen Schlüssels zurück.</entry>
</row>

</tbody>
</tgroup>
</informaltable>


</sect2>

</sect1>

<sect1 id="cmd-line-options">
<title
>Optionen auf der Kommandozeile</title>

<para
>Amarok unterstützt die Kommandozeilen-Optionen von Qt und &kde;. Zusätzlich hat Amarok noch einige eigene Kommandozeilen-Optionen.</para>

<para
>Die Qt- und &kde;-Optionen:</para>

<informaltable>
<tgroup cols="2">
<thead>

<row>
<entry
>Option</entry>
<entry
>Funktion</entry>
</row>
</thead>
<tbody>

<row>
<entry
>--help</entry>
<entry
>Hilfe zu den Optionen anzeigen.</entry>
</row>

<row>
<entry
>--help-qt</entry>
<entry
>Qt-Optionen anzeigen</entry>
</row>

<row>
<entry
>--help-kde</entry>
<entry
>&kde;-Optionen anzeigen.</entry>
</row>

<row>
<entry
>--help-all</entry>
<entry
>Alle Optionen anzeigen.</entry>
</row>

<row>
<entry
>--author</entry>
<entry
>Informationen über den Autor anzeigen.</entry>
</row>

<row>
<entry
>-v, --version</entry>
<entry
>Versionsinformationen anzeigen.</entry>
</row>

<row>
<entry
>--license</entry>
<entry
>Lizenzinformationen anzeigen.</entry>
</row>

</tbody>
</tgroup>
</informaltable>

<para
>Die Amarok-Optionen:</para>

<note
><para
>Die &amarok;-Optionen sollten verwendet werden, während &amarok; läuft.</para
></note>

<informaltable>
<tgroup cols="2">
<thead>

<row>
<entry
>Option</entry>
<entry
>Funktion</entry>
</row>
</thead>
<tbody>

<row>
<entry
>-r, --previous</entry>
<entry
>Zum vorigen Stück in der Wiedergabeliste springen.</entry>
</row>

<row>
<entry
>-p, --play</entry>
<entry
>Die Wiedergabe der aktuellen Wiedergabeliste starten.</entry>
</row>

<row>
<entry
>-s, --stop</entry>
<entry
>Die Wiedergabe stoppen.</entry>
</row>

<row>
<entry
>--pause</entry>
<entry
>Die Wiedergabe anhalten (Pause).</entry>
</row>

<row>
<entry
>-f, --next</entry>
<entry
>Zum nächsten Stück in der Wiedergabeliste springen.</entry>
</row>

<row>
<entry
>-a, --append</entry>
<entry
>Dateien/URLs and die Wiedergabeliste anhängen.</entry>
</row>

<row>
<entry
>-e, --enqueue</entry>
<entry
>Siehe "append", nur für Rückwärtskompatibilität vorhanden.</entry>
</row>

<row>
<entry
>--queue</entry>
<entry
>Dateien/URLs nach dem aktuellen Stück zur Wiedergabe einreihen.</entry>
</row>

<row>
<entry
>-m, --toggle-playlist-window</entry>
<entry
>Die Anzeige des Wiedergabelisten-Fensters ein/ausschalten.</entry>
</row>

<row>
<entry
>--wizard</entry>
<entry
>Den Einrichtungsassistent starten.</entry>
</row>

<row>
<entry
>--engine "Name"</entry>
<entry
>Startet &amarok; mit dem Audio-Ausgabe-Modul "Name".</entry>
</row>

</tbody>
</tgroup>
</informaltable>

</sect1>


<sect1 id="script-writing">
<title
>Schreiben von Skripten</title>

<para
>Mit Skripten kann &amarok; leicht erweitert werden, ohne die Codebasis von &amarok; ändern zu müssen. Skripte funktionieren ähnlich wie Module (Plugins), sie verwenden aber keine dedizierte Modul-API, sondern die DCOP-Schnittstelle. Auf diese Weise können &amarok;-Skripte in nahezu jeder Sprache programmiert werden (z. B. Ruby, Python oder PHP). Sie sind nichtmal auf Skriptsprachen beschränkt sondern können auch kompilierte Programme in C oder C++ verwenden. &amarok; kann Ihre Skripte über bestimmte Ereignisse informieren, sodass Ihre Skripte entsprechend reagieren können. Das Benachrichtigungs-System wird weiter hinten in diesem Abschnitt erklärt.</para>

<sect2 id="script-bindings">
<title
>Bindungen</title>

<para
>Man kann natürlich einfache Skripte ohne jegliche Benutzer-Interaktion programmieren. Aber es ist auch möglich, Skripte mit einer komfortablen Oberfläche zu programmieren, die sich wie eine eigene Anwendung verhalten. Zum Programmieren der Oberfläche können Sie eine der vielen KDE-Bindungen verwenden, zum Beispiel RubyQt. Bedenken Sie dabei aber bitte, dass nicht jeder Benutzer alle verfügbaren Bindungen installiert hat. Wenn Sie sich für eine Bindung entscheiden, dann verwenden Sie am besten eine der weit verbreiteten wie z. B. RubyQt oder PyQt.</para>

<para
>Sie sollten dem Anwender eine Rückmeldung geben, wenn das Skript wegen einer fehlenden Abhängigkeit nicht ausgeführt werden kann. Bitte prüfen Sie in Ihrem Skript, ob alle benötigten Module vorhanden sind und nutzen Sie <quote
>kdialog</quote
>, damit der Anwender weis, warum ein Skript nicht läuft.</para>

<para
>Dieses Beispiel soll zeigen, wie man in Ruby eine fehlende Abhängigkeit abfängt:</para>

<programlisting
>begin
       require 'Korundum'
rescue LoadError
       error = 'Korundum (KDE bindings for ruby) from kdebindings v3.4 is required for this script.'
       `kdialog --sorry '#{error}'`
       exit
end
</programlisting>

</sect2>

<sect2 id="script-templates">
<title
>Erste Schritte: Die Vorlagen</title>

<para
>Im Ordner <filename class="directory"
>scripts/templates</filename
> finden Sie eine Menge Vorlage-Skripte in vielen verschiedenen Sprachen. Sie können sie als Basis für Ihre eigenen Skripte verwenden oder sie einfach um die benötigten Funktionen erweitern. Sie werden schnell feststellen, dass das Schreiben von Skripten relativ einfach ist.</para>

</sect2>

<sect2 id="script-controlling-amarok">
<title
>DCOP zur Steuerung von &amarok; verwenden</title>

<para
>Mit Hilfe von DCOP können Ihre Skripte Daten mit Amarok austauschen und Amarok steuern. Der einfachste Weg ist die Verwendung des Kommandos <quote
>dcop</quote
>;, welches jeder KDE-Installation beiliegen sollte.</para>

<para
>So können Sie beispielsweise die Lautstärke erhöhen:</para>

<programlisting
>dcop amarok player volumeUp</programlisting>

<para
>Die meisten Skriptsprachen ermöglichen das Ausführen von externen Programmen und Befehlen. Dazu wird meist die Funktion exec() verwendet. Auf diese Weise kann <quote
>dcop
></quote
> relativ einfach aufgerufen werden. Hier ein Beispiel in Python:</para>

<programlisting
>import os
 os.system("dcop amarok player volumeDown")
</programlisting>

</sect2>

<sect2 id="script-notifications">
<title
>Benachrichtigungen</title>

<para
>&amarok; sendet Benachrichtigungen an alle laufenden Skripte. Dazu werden Strings an die Standardeingabe des Skripts geschrieben. Aus diesem Grund sollten Skripte ihre Standardeingabe laufend überwachen und entsprechend auf Ereignisse reagieren. Natürlich kann ein Skript die Ereignisse auch ignorieren wenn es keine Verwendung dafür hat.</para>

<para
>Die folgenden Benachrichtigungen werden von &amarok; gesendet:</para>

<programlisting
><cmdsynopsis
><command
>configure</command
></cmdsynopsis>
Weist das Skript an, den Einrichtungsdialog anzuzeigen.
Um das Speichern und Laden der Einrichtungsdaten muss sich jedes Skript 
selbst kümmern. Wenn ein Skript gestartet wird, setzt Amarok den 
Arbeitsordner auf den Ordner, wo alle Daten gespeichert werden sollten.
</programlisting>

<programlisting
><cmdsynopsis
><command
>engineStateChange:</command
><arg
>empty|idle|paused|playing</arg
></cmdsynopsis>
Signalisiert eine Änderung im Modul für Audio-Ausgabe.
</programlisting>

<programlisting
><cmdsynopsis
><command
>trackChange</command
></cmdsynopsis>
Signalisiert, dass ein neues Stück angespielt wird. Das Skript könnte nun 
&zb; mit DCOP-Funktionen weitere Informationen zu dem neuen Stück abfragen (zum Beispiel die Metadaten 
oder die Stücklänge).
</programlisting>

<programlisting
><cmdsynopsis
><command
>volumeChange</command
><arg
>newVolume</arg
></cmdsynopsis>
Signalisiert eine Änderung der Lautstärke. Die neue Lautstärke ist ein
Integerwert zwischen 0 und 100.
</programlisting>

<programlisting
><cmdsynopsis
><command
>customMenuClicked:</command
><arg
>submenu itemTitle paths</arg
></cmdsynopsis>
Enthält den Pfad zu den ausgewählten Dateien der Wiedergabeliste, wenn ein
benutzerdefinierter Menüeintrag angeklickt wurde. submenu und itemTitle 
werden ebenfalls übergeben, damit das Skript den geklickten 
Eintrag identifizieren kann. Um dem Menü einen eigenen Eintrag 
hinzuzufügen, kann man die DCOP-Funktion <quote
>dcop amarok script
addCustomMenuItem( submenu itemTitle )</quote
> verwenden. Um einen 
Eintrag wieder zu entfernen verwendet man 
<quote
>dcop amarok script removeCustomMenuItem( submenu itemTitle )</quote
>.
</programlisting>

</sect2>

<sect2 id="script-termination">
<title
>Beenden von Skripten</title>

<para
>Bevor &amarok; sich beendet, oder wenn der Benutzer ein Skript stoppt, sendet &amarok; das Signal SIGTERM an das Skript. Dieses Signal sollte verarbeitet werden, um z. B. Aufräumarbeiten zu erledigen. Dazu gehört z. B. das Speichern von Daten oder Konfigurationseinstellungen.</para>

</sect2>

<sect2 id="script-packaging">
<title
>Skript-Pakete</title>

<para
>Amaroks Skript-Verwaltung kann auch Skript-Pakete installieren, die der Anwender &zb; von einem Webserver heruntergeladen hat. Solche Pakete sind im Grunde normale Tar-Archive (.tar), die optional auch mit bzip2 (.bz2) komprimiert sein können. Wir empfehlen einen Archivnamen wie z.&nbsp;B. meinskript.amarokscript.tar.bz2, damit der Benutzer das Archiv eindeutig als Amarok-Skript-Paket erkennen kann.</para>

<note
><para
>&amarok; 1.3 wird nur Skript-Pakete mit der Erweitungerung <quote
>amarokscript</quote
> akzeptieren. Aus diesem Grund sollten Sie Ihre Skript-Pakete gleich richtig benennen.</para
></note>

<para
>Der Inhalt des Skript-Pakets muss so organisiert sein:</para>

<programlisting
>meinskript/
   README
   meinskript.py (ausführbar)
   einmodul.py
   foo.data
   ...
</programlisting>

</sect2>

<sect2 id="script-permissions">
<title
>Dateirechte</title>

<para
>Das Hauptskript muss ausführbar sein (+x), die restlichen zu ladenden Module sollte nicht ausführbar sein. Verwenden Sie den Tar-Parameter -p um die Dateirechte zu erhalten:</para>

<programlisting
>tar -cf meinskript.amarokscript.tar -p meinskript</programlisting>

<note
><para
>&amarok; wird das Skript nicht installieren, wenn die Dateirechte nicht korrekt eingestellt sind!</para
></note>

</sect2>

<sect2 id="script-distributing">
<title
>Veröffentlichung</title>

<para
>Wenn Ihr Skript-Paket fertig ist, können Sie es auf <ulink url="http://www.kde-apps.org"
>www.kde-apps.org</ulink
> hinaufladen und den Link an die <ulink url="http://amarok.kde.org/amarokwiki/index.php/Scripts"
>Wiki Skripts Seite</ulink
> von &amarok; anhängen. Für Ihren Eintrag auf kde-apps sollten Sie die Kategorie <ulink url="http://kde-apps.org/index.php?xcontentmode=56"
>&amarok; Skripts</ulink
> verwenden.</para>

</sect2>

</sect1>


</chapter>