Class Tag`Abstract`

Abstract base class for all tag implementations. Subclasses provide format-specific reading/writing of metadata fields.

Hierarchy (View Summary)

Tag

Index

Constructors

Accessors

album artist comment genre isEmpty title track year

Methods

complexProperties complexPropertyKeys properties removeUnsupportedProperties setComplexProperties setProperties duplicate joinTagValues

Constructors

constructor

new Tag(): Tag
Returns Tag

Accessors

`Abstract`album

get album(): string
Album name. An empty string indicates the field is not set.

Returns string
- Defined in tag.ts:26
set album(value: string): void
Parameters
- value: string
  The album name to store, or an empty string to clear it.
Returns void
- Defined in tag.ts:28

`Abstract`artist

get artist(): string
Primary artist or performer. An empty string indicates the field is not set.

Returns string
- Defined in tag.ts:21
set artist(value: string): void
Parameters
- value: string
  The artist to store, or an empty string to clear it.
Returns void
- Defined in tag.ts:23

`Abstract`comment

get comment(): string
Free-form comment. An empty string indicates the field is not set.

Returns string
- Defined in tag.ts:31
set comment(value: string): void
Parameters
- value: string
  The comment to store, or an empty string to clear it.
Returns void
- Defined in tag.ts:33

`Abstract`genre

get genre(): string
Genre string (may be an ID3v1 genre name or a custom string). An empty string indicates the field is not set.

Returns string
- Defined in tag.ts:36
set genre(value: string): void
Parameters
- value: string
  The genre to store, or an empty string to clear it.
Returns void
- Defined in tag.ts:38

isEmpty

get isEmpty(): boolean
True when every field is empty / zero.

Returns boolean
- Defined in tag.ts:55

`Abstract`title

get title(): string
Track title. An empty string indicates the field is not set.

Returns string
- Defined in tag.ts:16
set title(value: string): void
Parameters
- value: string
  The title to store, or an empty string to clear it.
Returns void
- Defined in tag.ts:18

`Abstract`track

get track(): number
Track number within the album. Returns 0 if not set.

Returns number
- Defined in tag.ts:46
set track(value: number): void
Parameters
- value: number
  The track number to store, or 0 to clear it.
Returns void
- Defined in tag.ts:48

`Abstract`year

get year(): number
Release year. Returns 0 if not set.

Returns number
- Defined in tag.ts:41
set year(value: number): void
Parameters
- value: number
  The year to store, or 0 to clear it.
Returns void
- Defined in tag.ts:43

Methods

complexProperties

complexProperties(_key: string): VariantMap[]
Return all complex property values for the given key.
Parameters
- _key: string
  The property key (e.g. "PICTURE").
Returns VariantMap[]
An array of VariantMap objects, or an empty array if the key is not present.
- Defined in tag.ts:158

complexPropertyKeys

complexPropertyKeys(): string[]
Return the keys of all complex (non-string) properties stored in this tag. Complex properties include embedded pictures and similar structured data.

Returns string[]
An array of property key strings, or an empty array if none.
- Defined in tag.ts:147

properties

properties(): PropertyMap
Export the tag as a PropertyMap.

Returns PropertyMap
A PropertyMap populated with all non-empty tag fields.
- Defined in tag.ts:76

removeUnsupportedProperties

removeUnsupportedProperties(_properties: string[]): void
Remove properties that are not supported by this tag format. The default implementation is a no-op; subclasses may override.
Parameters
- _properties: string[]
  Keys of the properties to remove.
Returns void
- Defined in tag.ts:137

setComplexProperties

setComplexProperties(_key: string, _value: VariantMap[]): boolean
Set complex property values for the given key, replacing any existing values.
Parameters
- _key: string
  The property key (e.g. "PICTURE").
- _value: VariantMap[]
  The new values to store.
Returns boolean
true if the property was stored, false if the format does not support complex properties.
- Defined in tag.ts:170

setProperties

setProperties(properties: PropertyMap): PropertyMap
Apply a PropertyMap to the tag, returning unhandled properties.
Parameters
- properties: PropertyMap
  The property map to apply.
Returns PropertyMap
A PropertyMap containing any keys that this tag does not support.
- Defined in tag.ts:95

`Static`duplicate

duplicate(source: Tag, target: Tag, overwrite: boolean): void
Copy tag fields from source to target. When overwrite is false, only empty fields in the target are filled in.
Parameters
- source: Tag
  The tag to copy values from.
- target: Tag
  The tag to copy values into.
- overwrite: boolean
  When true, all fields in target are overwritten; when false, only unset fields are populated.
Returns void
- Defined in tag.ts:187

`Static`joinTagValues

joinTagValues(values: string[]): string
Join an array of tag values with " / ".
Parameters
- values: string[]
  The string values to join.
Returns string
A single string with values separated by " / ".
- Defined in tag.ts:203