taglib-ts
    Preparing search index...

    Comments frame (COMM).

    Structure: encoding(1) + language(3) + description(null-terminated) + text.

    Hierarchy (View Summary)

    Index

    Constructors

    • Creates a new, empty CommentsFrame.

      Parameters

      • encoding: StringType = StringType.UTF8

        Text encoding to use for description and comment text. Defaults to StringType.UTF8 so all Unicode characters (including CJK) are stored correctly. Note: this differs from the previous Latin-1 default, meaning newly created frames will have a different encoding byte (0x03 vs 0x00) compared to older taglib-ts output. Frames read from existing files preserve whatever encoding was stored on disk.

      Returns CommentsFrame

    Properties

    The parsed frame header, containing the frame ID, size, and flags.

    Accessors

    • get size(): number

      Gets the payload size in bytes from the header.

      Returns number

    Methods

    • Searches for a CommentsFrame with the given description in an ID3v2 tag.

      Parameters

      • tag: { frames?: Id3v2Frame[] }

        An object exposing a frames array of Id3v2Frame instances.

      • description: string

        The content description to match against.

      Returns CommentsFrame | null

      The first matching CommentsFrame, or null if none is found.