API D-Bus

Le API D-Bus è specificata in org.kde.Kid3.xml. L'interfaccia di Kid3 ha i seguenti metodi:

Aprire un file o una cartella

boolean openDirectory(percorso); 
string percorso;
 
percorso

percorso a un file o a una cartella

Restituisce vero se OK.

Scaricare i tag di tutti i file che non sono stati modificati o selezionati

unloadAllTags(); 
 

Salvare tutti i file modificati

boolean save(); 
 

Restituisce vero se OK.

Ricevere un messaggio di errore dettagliato fornito da alcuni metodi

string getErrorMessage(); 
 

Restituisce il messaggio di errore dettagliato.

Ripristina le modifiche nei file selezionati

revert(); 
 

Avvia un'importazione in serie automatica

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

maschera del tag (bit 0 per tag 1, bit 1 per tag 2)

profileName

nome del profilo di importazione in serie da utilizzare

Importare i tag da un file

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

bit del tag (1 per tag 1, 2 per tag 2)

percorso

percorso del file

fmtIdx

Indice di formato

Restituisce vero se OK.

Importare i tag da altri tag

importFromTags(tagMask,  
 origine,  
 estrazione); 
int32 tagMask;
string origine;
string estrazione;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

origine

formato per ottenere il testo originale dai tag

estrazione

espressione regolare con i nomi dei frame e le catture per estrarre il testo originale

Importare i tag da altri tag sui file selezionati

array importFromTagsToSelection(tagMask,  
 origine,  
 estrazione); 
int32 tagMask;
string origine;
string estrazione;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

origine

formato per ottenere il testo originale dai tag

estrazione

espressione regolare con i nomi dei frame e le catture per estrarre il testo originale

returnValues

valore estratto per «%{__return}(.+)»

Scaricare la copertina dell'album

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

URL di un'immagine o di una copertina

allFilesInDir

vero per aggiungere l'immagine a tutti i file nella cartella

Esportare tag in un file

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

bit del tag (1 per tag 1, 2 per tag 2)

percorso

percorso del file

fmtIdx

Indice di formato

Restituisce vero se OK.

Creare una scaletta

boolean createPlaylist(); 
 

Restituisce vero se OK.

Ottenere gli elementi di una scaletta

array getPlaylistItems(percorso); 
string percorso;
 
percorso

percorso al file della scaletta

Restituisce un elenco di percorsi assoluti agli elementi della scaletta.

Impostare gli elementi di una scaletta

boolean setPlaylistItems(percorso,  
 elementi); 
string percorso;
array elementi;
 
percorso

percorso al file della scaletta

elementi

elenco di percorsi assoluti agli elementi della scaletta

Restituisce vero se OK, falso se non tutti gli elementi sono stati trovati e aggiunti o il salvataggio non è riuscito.

Uscire dall'applicazione

quit(); 
 

Selezionare tutti i file

selectAll(); 
 

Deselezionare tutti i file

deselectAll(); 
 

Impostare il primo file come file attuale

boolean firstFile(); 
 

Restituisce vero se esiste un primo file.

Impostare il file precedente come file attuale

boolean previousFile(); 
 

Restituisce vero se esiste un file precedente.

Impostare il file successivo come file attuale

boolean nextFile(); 
 

Restituisce vero se esiste un file successivo.

Selezionare il primo file

boolean selectFirstFile(); 
 

Restituisce vero se esiste un primo file.

Selezionare il file precedente

boolean selectPreviousFile(); 
 

Restituisce vero se esiste un file precedente.

Selezionare il file successivo

boolean selectNextFile(); 
 

Restituisce vero se esiste un file successivo.

Selezionare il file attuale

boolean selectCurrentFile(); 
 

Restituisce vero se esiste un file attuale.

Espandere o contrarre l'elemento attuale se è una cartella

boolean expandDirectory(); 
 

Una voce dell'elenco dei file è una cartella se getFileName() restituisce un nome con «/» come ultimo carattere.

Restituisce vero se l'elemento attuale è una cartella.

