http://docs.kde.org/
TerugD-Bus-interfaceVolgende

D-Bus API

De D-Bus API is gespecificeerd in org.kde.Kid3.xml. Het Kid3 interface heeft de volgende methoden:

Bestand of map openen

boolean openDirectory(pad); 
tekenreeks pad;
 
pad

pad naar bestand of map

Geeft true terug indien OK.

Ontlaad de tags van alle bestanden die niet zijn gewijzigd of geselecteerd

unloadAllTags(); 
 

Alle gewijzigde bestanden opslaan

boolean save(); 
 

Geeft true terug indien OK.

Krijgt een gedetaileerde foutmelding geleverd door sommige methoden

string getErrorMessage(); 
 

Geeft een gedetailleerde foutmelding terug.

Draait wijzigingen in de geselecteerde bestanden terug

ongedaan maken(); 
 

Start een automatische bulkimport

boolean batchImport(tagMask,  
 profileName); 
int32 tagMask;
string profileName;
 
tagMask

tag mask (bit 0 voor tag 1, bit 1 voor tag 2)

profileName

naam van te gebruiken bulkimportprofiel

Tags importeren uit een bestand

boolean importFromFile(tagMask,  
 path,  
 fmtIdx); 
int32 tagMask;
string path;
int32 fmtIdx;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

pad

pad van bestand

fmtIdx

index van formaat

Geeft true terug indien OK.

Tags importeren uit andere tags

importFromTags(tagMask,  
 source,  
 extraction); 
int32 tagMask;
string source;
string extraction;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

bron

formaat om brontekst uit tags op te halen

extractie

reguliere expressie met framenamen en vangsten om uit brontekst te halen

Tags importeren uit andere tags uit geselecteerde bestanden

array importFromTagsToSelection(tagMask,  
 source,  
 extraction); 
int32 tagMask;
string source;
string extraction;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

bron

formaat om brontekst uit tags op te halen

extractie

reguliere expressie met framenamen en vangsten om uit brontekst te halen

returnValues

opgehaalde waarde voor "%{__return}(.+)"

Hoesillustratie van album downloaden

downloadAlbumArt(url,  
 allFilesInDir); 
string url;
boolean allFilesInDir;
 
url

URL van afbeeldingsbestand of albumillustratiebron

allFilesInDir

true om de afbeelding aan alle bestanden in de map toe te voegen

Tags exporteren naar een bestand

boolean exportToFile(tagMask,  
 path,  
 fmtIdx); 
int32 tagMask;
string path;
int32 fmtIdx;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

pad

pad van bestand

fmtIdx

index van formaat

Geeft true terug indien OK.

Een afspeellijst aanmaken

boolean createPlaylist(); 
 

Geeft true terug indien OK.

Items uit een afspeellijst halen

array getPlaylistItems(path); 
string path;
 
pad

Pad naar afspeellijstbestand

Geeft lijst terug met absolute paden naar items in afspeellijst.

Items van een afspeellijst instellen

boolean setPlaylistItems(pad,  
 items); 
string pad;
array items;
 
pad

Pad naar afspeellijstbestand

items

Lijst met absolute paden naar items in afspeellijst

Geeft true terug indien OK, false indien niet alle items zijn gevonden en toegevoegd of opslaan is mislukt.

Sluit de toepassing

afsluiten(); 
 

Alle bestanden selecteren

selectAll(); 
 

Selectie van alle bestanden ongedaan maken

deselectAll(); 
 

Het eerste bestand als het huidige bestand instellen

boolean firstFile(); 
 

Geeft true terug als er een eerste bestand is.

Het vorige bestand als het huidige bestand instellen

boolean previousFile(); 
 

Geeft true terug als er een vorig bestand is.

Het volgende bestand als het huidige bestand instellen

boolean nextFile(); 
 

Geeft true terug als er een volgend bestand is.

Het eerste bestand selecteren

boolean selectFirstFile(); 
 

Geeft true terug als er een eerste bestand is.

Het vorige bestand selecteren

boolean selectPreviousFile(); 
 

Geeft true terug als er een vorig bestand is.

Het volgende bestand selecteren

boolean selectNextFile(); 
 

Geeft true terug als er een volgend bestand is.

De huidige bestand selecteren

boolean selectCurrentFile(); 
 

Geeft true terug als er een huidig bestand is.

Het huidige bestandsitem uit- of invouwen als het een map is

boolean expandDirectory(); 
 

Een bestandslijstitem is een map als getFileName() een naam teruggeeft met '/' als het laatste teken.

