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

Програмний інтерфейс D-Bus визначено у файлі org.kde.Kid3.xml. У програмному інтерфейсі Kid3 передбачено такі методи:

Відкриття файла або теки

boolean openDirectory(шлях); 
string шлях;
 
шлях

шлях до файла або теки

Повертає true, якщо виконано вдало.

Вивантаження міток усіх файлів, які не змінено і не позначено

unloadAllTags(); 
 

Збереження усіх змінених файлів

boolean save(); 
 

Повертає true, якщо виконано вдало.

Отримання докладного повідомлення щодо помилки, яке надається іншими методами

string getErrorMessage(); 
 

Повертає докладне повідомлення про помилку.

Скасовування змін у позначених файлах

revert(); 
 

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

boolean batchImport(маскаМітки,  
 назваПрофілю); 
int32 маскаМітки;
string назваПрофілю;
 
маскаМітки

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

назваПрофілю

назва профілю пакетного імпортування, яким слід скористатися

Імпортуванням міток з файла

boolean importFromFile(маскаМітки,  
 шлях,  
 індексФормату); 
int32 маскаМітки;
string шлях;
int32 індексФормату;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

шлях

шлях до файла

індексФормату

індекс формату

Повертає true, якщо виконано вдало.

Імпортування міток з інших міток

importFromTags(маскаМітки,  
 джерело,  
 видобування); 
int32 маскаМітки;
string джерело;
string видобування;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

джерело

формат для отримання тексту-джерела для міток

видобування

формальний вираз із назвами кадрів або вирізаних підрядків для видобування із тексту-джерела

Імпортування міток з інших міток позначених файлів

array importFromTagsToSelection(маскаМітки,  
 джерело,  
 видобування); 
int32 маскаМітки;
string джерело;
string видобування;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

джерело

формат для отримання тексту-джерела для міток

видобування

формальний вираз із назвами кадрів або вирізаних підрядків для видобування із тексту-джерела

повернутіЗначення

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

Отримання зображення обкладинки альбому

downloadAlbumArt(адреса,  
 усіФайлиУТеці); 
string адреса;
boolean усіФайлиУТеці;
 
адреса

адреса файла зображення або ресурсу зображення обкладинки альбому

усіФайлиУТеці

true, якщо зображення слід додати до усіх файлів у теці

Експортування міток до файла

boolean exportToFile(маскаМітки,  
 шлях,  
 індексФормату); 
int32 маскаМітки;
string шлях;
int32 індексФормату;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

шлях

шлях до файла

індексФормату

індекс формату

Повертає true, якщо виконано вдало.

Створення списку відтворення

boolean createPlaylist(); 
 

Повертає true, якщо виконано вдало.

Отримання записів у списку відтворення

array getPlaylistItems(шлях); 
string шлях;
 
шлях

шлях до файла списку відтворення

Повертає список абсолютних шляхів до файлів-пунктів списку відтворення.

Встановлення записів списку відтворення

boolean setPlaylistItems(шлях,  
 пункти); 
string шлях;
array пункти;
 
шлях

шлях до файла списку відтворення

пункти

список абсолютних шляхів до файлів-пунктів списку відтворення

Повертає 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(маскаМітки,  
 формат,  
 створення); 
int32 маскаМітки;
string формат;
boolean створення;
 
маскаМітки

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

формат

формат назви теки

створення

true для створення, false для перейменування

Повертає true, якщо дію виконано вдало. Якщо дію не вдалося виконати, повертає повідомлення про помилку, доступ до якого можна отримати за допомогою getErrorMessage().

Встановлення послідовної нумерації доріжок для позначених файлів

numberTracks(маскаМітки,  
 номерПершоїДоріжки); 
int32 маскаМітки;
int32 номерПершоїДоріжки;
 
маскаМітки

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

номерПершоїДоріжки

номер, який слід використати для першого файла

Фільтрування файлів

filter(вираз); 
string вираз;
 
вираз

вираз для фільтрування

Перетворення міток ID3v2.3 на ID3v2.4

convertToId3v24(); 
 

Перетворення міток ID3v2.4 на ID3v2.3

convertToId3v23(); 
 

Повертає true, якщо виконано вдало.

Отримання шляху до теки

string getDirectoryName(); 
 

Повертає абсолютний шлях до теки.

Отримання назви поточного файла

string getFileName(); 
 

Повертає абсолютну назву поточного файла, яка завершуватиметься на «/», якщо це тека.

Встановлення назви позначеного файла

setFileName(назва); 
string назва;
 
назва

назва файла

Файл буде перейменовано при збереженні теки.

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

setFileNameFormat(формат); 
string формат;
 
формат

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

Встановлення назв позначених файлів на основі міток

setFileNameFromTag(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Отримання значення кадру

string getFrame(маскаМітки,  
 назва); 
int32 маскаМітки;
string назва;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

назва

назва кадру (наприклад "artist")

Щоб отримати двійкові дані, наприклад зображення, можна додати назву файла, куди буде записано дані, після name. Приклад: «Picture:/шлях/до/файла». У той самий спосіб можна експортувати синхронізований текст пісні. Приклад: «SYLT:/шлях/до/файла».

Повертає значення кадру.

Встановлення значення кадру

boolean setFrame(маскаМітки,  
 назва,  
 значення); 
int32 маскаМітки;
string назва;
string значення;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

назва

назва кадру (наприклад "artist")

значення

значення кадру

Для мітки 2 (tagMask 2), якщо не існує кадру name, буде додано новий кадр. Якщо значення value є порожнім, кадр буде вилучено. Щоб додати двійкові дані, зокрема зображення, можна додати назву відповідного файла після name. Приклад: «Picture:/шлях/до/файла». Для імпортування синхронізованого тексту пісні можна скористатися виразом «SYLT:/шлях/до/файла».

Повертає true, якщо виконано вдало.

Отримання усіх кадрів мітки

array of string getTag(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Повертає список із послідовно розташованими назвами кадрів та значеннями.

Отримання технічних даних щодо файла

масив рядків getInformation(); 
 

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

Повертає список із послідовно розташованими назвами властивостей та значеннями.

Встановлення мітки на основі назви файла

setTagFromFileName(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Встановлення мітки на основі іншої мітки

setTagFromOtherTag(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Копіювання мітки

copyTag(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Вставлення мітки

pasteTag(маскаМітки); 
int32 маскаМітки;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Вилучення мітки

removeTag(tagMask); 
int32 tagMask;
 
маскаМітки

біт мітки (1 для мітки 1, 2 для мітки 2)

Повторно обробити налаштування

reparseConfiguration(); 
 

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

Відтворення позначених файлів

playAudio();