http://docs.kde.org/
AnteriorA Interface de D-BusPróximo

API de D-Bus

A API de D-Bus está definida em org.kde.Kid3.xml. A interface do Kid3 tem os seguintes métodos:

Abrir um ficheiro ou pasta

boolean openDirectory(localização); 
string localização;
 
localização

localização de um ficheiro ou pasta

Devolve verdadeiro se OK.

Descarrega as marcas de todos os ficheiros que não estejam modificados ou seleccionados

unloadAllTags(); 
 

Grava todos os ficheiros modificados

boolean save(); 
 

Devolve verdadeiro se OK.

Obtém uma mensagem de erro detalhada oferecida por alguns dos métodos

string getErrorMessage(); 
 

Devolve uma mensagem de erro detalhada.

Reverte as modificações nos ficheiros seleccionados

revert(); 
 

Inicia uma importação automática em lote

boolean batchImport(mascaraMarcas,  
 nomePerfil); 
int32 mascaraMarcas;
string nomePerfil;
 
mascaraMarcas

máscara de marcas (bit 0 para a marca 1, bit 1 para a marca 2)

nomePerfil

nome do perfil de importação em lote a usar

Importar as marcas de um ficheiro

boolean importFromFile(mascaraMarcas,  
 localização,  
 indFmt); 
int32 mascaraMarcas;
string localização;
int32 indFmt;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

localização

localização do ficheiro

indFmt

índice do formato

Devolve verdadeiro se OK.

Importar as marcas de outras marcas

importFromTags(mascaraMarcas,  
 origem,  
 extracção); 
int32 mascaraMarcas;
string origem;
string extracção;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

origem

o formato para obter o texto da origem a partir das marcas

extracção

expressão regular com os nomes dos pacotes e as capturas para extrair os dados a partir do texto de origem

Imptrar as marcas de outras marcas nos ficheiros seleccionados

array importFromTagsToSelection(mascaraMarcas,  
 origem,  
 extracção); 
int32 mascaraMarcas;
string origem;
string extracção;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

origem

o formato para obter o texto da origem a partir das marcas

extracção

expressão regular com os nomes dos pacotes e as capturas para extrair os dados a partir do texto de origem

returnValues

valor extraído para o "%{__return}(.+)"

Obter as imagens da capa do álbum

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

URL do ficheiro da imagem ou recurso artístico do álbum

todosFicheirosNaPasta

verdadeiro para adicionar a imagem a todos os ficheiros na pasta

Exportar as marcas para um ficheiro

boolean exportToFile(mascaraMarcas,  
 localização,  
 indFmt); 
int32 mascaraMarcas;
string localização;
int32 indFmt;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

localização

localização do ficheiro

indFmt

índice do formato

Devolve verdadeiro se OK.

Criar uma lista de reprodução

boolean createPlaylist(); 
 

Devolve verdadeiro se OK.

Obter os itens de uma lista de reprodução

array getPlaylistItems(localização); 
string localização;
 
localização

localização do ficheiro da lista de reprodução

Devolve uma lista com as localizações absolutas dos itens da lista de reprodução.

Define os itens de uma lista de reprodução

boolean setPlaylistItems(localização,  
 itens); 
string localização;
array itens;
 
localização

localização do ficheiro da lista de reprodução

itens

lista de localizações absolutas dos itens da lista de reprodução

Devolve verdadeiro se OK, ou falso se nem todos os itens foram encontrados ou se a adição ou gravação ou gravação foi mal-sucedida.

Sair da aplicação

quit(); 
 

Seleccionar todos os ficheiros

selectAll(); 
 

Deseleccionar todos os ficheiros

deselectAll(); 
 

Configura o primeiro ficheiro como o ficheiro actual

boolean firstFile(); 
 

Devolve verdadeiro se existe um primeiro ficheiro.

Configura o ficheiro anterior como sendo o actual

boolean previousFile(); 
 

Devolve verdadeiro se existe um ficheiro anterior.

Configura o ficheiro seguinte como sendo o actual

boolean nextFile(); 
 

Devolve verdadeiro se existe um ficheiro seguinte.

Selecciona o primeiro ficheiro

boolean selectFirstFile(); 
 

Devolve verdadeiro se existe um primeiro ficheiro.

Seleccionar o ficheiro anterior

boolean selectPreviousFile(); 
 

Devolve verdadeiro se existe um ficheiro anterior.

Seleccionar o ficheiro seguinte

boolean selectNextFile(); 
 

Devolve verdadeiro se existe um ficheiro seguinte.

Seleccionar o ficheiro actual

boolean selectCurrentFile(); 
 

Devolve verdadeiro se existe um ficheiro actual.

Expande ou fecha o item do ficheiro actual se for uma pasta

boolean expandDirectory(); 
 