Geeft true terug als het huidige bestands item een map is.

Het bestandsnaamformaat toepassen

applyFilenameFormat(); 
 

Het tagformaat toepassen

applyTagFormat(); 
 

Tekst-codering toepassen

applyTextEncoding(); 
 

Mapnaam uit de tags instellen

boolean setDirNameFromTag(tagMask,  
 format,  
 create); 
int32 tagMask;
string format;
boolean create;
 
tagMask

tag mask (bit 0 voor tag 1, bit 1 voor tag 2)

opmaak

mapnaamformaat

aanmaken

true om aan te maken, false om te hernoemen

Geeft true terug indien OK, anders is de foutmelding beschikbaar met getErrorMessage().

Opvolgende tracknummers instellen in de geselecteerde bestanden

numberTracks(tagMask,  
 firstTrackNr); 
int32 tagMask;
int32 firstTrackNr;
 
tagMask

tag mask (bit 0 voor tag 1, bit 1 voor tag 2)

firstTrackNr

te gebruiken nummer voor het eerste bestand

De bestanden filteren

filter(expression); 
string expression;
 
expressie

filterexpressie

ID3v2.3 tags naar ID3v2.4 converteren

convertToId3v24(); 
 

ID3v2.4 tags naar ID3v2.3 converteren

convertToId3v23(); 
 

Geeft true terug indien OK.

Pad van map ophalen

string getDirectoryName(); 
 

Geeft absolute pad naar map terug.

Naam van huidig bestand ophalen

string getFileName(); 
 

Geeft absolute bestandsnaam terug, eindigt met "/" als het een map is.

Naam van geselecteerd bestand instellen

setFileName(naam); 
string naam;
 
naam

bestandsnaam

Het bestand zal hernoemd worden wanneer de map wordt opgeslagen.

Te gebruiken formaat instellen bij instellen van de bestandsnaam uit de tags

setFileNameFormat(formaat); 
string formaat;
 
opmaak

bestandsnaamformaat

De bestandsnamen van de geselecteerde bestanden instellen uit de tags

setFileNameFromTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Waarde van frame ophalen

string getFrame(tagMask,  
 naam); 
int32 tagMask;
string naam;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

naam

naam van frame (bijv. "artiest")

Om de binaire gegevens zoals een afbeelding, kan de naam van een te schrijven bestand toegevoegd worden na de naam, bijv. "Afbeelding:/pad/naar/bestand". Op dezelfde manier kunnen gesynchroniseerde liedteksten geëxporteerd worden, bijv. "SYLT:/pad/naar/bestand".

Geeft waarde van frame terug.

Stelt waarde van frame in

boolean setFrame(tagMask,  
 naam,  
 waarde); 
int32 tagMask;
string naam;
string waarde;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

naam

naam van frame (bijv. "artiest")

waarde

waarde van frame

Voor tag 2 (tagMask 2), als er geen frame met naam bestaat, wordt een nieuw frame toegevoegd, als waarde leeg is, wordt het frame verwijderd. Om binaire gegevens, zoals een afbeelding, kan een bestand worden toegevoegd na naam, bijv. "Afbeelding:/pad/naar/bestand". "SYLT:/path/to/file" kan gebruikt worden om gesynchroniseerde liedteksten te importeren.

Geeft true terug indien OK.

Alle frames van een tag ophalen

array of string getTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Geeft lijst terug met afwisselend namen van frames en waarden.

Technische informatie over bestand ophalen

array van tekenreeks getInformation(); 
 

Eigenschappen zijn formaat, bitsnelheid, samplesnelheid, kanalen, tijdsduur, kanaalmodus, VBR, Tag 1, Tag 2. Eigenschappen die niet beschikbaar zijn zijn weggelaten.

Geeft lijst terug met afwisselend eigenschapnamen en waarden.

Tag uit bestandsnaam instellen

setTagFromFileName(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Tag instellen uit andere tag

setTagFromOtherTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Tag kopiëren

copyTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Tag plakken

pasteTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

Tag verwijderen

removeTag(tagMask); 
int32 tagMask;
 
tagMask

tagbit (1 voor tag 1, 2 voor tag 2)

De configuratie opnieuw inlezen

reparseConfiguration(); 
 

Geautomatiseerde configuratiewijzigingen zijn mogelijk door het configuratiebestand te wijzigen en daarna de configuratie opnieuw in te lezen.

Speelt de geselecteerde bestanden

playAudio();