Skip to content

Latest commit

 

History

History
3067 lines (1751 loc) · 65.3 KB

ApeTag.md

File metadata and controls

3067 lines (1751 loc) · 65.3 KB

node-taglib-sharp / Exports / ApeTag

Class: ApeTag

Provides a representation of an APEv2 tag which can be read from and written to disk.

Hierarchy

  • Tag

    ↳ ApeTag

Table of contents

Accessors

Methods

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).

Remarks

Stored in the Album item

Returns

string

Overrides

Tag.album

• 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).

Remarks

Stored in the Album item

Parameters

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

Returns

void

Overrides

Tag.album

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"

Remarks

This property is implemented using the "Album Artist" item and "AlbumArtist" as a backup if it exists.

Returns

string[]

Overrides

Tag.albumArtists

• set albumArtists(value): void

Sets the bands or artists who are 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"

Remarks

Will be stored in "Album Artist" primarily. If "AlbumArtist" exists, value will also be stored there for compatibility.

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

Overrides

Tag.albumArtists

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"

Remarks

Stored in the AlbumArtistSort item

Returns

string[]

Overrides

Tag.albumArtistsSort

• 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"

Remarks

Stored in the AlbumArtistSort item

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

Overrides

Tag.albumArtistsSort

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.

Remarks

Stored in the AlbumSort item

Returns

string

Overrides

Tag.albumSort

• 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.

Remarks

Stored in the AlbumSort item

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

Overrides

Tag.albumSort

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.

Remarks

Stored in the ASIN item

Returns

string

Overrides

Tag.amazonId

• 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.

Remarks

Stored in the ASIN item

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

Overrides

Tag.amazonId

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.

Remarks

Stored in the BPM item

Returns

number

Overrides

Tag.beatsPerMinute

• 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.

Remarks

Stored in the BPM item

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

Overrides

Tag.beatsPerMinute

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 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.

Remarks

Stored in the Comment item

Returns

string

Overrides

Tag.comment

• 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 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.

Remarks

Stored in the Comment item

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

Overrides

Tag.comment

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.

Remarks

Stored in the Composer item

Returns

string[]

Overrides

Tag.composers

• 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.

Remarks

Stored in the Composer item

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

Overrides

Tag.composers

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.

Remarks

Stored in the ComposerSort item

Returns

string[]

Overrides

Tag.composersSort

• 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.

Remarks

via ComposerSort

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

Overrides

Tag.composersSort

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.

Remarks

Stored in the Conductor item

Returns

string

Overrides

Tag.conductor

• 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.

Remarks

Stored in the Conductor item

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

Overrides

Tag.conductor

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.

Remarks

Stored in the Copyright item

Returns

string

Overrides

Tag.copyright

• 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.

Remarks

Stored in the Copyright item

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

Overrides

Tag.copyright

dateTagged

• get dateTagged(): Date

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

Remarks

Stored in the DateTagged item

Returns

Date

Overrides

Tag.dateTagged

• set dateTagged(value): void

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

Remarks

Stored in the DateTagged item

Parameters

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

Returns

void

Overrides

Tag.dateTagged

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."

Remarks

Stored in the Description item

Returns

string

Overrides

Tag.description

• 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."

Remarks

Stored in the Description item

Parameters

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

Returns

void

Overrides

Tag.description

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.

Remarks

Stored in the Disc item numerator

Returns

number

Overrides

Tag.disc

• 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.

Remarks

Stored in the Disc item numerator

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

Overrides

Tag.disc

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.

Remarks

Stored in the Disc item denominator

Returns

number

Overrides

Tag.discCount

• 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.

Remarks

Stored in the Disc item denominator

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

Overrides

Tag.discCount

firstAlbumArtist

• get firstAlbumArtist(): string

Gets the first value contained in albumArtists.

Returns

string

Inherited from

Tag.firstAlbumArtist

firstAlbumArtistSort

• get firstAlbumArtistSort(): string

Gets the first value contained in albumArtistsSort

Returns

string

Inherited from

Tag.firstAlbumArtistSort

firstComposer

• get firstComposer(): string

Gets the first value contained in composers

Returns

string

Inherited from

Tag.firstComposer

firstComposerSort

• get firstComposerSort(): string

Gets the first value contained in composersSort

Returns

string

Inherited from

Tag.firstComposerSort

firstGenre

• get firstGenre(): string

Gets the first value contained in genres

Returns

string

Inherited from

Tag.firstGenre

firstPerformer

• get firstPerformer(): string

Gets the first value contained in performers

Returns

string

