http://docs.kde.org/
AnteriorInterfície de D-BusSegüent

API de D-Bus

L'API de D-Bus s'especifica a org.kde.Kid3.xml. La interfície del Kid3 disposa dels següents mètodes:

Obrir un fitxer o carpeta

boolean openDirectory(camí); 
string camí;
 
camí

camí cap al fitxer o carpeta

Retornarà cert si va bé.

Descarregar les etiquetes de tots els fitxers que no han estat modificats o seleccionats

unloadAllTags(); 
 

Desar tots els fitxers modificats

boolean save(); 
 

Retornarà cert si va bé.

Obtenir un missatge d'error detallat proporcionat per alguns mètodes

string getErrorMessage(); 
 

Retornarà un missatge d'error detallat.

Revertir els canvis fets als fitxers seleccionats

revert(); 
 

Iniciar automàticament una importació per lots

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

màscara de l'etiqueta (bit 0 per a l'etiqueta 1, bit 1 per a l'etiqueta 2)

Nom_Perfil

el nom del perfil que s'emprarà per a la importació per lots

Importar etiquetes des d'un fitxer

boolean importFromFile(tagMask,  
 camí,  
 fmtIdx); 
int32 tagMask;
string camí;
int32 fmtIdx;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

camí

camí del fitxer

fmtIdx

índex del format

Retornarà cert si va bé.

Importar etiquetes des d'altres etiquetes

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

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

font

format per a obtenir el text font a partir de les etiquetes

extracció

expressió regular amb els noms de marc i captures per a extreure del text font

Importar etiquetes des d'altres etiquetes als fitxers seleccionats

array importFromTagsToSelection(tagMask,  
 font,  
 extracció); 
int32 tagMask;
string font;
string extracció;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

font

format per a obtenir el text font a partir de les etiquetes

extracció

expressió regular amb els noms de marc i captures per a extreure del text font

Valors_Retornats

valor extret per «%{__return}(.+)»

Descarregar una caràtula de l'àlbum

downloadAlbumArt(URL,  
 tots_els_fitxers_a_la_carpeta); 
string URL;
boolean tots_els_fitxers_a_la_carpeta;
 
URL

URL del fitxer d'imatge o recurs de caràtula

tots_els_fitxers_a_la_carpeta

cert per a afegir la imatge a tots els fitxers que hi ha a la carpeta

Exportar les etiquetes a un fitxer

boolean exportToFile(tagMask,  
 camí,  
 fmtIdx); 
int32 tagMask;
string camí;
int32 fmtIdx;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

camí

camí del fitxer

fmtIdx

índex del format

Retornarà cert si va bé.

Crear una llista de reproducció

boolean createPlaylist(); 
 

Retornarà cert si va bé.

Obtenir els elements d'una llista de reproducció

array getPlaylistItems(camí); 
string camí;
 
camí

camí a la llista de reproducció

Retornarà la llista dels camins absoluts als elements de la llista de reproducció.

Establir els elements d'una llista de reproducció

boolean setPlaylistItems(camí,  
 elements); 
string camí;
array elements;
 
camí

camí a la llista de reproducció

elements

llista dels camins absoluts als elements de la llista de reproducció

Retornarà cert si va bé i fals si no s'han trobat tots els elements, també si s'ha fallat en afegir o desar.

Surt de l'aplicació

quit(); 
 

Seleccionar tots els fitxers

selectAll(); 
 

Desseleccionar tots els fitxers

deselectAll(); 
 

Establir el primer fitxer com a fitxer actual

boolean firstFile(); 
 

Retornarà cert si hi ha un primer fitxer.

Establir el fitxer anterior com a fitxer actual

boolean previousFile(); 
 

Retornarà cert si hi ha un fitxer anterior.

Establir el següent fitxer com a fitxer actual

boolean nextFile(); 
 

Retornarà cert si hi ha un fitxer següent.

Selecciona el primer fitxer

boolean selectFirstFile(); 
 

Retornarà cert si hi ha un primer fitxer.

Seleccionar el fitxer anterior

boolean selectPreviousFile(); 
 

Retornarà cert si hi ha un fitxer anterior.

Seleccionar el següent fitxer

boolean selectNextFile(); 
 

Retornarà cert si hi ha un fitxer següent.

Seleccionar el fitxer actual

boolean selectCurrentFile(); 
 

Retornarà cert si hi ha un fitxer actual.

Expandir o contraure l'element de fitxer actual si es tracta d'una carpeta

boolean expandDirectory(); 
 

