Tag.md

node-taglib-sharp / Exports / Tag

Class: Tag

Abstract class that provides generic access to standard tag features. All tag types will extend this class. Because not every tag type supports the same features, it may be useful to check that the value is stored by re-reading the property after it is set.

Hierarchy

• Tag

  ↳ CombinedTag

  ↳ ApeTag

  ↳ AsfTag

  ↳ Id3v1Tag

  ↳ Id3v2Tag

  ↳ Mpeg4AppleTag

  ↳ DivxTag

  ↳ RiffListTag

  ↳ XiphComment

Table of contents

Constructors

• constructor

Properties

• tagTypes

Accessors

• album
• albumArtists
• albumArtistsSort
• albumSort
• amazonId
• beatsPerMinute
• comment
• composers
• composersSort
• conductor
• copyright
• dateTagged
• description
• disc
• discCount
• firstAlbumArtist
• firstAlbumArtistSort
• firstComposer
• firstComposerSort
• firstGenre
• firstPerformer
• firstPerformerSort
• genres
• grouping
• initialKey
• isCompilation
• isEmpty
• isrc
• joinedAlbumArtists
• joinedComposers
• joinedGenres
• joinedPerformers
• joinedPerformersSort
• lyrics
• musicBrainzArtistId
• musicBrainzDiscId
• musicBrainzReleaseArtistId
• musicBrainzReleaseCountry
• musicBrainzReleaseGroupId
• musicBrainzReleaseId
• musicBrainzReleaseStatus
• musicBrainzReleaseType
• musicBrainzTrackId
• musicIpId
• performers
• performersRole
• performersSort
• pictures
• publisher
• remixedBy
• replayGainAlbumGain
• replayGainAlbumPeak
• replayGainTrackGain
• replayGainTrackPeak
• sizeOnDisk
• subtitle
• title
• titleSort
• track
• trackCount
• year

Methods

• clear
• copyTo
• firstInGroup
• isFalsyOrLikeEmpty
• joinGroup
• tagTypeFlagsToArray

Constructors

constructor

• new Tag()

Properties

tagTypes

• Abstract tagTypes: TagTypes

Gets the tag types contained in the current instance. A bit wise combined TagTypes containing the tag types contained in the current instance.

Remarks

For a standard tag, the value should be intuitive. For example, Id3v2Tag objects have a value of Id3v2. However, for CombinedTag type objects, they may contain multiple or no types.

Accessors

album

• get album(): string

Gets the album of the media represented by the current instance. For video media, this represents the collection the video belongs to.

This field represents the name of the album the media belongs to. In the case of a boxed set, it should be the name of the entire set rather than the individual disc. In the case of a series, this should be the name of the series, rather than the season of a series.

For example, "Kintsugi" (an album by Death Cab for Cutie), "The Complete Red Green Show" (a boxed set of TV episodes), or "Shark Tank" (a series with several seasons).

Returns

string

Album of the media represented by the current instance or undefined if no value is present

• set album(value): void

Sets the album of the media represented by the current instance. For video media, this represents the collection the video belongs to.

This field represents the name of the album the media belongs to. In the case of a boxed set, it should be the name of the entire set rather than the individual disc. In the case of a series, this should be the name of the series, rather than the season of a series.

For example, "Kintsugi" (an album by Death Cab for Cutie), "The Complete Red Green Show" (a boxed set of TV episodes), or "Shark Tank" (a series with several seasons).

Parameters

Name	Type	Description
value	string	of the media represented by the current instance or undefined if no value is present

Returns

void

---

albumArtists

• get albumArtists(): string[]

Gets the band or artist who is credited in the creation of the entire album or collection containing the media described by the current instance.

This field is typically optional but aids in the sorting of compilations or albums with multiple artist. For example, if an album has several artists, sorting by artist will split up albums by the same artist. Having a single album artist for an entire album solves this problem. As this value is to be used as a sorting key, it should be used with less variation than performers. Where performers can be broken into multiple artists, it is best to stick to a single name. Eg, "Super8 & Tab"

Returns

string[]

Band or artist credited with the creation of the entire album or collection containing the media described by the current instance or an empty array if no value is present

• set albumArtists(value): void

Sets the bands or artists who is credited in the creation of the entire album or collection containing the media described by the current instance.

This field is typically optional but aids in the sorting of compilations or albums with multiple artist. For example, if an album has several artists, sorting by artist will split up albums by the same artist. Having a single album artist for an entire album solves this problem. As this value is to be used as a sorting key, it should be used with less variation than performers. Where performers can be broken into multiple artists, it is best to stick to a single name. Eg, "Super8 & Tab"

Parameters

Name	Type	Description
value	string[]	Band or artist credited with the creation of the entire album or collection containing the media described by the current instance or an empty array if no value is present

Returns

void

---