Inherited from

Tag.firstPerformer

firstPerformerSort

• get firstPerformerSort(): string

Gets the first value contained in performersSort

Returns

string

Inherited from

Tag.firstPerformerSort

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.

Remarks

Stored in the Genre item

Returns

string[]

Overrides

Tag.genres

• 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.

Remarks

Stored in the Genre item

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

Overrides

Tag.genres

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.

Remarks

Stored in the Grouping item

Returns

string

Overrides

Tag.grouping

• 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.

Remarks

Stored in the Grouping item

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

Overrides

Tag.grouping

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

Inherited from

Tag.initialKey

• 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

Inherited from

Tag.initialKey

isCompilation

• get isCompilation(): boolean

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

Returns

boolean

Inherited from

Tag.isCompilation

• set isCompilation(value): void

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

Parameters

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

Returns

void

Inherited from

Tag.isCompilation

isEmpty

• get isEmpty(): boolean

Gets whether the current instance is empty.

Returns

boolean

Overrides

Tag.isEmpty

isHeaderPresent

• get isHeaderPresent(): boolean

Gets whether the current instance has a header when rendered.

Returns

boolean

• set isHeaderPresent(value): void

Sets whether the current instance has a header when rendered.

Parameters

Name Type
value boolean

Returns

void

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

Inherited from

Tag.isrc

• 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

Inherited from

Tag.isrc

items

• get items(): ApeTagItem[]

Gets all items stored in the current instance

Returns

ApeTagItem[]

joinedAlbumArtists

• get joinedAlbumArtists(): string

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

Returns

string

Inherited from

Tag.joinedAlbumArtists

joinedComposers

• get joinedComposers(): string

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

Returns

string

Inherited from

Tag.joinedComposers

joinedGenres

• get joinedGenres(): string

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

Returns

string

Inherited from

Tag.joinedGenres

joinedPerformers

• get joinedPerformers(): string

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

Returns

string

Inherited from

Tag.joinedPerformers

joinedPerformersSort

• get joinedPerformersSort(): string

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

Returns

string

Inherited from

Tag.joinedPerformersSort

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.

Remarks

Stored in the Lyrics item

Returns

string

Overrides

Tag.lyrics

• 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.

Remarks

Stored in the Lyrics item

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

Overrides

Tag.lyrics

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.

Remarks

Stored in the MUSICBRAINZ_ARTISTID item

Returns

string

Overrides

Tag.musicBrainzArtistId

• 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.

Remarks

Stored in the MUSICBRAINZ_ARTISTID item

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

Overrides

Tag.musicBrainzArtistId

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.

Remarks

Stored in the MUSICBRAINZ_DISCID item

Returns

string

Overrides

Tag.musicBrainzDiscId

• 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.

Remarks

Stored in the MUSICBRAINZ_DISCID item

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

Overrides

Tag.musicBrainzDiscId

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.

Remarks

Stored in the MUSICBRAINZ_ALBUMARTISTID item

Returns

string

Overrides

Tag.musicBrainzReleaseArtistId

• 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.

Remarks

Stored in the MUSICBRAINZ_ALBUMARTISTID item

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

Overrides

Tag.musicBrainzReleaseArtistId

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.

Remarks

Stored in the RELEASECOUNTRY item

Returns

string

Overrides

Tag.musicBrainzReleaseCountry

• 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.

Remarks

Stored in the RELEASECOUNTRY item

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

Overrides

Tag.musicBrainzReleaseCountry

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.

Remarks

Stored in the MUSICBRAINZ_RELEASEGROUPID item

Returns

string

Overrides

Tag.musicBrainzReleaseGroupId

• 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.

Remarks

Stored in the MUSICBRAINZ_RELEASEGROUPID item

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

Overrides

Tag.musicBrainzReleaseGroupId

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.

Remarks

Stored in the MUSICBRAINZ_ALBUMID item

Returns

string

Overrides

Tag.musicBrainzReleaseId

• 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.

Remarks

Stored in the MUSICBRAINZ_ALBUMID item

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

Overrides

Tag.musicBrainzReleaseId

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.

Remarks

Stored in the MUSICBRAINZ_ALBUMSTATUS item

Returns

string

Overrides

Tag.musicBrainzReleaseStatus

• 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.

Remarks

Stored in the MUSICBRAINZ_ALBUMSTATUS item

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

Overrides

Tag.musicBrainzReleaseStatus

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

Remarks

Stored in the MUSICBRAINZ_ALBUMTYPE item

Returns

string

Overrides

Tag.musicBrainzReleaseType

