Программный интерфейс D-Bus определён в файле org.kde.Kid3.xml
. В интерфейсе Kid3 предусмотрены следующие методы:
boolean openDirectory( | path) ; |
string path
;path
путь к файлу или каталогу
Возвращает true, если выполнено успешно.
string getErrorMessage( | ) ; |
Возвращает подробное сообщение об ошибке.
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, если не все элементы были найдены и добавлены или сохранение завершилось ошибкой.
boolean firstFile( | ) ; |
Возвращает true, если первый файл существует.
boolean previousFile( | ) ; |
Возвращает true, если предыдущий файл существует.
boolean nextFile( | ) ; |
Возвращает true, если следующий файл существует.
boolean selectPreviousFile( | ) ; |
Возвращает true, если предыдущий файл существует.
boolean selectNextFile( | ) ; |
Возвращает true, если следующий файл существует.
boolean expandDirectory( | ) ; |
Пункт списка файлов является каталогом, если getFileName() возвращает название, последний символ которого — косая черта, «/».
Возвращает true, если текущий элемент — каталог.
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
номер, который будет использоваться для первого файла
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( | ) ; |
Автоматизированная обработка изменений в параметрах конфигурации доступна посредством внесения изменений в файл конфигурации с их последующей повторной обработкой.