Class ID3V2RawBuilder

Hierarchy

ID3V2FramesCollect
- ID3V2RawBuilder

Constructors

constructor

new ID3V2RawBuilder(encoding?: string): ID3V2RawBuilder

Inherited from ID3V2FramesCollect.constructor
- Defined in id3v2/id3v2.builder.collect.ts:6
Parameters
- Optional encoding: string
Returns ID3V2RawBuilder

Methods

audioEncryption

audioEncryption(key: string, id: string, previewStart: number, previewLength: number, bin: Buffer): void

- Defined in id3v2/id3v2.builder.ts:6
Parameters
- key: string
- id: string
- previewStart: number
- previewLength: number
- bin: Buffer
Returns void

bool

bool(key: string, bool: boolean): void

- Defined in id3v2/id3v2.builder.ts:10
Parameters
- key: string
- bool: boolean
Returns void

build

build(): Map

Inherited from ID3V2FramesCollect.build
- Defined in id3v2/id3v2.builder.collect.ts:40
Returns Map

chapter

chapter(key: string, chapterID: string, start: number, end: number, offset: number, offsetEnd: number, subframes?: IID3V2.Frame[]): void

- Defined in id3v2/id3v2.builder.ts:16
Parameters
- key: string
- chapterID: string
- start: number
- end: number
- offset: number
- offsetEnd: number
- Optional subframes: IID3V2.Frame[]
Returns void

chapterTOC

chapterTOC(key: string, id: string, ordered: boolean, topLevel: boolean, children: string[]): void

- Defined in id3v2/id3v2.builder.ts:26
Parameters
- key: string
- id: string
- ordered: boolean
- topLevel: boolean
- children: string[]
Returns void

eventTimingCodes

eventTimingCodes(key: string, timeStampFormat: number, events: { timestamp: number; type: number }[]): void

- Defined in id3v2/id3v2.builder.ts:30
Parameters
- key: string
- timeStampFormat: number
- events: { timestamp: number; type: number }[]
Returns void

idBin

idBin(key: string, id: string, binary: Buffer): void

- Defined in id3v2/id3v2.builder.ts:34
Parameters
- key: string
- id: string
- binary: Buffer
Returns void

idLangText

idLangText(key: string, value: undefined | string, lang: undefined | string, id: undefined | string): void

- Defined in id3v2/id3v2.builder.ts:38
Parameters
- key: string
- value: undefined | string
- lang: undefined | string
- id: undefined | string
Returns void

idText

idText(key: string, id: string, value: undefined | string): void

- Defined in id3v2/id3v2.builder.ts:44
Parameters
- key: string
- id: string
- value: undefined | string
Returns void

keyTextList

keyTextList(key: string, group: string, value?: string): void

- Defined in id3v2/id3v2.builder.ts:50
Parameters
- key: string
- group: string
- Optional value: string
Returns void

langText

langText(key: string, language: string, text: string): void

- Defined in id3v2/id3v2.builder.ts:60
Parameters
- key: string
- language: string
- text: string
Returns void

linkedInformation

linkedInformation(key: string, id: string, url: string, additional: string[]): void

- Defined in id3v2/id3v2.builder.ts:64
Parameters
- key: string
- id: string
- url: string
- additional: string[]
Returns void

nrAndTotal

nrAndTotal(key: string, value: undefined | string | number, total: undefined | string | number): void

- Defined in id3v2/id3v2.builder.ts:68
Parameters
- key: string
- value: undefined | string | number
- total: undefined | string | number
Returns void

number

number(key: string, num: undefined | number): void

- Defined in id3v2/id3v2.builder.ts:75
Parameters
- key: string
- num: undefined | number
Returns void

object

object(key: string, filename: string, mimeType: string, contentDescription: string, bin: Buffer): void

- Defined in id3v2/id3v2.builder.ts:81
Parameters
- key: string
- filename: string
- mimeType: string
- contentDescription: string
- bin: Buffer
Returns void

picture

picture(key: string, pictureType: number, description: string, mimeType: string, binary: Buffer): void

- Defined in id3v2/id3v2.builder.ts:85
Parameters
- key: string
- pictureType: number
- description: string
- mimeType: string
- binary: Buffer
Returns void

popularimeter

popularimeter(key: string, email: string, rating: number, count: number): void

- Defined in id3v2/id3v2.builder.ts:89
Parameters
- key: string
- email: string
- rating: number
- count: number
Returns void

relativeVolumeAdjustment

relativeVolumeAdjustment(key: string, right: number, left: number, peakRight?: number, peakLeft?: number, rightBack?: number, leftBack?: number, peakRightBack?: number, peakLeftBack?: number, center?: number, peakCenter?: number, bass?: number, peakBass?: number): void

- Defined in id3v2/id3v2.builder.ts:93
Parameters
- key: string
- right: number
- left: number
- Optional peakRight: number
- Optional peakLeft: number
- Optional rightBack: number
- Optional leftBack: number
- Optional peakRightBack: number
- Optional peakLeftBack: number
- Optional center: number
- Optional peakCenter: number
- Optional bass: number
- Optional peakBass: number
Returns void

relativeVolumeAdjustment2

relativeVolumeAdjustment2(key: string, id: string, channels: { adjustment: number; peak?: number; type: number }[]): void

- Defined in id3v2/id3v2.builder.ts:103
Parameters
- key: string
- id: string
- channels: { adjustment: number; peak?: number; type: number }[]
Returns void

replayGainAdjustment

replayGainAdjustment(key: string, peak: number, radioAdjustment: number, audiophileAdjustment: number): void

- Defined in id3v2/id3v2.builder.ts:107
Parameters
- key: string
- peak: number
- radioAdjustment: number
- audiophileAdjustment: number
Returns void

synchronisedLyrics

synchronisedLyrics(key: string, id: string, language: string, timestampFormat: number, contentType: number, events: { text: string; timestamp: number }[]): void

- Defined in id3v2/id3v2.builder.ts:111
Parameters
- key: string
- id: string
- language: string
- timestampFormat: number
- contentType: number
- events: { text: string; timestamp: number }[]
Returns void

text

text(key: string, text: undefined | string): void

- Defined in id3v2/id3v2.builder.ts:115
Parameters
- key: string
- text: undefined | string
Returns void

unknown

unknown(key: string, binary: Buffer): void

- Defined in id3v2/id3v2.builder.ts:121
Parameters
- key: string
- binary: Buffer
Returns void

Generated using TypeDoc