taglib-ts
    Preparing search index...

    Class CombinedTag

    A combined / union tag that delegates to multiple underlying tags in priority order. Getters return the first non-empty value; setters write to all non-null tags so that every format stays in sync.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get album(): string

      Album name. An empty string indicates the field is not set.

      Returns string

    • set album(v: string): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: string

      Returns void

    • get artist(): string

      Primary artist or performer. An empty string indicates the field is not set.

      Returns string

    • set artist(v: string): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: string

      Returns void

    • get comment(): string

      Free-form comment. An empty string indicates the field is not set.

      Returns string

    • set comment(v: string): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: string

      Returns void

    • 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

    • set genre(v: string): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: string

      Returns void

    • get isEmpty(): boolean

      true when every non-null underlying tag reports itself as empty.

      Returns boolean

    • get title(): string

      Track title. An empty string indicates the field is not set.

      Returns string

    • set title(v: string): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: string

      Returns void

    • get track(): number

      Track number within the album. Returns 0 if not set.

      Returns number

    • set track(v: number): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: number

      Returns void

    • get year(): number

      Release year. Returns 0 if not set.

      Returns number

    • set year(v: number): void

      Writes v to every non-null tag in the list.

      Parameters

      • v: number

      Returns void

    Methods

    • Return complex properties for key from the first tag that has any.

      Parameters

      • key: string

        The property key (e.g. "PICTURE").

      Returns VariantMap[]

      The first non-empty result found, or an empty array.

    • Collect the union of complex property keys from all underlying tags.

      Returns string[]

      Deduplicated array of complex property key strings.

    • 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

    • Delegate complex property writes to the highest-priority tag.

      Parameters

      • key: string

        The property key (e.g. "PICTURE").

      • value: VariantMap[]

        The new values to store.

      Returns boolean

      true if stored successfully, false if no tags are present.

    • Replace the internal tag list (used when tags are added/removed).

      Parameters

      • tags: (Tag | null)[]

      Returns 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

    • Join an array of tag values with " / ".

      Parameters

      • values: string[]

        The string values to join.

      Returns string

      A single string with values separated by " / ".