Class UniqueFileIdentifierFrame

Unique file identifier frame (UFID).

Structure: owner(null-terminated Latin1) + identifier(bytes).

Hierarchy (View Summary)

Id3v2Frame
- UniqueFileIdentifierFrame

Index

Constructors

Properties

Accessors

frameId header identifier owner size

Methods

parseFields render renderFields toString fieldData fromData

Constructors

constructor

new UniqueFileIdentifierFrame(
owner?: string,
identifier?: ByteVector,
): UniqueFileIdentifierFrame
Creates a new UFID frame with an optional owner and identifier.
Parameters
- Optionalowner: string
  The owner URL or scheme identifier string.
- Optionalidentifier: ByteVector
  The binary file identifier data.
Returns UniqueFileIdentifierFrame
Overrides Id3v2Frame.constructor
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:25

Properties

`Protected`_header

_header: Id3v2FrameHeader

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

Accessors

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

identifier

get identifier(): ByteVector
Gets the binary file identifier data.

Returns ByteVector
A ByteVector containing the identifier bytes.
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:56
set identifier(data: ByteVector): void
Sets the binary file identifier data.
Parameters
- data: ByteVector
  The new identifier bytes.
Returns void
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:64

owner

get owner(): string
Gets the owner URL or scheme identifier string.

Returns string
The owner string.
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:40
set owner(value: string): void
Sets the owner URL or scheme identifier string.
Parameters
- value: string
  The new owner string.
Returns void
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:48

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
Parses the raw frame fields into owner and identifier data.
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/uniqueFileIdentifierFrame.ts:97

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
Serializes the UFID frame fields into bytes.
Parameters
- _version: number
  The ID3v2 version (unused).
Returns ByteVector
A ByteVector containing the encoded frame fields.
Overrides Id3v2Frame.renderFields
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:113

toString

toString(): string
Returns the owner identifier string.

Returns string
The owner string of this frame.
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:72

`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,
): UniqueFileIdentifierFrame
Internal
Create from raw frame data.
Parameters
- data: ByteVector
- header: Id3v2FrameHeader
- version: number
Returns UniqueFileIdentifierFrame
- Defined in mpeg/id3v2/frames/uniqueFileIdentifierFrame.ts:79