taglib-ts
    Preparing search index...

    Class Id3v2FrameHeader

    ID3v2 frame header.

    • v2.2: 3-byte frame ID + 3-byte size (big-endian, NOT synchsafe)
    • v2.3: 4-byte frame ID + 4-byte size (big-endian, NOT synchsafe) + 2-byte flags
    • v2.4: 4-byte frame ID + 4-byte size (synchsafe) + 2-byte flags
    Index

    Constructors

    constructor

    Accessors

    compression dataLengthIndicator encryption fileAlterPreservation frameId frameSize groupIdentity readOnly tagAlterPreservation unsynchronisation version

    Methods

    render size

    Constructors

    • Construct an Id3v2FrameHeader.

      • If both data and version are provided, the header is parsed from data.
      • If only data is provided, it is used directly as the frame ID.
      • If neither is provided, an empty header is created.

      Parameters

      • Optionaldata: ByteVector

        Raw header bytes to parse, or a frame ID ByteVector.

      • Optionalversion: number

        ID3v2 major version (2, 3, or 4).

      Returns Id3v2FrameHeader

    Accessors

    • get compression(): boolean

      Gets whether the frame data is zlib-compressed.

      Returns boolean

    • set compression(v: boolean): void

      Sets the compression flag.

      Parameters

      • v: boolean

        true if the frame data is compressed.

      Returns void

    • get dataLengthIndicator(): boolean

      Gets whether a 4-byte data-length indicator precedes the payload.

      Returns boolean

    • set dataLengthIndicator(v: boolean): void

      Sets the data-length-indicator flag.

      Parameters

      • v: boolean

        true if a data-length indicator is present.

      Returns void

    • get encryption(): boolean

      Gets whether the frame data is encrypted.

      Returns boolean

    • set encryption(v: boolean): void

      Sets the encryption flag.

      Parameters

      • v: boolean

        true if the frame data is encrypted.

      Returns void

    • get fileAlterPreservation(): boolean

      Gets whether the frame should be discarded when the file is altered.

      Returns boolean

    • set fileAlterPreservation(v: boolean): void

      Sets the file-alter-preservation flag.

      Parameters

      • v: boolean

        true if the frame should be discarded on file alteration.

      Returns void

    • get frameSize(): number

      Gets the payload size of the frame in bytes.

      Returns number

    • set frameSize(size: number): void

      Sets the payload size of the frame in bytes.

      Parameters

      • size: number

        The new payload size.

      Returns void

    • get groupIdentity(): boolean

      Gets whether the frame belongs to a group identified by a group byte.

      Returns boolean

    • set groupIdentity(v: boolean): void

      Sets the group identity flag.

      Parameters

      • v: boolean

        true if a group-identity byte is present in the frame.

      Returns void

    • get tagAlterPreservation(): boolean

      Gets whether the frame should be discarded when the tag is altered.

      Returns boolean

    • set tagAlterPreservation(v: boolean): void

      Sets the tag-alter-preservation flag.

      Parameters

      • v: boolean

        true if the frame should be discarded on tag alteration.

      Returns void

    • get unsynchronisation(): boolean

      Gets whether per-frame unsynchronisation has been applied (v2.4 only).

      Returns boolean

    • set unsynchronisation(v: boolean): void

      Sets the unsynchronisation flag.

      Parameters

      • v: boolean

        true if the frame payload has been unsynchronised.

      Returns void

    • get version(): number

      Gets the ID3v2 major version associated with this header.

      Returns number

    • set version(v: number): void

      Sets the ID3v2 major version associated with this header.

      Parameters

      • v: number

        The major version number (2, 3, or 4).

      Returns void

    Methods

    • Render the header to its binary representation.

      For v2.2 this produces 6 bytes; for v2.3/v2.4 it produces 10 bytes (frame ID + size + two flag bytes).

      Returns ByteVector

      The serialised header as a ByteVector.

    • Header size: 10 bytes for v2.3/v2.4, 6 bytes for v2.2.

      Parameters

      • version: number = 4

      Returns number

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods