id3

0.6.0

id3/io.github.kingg22.vibrion.id3/Id3WriterBuilder

Id3WriterBuilder

class Id3WriterBuilder

Builder for Id3AudioWriter, aka a verbose builder for tag frame.

All properties and function correspond to a Id3v2v3TagFrame supported.

Note: Current is impossible to delete a value from the builder. If you need to do that, create a Id3WriterBuilder.copy before and modify it, or only don't set the value.

For advanced user with knowledge in tags frame of the Id3 tag, you can use Id3AudioWriter.id3AudioWriter directly, it is type safe with all overloads of Id3AudioWriter.set.

Example:

val tag: ByteArray = Id3WriterBuilder.id3Writer {
    title = "Song Title Example"
    artist("Example Artist")
    album = "Example Album"
    length = 240_000
    year = 2021
    picture {
        type = AttachedPictureType.CoverFront
        data = byteArrayOf(0xFF.toByte(), 0xD8.toByte(), 0xFF.toByte())
    }
    syncLyrics {
        line("Just a simple line", timestamp = 1000)
        line("Another line of lyrics", timestamp = 5000)
    }
}.toByteArray()

Java builder style:

final byte[] tag = Id3WriterBuilder.id3Writer()
    .title("Song Title Example")
    .artist("Example Artist")
    .album("Example Album")
    .year(2021)
    .length(240000)
    .picture(
        new AttachedPictureBuilder()
            .type(AttachedPictureType.CoverFront)
            .data(new byte[]{(byte) 0xFF, (byte) 0xD8, (byte) 0xFF})
    ).syncLyrics(
        new SynchronizedLyricsBuilder()
            .line("Just a simple line", 1000)
            .line("Another line of lyrics", 5000)
    ).toByteArray();

See also

Id3v2v3TagFrame

Id3WriterBuilder.build

Id3WriterBuilder.toByteArray

Id3WriterBuilder.Companion.id3Writer

Constructors

Id3WriterBuilder

constructor()

Types

object Companion

Properties

var album: String?

var albumArtist: String?

var artists: List<String>?

var artistWeb: String?

var bpm: Int?

var comment: CommentFrame?

var commercialWeb: String?

var composer: List<String>?

var conductor: String?

var contentGroup: String?

var copyright: String?

var copyrightWeb: String?

var disc: String?

encoderSoftware

var encoderSoftware: String?

var fileWeb: String?

var genres: List<String>?

var involvedPeople: List<Pair<String, String>>?

var isCompilation: Boolean

var isrc: String?

var key: String?

var label: String?

var language: String?

var length: Int?

var lyricist: String?

var lyrics: UnsynchronisedLyrics?

var mediaType: String?

var payWeb: String?

var picture: AttachedPicture?

var privateFrame: PrivateFrame?

var publisherWeb: String?

var radioWeb: String?

var releaseDate: String?

var remixer: String?

var sourceWeb: String?

var subtitle: String?

var syncLyrics: SynchronizedLyrics?

var title: String?

var track: String?

var userText: UserDefinedText?

var userUrl: UserDefinedText?

@ExperimentalVibrionId3

val valuesForTest: Map<Id3v2v3TagFrame, FrameValue>

Exclusive to test the computed values

var year: Int?

Functions

fun album(album: String): Id3WriterBuilder

fun albumArtist(albumArtist: String): Id3WriterBuilder

fun artist(name: String, vararg names: String): Id3WriterBuilder

fun artistWeb(url: String): Id3WriterBuilder

fun bpm(bpm: Int): Id3WriterBuilder

fun build(): Id3AudioWriter

Build the Id3AudioWriter instance and set all the tags.

fun comment(comment: CommentFrame): Id3WriterBuilder

fun comment(text: String, lang: String = "eng", description: String = ""): Id3WriterBuilder

fun commercialWeb(url: String): Id3WriterBuilder

fun composer(composer: String, vararg composers: String): Id3WriterBuilder

fun conductor(name: String): Id3WriterBuilder

fun contentGroup(group: String): Id3WriterBuilder

fun copy(): Id3WriterBuilder

Generate a copy of this builder.

fun copyright(copyright: String): Id3WriterBuilder

fun copyrightWeb(url: String): Id3WriterBuilder

fun disc(number: String): Id3WriterBuilder

encoderSoftware

fun encoderSoftware(name: String): Id3WriterBuilder

open operator override fun equals(other: Any?): Boolean

fun fileWeb(url: String): Id3WriterBuilder

fun genre(genre: String, vararg genres: String): Id3WriterBuilder

open override fun hashCode(): Int

fun involvedPeople(people: Map<String, String>): Id3WriterBuilder

fun involvedPeople(people: Pair<String, String>, vararg peoples: Pair<String, String>): Id3WriterBuilder

fun isCompilation(flag: Boolean = true): Id3WriterBuilder

fun isrc(isrc: String): Id3WriterBuilder

fun key(key: String): Id3WriterBuilder

fun label(label: String): Id3WriterBuilder

fun language(language: String): Id3WriterBuilder

fun length(length: Int): Id3WriterBuilder

fun lyricist(name: String): Id3WriterBuilder

fun lyrics(builder: UnsynchronisedLyricsBuilder): Id3WriterBuilder

fun lyrics(unsynchronisedLyrics: UnsynchronisedLyrics): Id3WriterBuilder

fun lyrics(block: UnsynchronisedLyricsBuilder.() -> Unit): Id3WriterBuilder

Need UnsynchronisedLyricsBuilder.lyrics

fun mediaType(mediaType: String): Id3WriterBuilder

fun payWeb(url: String): Id3WriterBuilder

fun picture(builder: AttachedPictureBuilder): Id3WriterBuilder

fun picture(attachedPicture: AttachedPicture): Id3WriterBuilder

fun picture(block: AttachedPictureBuilder.() -> Unit): Id3WriterBuilder

fun privateFrame(privateFrame: PrivateFrame): Id3WriterBuilder

fun privateFrame(id: String, data: ByteArray): Id3WriterBuilder

fun publisherWeb(url: String): Id3WriterBuilder

fun radioWeb(url: String): Id3WriterBuilder

fun releaseDate(date: String): Id3WriterBuilder

fun remixer(name: String): Id3WriterBuilder

fun sourceWeb(url: String): Id3WriterBuilder

fun subtitle(subtitle: String): Id3WriterBuilder

fun syncLyrics(builder: SynchronizedLyricsBuilder): Id3WriterBuilder

fun syncLyrics(synchronizedLyrics: SynchronizedLyrics): Id3WriterBuilder

fun syncLyrics(block: SynchronizedLyricsBuilder.() -> Unit): Id3WriterBuilder

fun title(title: String): Id3WriterBuilder

fun toByteArray(padding: Int = 4096): ByteArray

Shortcut for build and Id3AudioWriter.toByteArray

open override fun toString(): String

fun track(number: String): Id3WriterBuilder

fun userText(user: UserDefinedText): Id3WriterBuilder

fun userText(description: String, value: String): Id3WriterBuilder

fun userUrl(userUrl: UserDefinedText): Id3WriterBuilder

fun userUrl(description: String, url: String): Id3WriterBuilder

fun year(year: Int): Id3WriterBuilder