The Kid3 Handbook

Urs Fleisch

Revision 3.8.3 (2020-05-10)

Kid3 is an application to edit the ID3v1 and ID3v2 tags in MP3 files in an efficient way. Also tags in Ogg/Vorbis, Opus, DSF, FLAC, MPC, APE, MP4/AAC, MP2, Speex, TrueAudio, WavPack, WMA, WAV, AIFF files and tracker modules (MOD, S3M, IT, XM) are supported. It is easy to set tags of multiple files to the same values (e.g. album, artist, year and genre in all files of the same album) and generate the tags from the file name or vice versa.


Table of Contents

Synopsis
Options
kid3
kid3-qt
kid3-cli
1. Introduction
2. Using Kid3
Kid3 features
Example Usage
3. Command Reference
The GUI Elements
File List
Edit Playlist
Folder List
File
Tag 1
Tag 2
Tag 3
Frame List
Synchronized Lyrics and Event Timing Codes
The File Menu
The Edit Menu
The Tools Menu
The Settings Menu
The Help Menu
4. kid3-cli
Commands
Help
Timeout
Quit application
Change folder
Print the filename of the current folder
Folder list
Save the changed files
Select file
Select tag
Get tag frame
Set tag frame
Revert
Import from file
Automatic import
Download album cover artwork
Export to file
Create playlist
Apply filename format
Apply tag format
Apply text encoding
Rename folder
Number tracks
Filter
Convert ID3v2.3 to ID3v2.4
Convert ID3v2.4 to ID3v2.3
Filename from tag
Tag from filename
Tag to other tag
Copy
Paste
Remove
Examples
JSON Format
5. Credits and License
A. Installation
How to obtain Kid3
Requirements
Compilation and Installation
Configuration
B. D-Bus Interface
D-Bus Examples
D-Bus API
Open file or folder
Unload the tags of all files which are not modified or selected
Save all modified files
Get a detailed error message provided by some methods
Revert changes in the selected files
Start an automatic batch import
Import tags from a file
Import tags from other tags
Import tags from other tags on selected files
Download album cover art
Export tags to a file
Create a playlist
Get items of a playlist
Set items of a playlist
Quit the application
Select all files
Deselect all files
Set the first file as the current file
Set the previous file as the current file
Set the next file as the current file
Select the first file
Select the previous file
Select the next file
Select the current file
Expand or collapse the current file item if it is a folder
Apply the file name format
Apply the tag format
Apply text encoding
Set the folder name from the tags
Set subsequent track numbers in the selected files
Filter the files
Convert ID3v2.3 tags to ID3v2.4
Convert ID3v2.4 tags to ID3v2.3
Get path of folder
Get name of current file
Set name of selected file
Set format to use when setting the filename from the tags
Set the file names of the selected files from the tags
Get value of frame
Set value of frame
Get all frames of a tag
Get technical information about file
Set tag from file name
Set tag from other tag
Copy tag
Paste tag
Remove tag
Reparse the configuration
Plays the selected files
C. QML Interface
QML Examples
QML API
Kid3Script
Scripting Functions
Application Context
Configuration Objects