http://docs.kde.org/
Пред.Интерфейс D-BusСлед.

Программный интерфейс D-Bus

Программный интерфейс D-Bus определён в файле org.kde.Kid3.xml. В интерфейсе Kid3 предусмотрены следующие методы:

Открытие файлов или каталогов

boolean openDirectory(path); 
string path;
 
path

путь к файлу или каталогу

Возвращает true, если выполнено успешно.

Выгрузка тегов всех файлов, которые не были изменены или выбраны

unloadAllTags(); 
 

Сохранение всех изменённых файлов

boolean save(); 
 

Возвращает true, если выполнено успешно.

Получение подробного сообщения об ошибке, предоставляемого некоторыми методами

string getErrorMessage(); 
 

Возвращает подробное сообщение об ошибке.

Отмена изменений в выбранных файлах

revert(); 
 

Запуск автоматического пакетного импорта

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

profileName

название профиля пакетного импорта для использования

Импорт тегов из файла

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

path

путь к файлу

fmtIdx

индекс формата

Возвращает true, если выполнено успешно.

Импорт тегов из других тегов

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

source

формат для получения исходного текста из тегов

extraction

регулярное выражение с названиями фреймов и группами скобок для извлечения совпадений из исходного текста

Импорт тегов из других тегов выбранных файлов

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

source

формат для получения исходного текста из тегов

extraction

регулярное выражение с названиями фреймов и группами скобок для извлечения совпадений из исходного текста

returnValues

извлечённое значение для «%{__return}(.+)»

Загрузка обложки альбома

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

URL-адрес файла изображения или источника изображения

allFilesInDir

true, если изображение следует добавить во все файлы в каталоге

Экспорт тегов в файл

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

path

путь к файлу

fmtIdx

индекс формата

Возвращает true, если выполнено успешно.

Создание нового списка воспроизведения

boolean createPlaylist(); 
 

Возвращает true, если выполнено успешно.

Получение элементов списка воспроизведения

array getPlaylistItems(path); 
string path;
 
path

путь к файлу списка воспроизведения

Возвращает список абсолютных путей к элементам списка воспроизведения.

Установка элементов списка воспроизведения

boolean setPlaylistItems(path,  
 items); 
string path;
array items;
 
path

путь к файлу списка воспроизведения

items

список абсолютных путей к элементам списка воспроизведения

Возвращает true, если выполнено успешно, и false, если не все элементы были найдены и добавлены или сохранение завершилось ошибкой.

Выход из приложения

quit(); 
 

Выделение всех файлов

selectAll(); 
 

Отмена выделения всех файлов

deselectAll(); 
 

Установка первого файла в качестве текущего файла

boolean firstFile(); 
 

Возвращает true, если первый файл существует.

Установка предыдущего файла в качестве текущего файла

boolean previousFile(); 
 

Возвращает true, если предыдущий файл существует.

Установка следующего файла в качестве текущего файла

boolean nextFile(); 
 

Возвращает true, если следующий файл существует.

Выделение первого файла

boolean selectFirstFile(); 
 

Возвращает true, если первый файл существует.

Выделение предыдущего файла

boolean selectPreviousFile(); 
 

Возвращает true, если предыдущий файл существует.

Выделение следующего файла

boolean selectNextFile(); 
 

Возвращает true, если следующий файл существует.

Выделение текущего файла

boolean selectCurrentFile(); 
 

Возвращает true, если текущий файл существует.

Разворачивание или сворачивание текущего элемента, если это каталог

boolean expandDirectory(); 
 

Пункт списка файлов является каталогом, если getFileName() возвращает название, последний символ которого — косая черта, «/».

Возвращает true, если текущий элемент — каталог.

Применение формата имени файла

applyFilenameFormat(); 
 

Применение формата тега

applyTagFormat(); 
 

Применить кодировку текста

applyTextEncoding(); 
 

Установка имени каталога из тегов

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

format

формат имени каталога

create

true для создания, false для переименования

Возвращает true, если выполнено успешно, в противном случае воспользуйтесь командой getErrorMessage() для получения сообщения об ошибке

Установка последовательной нумерации дорожек для выделенных файлов

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

firstTrackNr

номер, который будет использоваться для первого файла

Фильтр файлов

filter(expression); 
string expression;
 
expression

фильтрующее выражение

Преобразование тегов ID3v2.3 в ID3v2.4

convertToId3v24(); 
 

Преобразование тегов ID3v2.4 в ID3v2.3

convertToId3v23(); 
 

Возвращает true, если выполнено успешно.

Получение пути к каталогу

string getDirectoryName(); 
 

Возвращает абсолютный путь к каталогу.

Получение имени текущего файла

string getFileName(); 
 

Возвращает абсолютное имя текущего файла. Если это каталог, оно будет завершаться символом «/».

Установка имени выделенного файла

setFileName(name); 
string name;
 
name

название файла

Файл будет переименован при сохранении каталога.

Установка формата, который будет использован при установке названий файлов на основе тегов

setFileNameFormat(format); 
string format;
 
format

формат названия файла

Установка названий выделенных файлов на основе тегов

setFileNameFromTag(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Получение значения фрейма

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

name

название фрейма (например, «artist»)

Чтобы сохранить двоичные данные (например, изображение) в файле, добавьте имя файла к имени фрейма, например: «Picture:/путь/к/файлу». Таким же образом возможно экспортировать синхронизированный текст песни, например: «SYLT:/путь/к/файлу».

Возвращает значение фрейма.

Установка значения фрейма

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

name

название фрейма (например, «artist»)

value

значение фрейма

Для тега 2 (tagMask 2): если фрейма с указанным именем не существует, будет добавлен новый фрейм; если значение параметра «value» пустое, фрейм будет удалён. Чтобы добавить двоичные данные (например, изображение), добавьте имя файла к имени фрейма, например: «Picture:/путь/к/файлу». Таким же образом возможно импортировать синхронизированный текст песни, например: «SYLT:/путь/к/файлу».

Возвращает true, если выполнено успешно.

Получение всех фреймов тега

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

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Возвращает список с чередующимися названиями и значениями фреймов.

Получение технической информации о файле

array of string getInformation(); 
 

Свойствами являются Format, Bitrate, Samplerate, Channels, Duration, Channel Mode, VBR, Tag 1, Tag 2. Свойства, которые недоступны, будут пропущены.

Возвращает список с чередующимися названиями и значениями свойств.

Установка тега на основе имени файла

setTagFromFileName(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Установка тега на основе другого тега

setTagFromOtherTag(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Копирование тега

copyTag(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Вставка тега

pasteTag(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Удаление тега

removeTag(tagMask); 
int32 tagMask;
 
tagMask

маска тега (бит 0 для тега 1, бит 1 для тега 2)

Повторная обработка параметров конфигурации

reparseConfiguration(); 
 

Автоматизированная обработка изменений в параметрах конфигурации доступна посредством внесения изменений в файл конфигурации с их последующей повторной обработкой.

Воспроизведение выбранных файлов

playAudio();