node-taglib-sharp / Exports / StartTag
Provides support for accessing and modifying a collection of tags appearing at the start of a file. This class is used by SandwichFile to read all the tags appearing at the start of the file but could be used by other classes. It currently supports ID3v2 and APE tags.
-
↳
StartTag
- 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
- supportedTagTypes
- tagTypes
- tags
- title
- titleSort
- track
- trackCount
- year
- addTag
- clear
- copyTo
- createTag
- getTag
- removeTags
- render
- replaceTag
- validateTagCreation
- firstInGroup
- isFalsyOrLikeEmpty
- joinGroup
- tagTypeFlagsToArray
• new StartTag(file, readStyle)
Constructs and initializes a new instance by reading tags from the beginning of the specified file until non-tag content is found.
| Name | Type | Description |
|---|---|---|
file |
File |
File on which the new instance will perform its operations |
readStyle |
ReadStyle |
How deeply to read the tag and its properties |
▪ Static Readonly SUPPORTED_TAG_TYPES: TagTypes
List of tag types that are supported by a sandwich tag's start tag.
• 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).
string
CombinedTag.album
• set album(val): 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).
| Name | Type | Description |
|---|---|---|
val |
string |
of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.album
• 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"
string[]
CombinedTag.albumArtists
• set albumArtists(val): 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"
| Name | Type | Description |
|---|---|---|
val |
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 |
void
CombinedTag.albumArtists
• 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"
string[]
CombinedTag.albumArtistsSort
• set albumArtistsSort(val): 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"
| Name | Type | Description |
|---|---|---|
val |
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. |
void
CombinedTag.albumArtistsSort
• 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.
string
CombinedTag.albumSort
• set albumSort(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Sortable name for the album title of the media or undefined if the value is not present |
void
CombinedTag.albumSort
• 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.
string
CombinedTag.amazonId
• set amazonId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Amazon ID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.amazonId
• 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.
number
CombinedTag.beatsPerMinute
• set beatsPerMinute(val): 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.
| Name | Type | Description |
|---|---|---|
val |
number |
Beats per minute of the audio in the media represented by the current instance, or 0 if not specified |
void
CombinedTag.beatsPerMinute
• 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.
string
CombinedTag.comment
• set comment(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
User comments on the media represented by the current instance or undefined if the value is not present |
void
CombinedTag.comment
• 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.
string[]
CombinedTag.composers
• set composers(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string[] |
Composers of the media represented by the current instance of an empty array if no value is present. |
void
CombinedTag.composers
• 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.
string[]
CombinedTag.composersSort
• set composersSort(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string[] |
Sortable names for the composers of the media represented by the current instance or an empty array if no value is present. |
void
CombinedTag.composersSort
• 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.
string
CombinedTag.conductor
• set conductor(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Conductor or director of the media represented by the current instance or undefined if no value present. |
void
CombinedTag.conductor
• 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.
string
CombinedTag.copyright
• set copyright(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Copyright information for the media represented by the current instance or undefined if no value is present. |
void
CombinedTag.copyright
• get dateTagged(): Date
Gets the date and time at which the tag has been written.
Date
CombinedTag.dateTagged
• set dateTagged(val): void
Sets the date and time at which the tag has been written.
| Name | Type | Description |
|---|---|---|
val |
Date |
Date/time at which the tag has been written, or undefined if no value is present |
void
CombinedTag.dateTagged
• 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."
string
CombinedTag.description
• set description(val): 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."
| Name | Type | Description |
|---|---|---|
val |
string |
Description of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.description
• 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.
number
CombinedTag.disc
• set disc(val): 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.
| Name | Type | Description |
|---|---|---|
val |
number |
Number of the disc or season of the media represented by the current instance in a boxed set. |
void
CombinedTag.disc
• 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.
number
CombinedTag.discCount
• set discCount(val): 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.
| Name | Type | Description |
|---|---|---|
val |
number |
Number of discs or seasons in the boxed set containing the media represented by the current instance or 0 if not specified. |
void
CombinedTag.discCount
• get firstAlbumArtist(): string
Gets the first value contained in albumArtists.
string
CombinedTag.firstAlbumArtist
• get firstAlbumArtistSort(): string
Gets the first value contained in albumArtistsSort
string
CombinedTag.firstAlbumArtistSort
• get firstComposer(): string
Gets the first value contained in composers
string
CombinedTag.firstComposer
• get firstComposerSort(): string
Gets the first value contained in composersSort
string
CombinedTag.firstComposerSort
• get firstGenre(): string
Gets the first value contained in genres
string
CombinedTag.firstGenre
• get firstPerformer(): string
Gets the first value contained in performers
string
CombinedTag.firstPerformer
• get firstPerformerSort(): string
Gets the first value contained in performersSort
string
CombinedTag.firstPerformerSort
• 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.
string[]
CombinedTag.genres
• set genres(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string[] |
Genres of the media represented by the current instance or an empty array if no value is present. |
void
CombinedTag.genres
• 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.
string
CombinedTag.grouping
• set grouping(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Grouping on the album which the media in the current instance belongs to or undefined if no value is present. |
void
CombinedTag.grouping
• get initialKey(): string
Gets the initial key of the track.
string
CombinedTag.initialKey
• set initialKey(val): void
Sets the initial key of the track.
| Name | Type | Description |
|---|---|---|
val |
string |
Initial key of the track or undefined if no value is set |
void
CombinedTag.initialKey
• get isCompilation(): boolean
Gets whether the album described by the current instance is a compilation.
boolean
CombinedTag.isCompilation
• set isCompilation(val): void
Gets whether the album described by the current instance is a compilation.
| Name | Type | Description |
|---|---|---|
val |
boolean |
Whether the album described by the current instance is a compilation |
void
CombinedTag.isCompilation
• get isEmpty(): boolean
Gets whether the current instance is empty.
boolean
CombinedTag.isEmpty
• get isrc(): string
Gets the ISRC (International Standard Recording Code) of the track.
string
CombinedTag.isrc
• set isrc(val): void
Sets the ISRC (International Standard Recording Code) of the track.
| Name | Type | Description |
|---|---|---|
val |
string |
ISRC of the track or undefined if no value is set |
void
CombinedTag.isrc
• get joinedAlbumArtists(): string
Gets a semicolon and space separated string containing the values in albumArtists
string
CombinedTag.joinedAlbumArtists
• get joinedComposers(): string
Gets a semicolon and space separated string containing the values in composers
string
CombinedTag.joinedComposers
• get joinedGenres(): string
Gets a semicolon and space separated string containing the values in genres
string
CombinedTag.joinedGenres
• get joinedPerformers(): string
Gets a semicolon and space separated string containing the values in performers
string
CombinedTag.joinedPerformers
• get joinedPerformersSort(): string
Gets a semicolon and space separated string containing the values in performersSort
string
CombinedTag.joinedPerformersSort
• 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.
string
CombinedTag.lyrics
• set lyrics(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
Lyrics or script of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.lyrics
• 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.
string
CombinedTag.musicBrainzArtistId
• set musicBrainzArtistId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ArtistID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzArtistId
• 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.
string
CombinedTag.musicBrainzDiscId
• set musicBrainzDiscId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz DiscID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzDiscId
• 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.
string
CombinedTag.musicBrainzReleaseArtistId
• set musicBrainzReleaseArtistId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ReleaseArtistID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzReleaseArtistId
• 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.
string
CombinedTag.musicBrainzReleaseCountry
• set musicBrainzReleaseCountry(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ReleaseCountry of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzReleaseCountry
• 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.
string
CombinedTag.musicBrainzReleaseGroupId
• set musicBrainzReleaseGroupId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ReleaseGroupID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzReleaseGroupId
• 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.
string
CombinedTag.musicBrainzReleaseId
• set musicBrainzReleaseId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ReleaseID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzReleaseId
• 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.
string
CombinedTag.musicBrainzReleaseStatus
• set musicBrainzReleaseStatus(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz ReleaseStatus of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzReleaseStatus
• 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
string
CombinedTag.musicBrainzReleaseType
• set musicBrainzReleaseType(val): 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
| Name | Type |
|---|---|
val |
string |
void
CombinedTag.musicBrainzReleaseType
• 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.
string
CombinedTag.musicBrainzTrackId
• set musicBrainzTrackId(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string |
MusicBrainz TrackID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicBrainzTrackId
• 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".
string
CombinedTag.musicIpId
• set musicIpId(val): 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".
| Name | Type | Description |
|---|---|---|
val |
string |
MusicIP PUID of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.musicIpId
• 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.
string[]
CombinedTag.performers
• set performers(val): 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.
| Name | Type | Description |
|---|---|---|
val |
string[] |
Performers who performed in the media described by the current instance or an empty array if no value is present. |
void
CombinedTag.performers
• 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].
string[]
CombinedTag.performersRole
• set performersRole(val): 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].
| Name | Type | Description |
|---|---|---|
val |
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. |
void
CombinedTag.performersRole
• 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
string[]
CombinedTag.performersSort
• set performersSort(val): 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
| Name | Type | Description |
|---|---|---|
val |
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. |
void
CombinedTag.performersSort
• 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.
IPicture[]
CombinedTag.pictures
• set pictures(val): 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.
| Name | Type | Description |
|---|---|---|
val |
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. |
void
CombinedTag.pictures
• get publisher(): string
Gets the publisher of the track.
string
CombinedTag.publisher
• set publisher(val): void
Sets the publisher of the track.
| Name | Type | Description |
|---|---|---|
val |
string |
Publisher of the track or undefined if no value is set |
void
CombinedTag.publisher
• get remixedBy(): string
Gets the remixer of the track.
string
CombinedTag.remixedBy
• set remixedBy(val): void
Sets the remixer of the track.
| Name | Type | Description |
|---|---|---|
val |
string |
Remixer of the track or undefined if no value is set |
void
CombinedTag.remixedBy
• get replayGainAlbumGain(): number
Gets the ReplayGain album gain in dB.
number
CombinedTag.replayGainAlbumGain
• set replayGainAlbumGain(val): void
Sets the ReplayGain album gain in dB.
| Name | Type | Description |
|---|---|---|
val |
number |
Album gain as per the ReplayGain specifications, in dB, or NaN if no value is set |
void
CombinedTag.replayGainAlbumGain
• get replayGainAlbumPeak(): number
Gets the ReplayGain album peak sample.
number
CombinedTag.replayGainAlbumPeak
• set replayGainAlbumPeak(val): void
Sets the ReplayGain album peak sample.
| Name | Type | Description |
|---|---|---|
val |
number |
Album peak as per the ReplayGain specifications, or NaN if no value is set |
void
CombinedTag.replayGainAlbumPeak
• get replayGainTrackGain(): number
Gets the ReplayGain track gain in dB.
number
CombinedTag.replayGainTrackGain
• set replayGainTrackGain(val): void
Sets the ReplayGain track gain in dB.
| Name | Type | Description |
|---|---|---|
val |
number |
Track gain as per ReplayGain specifications, in dB, or NaN if no value is set |
void
CombinedTag.replayGainTrackGain
• get replayGainTrackPeak(): number
Gets the ReplayGain track peak sample.
number
CombinedTag.replayGainTrackPeak
• set replayGainTrackPeak(val): void
Sets the ReplayGain track peak sample.
| Name | Type | Description |
|---|---|---|
val |
number |
Track peak as per the ReplayGain specifications, or NaN if no value is set |
void
CombinedTag.replayGainTrackPeak
• get sizeOnDisk(): number
Gets the size of the tag in bytes on disk as it was read from disk.
Remarks
Note that tags may not appear contiguously in a file. Access the tags contained in this object to see the size of each tag on the disk.
number
CombinedTag.sizeOnDisk
• 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".
string
CombinedTag.subtitle
• set subtitle(val): 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".
| Name | Type | Description |
|---|---|---|
val |
string |
Subtitle of the media represented by the current instance or undefined if no value is present |
void
CombinedTag.subtitle
• get supportedTagTypes(): TagTypes
Gets the types of tags that are supported by this instance of a combined tag. Only these tag types can be added to the instance.
CombinedTag.supportedTagTypes
• 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.
CombinedTag.tagTypes
• get tags(): Tag[]
Gets all tags contained within the current instance. If the tags within this tag are also CombinedTags, the retrieval will recurse and return a flat list of nested tags.
Remarks
Modifications of the returned array will not be retained.
Tag[]
CombinedTag.tags
• get title(): string
Gets the title for the media described by the current instance.
string
CombinedTag.title
• set title(val): 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).
| Name | Type | Description |
|---|---|---|
val |
string |
Title of the media described by the current instance or undefined if no value is present. |
void
CombinedTag.title
• 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.
string
CombinedTag.titleSort
• set titleSort(val): void
Sets the sortable name for the title of the media described by the current instance.
Possibly used to sort compilations or episodic content.
| Name | Type | Description |
|---|---|---|
val |
string |
Sortable name of the media described by the current instance or undefined if no value is present |
void
CombinedTag.titleSort
• 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.
number
CombinedTag.track
• set track(val): 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.
| Name | Type | Description |
|---|---|---|
val |
number |
Position of the media represented by the current instance in its containing album or 0 if not specified. |
void
CombinedTag.track
• 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.
number
CombinedTag.trackCount
• set trackCount(val): 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.
| Name | Type | Description |
|---|---|---|
val |
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. |
void
CombinedTag.trackCount
• 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.
number
CombinedTag.year
• set year(val): 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.
| Name | Type | Description |
|---|---|---|
val |
number |
Year that the media represented by the current instance was created or 0 if no value is present. |
void
CombinedTag.year
▸ Protected addTag(tag): void
Adds the provided tag to the list of tags contained in the current instance.
| Name | Type | Description |
|---|---|---|
tag |
Tag |
Tag to add to the current instance. |
void
▸ clear(): void
Clears all values stored in the current instance.
Remarks
Clears all child tags.
void
▸ 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.
| Name | Type | Description |
|---|---|---|
target |
Tag |
Target tag to copy values to |
overwrite |
boolean |
Whether or not to copy values over existing ones |
void
▸ createTag(type, copy): Tag
Creates a new instance of the desired tag type and adds it to the current instance. If the tag type is unsupported in the current context or the tag type already exists, an error will be thrown.
| Name | Type | Description |
|---|---|---|
type |
TagTypes |
Type of tag to create |
copy |
boolean |
Whether or not to copy the contents of the current instance to the newly created tag instance |
▸ getTag<TTag>(tagType): TTag
Gets a tag of the specified tag type if a matching tag exists in the current instance.
| Name | Type |
|---|---|
TTag |
extends Tag<TTag> |
| Name | Type | Description |
|---|---|---|
tagType |
TagTypes |
Type of tag to retrieve |
TTag
Tag with specified type, if it exists. undefined otherwise.
▸ removeTags(tagTypes): void
Remove all tags that match the specified tagTypes. This is performed recursively. Any nested
CombinedTag instances are left in place.
| Name | Type | Description |
|---|---|---|
tagTypes |
TagTypes |
Types of tags to remove |
void
▸ render(): ByteVector
Renders the tags contained in the current instance. The tags are rendered in the order that they are stored in the current instance.
Physical representation of the tags stored in the current instance
▸ Protected replaceTag(oldTag, newTag): void
This is used for special cases where the order of tags is important.
| Name | Type |
|---|---|
oldTag |
Tag |
newTag |
Tag |
void
▸ Protected validateTagCreation(tagType): void
Verifies if a tag can be added to the current instance. The criteria for validation are:
- A tag of the given tag type does not already exist
- The given tag type is supported by the current instance
| Name | Type | Description |
|---|---|---|
tagType |
TagTypes |
Tag type that the caller wants to create |
void
CombinedTag.validateTagCreation
▸ Static Protected firstInGroup(group): string
Gets the first string in an array.
| Name | Type | Description |
|---|---|---|
group |
string[] |
Array of strings to get the first string from. |
string
First string contained in group or undefined if the array is
undefined or empty
▸ Static Protected isFalsyOrLikeEmpty(value): boolean
Checks if a value is falsy or empty.
| Name | Type | Description |
|---|---|---|
value |
string | string[] |
Object to check |
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.
CombinedTag.isFalsyOrLikeEmpty
▸ Static Protected joinGroup(group): string
Joins an array of string into a single, semicolon and space separated string.
| Name | Type | Description |
|---|---|---|
group |
string[] |
Array of string to join |
string
A semicolon and space separated string containing the values from group
or undefined if the array is undefined or empty.
▸ Static tagTypeFlagsToArray(tagTypes): TagTypes[]
Generates an array of tag types that are set in the provided flags value.
| Name | Type | Description |
|---|---|---|
tagTypes |
TagTypes |
Tag types that have been OR'd together. |
TagTypes[]