jamp3
    Preparing search index...

    Class ID3V24TagBuilder

    Class for

    • building an ID3v2.4.0 object

    Basic usage example:

    import { ID3v2, ID3V24TagBuilder, IID3V2 } from 'jamp3';

    async function run(): Promise<void> {
    	const id3v2 = new ID3v2();
    	const filename = 'demo.mp3';

    	const builder = new ID3V24TagBuilder(ID3V24TagBuilder.encodings.utf8);
    	builder
    		.album('An album')
    		.artist('An artist')
    		.artistSort('artist, An')
    		.title('A title');

    	const options: IID3V2.WriteOptions = {
    		keepBackup: true, // keep a filename.mp3.bak copy of the original file
    		paddingSize: 10 // add padding zeros between id3v2 and the audio (in bytes)
    	};
    	await id3v2.writeBuilder(filename, builder, options);
    	console.log('id3v2.4 written');
    }

    run().catch(console.error);

    Hierarchy

    • ID3V2TagBuilder
      • ID3V24TagBuilder
    Index

    Constructors

    constructor

    Properties

    rawBuilder encodings

    Methods

    acoustidFingerprint acoustidID album albumArtist albumArtistSort albumSort artist artists artistSort asin audioEncryption averageLevel barcode bool bpm buildFrames buildTag catalogNumber chapter chapterTOC clearAudioEncryption clearChapters clearChapterTOCs clearComments clearCustom clearEventTimingCodes clearLinkedInformation clearLyrics clearObjects clearPictures clearPopularimeters clearPriv clearRelativeVolumeAdjustment clearRelativeVolumeAdjustment2 clearReplayGainAdjustment clearSynchronisedLyrics clearTermsOfUse clearUniqueFileIDs clearUnknown clearURLs comment commercialInformationURL composer composerSort conductor copyright copyrightURL custom date disc discSubtitle encoder encoderSettings encodingDate eventTimingCodes fileOwner fileType genre grouping idBin idBinRaw idGuid idLangText idNum idText initialKey internetRadioStation internetRadioStationOwner involved isCompilation isPodcast isrc keyTextList label labelURL langText language license linkedInformation loadTag lyricist lyrics mbAlbumArtistID mbAlbumID mbAlbumReleaseCountry mbAlbumStatus mbAlbumType mbArtistID mbDiscID mbOriginalAlbumID mbOriginalArtistID mbReleaseGroupID mbReleaseTrackID mbTrackDisambiguation mbTrackID mbTRMID mbWorkID mediaType mood movement movementNr musicianCredit musicIPPUID nrAndTotal number object officialArtistURL officialAudioFileURL officialAudioSourceURL officialInternetRadioStationURL originalAlbum originalArtist originalDate originalFilename originalLyricist paymentURL peakValue picture playCount playlistDelay podcastDescription podcastFeedURL podcastKeywords podcastURL popularimeter priv productionNotice relativeVolumeAdjustment relativeVolumeAdjustment2 releaseDate remixer replayGainAdjustment rev script subtitle synchronisedLyrics taggingDate termsOfUse text title titleSort track trackLength uniqueFileID unknown url version website wmMediaClassPrimaryID wmMediaClassSecondaryID wmMood wmProvider wmUniqueFileIdentifier work writer

    Constructors

    Properties

    rawBuilder: ID3V2RawBuilder
    encodings: { iso88591: string; ucs2: string; utf16be: string; utf8: string } = ...

    Methods

    • Parameters

      • id: string
      • previewStart: number
      • previewLength: number
      • bin: Buffer

      Returns ID3V24TagBuilder

    • Parameters

      • timeStampFormat: number
      • events: { timestamp: number; type: number }[]

      Returns ID3V24TagBuilder

    • TIPL: The 'Involved people list' is intended as a mapping between the function and a person

      Parameters

      • group: string

        function, e.g. producer

      • Optionalvalue: string

        a name or comma seperated list of names *

      Returns ID3V24TagBuilder

    • Load existing frames from a tag into the builder. After calling this, subsequent setter calls will update or add to the existing frames. Single-value frames (e.g. title, artist) will be replaced; multi-value frames (e.g. picture, comment) will be appended.

      Parameters

      Returns this

    • TMCL The 'Musician credits list' is intended as a mapping between instruments and the musician that played it.

      Parameters

      • group: string

        an instrument

      • Optionalvalue: string

        an artist or a comma delimited list of artists *

      Returns ID3V24TagBuilder

    • Parameters

      • filename: string
      • mimeType: string
      • contentDescription: string
      • bin: Buffer

      Returns ID3V24TagBuilder

    • WOAS The 'Official audio source webpage' frame is a URL pointing at the official webpage for the source of the audio file, e.g. a movie. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • WORS The 'Official Internet radio station homepage' contains a URL pointing at the homepage of the internet radio station. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • TOAL The 'Original album/movie/show title' frame is intended for the title of the original recording (or source of sound), if for example the music in the file should be a cover of a previously released song.

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • TOPE: The 'Original artist/performer' frame is intended for the performer of the original recording, if for example the music in the file should be a cover of a previously released song. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • TDOR: The 'Original release time' frame contains a timestamp describing when the original recording of the audio was released.

      Parameters

      • Optionalvalue: string

        timestamp in UTC yyyy, yyyy-MM, yyyy-MM-dd, yyyy-MM-ddTHH, yyyy-MM-ddTHH:mm, yyyy-MM-ddTHH:mm:ss

      Returns ID3V24TagBuilder

    • TOFN: The 'Original filename' frame contains the preferred filename for the file, since some media doesn't allow the desired length of the filename. The filename is case sensitive and includes its suffix. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • TOLY: The 'Original lyricist/text writer' frame is intended for the text writer of the original recording, if for example the music in the file should be a cover of a previously released song. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • APIC: Attached picture

      Parameters

      • pictureType: number

        Picture type [[ID3V2ValueTypes]]

      • description: string

        a short description of the picture

      • mimeType: string

        MIME media type e.g. "image/png"

      • binary: Buffer

        binary data of a image

      Returns ID3V24TagBuilder

    • PCNT: This is simply a counter of the number of times a file has been played. The value is increased by one every time the file begins to play. *

      Parameters

      • Optionalvalue: number

      Returns ID3V24TagBuilder

    • TDLY: The 'Playlist delay' defines the numbers of milliseconds of silence that should be inserted before this audio. The value zero indicates that this is a part of a multifile audio track that should be played continuously. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • Parameters

      • right: number
      • left: number
      • OptionalpeakRight: number
      • OptionalpeakLeft: number
      • OptionalrightBack: number
      • OptionalleftBack: number
      • OptionalpeakRightBack: number
      • OptionalpeakLeftBack: number
      • Optionalcenter: number
      • OptionalpeakCenter: number
      • Optionalbass: number
      • OptionalpeakBass: number

      Returns ID3V24TagBuilder

    • TPE4: The 'Interpreted, remixed, or otherwise modified by' frame contains more information about the people behind a remix and similar interpretations of another existing piece. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    • Parameters

      • id: string
      • language: string
      • timestampFormat: number
      • contentType: number
      • events: { text: string; timestamp: number }[]

      Returns ID3V24TagBuilder

    text

    • TLEN The 'Length' frame contains the length of the audio file in milliseconds, represented as a numeric string. *

      Parameters

      • Optionalvalue: string | number

      Returns ID3V24TagBuilder

    • WOAR: The 'Official artist/performer webpage' frame is a URL pointing at the artists official webpage. There may be more than one "WOAR" frame in a tag if the audio contains more than one performer, but not with the same content. *

      Parameters

      • Optionalvalue: string

      Returns ID3V24TagBuilder

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    acoustidFingerprintacoustidIDalbumalbumArtistalbumArtistSortalbumSortartistartistsartistSortasinaudioEncryptionaverageLevelbarcodeboolbpmbuildFramesbuildTagcatalogNumberchapterchapterTOCclearAudioEncryptionclearChaptersclearChapterTOCsclearCommentsclearCustomclearEventTimingCodesclearLinkedInformationclearLyricsclearObjectsclearPicturesclearPopularimetersclearPrivclearRelativeVolumeAdjustmentclearRelativeVolumeAdjustment2clearReplayGainAdjustmentclearSynchronisedLyricsclearTermsOfUseclearUniqueFileIDsclearUnknownclearURLscommentcommercialInformationURLcomposercomposerSortconductorcopyrightcopyrightURLcustomdatediscdiscSubtitleencoderencoderSettingsencodingDateeventTimingCodesfileOwnerfileTypegenregroupingidBinidBinRawidGuididLangTextidNumidTextinitialKeyinternetRadioStationinternetRadioStationOwnerinvolvedisCompilationisPodcastisrckeyTextListlabellabelURLlangTextlanguagelicenselinkedInformationloadTaglyricistlyricsmbAlbumArtistIDmbAlbumIDmbAlbumReleaseCountrymbAlbumStatusmbAlbumTypembArtistIDmbDiscIDmbOriginalAlbumIDmbOriginalArtistIDmbReleaseGroupIDmbReleaseTrackIDmbTrackDisambiguationmbTrackIDmbTRMIDmbWorkIDmediaTypemoodmovementmovementNrmusicianCreditmusicIPPUIDnrAndTotalnumberobjectofficialArtistURLofficialAudioFileURLofficialAudioSourceURLofficialInternetRadioStationURLoriginalAlbumoriginalArtistoriginalDateoriginalFilenameoriginalLyricistpaymentURLpeakValuepictureplayCountplaylistDelaypodcastDescriptionpodcastFeedURLpodcastKeywordspodcastURLpopularimeterprivproductionNoticerelativeVolumeAdjustmentrelativeVolumeAdjustment2releaseDateremixerreplayGainAdjustmentrevscriptsubtitlesynchronisedLyricstaggingDatetermsOfUsetexttitletitleSorttracktrackLengthuniqueFileIDunknownurlversionwebsitewmMediaClassPrimaryIDwmMediaClassSecondaryIDwmMoodwmProviderwmUniqueFileIdentifierworkwriter