Un element de la llista de fitxers serà una carpeta si «getFileName()» retorna un nom amb «/» com a últim caràcter.

Retornarà cert si l'element de fitxer actual és una carpeta.

Aplicar el format per al nom del fitxer

applyFilenameFormat(); 
 

Aplicar el format per a les etiquetes

applyTagFormat(); 
 

Aplicar la codificació del text

applyTextEncoding(); 
 

Establir el nom de la carpeta a partir de les etiquetes

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

màscara de l'etiqueta (bit 0 per a l'etiqueta 1, bit 1 per a l'etiqueta 2)

format

format per al nom de la carpeta

create

cert per a crear i fals per a reanomenar

Retornarà cert si va bé, en cas contrari, el missatge d'error estarà disponible utilitzant «getErrorMessage()».

Establir els números de peça subsegüents en els fitxers seleccionats

numberTracks(tagMask,  
 NúmPrimeraPeça); 
int32 tagMask;
int32 NúmPrimeraPeça;
 
tagMask

màscara de l'etiqueta (bit 0 per a l'etiqueta 1, bit 1 per a l'etiqueta 2)

NúmPrimeraPeça

número a utilitzar per al primer fitxer

Filtratge de fitxers

filter(expressió); 
string expressió;
 
expressió

expressió de filtre

Convertir entre les etiquetes ID3 versió 2.3 i 2.4

convertToId3v24(); 
 

Convertir entre les etiquetes ID3 versió 2.4 i 2.3

convertToId3v23(); 
 

Retornarà cert si va bé.

Obtenir el camí de la carpeta

string getDirectoryName(); 
 

Retornarà el camí absolut de la carpeta.

Obtenir el nom del fitxer actual

string getFileName(); 
 

Retornarà el nom de fitxer absolut veritable, finalitzarà amb «/» si és una carpeta.

Establir el nom del fitxer seleccionat

setFileName(nom); 
string nom;
 
nom

nom del fitxer

El fitxer serà reanomenat quan es desi la carpeta.

Establir el format que s'utilitzarà en establir el nom del fitxer a partir de les etiquetes

setFileNameFormat(format); 
string format;
 
format

format per al nom del fitxer

Establir els noms de fitxer a partir dels fitxers seleccionats des de les etiquetes

setFileNameFromTag(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Obtenir el valor del marc

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

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

nom

nom del marc (p. ex., «artista»)

Per a obtenir les dades binàries com una imatge, es podrà afegir el nom d'un fitxer per a escriure després del nom, p. ex., «Picture:/camí/al/fitxer». De la mateixa manera, es pot exportar una lletra sincronitzada, p. ex., «SYLT:/camí/al/fitxer».

Retornarà el valor del marc.

Establir el valor del marc

boolean setFrame(tagMask,  
 nom,  
 valor); 
int32 tagMask;
string nom;
string valor;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

nom

nom del marc (p. ex., «artista»)

valor

valor del marc

Per a l'etiqueta 2 (tagMask 2), si no hi ha un marc amb nom, s'afegirà un marc nou, si el valor està buit, el marc se suprimirà. Per a afegir dades binàries com una imatge, es pot afegir un fitxer després del nom, p. ex., es pot fer servir «Picture:/camí/a/fitxer». "SYLT:/camí/a/fitxer" per a importar la lletra sincronitzada.

Retornarà cert si va bé.

Obtenir tots els marcs d'una etiqueta

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

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Retornarà una llista amb els noms i valors dels marcs de forma alterna.

Obtenir la informació tècnica sobre el fitxer

array of string getInformation(); 
 

Les propietats són Format, Velocitat de bits, Velocitat de mostreig, Canals, Durada, Mode del canal, VBR, Etiqueta 1, Etiqueta 2. S'ometran les propietats que no estiguin disponibles.

Retornarà una llista amb els noms i valors de les propietats de forma alterna.

Establir l'etiqueta a partir del nom de fitxer

setTagFromFileName(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Establir l'etiqueta a partir d'una altra etiqueta

setTagFromOtherTag(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Copiar una etiqueta

copyTag(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Enganxar una etiqueta

pasteTag(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Eliminar una etiqueta

removeTag(tagMask); 
int32 tagMask;
 
tagMask

bit de l'etiqueta (1 per a l'etiqueta 1, 2 per a l'etiqueta 2)

Tornar a analitzar la configuració

reparseConfiguration(); 
 

És possible fer canvis automatitzats de la configuració modificant el fitxer de configuració i després tornant a analitzar la configuració.

Reproduir els fitxers seleccionats

playAudio();