Class PrivateFrame

Private frame (PRIV).

Structure: owner(null-terminated Latin1) + data.

Hierarchy (View Summary)

Id3v2Frame
- PrivateFrame

Index

Constructors

Properties

Accessors

data frameId header owner renderData size

Methods

parseFields render renderFields toString fieldData fromData

Constructors

constructor

new PrivateFrame(): PrivateFrame
Creates a new, empty PRIV frame.

Returns PrivateFrame
Overrides Id3v2Frame.constructor
- Defined in mpeg/id3v2/frames/privateFrame.ts:21

Properties

`Protected`_header

_header: Id3v2FrameHeader

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

Accessors

data

get data(): ByteVector
Gets the raw private binary payload.

Returns ByteVector
- Defined in mpeg/id3v2/frames/privateFrame.ts:41
set data(value: ByteVector): void
Sets the raw private binary payload.
Parameters
- value: ByteVector
Returns void
- Defined in mpeg/id3v2/frames/privateFrame.ts:46

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

owner

get owner(): string
Gets the owner identifier string.

Returns string
- Defined in mpeg/id3v2/frames/privateFrame.ts:31
set owner(value: string): void
Sets the owner identifier string.
Parameters
- value: string
Returns void
- Defined in mpeg/id3v2/frames/privateFrame.ts:36

renderData

get renderData(): ByteVector
Returns the private data bytes stored in this frame.

Returns ByteVector
- Defined in mpeg/id3v2/frames/privateFrame.ts:51

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 binary payload of the PRIV frame.
Parameters
- data: ByteVector
  Raw field bytes beginning with the null-terminated owner string.
- _version: number
  ID3v2 version (unused; parsing is version-independent).
Returns void
Overrides Id3v2Frame.parseFields
- Defined in mpeg/id3v2/frames/privateFrame.ts:84

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
Serialises the frame fields into a binary payload.
Parameters
- _version: number
  ID3v2 version (unused; rendering is version-independent).
Returns ByteVector
A ByteVector containing the null-terminated owner string followed by the private data bytes.
Overrides Id3v2Frame.renderFields
- Defined in mpeg/id3v2/frames/privateFrame.ts:100

toString

toString(): string
Returns the owner identifier string.

Returns string
The owner string stored in this frame.
- Defined in mpeg/id3v2/frames/privateFrame.ts:59

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