Програмний інтерфейс D-BusПрограмний інтерфейс D-Bus визначено у файлі org.kde.Kid3.xml. У програмному інтерфейсі Kid3 передбачено такі методи:
boolean openDirectory( | шлях); |
string шлях;шляхшлях до файла або теки
Повертає true, якщо виконано вдало.
string getErrorMessage( | ); |
Повертає докладне повідомлення про помилку.
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, якщо виконано вдало.
array getPlaylistItems( | шлях); |
string шлях;шляхшлях до файла списку відтворення
Повертає список абсолютних шляхів до файлів-пунктів списку відтворення.
boolean setPlaylistItems( | шлях, | |
пункти); |
string шлях;array пункти;шляхшлях до файла списку відтворення
пунктисписок абсолютних шляхів до файлів-пунктів списку відтворення
Повертає true, якщо дію виконано вдало, і false, якщо знайдено не усі пункти і додавання або збереження не було вдало виконано.
boolean firstFile( | ); |
Повертає true, якщо існує перший файл.
boolean previousFile( | ); |
Повертає true, якщо існує попередній файл.
boolean nextFile( | ); |
Повертає true, якщо існує наступний файл.
boolean selectPreviousFile( | ); |
Повертає true, якщо існує попередній файл.
boolean expandDirectory( | ); |
Пункт списку файлів є текою, якщо getFileName() повертає назву із останнім символом «/».
Повертає true, якщо поточний пункт у ієрархії файлів є текою.
boolean setDirNameFromTag( | маскаМітки, | |
| формат, | ||
створення); |
int32 маскаМітки;string формат;boolean створення;маскаМіткимаска мітки (біт 0 для мітки 1, біт 1 для мітки 2)
форматформат назви теки
створенняtrue для створення, false для перейменування
Повертає true, якщо дію виконано вдало. Якщо дію не вдалося виконати, повертає повідомлення про помилку, доступ до якого можна отримати за допомогою getErrorMessage().
numberTracks( | маскаМітки, | |
номерПершоїДоріжки); |
int32 маскаМітки;int32 номерПершоїДоріжки;маскаМіткимаска мітки (біт 0 для мітки 1, біт 1 для мітки 2)
номерПершоїДоріжкиномер, який слід використати для першого файла
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( | ); |
Автоматизацію обробки змін у налаштуваннях можна реалізувати внесенням змін до файла налаштувань із наступною повторною обробкою налаштувань.