Class UserTextIdentificationFrame

User text identification frame (TXXX).

Structure: encoding(1) + description(null-terminated) + value(in encoding). The first field is the description, the rest are values.

Hierarchy (View Summary)

TextIdentificationFrame
- UserTextIdentificationFrame

Index

Constructors

Properties

Accessors

description encoding fieldList frameId header size text

Methods

parseFields render renderFields toString createTextFrame fieldData find fromData fromRawData

Constructors

constructor

new UserTextIdentificationFrame(
encoding?: StringType,
): UserTextIdentificationFrame
Parameters
- encoding: StringType = StringType.UTF8
Returns UserTextIdentificationFrame
Overrides TextIdentificationFrame.constructor
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:175

Properties

`Protected`_header

_header: Id3v2FrameHeader

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

Accessors

description

get description(): string
Returns string
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:179
set description(value: string): void
Parameters
- value: string
Returns void
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:184

encoding

get encoding(): StringType
Returns StringType
Inherited from TextIdentificationFrame.encoding
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:31
set encoding(e: StringType): void
Parameters
- e: StringType
Returns void
Inherited from TextIdentificationFrame.encoding
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:36

fieldList

get fieldList(): string[]
Returns string[]
Overrides TextIdentificationFrame.fieldList
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:194
set fieldList(fields: string[]): void
Parameters
- fields: string[]
Returns void
Overrides TextIdentificationFrame.fieldList
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:198

frameId

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

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

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

Returns Id3v2FrameHeader
Inherited from TextIdentificationFrame.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 TextIdentificationFrame.size
- Defined in mpeg/id3v2/id3v2Frame.ts:366

text

get text(): string
Returns string
Overrides TextIdentificationFrame.text
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:202
set text(value: string): void
Parameters
- value: string
Returns void
Overrides TextIdentificationFrame.text
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:207

Methods

`Protected`parseFields

parseFields(data: ByteVector, version: number): void
Parse the frame-specific payload (after header decoding).
Parameters
- data: ByteVector
- version: number
Returns void
Inherited from TextIdentificationFrame.parseFields
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:91

render

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

`Protected`renderFields

renderFields(version: number): ByteVector
Render the frame-specific payload for the given version.
Parameters
- version: number
Returns ByteVector
Inherited from TextIdentificationFrame.renderFields
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:96

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from TextIdentificationFrame.toString
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:61

`Static`createTextFrame

createTextFrame(id: ByteVector, values: string[]): TextIdentificationFrame
Parameters
- id: ByteVector
- values: string[]
Returns TextIdentificationFrame
Inherited from TextIdentificationFrame.createTextFrame
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:67

`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 TextIdentificationFrame.fieldData
- Defined in mpeg/id3v2/id3v2Frame.ts:406

`Static`find

find(
tag: { frames?: Id3v2Frame[] },
description: string,
): UserTextIdentificationFrame | null
Parameters
- tag: { frames?: Id3v2Frame[] }
- description: string
Returns UserTextIdentificationFrame | null
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:229

`Static`fromData

fromData(
    data: ByteVector,
    header: Id3v2FrameHeader,
    version: number,
): TextIdentificationFrame
Internal
Create from raw frame data (used by frame factory).
Parameters
- data: ByteVector
- header: Id3v2FrameHeader
- version: number
Returns TextIdentificationFrame
Inherited from TextIdentificationFrame.fromData
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:77

`Static`fromRawData

fromRawData(
    data: ByteVector,
    header: Id3v2FrameHeader,
    version: number,
): UserTextIdentificationFrame
Internal
Create from raw frame data.
Parameters
- data: ByteVector
- header: Id3v2FrameHeader
- version: number
Returns UserTextIdentificationFrame
- Defined in mpeg/id3v2/frames/textIdentificationFrame.ts:217