taglib-ts
    Preparing search index...

    Class ShortenTag

    Stub tag for Shorten (.shn) files.

    Shorten does not support any metadata tags. All getters return empty strings or zero, and all setters are no-ops. setProperties returns every supplied property as unsupported.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    album artist comment genre isEmpty title track year

    Methods

    complexProperties complexPropertyKeys properties removeUnsupportedProperties setComplexProperties setProperties duplicate joinTagValues

    Constructors

    Accessors

    • get album(): string

      Returns an empty string; Shorten files have no album field.

      Returns string

      "".

    • set album(_value: string): void

      No-op; Shorten files do not support an album field.

      Parameters

      • _value: string

        Ignored.

      Returns void

    • get artist(): string

      Returns an empty string; Shorten files have no artist field.

      Returns string

      "".

    • set artist(_value: string): void

      No-op; Shorten files do not support an artist field.

      Parameters

      • _value: string

        Ignored.

      Returns void

    • get comment(): string

      Returns an empty string; Shorten files have no comment field.

      Returns string

      "".

    • set comment(_value: string): void

      No-op; Shorten files do not support a comment field.

      Parameters

      • _value: string

        Ignored.

      Returns void

    • get genre(): string

      Returns an empty string; Shorten files have no genre field.

      Returns string

      "".

    • set genre(_value: string): void

      No-op; Shorten files do not support a genre field.

      Parameters

      • _value: string

        Ignored.

      Returns void

    • get isEmpty(): boolean

      True when every field is empty / zero.

      Returns boolean

    • get title(): string

      Returns an empty string; Shorten files have no title field.

      Returns string

      "".

    • set title(_value: string): void

      No-op; Shorten files do not support a title field.

      Parameters

      • _value: string

        Ignored.

      Returns void

    • get track(): number

      Returns 0; Shorten files have no track number field.

      Returns number

      0.

    • set track(_value: number): void

      No-op; Shorten files do not support a track number field.

      Parameters

      • _value: number

        Ignored.

      Returns void

    • get year(): number

      Returns 0; Shorten files have no year field.

      Returns number

      0.

    • set year(_value: number): void

      No-op; Shorten files do not support a year field.

      Parameters

      • _value: number

        Ignored.

      Returns void

    Methods

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

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

    • 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

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods