Class AttachedPictureFrame

Attached picture frame (APIC).

Structure: encoding(1) + mimeType(null-terminated Latin1) + pictureType(1) + description(null-terminated in encoding) + pictureData.

Hierarchy (View Summary)

Id3v2Frame
- AttachedPictureFrame

Index

Constructors

Properties

Accessors

description encoding frameId header mimeType picture pictureType size

Methods

parseFields render renderFields toString fieldData fromData

Constructors

constructor

new AttachedPictureFrame(encoding?: StringType): AttachedPictureFrame
Creates a new, empty AttachedPictureFrame.
Parameters
- encoding: StringType = StringType.UTF8
  Text encoding to use for the description field. Defaults to StringType.UTF8 so all Unicode characters are stored correctly.
Returns AttachedPictureFrame
Overrides Id3v2Frame.constructor
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:60

Properties

`Protected`_header

_header: Id3v2FrameHeader

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

Accessors

description

get description(): string
Gets the short description of the picture.

Returns string
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:101
set description(value: string): void
Sets the short description of the picture.
Parameters
- value: string
Returns void
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:106

encoding

get encoding(): StringType
Gets the text encoding used for the description field.

Returns StringType
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:71
set encoding(e: StringType): void
Sets the text encoding used for the description field.
Parameters
- e: StringType
Returns void
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:76

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

mimeType

get mimeType(): string
Gets the MIME type of the embedded image (e.g. "image/jpeg").

Returns string
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:81
set mimeType(value: string): void
Sets the MIME type of the embedded image.
Parameters
- value: string
Returns void
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:86

picture

get picture(): ByteVector
Gets the raw binary image data.

Returns ByteVector
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:111
set picture(data: ByteVector): void
Sets the raw binary image data.
Parameters
- data: ByteVector
Returns void
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:116

pictureType

get pictureType(): PictureType
Gets the semantic picture type.

Returns PictureType
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:91
set pictureType(value: PictureType): void
Sets the semantic picture type.
Parameters
- value: PictureType
Returns void
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:96

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 APIC frame field data, populating all picture properties.
Parameters
- data: ByteVector
  Decoded frame field bytes (after unsynchronisation/decompression).
- version: number
  ID3v2 version number (2 for v2.2, 3 for v2.3, 4 for v2.4).
Returns void
Overrides Id3v2Frame.parseFields
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:149

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
Renders the frame field data to bytes.
Parameters
- version: number
  ID3v2 version number used to determine the on-disk format.
Returns ByteVector
A ByteVector containing the encoded APIC field data.
Overrides Id3v2Frame.renderFields
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:190

toString

toString(): string
Returns a human-readable string combining the MIME type and description.

Returns string
A string in the form "[mimeType] description".
- Defined in mpeg/id3v2/frames/attachedPictureFrame.ts:124

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