D-Bus APIDas D-Bus API ist in org.kde.Kid3.xml spezifiziert. Die Kid3 Schnittstelle hat die folgenden Methoden:
boolean openDirectory( | path); |
string path;pathPfad zu Datei oder Ordner
Wenn OK wird true zurückgegeben.
string getErrorMessage( | ); |
Gibt eine detaillierte Fehlermeldung zurück.
boolean batchImport( | tagMask, | |
profileName); |
int32 tagMask;string profileName;tagMaskTag Maske (Bit 0 für Tag 1, Bit 1 für Tag 2)
profileNameName des zu verwendenden Profils
boolean importFromFile( | tagMask, | |
| path, | ||
fmtIdx); |
int32 tagMask;string path;int32 fmtIdx;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
pathPfad zu Datei
fmtIdxFormat Index
Wenn OK wird true zurückgegeben.
importFromTags( | tagMask, | |
| source, | ||
extraction); |
int32 tagMask;string source;string extraction;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
sourceFormat-Spezifikation, um Ausgangstext aus den vorhandenen Tags zu erhalten
extractionRegulärer Ausdruck mit Elementnamen und Klammergruppen, um Treffer aus dem Ausgangstext zu extrahieren
array importFromTagsToSelection( | tagMask, | |
| source, | ||
extraction); |
int32 tagMask;string source;string extraction;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
sourceFormat-Spezifikation, um Ausgangstext aus den vorhandenen Tags zu erhalten
extractionRegulärer Ausdruck mit Elementnamen und Klammergruppen, um Treffer aus dem Ausgangstext zu extrahieren
returnValuesExtrahierter Wert für "%{__return}(.+)"
downloadAlbumArt( | url, | |
allFilesInDir); |
string url;boolean allFilesInDir;urlURL des Bildes oder einer dazugehörigen Webseite
allFilesInDirfalls true, wird das Bild in allen Dateien des Ordners hinzugefügt
boolean exportToFile( | tagMask, | |
| path, | ||
fmtIdx); |
int32 tagMask;string path;int32 fmtIdx;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
pathPfad zu Datei
fmtIdxFormat Index
Wenn OK wird true zurückgegeben.
array getPlaylistItems( | path); |
string path;pathPfad zu Stücklistendatei
Gibt eine Liste mit absoluten Pfaden zu den Stücken der Wiedergabeliste zurück.
boolean setPlaylistItems( | path, | |
items); |
string path;array items;pathPfad zu Stücklistendatei
itemsListe mit absoluten Pfaden zu den Stücken der Wiedergabeliste
Wenn OK wird true zurückgegeben, false wenn nicht alle Stücke gefunden wurden oder das Speichern fehlgeschlagen ist.
boolean previousFile( | ); |
Gibt true zurück, wenn eine vorangehende Datei existiert.
boolean selectPreviousFile( | ); |
Gibt true zurück, wenn eine vorangehende Datei existiert.
boolean selectNextFile( | ); |
Gibt true zurück, wenn eine nächste Datei existiert.
boolean selectCurrentFile( | ); |
Gibt true zurück, wenn eine aktuelle Datei existiert.
boolean expandDirectory( | ); |
Ein Dateilistenelement ist ein Ordner, wenn getFileName() einen Namen mit '/' als letztem Zeichen zurückgibt.
Gibt true zurück, wenn das aktuelle Dateilistenelement ein Ordner ist.
boolean setDirNameFromTag( | tagMask, | |
| format, | ||
create); |
int32 tagMask;string format;boolean create;tagMaskTag Maske (Bit 0 für Tag 1, Bit 1 für Tag 2)
formatOrdnerformat
createtrue zum Erstellen, false zum Umbenennen
Wenn OK wird true zurückgegeben, sonst ist eine Fehlermeldung mit getErrorMessage() abrufbar.
numberTracks( | tagMask, | |
firstTrackNr); |
int32 tagMask;int32 firstTrackNr;tagMaskTag Maske (Bit 0 für Tag 1, Bit 1 für Tag 2)
firstTrackNrNummer für erste Datei
string getFileName( | ); |
Gibt den absoluten Dateinamen zurück, wenn es ein Ordner ist, endet er mit "/".
setFileName( | name); |
string name;nameDateiname
Die Datei wird umbenannt, wenn der Ordner gespeichert wird.
setFileNameFromTag( | tagMask); |
int32 tagMask;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
string getFrame( | tagMask, | |
name); |
int32 tagMask;string name;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
nameElementname (z.B. "artist")
Um binäre Daten wie ein Bild von einem Element in einer Datei zu speichern, kann der Dateiname dem Elementnamen hinzugefügt werden, z.B. "Picture:/Pfad/zu/Datei". Auf dieselbe Weise kann synchronisierter Liedtext exportiert werden, z.B. "SYLT:/Pfad/zu/Datei".
Gibt Wert des Elementes zurück.
boolean setFrame( | tagMask, | |
| name, | ||
value); |
int32 tagMask;string name;string value;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
nameElementname (z.B. "artist")
valueWert des Elementes
Für Tag 2 (tagMask 2) gilt: Wenn kein Element mit name existiert, so wird ein neues Element hinzugefügt, wenn value leer ist, so wird das Element gelöscht. Um binäre Daten wie ein Bild einem Element hinzuzufügen, kann der Dateiname dem Elementnamen hinzugefügt werden, z.B. "Picture:/Pfad/zu/Datei". "SYLT:/Pfad/zu/Datei" kann verwendet werden, um synchronisierten Liedtext im LRC-Format zu importieren.
Wenn OK wird true zurückgegeben.
array of string getTag( | tagMask); |
int32 tagMask;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
Gibt eine Liste mit abwechselnd Elementnamen und -werten zurück.
array of string getInformation( | ); |
Eigenschaften sind Format, Bitrate, Samplerate, Channels, Duration, Channel Mode, VBR, Tag 1, Tag 2. Eigenschaften, welche nicht vorhanden sind, werden ausgelassen.
Gibt eine Liste mit abwechselnd Eigenschaftsnamen und -werten zurück.
setTagFromFileName( | tagMask); |
int32 tagMask;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
setTagFromOtherTag( | tagMask); |
int32 tagMask;tagMaskTag Bit (1 für Tag 1, 2 für Tag 2)
reparseConfiguration( | ); |
Automatisierte Konfigurationsänderungen sind durch direktes Modifizieren der Konfigurationsdatei und anschließendes Einlesen möglich.