albumArtistsSort

• get albumArtistsSort(): string[]

Gets the sortable names of the bands/artists who are credited with creating the entire album or collection containing the media described by the current instance. See also: albumArtists

This is used to provide more control over how the media is sorted. Typical uses are to skip articles or sort by last name. For example "Ben Folds" might be sorted as "Folds, Ben". As this value is to be used as a sorting key, it should be used with less variation than performers. Where performers can be broken into multiple performers, it is best to stick to a single album artist. Eg, "Van Buuren, Armin"

Returns

string[]

Sortable names for the bands/artists are credited with the creation of the entire album or collection containing the media described by the current instance, or an empty array if no value is present.

• set albumArtistsSort(value): void

Sets the sortable names of the bands/artists who are credited with creating the entire album or collection containing the media described by the current instance. See also: albumArtists

This is used to provide more control over how the media is sorted. Typical uses are to skip articles or sort by last name. For example "Ben Folds" might be sorted as "Folds, Ben". As this value is to be used as a sorting key, it should be used with less variation than performers. Where performers can be broken into multiple performers, it is best to stick to a single album artist. Eg, "Van Buuren, Armin"

Parameters

Name	Type	Description
value	string[]	Sortable names for the bands/artists are credited with the creation of the entire album or collection containing the media described by the current instance, or an empty array if no value is present.

Returns

void

---

albumSort

• get albumSort(): string

Gets the sortable name of the album title of the media represented by the current instance. See also: album

This field is typically optional but aids in sort of compilations or albums with similar titles.

Returns

string

Sortable name for the album title of the media or undefined if the value is not present

• set albumSort(value): void

Sets the sortable name of the album title of the media represented by the current instance. See also: album

This field is typically optional but aids in sort of compilations or albums with similar titles.

Parameters

Name	Type	Description
value	string	Sortable name for the album title of the media or undefined if the value is not present

Returns

void

---

amazonId

• get amazonId(): string

Gets the Amazon ID of the media represented by the current instance.

This field represents the AmazonID, also called the ASIN, and is used to uniquely identify the particular track or album in the Amazon catalog.

Returns

string

Amazon ID of the media represented by the current instance or undefined if no value is present

• set amazonId(value): void

Sets the Amazon ID of the media represented by the current instance.

This field represents the AmazonID, also called the ASIN, and is used to uniquely identify the particular track or album in the Amazon catalog.

Parameters

Name	Type	Description
value	string	Amazon ID of the media represented by the current instance or undefined if no value is present

Returns

void

---

beatsPerMinute

• get beatsPerMinute(): number

Gets the number of beats per minute in the audio of the media represented by the current instance.

This field is useful for DJ's who are trying to beat match tracks. It should be calculated from the audio or pulled from a database.

Returns

number

Beats per minute of the audio in the media represented by the current instance, or 0 if not specified

• set beatsPerMinute(value): void

Sets the number of beats per minute in the audio of the media represented by the current instance.

This field is useful for DJ's who are trying to beat match tracks. It should be calculated from the audio or pulled from a database.

Parameters

Name	Type	Description
value	number	Beats per minute of the audio in the media represented by the current instance, or 0 if not specified

Returns

void

---

comment

• get comment(): string

Gets a user comment on the media represented by the current instance.

This field should be used to store user notes and comments. There is no constraint on what text can be stored here, but it should not contain programmatic data. Because this field contains notes the the user might think of while consuming the media, it may be useful for an application to make this field easily accessible, perhaps even including it in the main interface.

Returns

string

User comments on the media represented by the current instance or undefined if the value is not present

• set comment(value): void

Sets a user comment on the media represented by the current instance.

This field should be used to store user notes and comments. There is no constraint on what text can be stored here, but it should not contain programmatic data. Because this field contains notes the the user might think of while consuming the media, it may be useful for an application to make this field easily accessible, perhaps even including it in the main interface.

Parameters

Name	Type	Description
value	string	User comments on the media represented by the current instance or undefined if the value is not present

Returns

void

---

composers

• get composers(): string[]

Gets the composers of the media represented by the current instance.

This field represents the composers, songwriters, scriptwriters, or persons who claim authorship of the media.

Returns

string[]

Composers of the media represented by the current instance of an empty array if no value is present.

• set composers(value): void

Sets the composers of the media represented by the current instance.

This field represents the composers, songwriters, scriptwriters, or persons who claim authorship of the media.

Parameters

Name	Type	Description
value	string[]	Composers of the media represented by the current instance of an empty array if no value is present.

Returns

void

---

composersSort

• get composersSort(): string[]

Gets the sortable names of the composers of the media represented by the current instance. See also: composers

This field is typically optional but aids in the sorting of compilations or albums with multiple composers.

Returns

string[]

Sortable names for the composers of the media represented by the current instance or an empty array if no value is present.

