Class MatroskaChapters

Parses and renders Matroska Chapters EBML elements.

Index

Constructors

Accessors

Methods

addEdition fromComplexProperties isEmpty removeEdition renderChapters toComplexProperties parseFromStream

Constructors

constructor

new MatroskaChapters(): MatroskaChapters
Returns MatroskaChapters

Accessors

editions

get editions(): ChapterEdition[]
Returns all chapter editions.

Returns ChapterEdition[]
- Defined in matroska/matroskaChapters.ts:66

Methods

addEdition

addEdition(edition: ChapterEdition): void
Adds a chapter edition.
Parameters
- edition: ChapterEdition
  The edition to add.
Returns void
- Defined in matroska/matroskaChapters.ts:74

fromComplexProperties

fromComplexProperties(properties: VariantMap[]): void
Set chapters from complex properties (one entry per edition). Replaces all existing editions.
Parameters
- properties: VariantMap[]
  Array of edition VariantMaps.
Returns void
- Defined in matroska/matroskaChapters.ts:338

isEmpty

isEmpty(): boolean
Returns true if there are no editions.

Returns boolean
- Defined in matroska/matroskaChapters.ts:90

removeEdition

removeEdition(uid: number): void
Removes a chapter edition by UID.
Parameters
- uid: number
  Edition UID to remove. Use 0 to remove the first edition with uid=0.
Returns void
- Defined in matroska/matroskaChapters.ts:82

renderChapters

renderChapters(): ByteVector | null
Renders all editions into a Chapters EBML element. Returns null if there are no editions.

Returns ByteVector | null
- Defined in matroska/matroskaChapters.ts:222

toComplexProperties

toComplexProperties(): VariantMap[]
Returns this chapters object as a complex properties array (one entry per edition).

Returns VariantMap[]
- Defined in matroska/matroskaChapters.ts:287

`Static`parseFromStream

parseFromStream(
stream: IOStream,
chaptersEl: EbmlElement,
): Promise<MatroskaChapters>
Parse a Chapters EBML element from the stream.
Parameters
- stream: IOStream
  The I/O stream to read from.
- chaptersEl: EbmlElement
  The Chapters EBML element descriptor.
Returns Promise<MatroskaChapters>
A new MatroskaChapters instance.
- Defined in matroska/matroskaChapters.ts:100