• 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

Remarks

Stored in the MUSICBRAINZ_ALBUMTYPE item

Parameters

Name Type
value string

Returns

void

Overrides

Tag.musicBrainzReleaseType

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.

Remarks

Stored in the MUSICBRAINZ_TRACKID item

Returns

string

Overrides

Tag.musicBrainzTrackId

• 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.

Remarks

Stored in the MUSICBRAINZ_TRACKID item

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

Overrides

Tag.musicBrainzTrackId

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".

Remarks

Stored in the MUSICIP_PUID item

Returns

string

Overrides

Tag.musicIpId

• 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".

Remarks

Stored in the MUSICIP_PUID item

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

Overrides

Tag.musicIpId

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.

Remarks

Stored in the Artist item

Returns

string[]

Overrides

Tag.performers

• 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 regarding the number of performers.

Remarks

Stored in the Artist item

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

Overrides

Tag.performers

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].

Remarks

Stored in the PerformersRole item

Returns

string[]

Overrides

Tag.performersRole

• 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].

Remarks

Stored in the PerformersRole item

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

Overrides

Tag.performersRole

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

Remarks

Stored in the ArtistSort item

Returns

string[]

Overrides

Tag.performersSort

• 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

Remarks

Stored in the ArtistSort item

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

Overrides

Tag.performersSort

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.

Remarks

Stored in Cover Art * or Embedded Object items

Returns

IPicture[]

Overrides

Tag.pictures

• 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.

Remarks

Stored in Cover Art * or Embedded Object items

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

Overrides

Tag.pictures

publisher

• get publisher(): string

Gets the publisher of the track.

Returns

string

Publisher of the track or undefined if no value is set

Inherited from

Tag.publisher

• 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

Inherited from

Tag.publisher

remixedBy

• get remixedBy(): string

Gets the remixer of the track.

Returns

string

Remixer of the track or undefined if no value is set

Inherited from

Tag.remixedBy

• 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

Inherited from

Tag.remixedBy

replayGainAlbumGain

• get replayGainAlbumGain(): number

Gets the ReplayGain album gain in dB.

Remarks

Stored in the REPLAYGAIN_ALBUM_GAIN item

Returns

number

Overrides

Tag.replayGainAlbumGain

• set replayGainAlbumGain(value): void

Sets the ReplayGain album gain in dB.

Remarks

Stored in the REPLAYGAIN_ALBUM_GAIN item

Parameters

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

Returns

void

Overrides

Tag.replayGainAlbumGain

replayGainAlbumPeak

• get replayGainAlbumPeak(): number

Gets the ReplayGain album peak sample.

Remarks

Stored in the REPLAYGAIN_ALBUM_PEAK item

Returns

number

Overrides

Tag.replayGainAlbumPeak

• set replayGainAlbumPeak(value): void

Sets the ReplayGain album peak sample.

Remarks

Stored in the REPLAYGAIN_ALBUM_PEAK item

Parameters

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

Returns

void

Overrides

Tag.replayGainAlbumPeak

replayGainTrackGain

• get replayGainTrackGain(): number

Gets the ReplayGain track gain in dB.

Remarks

Stored in the REPLAYGAIN_TRACK_GAIN item

Returns

number

Overrides

Tag.replayGainTrackGain

• set replayGainTrackGain(value): void

Sets the ReplayGain track gain in dB.

Remarks

Stored in the REPLAYGAIN_TRACK_GAIN item

Parameters

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

Returns

void

Overrides

Tag.replayGainTrackGain

replayGainTrackPeak

• get replayGainTrackPeak(): number

Gets the ReplayGain track peak sample.

Remarks

Stored in the REPLAYGAIN_TRACK_PEAK item

Returns

number

Overrides

Tag.replayGainTrackPeak

• set replayGainTrackPeak(value): void

Sets the ReplayGain track peak sample.

Remarks

Stored in the REPLAYGAIN_TRACK_PEAK item

Parameters

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

Returns

void

Overrides

Tag.replayGainTrackPeak

sizeOnDisk

• get sizeOnDisk(): number

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

Returns

number

Overrides

Tag.sizeOnDisk

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".

Remarks

Stored in the Subtitle item

Returns

string

Overrides

Tag.subtitle

• 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".

Remarks

Stored in the Subtitle

Parameters

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

Returns

void

Overrides

Tag.subtitle

tagTypes

• get 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.

Returns

TagTypes

Overrides

Tag.tagTypes

title

• get title(): string

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

Remarks

Stored in the Title item

Returns

string

Overrides

Tag.title

