Programmeringsgränssnittet för D-Bus specificeras i org.kde.Kid3.xml
. Gränssnittet i Kid3 har följande metoder:
boolean openDirectory( | path) ; |
string path
;sökväg
sökväg till fil eller katalog
Returnerar true om ok.
string getErrorMessage( | ) ; |
Returnerar detaljerat felmeddelande.
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
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.
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
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}(.+)"
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
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.
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.
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.
boolean firstFile( | ) ; |
Returnerar true om det finns en första fil.
boolean previousFile( | ) ; |
Returnerar true om det finns en föregående fil.
boolean nextFile( | ) ; |
Returnerar true om det finns en nästa fil.
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.
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().
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
string getFileName( | ) ; |
Returnerar det verkliga absoluta filnamnet, slutar med "/" om det är en katalog.
setFileName( | name) ; |
string name
;namn
filnamn
Filens namn byts när katalogen sparas.
setFileNameFormat( | format) ; |
string format
;format
filnamnsformat
setFileNameFromTag( | tagMask) ; |
int32 tagMask
;tagMask
taggbit (1 för tagg 1, 2 för tagg 2)
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.
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.
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.
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.
setTagFromFileName( | tagMask) ; |
int32 tagMask
;tagMask
taggbit (1 för tagg 1, 2 för tagg 2)
setTagFromOtherTag( | tagMask) ; |
int32 tagMask
;tagMask
taggbit (1 för tagg 1, 2 för tagg 2)
reparseConfiguration( | ) ; |
Automatiserade inställningsändringar är möjliga genom att ändra inställningsfilen och sedan tolka om inställningen.