Um item de lista de ficheiros é uma pasta se o getFileName() devolver um um nome com '/' como último carácter.

Devolve verdadeiro se o item do ficheiro actual for uma pasta.

Aplicar o formato de nomes dos ficheiros

applyFilenameFormat(); 
 

Aplicar o formato das marcas

applyTagFormat(); 
 

Aplicar a codificação do texto

applyTextEncoding(); 
 

Definir o nome da pasta a partir das marcas

boolean setDirNameFromTag(mascaraMarcas,  
 formato,  
 criar); 
int32 mascaraMarcas;
string formato;
boolean criar;
 
mascaraMarcas

máscara de marcas (bit 0 para a marca 1, bit 1 para a marca 2)

formato

formato dos nomes dos ficheiros

criar

verdadeiro para criar, falso para mudar o nome

Devolve verdadeiro se OK, caso contrário a mensagem de erro estará disponível se usar o getErrorMessage().

Define os números das faixas subsequentes nos ficheiros seleccionados

numberTracks(mascaraMarcas,  
 nrPrimeiraFaixa); 
int32 mascaraMarcas;
int32 nrPrimeiraFaixa;
 
mascaraMarcas

máscara de marcas (bit 0 para a marca 1, bit 1 para a marca 2)

nrPrimeiraFaixa

número a usar para o primeiro ficheiro

Filtrar os ficheiros

filter(expressão); 
string expressão;
 
expressão

expressão de filtragem

Converter as marcas de ID3v2.3 para ID3v2.4

convertToId3v24(); 
 

Converter as marcas de ID3v2.4 para ID3v2.3

convertToId3v23(); 
 

Devolve verdadeiro se OK.

Obter a localização da pasta

string getDirectoryName(); 
 

Devolve a localização absoluta da pasta.

Obtém o nome do ficheiro actual

string getFileName(); 
 

Devolve a localização absoluta do nome do ficheiro; termina com "/" se for uma pasta.

Define o nome do ficheiro seleccionado

setFileName(nome); 
string nome;
 
nome

nome do ficheiro

O ficheiro irá mudar de nome quando a pasta for gravada.

Define o formato a usar quando definir o nome do ficheiro a partir das marcas

setFileNameFormat(formato); 
string formato;
 
formato

formato dos nomes dos ficheiros

Configura os nomes dos ficheiros para os ficheiros seleccionados a partir das marcas

setFileNameFromTag(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Obter o valor do pacote

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

bit da marca (1 para a marca 1, 2 para a marca 2)

nome

nome do pacote (p.ex. "artist")

Para obter dados binários, como uma imagem, o nome do ficheiro a gravar pode ser adicionado a seguir ao name, p.ex. "Picture:/local/do/ficheiro". Da mesma forma, também poderão ser exportadas, p.ex. "SYLT:/local/do/ficheiro".

Devolve o valor do pacote.

Configurar o valor do pacote

boolean setFrame(mascaraMarcas,  
 nome,  
 valor); 
int32 mascaraMarcas;
string nome;
string valor;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

nome

nome do pacote (p.ex. "artist")

valor

valor do pacote

Para a marca 2 (tagMask 2), se não existir nenhum pacote chamado nome, será adicionado um novo pacote; se o valor estiver vazio, o pacote é removido. Para adicionar dados binários, como uma imagem, poderá adicionar um ficheiro a seguir ao nome, p.ex. "Picture:/local/do/ficheiro". "SYLT:/local/do/ficheiro" pode ser usado para importar as letras sincronizadas.

Devolve verdadeiro se OK.

Obter todos os pacotes de uma marca

lista de textos getTag(tagMask); 
int32 tagMask;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Devolve uma lista com os nomes e valores dos pacotes de forma alternada.

Obter informações técnicas sobre o ficheiro

lista de textos getInformation(); 
 

As propriedades são o Formato, Taxa de Dados, Taxa de Amostragem, Canais, Duração, Modo do Canal, VBR, Marca 1, Marca 2. Propriedades; os que não estiverem disponíveis são omitidos.

Devolve uma lista alternada entre os nomes e os valores das propriedades.

Configurar uma marca a partir do nome do ficheiro

setTagFromFileName(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Configurar uma marca a partir de outra marca

setTagFromOtherTag(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Copiar a marca

copyTag(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Colar a marca

pasteTag(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Remover a marca

removeTag(mascaraMarcas); 
int32 mascaraMarcas;
 
mascaraMarcas

bit da marca (1 para a marca 1, 2 para a marca 2)

Volta a processar a configuração

reparseConfiguration(); 
 

As mudanças automatizadas da configuração serão possíveis se modificar o ficheiro de configuração e depois voltar a processar a configuração.

Reproduz os ficheiros seleccionados

playAudio();