• 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).

Remarks

Stored in the Title item

Parameters

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

Returns

void

Overrides

Tag.title

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.

Remarks

Stored in the TitleSort item

Returns

string

Overrides

Tag.titleSort

• 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.

Remarks

Stored in the TitleSort item

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

Overrides

Tag.titleSort

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.

Remarks

Stored in the Track item numerator

Returns

number

Overrides

Tag.track

• 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.

Remarks

Stored in the Track item numerator

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

Overrides

Tag.track

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.

Remarks

Stored in the Track item denominator

Returns

number

Overrides

Tag.trackCount

• 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.

Remarks

Stored in the Track item denominator

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

Overrides

Tag.trackCount

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.

Remarks

Stored in the Year item

Returns

number

Overrides

Tag.year

• 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.

Remarks

Stored in the Year item

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

Overrides

Tag.year

Methods

appendStringValue

▸ appendStringValue(key, value): void

Adds a single value to the contents of an item. Creates a new item if one does not exist.

Parameters

Name Type Description
key string Key to use to lookup to item to add value to
value string Values to add to item identified by key

Returns

void

appendStringValues

▸ appendStringValues(key, values): void

Adds a lists of strings to the values stored in a specified item. Creates a new item if one does not already exist.

Parameters

Name Type Description
key string Key to use to look up the item
values string[] Values to add to the item

Returns

void

clear

▸ clear(): void

Clears all values stored in the current instance.

Returns

void

Overrides

Tag.clear

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

Overrides

Tag.copyTo

getItem

▸ getItem(key): ApeTagItem

Gets an item from the current instance identified by key.

Parameters

Name Type Description
key string Identifier for the item to get

Returns

ApeTagItem

ApeTagItem Item specified by key if it exists, undefined is returned otherwise

hasItem

▸ hasItem(key): boolean

Determines if any items with the specified key exist in the current instance.

Parameters

Name Type Description
key string Identifier for looking up a matching item

Returns

boolean

true if an item with the specified key exists, false otherwise

removeItem

▸ removeItem(key): void

Removes all items from the current instance with the specified key.

Parameters

Name Type Description
key string Identifier of the items to remove.

Returns

void

render

▸ render(): ByteVector

Renders the current instance as a raw APEv2 tag.

Returns

ByteVector

Bytes that represent the current instance

setItem

▸ setItem(item): void

Adds an item to the current instance, replacing an existing one with the same key.

Parameters

Name Type Description
item ApeTagItem Item to add to the current instance

Returns

void

setNumericValue

▸ setNumericValue(key, numerator, denominator): void

Stores a number in a specified item. If both numerator and denominator are provided the item will be set to numerator/denominator. If neither numerator nor denominator are provided, the item will be removed from this tag. A new item is created if one with the specified key does not exist.

Parameters

Name Type Description
key string Identifier for the item to set the item
numerator number Whole number of top half of the fraction if denominator is provided
denominator number Bottom half of the fraction to store. Can be undefined if only numerator is needed.

Returns

void

setStringValue

▸ setStringValue(key, value): void

Stores a string in the item specified by key. This will replace the contents of the specified item. If value is falsy, the item will be removed.

Parameters

Name Type Description
key string Item to set the value of
value string String to store in the item. If falsy, the specified item will be removed

Returns

void

setStringValues

▸ setStringValues(key, values): void

Stores a list of strings in the item specified by key. This will replace the contents of the specified item. If value is falsy or empty, the item will be removed

Parameters

Name Type Description
key string Item to set the value of
values string[] String to store in the item. If falsy or empty, the specified item will be removed

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

Inherited from

Tag.firstInGroup

fromData

▸ Static fromData(data): ApeTag

Constructs and initializes a new instance by reading the contents of a raw tag in a specified ByteVector object.

Parameters

Name Type Description
data ByteVector Object containing the raw tag

Returns

ApeTag

fromEmpty

▸ Static fromEmpty(): ApeTag

Constructs an empty APEv2 tag.

Returns

ApeTag

fromFile

▸ Static fromFile(file, position): ApeTag

Constructs a new instance by reading the contents from a specified position in a specified file.

Remarks

If position points to the beginning of the tag footer, the footer will be read and then the parser will back up and start reading from the beginning of the file.

Parameters

Name Type Description
file File File to read the tag from
position number Position where the tag header or footer begins

Returns

ApeTag

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.

Inherited from

Tag.isFalsyOrLikeEmpty

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.

Inherited from

Tag.joinGroup

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[]

Inherited from

Tag.tagTypeFlagsToArray