Class UnknownFrame

Unknown frame – used for any frame type that we don't have a specific parser for.

Hierarchy (View Summary)

Id3v2Frame
- UnknownFrame

Index

Constructors

Properties

Accessors

data frameId header size

Methods

parseFields render renderFields toString fieldData fromData

Constructors

constructor

new UnknownFrame(frameId: ByteVector, data?: ByteVector): UnknownFrame
Creates a new unknown frame with the given frame ID and optional payload.
Parameters
- frameId: ByteVector
  The four-byte frame ID identifying the frame type.
- Optionaldata: ByteVector
  The raw payload bytes. Defaults to an empty ByteVector.
Returns UnknownFrame
Overrides Id3v2Frame.constructor
- Defined in mpeg/id3v2/frames/unknownFrame.ts:17

Properties

`Protected`_header

_header: Id3v2FrameHeader

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

Accessors

data

get data(): ByteVector
Returns the raw frame payload bytes.

Returns ByteVector
A ByteVector containing the unparsed frame data.
- Defined in mpeg/id3v2/frames/unknownFrame.ts:27

frameId

get frameId(): ByteVector
Gets the frame identifier from the header.

Returns ByteVector
Inherited from Id3v2Frame.frameId
- Defined in mpeg/id3v2/id3v2Frame.ts:361

get header(): Id3v2FrameHeader
Gets the frame's header object.

Returns Id3v2FrameHeader
Inherited from Id3v2Frame.header
- Defined in mpeg/id3v2/id3v2Frame.ts:371

size

get size(): number
Gets the payload size in bytes from the header.

Returns number
Inherited from Id3v2Frame.size
- Defined in mpeg/id3v2/id3v2Frame.ts:366

Methods

`Protected`parseFields

parseFields(data: ByteVector, _version: number): void
Stores the raw frame payload for later rendering.
Parameters
- data: ByteVector
  The raw field bytes of the frame.
- _version: number
  The ID3v2 version (unused).
Returns void
Overrides Id3v2Frame.parseFields
- Defined in mpeg/id3v2/frames/unknownFrame.ts:60

render

render(version?: number): ByteVector
Render the complete frame (header + fields) for the given version.
Parameters
- Optionalversion: number
Returns ByteVector
Inherited from Id3v2Frame.render
- Defined in mpeg/id3v2/id3v2Frame.ts:376

`Protected`renderFields

renderFields(_version: number): ByteVector
Returns the preserved raw payload bytes unchanged.
Parameters
- _version: number
  The ID3v2 version (unused).
Returns ByteVector
The raw ByteVector payload of this frame.
Overrides Id3v2Frame.renderFields
- Defined in mpeg/id3v2/frames/unknownFrame.ts:69

toString

toString(): string
Returns the frame ID as a Latin1 string.

Returns string
The four-character frame ID string.
- Defined in mpeg/id3v2/frames/unknownFrame.ts:35

`Protected` `Static`fieldData

fieldData(
    frameData: ByteVector,
    header: Id3v2FrameHeader,
    version: number,
): ByteVector
Extract the raw field data from a complete frame blob.

This handles unsynchronisation decoding, data-length indicators, and (stubbed) decompression.
Parameters
- frameData: ByteVector
- header: Id3v2FrameHeader
- version: number
Returns ByteVector
Inherited from Id3v2Frame.fieldData
- Defined in mpeg/id3v2/id3v2Frame.ts:406

`Static`fromData

fromData(
    data: ByteVector,
    header: Id3v2FrameHeader,
    version: number,
): UnknownFrame
Internal
Create from raw frame data.
Parameters
- data: ByteVector
- header: Id3v2FrameHeader
- version: number
Returns UnknownFrame
- Defined in mpeg/id3v2/frames/unknownFrame.ts:42