• set composersSort(value): void

Sets the sortable names of the composers of the media represented by the current instance. See also: composers

This field is typically optional but aids in the sorting of compilations or albums with multiple composers.

Parameters

Name	Type	Description
value	string[]	Sortable names for the composers of the media represented by the current instance or an empty array if no value is present.

Returns

void

---

conductor

• get conductor(): string

Gets the conductor or director of the media represented by the current instance.

This field is most useful for organizing classical music and movies.

Returns

string

Conductor or director of the media represented by the current instance or undefined if no value present.

• set conductor(value): void

Sets the conductor or director of the media represented by the current instance.

This field is most useful for organizing classical music and movies.

Parameters

Name	Type	Description
value	string	Conductor or director of the media represented by the current instance or undefined if no value present.

Returns

void

---

copyright

• get copyright(): string

Gets the copyright information for the media represented by the current instance.

This field should be used for storing copyright information. It may be useful to show this information somewhere in the program while the media is playing. Players should not support editing this field, but media creation tools should definitely allow modification.

Returns

string

Copyright information for the media represented by the current instance or undefined if no value is present.

• set copyright(value): void

Sets the copyright information for the media represented by the current instance.

This field should be used for storing copyright information. It may be useful to show this information somewhere in the program while the media is playing. Players should not support editing this field, but media creation tools should definitely allow modification.

Parameters

Name	Type	Description
value	string	Copyright information for the media represented by the current instance or undefined if no value is present.

Returns

void

---

dateTagged

• get dateTagged(): Date

Gets the date and time at which the tag has been written.

Returns

Date

Date/time at which the tag has been written, or undefined if no value is present

• set dateTagged(value): void

Sets the date and time at which the tag has been written.

Parameters

Name	Type	Description
value	Date	Date/time at which the tag has been written, or undefined if no value is present

Returns

void

---

description

• get description(): string

Gets a short description of the media. For music, this could be the comment that the artist made of his/her work. For a video, this should be a short summary of the story/plot, but generally no spoliers. This should give the impression of what to expect in the media.

This is especially relevant for a movie. For example, for "Fear and Loathing in Las Vegas", this could be "An oddball journalist and his psychopathic lawyer travel to Las Vegas for a series of psychedelic escapades."

Returns

string

Description of the media represented by the current instance or undefined if no value is present

• set description(value): void

Sets a short description of the media. For music, this could be the comment that the artist made of his/her work. For a video, this should be a short summary of the story/plot, but generally no spoliers. This should give the impression of what to expect in the media.

This is especially relevant for a movie. For example, for "Fear and Loathing in Las Vegas", this could be "An oddball journalist and his psychopathic lawyer travel to Las Vegas for a series of psychedelic escapades."

Parameters

Name	Type	Description
value	string	Description of the media represented by the current instance or undefined if no value is present

Returns

void

---

disc

• get disc(): number

Gets the number of the disc containing the media represented by the current instance in the boxed set. For a series, this represents the season number.

This value should be the same as the number that appears on the disc. For example, if the disc is the first of three, the value should be 1. It should be no more than discCount if discCount is non-zero.

Returns

number

Number of the disc or season of the media represented by the current instance in a boxed set.

• set disc(value): void

Sets the number of the disc containing the media represented by the current instance in the boxed set. For a series, this represents the season number.

This value should be the same as the number that appears on the disc. For example, if the disc is the first of three, the value should be 1. It should be no more than discCount if discCount is non-zero.

Parameters

Name	Type	Description
value	number	Number of the disc or season of the media represented by the current instance in a boxed set.

Returns

void

---

discCount

• get discCount(): number

Gets the number of discs or seasons in the boxed set containing the media represented by the current instance.

If non-zero, this should be at least equal to disc. If disc is zero, this value should also be zero.

Returns

number

Number of discs or seasons in the boxed set containing the media represented by the current instance or 0 if not specified.

• set discCount(value): void

Sets the number of discs or seasons in the boxed set containing the media represented by the current instance.

If non-zero, this should be at least equal to disc. If disc is zero, this value should also be zero.

Parameters

Name	Type	Description
value	number	Number of discs or seasons in the boxed set containing the media represented by the current instance or 0 if not specified.

Returns

void

---

firstAlbumArtist

• get firstAlbumArtist(): string

Gets the first value contained in albumArtists.

Returns

string

---

firstAlbumArtistSort

• get firstAlbumArtistSort(): string

Gets the first value contained in albumArtistsSort

Returns

string

---

firstComposer

• get firstComposer(): string

Gets the first value contained in composers

Returns

string

---

firstComposerSort

• get firstComposerSort(): string

Gets the first value contained in composersSort

Returns

string

---

firstGenre

• get firstGenre(): string

Gets the first value contained in genres

Returns

string

---

firstPerformer

