http://docs.kde.org/
FöregåendeD-Bus gränssnittNästa

D-Bus programmeringsgränssnitt

Programmeringsgränssnittet för D-Bus specificeras i org.kde.Kid3.xml. Gränssnittet i Kid3 har följande metoder:

Öppna fil eller katalog

boolean openDirectory(path); 
string path;
 
sökväg

sökväg till fil eller katalog

Returnerar true om ok.

Ladda ur taggarna för alla filer som inte är ändrade eller markerade

unloadAllTags(); 
 

Spara alla ändrade filer

boolean save(); 
 

Returnerar true om ok.

Hämta ett detaljerat felmeddelande som tillhandahålls av vissa metoder

string getErrorMessage(); 
 

Returnerar detaljerat felmeddelande.

Ångrar ändringar i markerade filer

revert(); 
 

Starta en automatisk import i bakgrunden

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

taggmask (bit 0 för tagg 1, bit 1 för tagg 2)

profileName

namn på bakgrundsimportprofil att använda

Importera taggar från en fil

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

taggbit (1 för tagg 1, 2 för tagg 2)

sökväg

sökväg till fil

fmtIdx

formatets index

Returnerar true om ok.

importera taggar från andra taggar

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

taggbit (1 för tagg 1, 2 för tagg 2)

källa

format för att hämta källtext från taggar

extrahering

reguljärt uttryck med ramnamn och infångningar för att extraheara från källtext

importera taggar från andra taggar för markerade filer

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

taggbit (1 för tagg 1, 2 för tagg 2)

källa

format för att hämta källtext från taggar

extrahering

reguljärt uttryck med ramnamn och infångningar för att extraheara från källtext

returnValues

extraherat värde för "%{__return}(.+)"

Ladda ner albumomslag

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

Webbadress till bildfil eller albumomslagsresurs

allFilesInDir

true för att lägga till bilden i alla filer i katalogen

Exportera taggar till en fil

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

taggbit (1 för tagg 1, 2 för tagg 2)

sökväg

sökväg till fil

fmtIdx

formatets index

Returnerar true om ok.

Skapa en spellista

boolean createPlaylist(); 
 

Returnerar true om ok.

Hämta objekt i en spellista

array getPlaylistItems(path); 
string path;
 
sökväg

sökväg till spellistefil

Returerar en lista över absoluta sökvägar till objekt i spellistan.

Tilldela objekten i en spellista

boolean setPlaylistItems(path,  
 items); 
string path;
array items;
 
sökväg

sökväg till spellistefil

items

lista över absoluta sökvägar till objekt i spellistan

Returnerar true om ok, false om inte alla objekt hittades och lades till eller spara misslyckades.

Avsluta programmet

avsluta(); 
 

Markera alla filer

selectAll(); 
 

Avmarkera alla filer

deselectAll(); 
 

Ställ in första filen som den aktuella filen

boolean firstFile(); 
 

Returnerar true om det finns en första fil.

Ställ in föregående fil som den aktuella filen

boolean previousFile(); 
 

Returnerar true om det finns en föregående fil.

Ställ in nästa fil som den aktuella filen

boolean nextFile(); 
 

Returnerar true om det finns en nästa fil.

Markera första filen

boolean selectFirstFile(); 
 

Returnerar true om det finns en första fil.

Markera föregående fil

boolean selectPreviousFile(); 
 

Returnerar true om det finns en föregående fil.

Markera nästa fil

boolean selectNextFile(); 
 

Returnerar true om det finns en nästa fil.

Markera aktuell fil

boolean selectCurrentFile(); 
 

Returnerar true om det finns en aktuell fil.

Expandera eller dra ihop aktuellt filobjekt om det är en katalog

boolean expandDirectory(); 
 

Ett objekt i fillistan är en katalog om getFileName() returnerar ett namn med '/' som det sista tecknet.

Returnera true om aktuellt filobjekt är en katalog.

Verkställ filnamnsformatet

applyFilenameFormat(); 
 

Verkställ taggformatet

applyTagFormat(); 
 

Verkställ textkodning

applyTextEncoding(); 
 

Ange katalognamn från taggar

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

taggmask (bit 0 för tagg 1, bit 1 för tagg 2)

format

katalognamnsformat

skapa

true för att skapa, false för att byta namn

Returnerar true om ok, annars är felmeddelandet tillgängligt genom att använda getErrorMessage().

Ställ in följande spårnummer i markerade filer

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

taggmask (bit 0 för tagg 1, bit 1 för tagg 2)

firstTrackNr

nummer att använda för första fil

Filtrera filerna

filter(expression); 
string expression;
 
uttryck

filteruttryck

Konvertera ID3v2.3 taggar till ID3v2.4

convertToId3v24(); 
 

Konvertera ID3v2.4 taggar till ID3v2.3

convertToId3v23(); 
 

Returnerar true om ok.

Hämta katalogens sökväg

string getDirectoryName(); 
 

Returnerar katalogens absoluta sökväg.

Hämta namnet på den aktuella filen

string getFileName(); 
 

Returnerar det verkliga absoluta filnamnet, slutar med "/" om det är en katalog.

Ställ in namnet på markerad fil

setFileName(name); 
string name;
 
namn

filnamn

Filens namn byts när katalogen sparas.

Ställ in format att använda när filnamnet ställs in från taggarna

setFileNameFormat(format); 
string format;
 
format

filnamnsformat

Ställ in filnamn för markerade filer från taggarna

setFileNameFromTag(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Hämta ramens värde

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

taggbit (1 för tagg 1, 2 för tagg 2)

namn

ramens namn (t.ex. "artist")

För att hämta binärdata, som en bild, kan namnet på en fil att skriva till läggas till efter namn, t.ex. ""Picture:/path/to/file". På samma sätt kan synkroniserad sångtext exporteras, t.ex. "SYLT:/sökväg/till/fil".

Returnerar ramens värde.

Tilldela ramens värde

boolean setFrame(tagMask,  
 name,  
 value); 
int32 tagMask;
string name;
string value;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

namn

ramens namn (t.ex. "artist")

värde

ramens värde

Om det inte finns någon ram med namn för tagg 2 (tagMask 2), läggs en ny ram till. Om värde är tomt, tas ramen bort. För att lägga till binärdata, som en bild, kan en fil läggas till efter namn, t.ex. ""Picture:/path/to/file". "SYLT:/sökväg/till/fil" kan användas för att importera synkroniserad sångtext.

Returnerar true om ok.

Hämta alla ramar i en tagg

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

taggbit (1 för tagg 1, 2 för tagg 2)

Returnerar lista med alternerande ramnamn och värden.

Hämta teknisk information om filen

array of string getInformation(); 
 

Egenskaperna är Format, Bithastighet, Samplingsfrekvens, Kanaler, Längd, Kanalläge, VBR, Tagg 1, Tagg 2. Egenskaper som inte är tillgängliga utelämnas.

Returnerar lista med alternerande egenskapsnamn och värden.

Tilldela tagg från filnamn

setTagFromFileName(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Tilldela tagg från en annan tagg

setTagFromOtherTag(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Kopiera tagg

copyTag(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Klistra in tagg

pasteTag(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Ta bort tagg

removeTag(tagMask); 
int32 tagMask;
 
tagMask

taggbit (1 för tagg 1, 2 för tagg 2)

Tolka om inställningen

reparseConfiguration(); 
 

Automatiserade inställningsändringar är möjliga genom att ändra inställningsfilen och sedan tolka om inställningen.

Spelar markerade filer

playAudio();