Applicare il formato del nome del file

applyFilenameFormat(); 
 

Applicare il formato del tag

applyTagFormat(); 
 

Applicare la codifica del testo

applyTextEncoding(); 
 

Impostare il nome della cartella dai tag

boolean setDirNameFromTag(tagMask,  
 formato,  
 creare); 
int32 tagMask;
string formato;
boolean creare;
 
tagMask

maschera del tag (bit 0 per tag 1, bit 1 per tag 2)

formato

formato del nome della cartella

creare

vero per creare, falso per rinominare

Restituisce vero se OK, altrimenti il messaggio di errore è disponibile utilizzando getErrorMessage().

Impostare i numeri di traccia successivi nei file selezionati

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

maschera del tag (bit 0 per tag 1, bit 1 per tag 2)

firstTrackNr

numero da utilizzare per il primo file

Filtrare i file

filter(espressione); 
string espressione;
 
espressione

espressione di filtro

Convertire i tag ID3v2.3 in ID3v2.4

convertToId3v24(); 
 

Convertire i tag ID3v2.4 in ID3v2.3

convertToId3v23(); 
 

Restituisce vero se OK.

Ottenere il percorso della cartella

string getDirectoryName(); 
 

Restituisce il percorso assoluto a una cartella.

Ottenere il nome del file attuale

string getFileName(); 
 

Restituisce il vero nome file assoluto, termina con «/» se si tratta di una cartella.

Impostare il nome del file selezionato

setFileName(nome); 
string nome;
 
nome

nome file

Il file sarà rinominato al salvataggio della cartella.

Impostare il formato da utilizzare quando si imposta il nome file dai tag

setFileNameFormat(formato); 
string formato;
 
formato

formato del nome file

Impostare i nomi dei file selezionati dai tag

setFileNameFromTag(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Ottenere il valore del frame

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

bit del tag (1 per tag 1, 2 per tag 2)

nome

nome del frame (ad es. "artista")

Per ottenere dati binari come un'immagine, il nome di un file da scrivere può essere aggiunto dopo il nome, ad es. «Picture:/percorso/a/file». Allo stesso modo, i testi sincronizzati possono essere esportati, ad es. «SYLT:/percorso/a/file».

Restituisce il valore del frame.

Impostare il valore del frame

boolean setFrame(tagMask,  
 nome,  
 valore); 
int32 tagMask;
string nome;
string valore;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

nome

nome del frame (ad es. "artista")

valore

valore del frame

Per il tag 2 (tagMask 2), se non esiste un frame con nome, viene aggiunto un nuovo frame, se il valore è vuoto, il frame è eliminato. Per aggiungere dati binari come un'immagine, è possibile aggiungere un file dopo il nome, ad es. «Picture:/percorso/a/file». «SYLT:/percorso/a/file» può essere usato per importare testi sincronizzati.

Restituisce vero se OK.

Ottenere tutti i frame da un tag

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

bit del tag (1 per tag 1, 2 per tag 2)

Restituisce un elenco con nomi e valori di frame alternati.

Ottenere informazioni tecniche sul file

array di stringhe getInformation(); 
 

Le proprietà sono Formato, Bitrate, Campionamento, Canali, Durata, Modalità canale, VBR, Tag 1, Tag 2. Le proprietà non disponibili sono omesse.

Restituisce un elenco con nomi e valori di proprietà alternati.

Impostare un tag dal nome del file

setTagFromFileName(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Impostare un tag da un altro tag

setTagFromOtherTag(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Copiare un tag

copyTag(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Incollare un tag

pasteTag(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Rimuovere un tag

removeTag(tagMask); 
int32 tagMask;
 
tagMask

bit del tag (1 per tag 1, 2 per tag 2)

Elaborare nuovamente la configurazione

reparseConfiguration(); 
 

Le modifiche automatizzate alla configurazione sono possibili modificando il file di configurazione e quindi elaborando nuovamente la configurazione.

Riproduce i file selezionati

playAudio();