• get firstPerformer(): string

Gets the first value contained in performers

Returns

string

---

firstPerformerSort

• get firstPerformerSort(): string

Gets the first value contained in performersSort

Returns

string

---

genres

• get genres(): string[]

Gets the genres of the media represented by the current instance.

This field represents genres that apply to the song, album, or video. This is often used for filtering media. A list of common audio genres as popularized by ID3v1 is stored in genres.ts. Additionally, genres.ts contains video genres as used by DivX.

Returns

string[]

Genres of the media represented by the current instance or an empty array if no value is present.

• set genres(value): void

Sets the genres of the media represented by the current instance.

This field represents genres that apply to the song, album, or video. This is often used for filtering media. A list of common audio genres as popularized by ID3v1 is stored in genres.ts. Additionally, genres.ts` contains video genres as used by DivX.

Parameters

Name	Type	Description
value	string[]	Genres of the media represented by the current instance or an empty array if no value is present.

Returns

void

---

grouping

• get grouping(): string

Gets the grouping on the album which the media in the current instance belongs to.

This field contains a non-physical group to which the track belongs. In classical music this could be a movement. It could also be parts of a series like "Introduction", "Closing Remarks", etc.

Returns

string

Grouping on the album which the media in the current instance belongs to or undefined if no value is present.

• set grouping(value): void

Sets the grouping on the album which the media in the current instance belongs to.

This field contains a non-physical group to which the track belongs. In classical music this could be a movement. It could also be parts of a series like "Introduction", "Closing Remarks", etc.

Parameters

Name	Type	Description
value	string	Grouping on the album which the media in the current instance belongs to or undefined if no value is present.

Returns

void

---

initialKey

• get initialKey(): string

Gets the initial key of the track.

Returns

string

Initial key of the track or undefined if no value is set

• set initialKey(value): void

Sets the initial key of the track.

Parameters

Name	Type	Description
value	string	Initial key of the track or undefined if no value is set

Returns

void

---

isCompilation

• get isCompilation(): boolean

Gets whether or not the album described by the current instance is a compilation.

Returns

boolean

• set isCompilation(value): void

Gets whether or not the album described by the current instance is a compilation.

Parameters

Name	Type	Description
value	boolean	Whether or not the album described by the current instance is a compilation

Returns

void

---

isEmpty

• get isEmpty(): boolean

Gets whether or not the current instance is empty.

Remarks

In the default implementation, this checks the values supported by Tag, but it may be extended by child classes to support other values.

Returns

boolean

true if the current instance does not contain any values. false otherwise

---

isrc

• get isrc(): string

Gets the ISRC (International Standard Recording Code) of the track.

Returns

string

ISRC of the track or undefined if no value is set

• set isrc(value): void

Sets the ISRC (International Standard Recording Code) of the track.

Parameters

Name	Type	Description
value	string	ISRC of the track or undefined if no value is set

Returns

void

---

joinedAlbumArtists

• get joinedAlbumArtists(): string

Gets a semicolon and space separated string containing the values in albumArtists

Returns

string

---

joinedComposers

• get joinedComposers(): string

Gets a semicolon and space separated string containing the values in composers

Returns

string

---

joinedGenres

• get joinedGenres(): string

Gets a semicolon and space separated string containing the values in genres

Returns

string

---

joinedPerformers

• get joinedPerformers(): string

Gets a semicolon and space separated string containing the values in performers

Returns

string

---

joinedPerformersSort

• get joinedPerformersSort(): string

Gets a semicolon and space separated string containing the values in performersSort

Returns

string

---

lyrics

• get lyrics(): string

Gets the lyrics or script of the media represented by the current instance.

This field contains a plain text representation of the lyrics or scripts with line breaks and whitespace being the only formatting marks. Some formats support more advanced lyrics, like synchronized lyrics, but those must be accessed using format-specific implementations.

Returns

string

Lyrics or script of the media represented by the current instance or undefined if no value is present

• set lyrics(value): void

Sets the lyrics or script of the media represented by the current instance.

This field contains a plain text representation of the lyrics or scripts with line breaks and whitespace being the only formatting marks. Some formats support more advanced lyrics, like synchronized lyrics, but those must be accessed using format-specific implementations.

Parameters

Name	Type	Description
value	string	Lyrics or script of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzArtistId

• get musicBrainzArtistId(): string

Gets the MusicBrainz artist ID of the media represented by the current instance.

This field represents the MusicBrainz ArtistID, and is used to uniquely identify a particular artist of the track.

Returns

string

MusicBrainz ArtistID of the media represented by the current instance or undefined if no value is present

• set musicBrainzArtistId(value): void

Sets the MusicBrainz artist ID of the media represented by the current instance.

This field represents the MusicBrainz ArtistID, and is used to uniquely identify a particular artist of the track.

Parameters

Name	Type	Description
value	string	MusicBrainz ArtistID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzDiscId

• get musicBrainzDiscId(): string

Gets the MusicBrainz disc ID of the media represented by the current instance.

This field represents the MusicBrainz DiscID and is used to uniquely identify the particular released media associated with this track.

Returns

string

MusicBrainz DiscID of the media represented by the current instance or undefined if no value is present

• set musicBrainzDiscId(value): void

Sets the MusicBrainz disc ID of the media represented by the current instance.

This field represents the MusicBrainz DiscID and is used to uniquely identify the particular released media associated with this track.

Parameters

Name	Type	Description
value	string	MusicBrainz DiscID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseArtistId

• get musicBrainzReleaseArtistId(): string

Gets the MusicBrainz release artist ID of the media represented by the current instance.

This field represents the MusicBrainz ReleaseArtistID, and is used to uniquely identify a particular album artist credited with the album.

Returns

string

MusicBrainz ReleaseArtistID of the media represented by the current instance or undefined if no value is present

• set musicBrainzReleaseArtistId(value): void

Sets the MusicBrainz release artist ID of the media represented by the current instance.

This field represents the MusicBrainz ReleaseArtistID, and is used to uniquely identify a particular album artist credited with the album.

Parameters

Name	Type	Description
value	string	MusicBrainz ReleaseArtistID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseCountry

• get musicBrainzReleaseCountry(): string

Gets the MusicBrainz release country of the media represented by the current instance.

This field represents the MusicBrainz ReleaseCountry which describes the country in which an album was released. Note that the release country of an album is not necessarily the country in which it was produced. The label itself will typically be more relevant. Eg, a release on "Foo Records UK" that has "Made in Austria" printed on it will likely be a UK release.

Returns

string

MusicBrainz ReleaseCountry of the media represented by the current instance or undefined if no value is present

• set musicBrainzReleaseCountry(value): void

Sets the MusicBrainz release country of the media represented by the current instance.

This field represents the MusicBrainz ReleaseCountry which describes the country in which an album was released. Note that the release country of an album is not necessarily the country in which it was produced. The label itself will typically be more relevant. Eg, a release on "Foo Records UK" that has "Made in Austria" printed on it will likely be a UK release.

Parameters

Name	Type	Description
value	string	MusicBrainz ReleaseCountry of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseGroupId

• get musicBrainzReleaseGroupId(): string

Gets the MusicBrainz release group ID of the media represented by the current instance.

This field represents the MusicBrainz ReleaseGroupID and is used to uniquely identify a particular release group to which this track belongs.

Returns

string

MusicBrainz ReleaseGroupID of the media represented by the current instance or undefined if no value is present

• set musicBrainzReleaseGroupId(value): void

Sets the MusicBrainz release group ID of the media represented by the current instance.

This field represents the MusicBrainz ReleaseGroupID and is used to uniquely identify a particular release group to which this track belongs.

Parameters

Name	Type	Description
value	string	MusicBrainz ReleaseGroupID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseId

• get musicBrainzReleaseId(): string

Gets the MusicBrainz release ID of the media represented by the current instance.

This field represents the MusicBrains ReleaseID and is used to uniquely identify a particular release to which this track belongs.

Returns

string

MusicBrainz ReleaseID of the media represented by the current instance or undefined if no value is present

• set musicBrainzReleaseId(value): void

Sets the MusicBrainz release ID of the media represented by the current instance.

This field represents the MusicBrains ReleaseID and is used to uniquely identify a particular release to which this track belongs.

Parameters

Name	Type	Description
value	string	MusicBrainz ReleaseID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseStatus

• get musicBrainzReleaseStatus(): string

Gets the MusicBrainz release status of the media represented by the current instance.

This field represents the MusicBrainz ReleaseStatus used to describe how 'official' a release is. Common statuses are: Official, Promotion, Bootleg, Pseudo-release.

Returns

string

MusicBrainz ReleaseStatus of the media represented by the current instance or undefined if no value is present

• set musicBrainzReleaseStatus(value): void

Sets the MusicBrainz release status of the media represented by the current instance.

This field represents the MusicBrainz ReleaseStatus used to describe how 'official' a release is. Common statuses are: Official, Promotion, Bootleg, Pseudo-release.

Parameters

Name	Type	Description
value	string	MusicBrainz ReleaseStatus of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicBrainzReleaseType

• get musicBrainzReleaseType(): string

Gets the MusicBrainz release type of the media represented by the current instance.

This field represents the MusicBrainz ReleaseType that describes what kind of release a release is. Common types are: Single, Album, EP, Compilation, Soundtrack, SpokenWord, Interview, Audiobook, Live, Remix, and Other`. Careful thought must be given when using this field to decide if a particular track "is a compilation".

@returns MusicBrainz ReleaseType of the media represented by the current instance or undefined if no value is present

Returns

string

• set musicBrainzReleaseType(value): void

Sets the MusicBrainz release type of the media represented by the current instance.

This field represents the MusicBrainz ReleaseType that describes what kind of release a release is. Common types are: Single, Album, EP, Compilation, Soundtrack, SpokenWord, Interview, Audiobook, Live, Remix, and Other`. Careful thought must be given when using this field to decide if a particular track "is a compilation".

@param value MusicBrainz ReleaseType of the media represented by the current instance or undefined if no value is present

Parameters

Name	Type
value	string

Returns

void

---

musicBrainzTrackId

• get musicBrainzTrackId(): string

Gets the MusicBrainz track ID of the media represented by the media represented by the current instance.

This field represents the MusicBrainz TrackID and is used to uniquely identify a particular track.

Returns

string

MusicBrainz TrackID of the media represented by the current instance or undefined if no value is present

• set musicBrainzTrackId(value): void

Sets the MusicBrainz track ID of the media represented by the media represented by the current instance.

This field represents the MusicBrainz TrackID and is used to uniquely identify a particular track.

Parameters

Name	Type	Description
value	string	MusicBrainz TrackID of the media represented by the current instance or undefined if no value is present

Returns

void

---

musicIpId

• get musicIpId(): string

Gets the MusicIP PUID of the media represented by the current instance.

This field represents the MusicIP PUID, an acoustic fingerprint identifier. It identifies wht this track "sounds like".

Returns

string

MusicIP PUID of the media represented by the current instance or undefined if no value is present

• set musicIpId(value): void

Sets the MusicIP PUID of the media represented by the current instance.

This field represents the MusicIP PUID, an acoustic fingerprint identifier. It identifies wht this track "sounds like".

Parameters

Name	Type	Description
value	string	MusicIP PUID of the media represented by the current instance or undefined if no value is present

Returns

void

---

performers

• get performers(): string[]

Gets the performers or artists who performed in the media described by the current instance.

This field is most commonly called "Artists" in audio media or "Actors" in video media, and should be used to represent each artist/actor appearing in the media. It can be simple in the form of "Above & Beyond" or more complicated in the form of "Jono Grant, Tony McGuinness, Paavo Siljamäki", depending on the preferences of the user and the degree to which they organize their media collection. As the preference of the user may vary, applications should avoid limiting the user in what constitutes the performers field - especially in regard to number of performers.

Returns

string[]

Performers who performed in the media described by the current instance or an empty array if no value is present.

• set performers(value): void

Sets the performers or artists who performed in the media described by the current instance.

This field is most commonly called "Artists" in audio media or "Actors" in video media, and should be used to represent each artist/actor appearing in the media. It can be simple in the form of "Above & Beyond" or more complicated in the form of "Jono Grant, Tony McGuinness, Paavo Siljamäki", depending on the preferences of the user and the degree to which they organize their media collection. As the preference of the user may vary, applications should avoid limiting the user in what constitutes the performers field - especially with regards to number of performers.

Parameters

Name	Type	Description
value	string[]	Performers who performed in the media described by the current instance or an empty array if no value is present.

Returns

void

---

performersRole

• get performersRole(): string[]

Gets the characters portrayed by an actor for a video or instruments played by a musician for music. This must match the performers array (for each person, correspond one/more role). Several roles for the same artist/actor can be separated with semicolons. For example: "Bass; Backing Vocals; Vibraphone".

It is highly important to match each role to the performers. This means that an entry in the performersRole array is undefined to maintain the relationship between performers[i] and performersRole[i].

Returns

string[]

Array containing the roles played by the performers in the media described by the current instance, or an empty array if no value is present.

• set performersRole(value): void

Sets the characters portrayed by an actor for a video or instruments played by a musician for music. This must match the performers array (for each person, correspond one/more role). Several roles for the same artist/actor can be separated with semicolons. For example: "Bass; Backing Vocals; Vibraphone".

It is highly important to match each role to the performers. This means that an entry in the performersRole array is undefined to maintain the relationship between performers[i] and performersRole[i].

Parameters

Name	Type	Description
value	string[]	Array containing the roles played by the performers in the media described by the current instance, or an empty array if no value is present.

Returns

void

---

performersSort

• get performersSort(): string[]

Gets the sortable names of the performers or artists who performed in the media described by the current instance.

This is used to provide more control over how the media is sorted. Typical uses are to skip articles or sort by last name. For example, "The Pillows" might be sorted as "Pillows, The". See also: performers

Returns

string[]

Sortable names for the performers who performed in the media described by the current instance, or an empty array if no value is present.

• set performersSort(value): void

Gets the sortable names of the performers or artists who performed in the media described by the current instance.

This is used to provide more control over how the media is sorted. Typical uses are to skip articles or sort by last name. For example, "The Pillows" might be sorted as "Pillows, The". See also: performers

Parameters

Name	Type	Description
value	string[]	Sortable names for the performers who performed in the media described by the current instance, or an empty array if no value is present.

Returns

void

---

pictures

• get pictures(): IPicture[]

Gets a collection of pictures associated with the media represented by the current instance.

Typically, this value is used to store an album cover or icon to use for the file, but it is capable of holding any type of image or file, including pictures of the band, the recording studio, the concert, etc.

Returns

IPicture[]

Array containing a collection of pictures associated with the media represented by the current instance or an empty array if no pictures are present.

• set pictures(value): void

Sets a collection of pictures associated with the media represented by the current instance.

Typically, this value is used to store an album cover or icon to use for the file, but it is capable of holding any type of image or file, including pictures of the band, the recording studio, the concert, etc.

Parameters

Name	Type	Description
value	IPicture[]	Array containing a collection of pictures associated with the media represented by the current instance or an empty array if no pictures are present.

Returns

void

---

publisher

• get publisher(): string

Gets the publisher of the track.

Returns

string

Publisher of the track or undefined if no value is set

• set publisher(value): void

Sets the publisher of the track.

Parameters

Name	Type	Description
value	string	Publisher of the track or undefined if no value is set

Returns

void

---

remixedBy

• get remixedBy(): string

Gets the remixer of the track.

Returns

string

Remixer of the track or undefined if no value is set

• set remixedBy(value): void

Sets the remixer of the track.

Parameters

Name	Type	Description
value	string	Remixer of the track or undefined if no value is set

Returns

void

---

replayGainAlbumGain

• get replayGainAlbumGain(): number

Gets the ReplayGain album gain in dB.

Returns

number

Album gain as per the ReplayGain specifications, in dB, or NaN if no value is set

• set replayGainAlbumGain(value): void

Sets the ReplayGain album gain in dB.

Parameters

Name	Type	Description
value	number	Album gain as per the ReplayGain specifications, in dB, or NaN if no value is set

Returns

void

---

replayGainAlbumPeak

• get replayGainAlbumPeak(): number

Gets the ReplayGain album peak sample.

Returns

number

Album peak as per the ReplayGain specifications, or NaN if no value is set

• set replayGainAlbumPeak(value): void

Sets the ReplayGain album peak sample.

Parameters

Name	Type	Description
value	number	Album peak as per the ReplayGain specifications, or NaN if no value is set

Returns

void

---

replayGainTrackGain

• get replayGainTrackGain(): number

Gets the ReplayGain track gain in dB.

Returns

number

Track gain as per ReplayGain specifications, in dB, or NaN if no value is set

• set replayGainTrackGain(value): void

Sets the ReplayGain track gain in dB.

Parameters

Name	Type	Description
value	number	Track gain as per ReplayGain specifications, in dB, or NaN if no value is set

Returns

void

---

replayGainTrackPeak

• get replayGainTrackPeak(): number

Gets the ReplayGain track peak sample.

Returns

number

Track peak as per the ReplayGain specifications, or NaN if no value is set

• set replayGainTrackPeak(value): void

Sets the ReplayGain track peak sample.

Parameters

Name	Type	Description
value	number	Track peak as per the ReplayGain specifications, or NaN if no value is set

Returns

void

---

sizeOnDisk

• Abstract get sizeOnDisk(): number

Gets the size of the tag in bytes on disk as it was read from disk.

Returns

number

---

subtitle

• get subtitle(): string

Gets a description, one-line. It represents the tagline of the vide/music.

This field gives a nice/short precision to the title, which is typically below the title on the front cover of the media. For example for "Ocean's 13", this would be "Revenge is a funny thing".

Returns

string

Subtitle of the media represented by the current instance or undefined if no value is present

• set subtitle(value): void

Sets a description, one-line. It represents the tagline of the vide/music.

This field gives a nice/short precision to the title, which is typically below the title on the front cover of the media. For example for "Ocean's 13", this would be "Revenge is a funny thing".

Parameters

Name	Type	Description
value	string	Subtitle of the media represented by the current instance or undefined if no value is present

Returns

void

---

title

• get title(): string

Gets the title for the media described by the current instance.

Remarks

The title is most commonly the name of the song, episode or a movie title. For example "Time Won't Me Go" (a song by The Bravery), "Three Stories" (an episode of House MD), or "Fear and Loathing In Las Vegas" (a movie).

Returns

string

Title of the media described by the current instance or undefined if no value is present.

• set title(value): void

Sets the title for the media described by the current instance.

The title is most commonly the name of the song, episode or a movie title. For example "Time Won't Me Go" (a song by The Bravery), "Three Stories" (an episode of House MD), or "Fear and Loathing In Las Vegas" (a movie).

Parameters

Name	Type	Description
value	string	Title of the media described by the current instance or undefined if no value is present.

Returns

void

---

titleSort

• get titleSort(): string

Gets the sortable name for the title of the media described by the current instance.

Possibly used to sort compilations or episodic content.

Returns

string

Sortable name of the media described by the current instance or undefined if no value is present

• set titleSort(value): void

Sets the sortable name for the title of the media described by the current instance.

Possibly used to sort compilations or episodic content.

Parameters

Name	Type	Description
value	string	Sortable name of the media described by the current instance or undefined if no value is present

Returns

void

---

track

• get track(): number

Gets the position of the media represented by the current instance in its containing album or season (for a series).

This value should be the same as is listed on the album cover and no more than trackCount, if trackCount is non-zero. Most tagging formats store this as a string. To help sorting, a two-digit zero-padded value is used in the resulting tag. For a series, this property represents the episodes in a season of the series.

Returns

number

Position of the media represented by the current instance in its containing album or 0 if not specified.

• set track(value): void

Sets the position of the media represented by the current instance in its containing album or season (for a series).

This value should be the same as is listed on the album cover and no more than trackCount, if trackCount is non-zero. Most tagging formats store this as a string. To help sorting, a two-digit zero-padded value is used in the resulting tag. For a series, this property represents the episodes in a season of the series.

Parameters

Name	Type	Description
value	number	Position of the media represented by the current instance in its containing album or 0 if not specified.

Returns

void

---

trackCount

• get trackCount(): number

Gets the number of tracks on the album or the number of episodes in a series of the media represented by the current instance.

If non-zero, this value should be equal to or greater than track. If track is 0, this value should also be 0.

Returns

number

Number of tracks on the album or number of episodes in a series of the media represented by the current instance or 0 if not specified.

• set trackCount(value): void

Sets the number of tracks on the album or the number of episodes in a series of the media represented by the current instance.

If non-zero, this value should be equal to or greater than track. If track is 0, this value should also be 0.

Parameters

Name	Type	Description
value	number	Number of tracks on the album or number of episodes in a series of the media represented by the current instance or 0 if not specified.

Returns

void

---

year

• get year(): number

Gets the year that the media represented by the current instance was recorded.

Years greater than 9999 cannot be stored by most tagging formats and will be cleared if a higher value is set. Some tagging formats store higher precision dates which will be truncated when this property is set. Format specific implementations are necessary to access the higher precision values.

Returns

number

Year that the media represented by the current instance was created or 0 if no value is present.

• set year(value): void

Sets the year that the media represented by the current instance was recorded.

Years greater than 9999 cannot be stored by most tagging formats and will be cleared if a higher value is set. Some tagging formats store higher precision dates which will be truncated when this property is set. Format specific implementations are necessary to access the higher precision values.

Parameters

Name	Type	Description
value	number	Year that the media represented by the current instance was created or 0 if no value is present.

Returns

void

Methods

clear

▸ Abstract clear(): void

Clears all values stored in the current instance.

Remarks

The clearing procedure is format specific and should clear all values.

Returns

void

---

copyTo

▸ copyTo(target, overwrite): void

Copies the values from the current instance to another Tag, optionally overwriting existing values.

This method only copies the most basic values when copying between different tag formats. However, if target is of the same type as the current instance, more advanced copying may be done. For example if both this and target are Id3v2Tag, all frames will be copied to the target.

Parameters

Name	Type	Description
target	Tag	Target tag to copy values to
overwrite	boolean	Whether or not to copy values over existing ones

Returns

void

---

firstInGroup

▸ Static Protected firstInGroup(group): string

Gets the first string in an array.

Parameters

Name	Type	Description
group	string[]	Array of strings to get the first string from.

Returns

string

First string contained in group or undefined if the array is undefined or empty

---

isFalsyOrLikeEmpty

▸ Static Protected isFalsyOrLikeEmpty(value): boolean

Checks if a value is falsy or empty.

Parameters

Name	Type	Description
value	string | string[]	Object to check

Returns

boolean

If value is a string, true is returned if the value is falsy or all whitespace, false is returned otherwise. If value is an array of strings, the array must be falsy or all elements must be falsy or whitespace to return true.

---

joinGroup

▸ Static Protected joinGroup(group): string

Joins an array of string into a single, semicolon and space separated string.

Parameters

Name	Type	Description
group	string[]	Array of string to join

Returns

string

A semicolon and space separated string containing the values from group or undefined if the array is undefined or empty.

---

tagTypeFlagsToArray

▸ Static tagTypeFlagsToArray(tagTypes): TagTypes[]

Generates an array of tag types that are set in the provided flags value.

Parameters

Name	Type	Description
tagTypes	TagTypes	Tag types that have been OR'd together.

Returns

TagTypes[]