Class Mp4ChapterHolder`Abstract`

Abstract base class for chapter list holders.

Implements the lazy-read / dirty-write pattern used by both Nero and QuickTime chapter implementations:

Chapters are read from disk only on first access.
Chapters are written to disk only when they have been modified.

Hierarchy (View Summary)

Mp4ChapterHolder
- NeroChapters
- QtChapters

Index

Constructors

Properties

_chapters _loaded _modified

Accessors

Methods

chapters getChapters read saveIfModified setChapters setModified write

Constructors

constructor

new Mp4ChapterHolder(): Mp4ChapterHolder
Returns Mp4ChapterHolder

Properties

`Protected`_chapters

_chapters: Mp4Chapter[] = []

The currently-held chapter list (may not yet be loaded from disk).

`Protected`_loaded

_loaded: boolean = false

Whether chapters have been loaded from disk at least once.

`Protected`_modified

_modified: boolean = false

Whether the in-memory chapter list differs from what is on disk.

Accessors

isModified

get isModified(): boolean
Returns true if the in-memory chapter list has been modified.

Returns boolean
- Defined in mp4/mp4Chapter.ts:77

Methods

chapters

chapters(): Mp4Chapter[]
Returns the held chapter list without triggering a disk read. Useful for mock implementations in tests.

Returns Mp4Chapter[]
- Defined in mp4/mp4Chapter.ts:112

`Abstract`getChapters

getChapters(stream: IOStream): Promise<Mp4Chapter[]>
Returns the current chapter list, loading from disk on first call.
Parameters
- stream: IOStream
  The file stream to read from (used only on first call).
Returns Promise<Mp4Chapter[]>
The chapter list.
- Defined in mp4/mp4Chapter.ts:56

`Abstract`read

read(stream: IOStream): Promise<boolean>
Reads chapters from disk into _chapters.
Parameters
- stream: IOStream
  The file stream.
Returns Promise<boolean>
true if chapters were found on disk.
- Defined in mp4/mp4Chapter.ts:64

saveIfModified

saveIfModified(stream: IOStream): Promise<boolean>
Writes the chapter list to disk only if it has been modified.
Parameters
- stream: IOStream
  The file stream.
Returns Promise<boolean>
true if successful (or if no write was needed).
- Defined in mp4/mp4Chapter.ts:122

setChapters

setChapters(chapters: Mp4Chapter[]): void
Updates the chapter list, marking it as modified if the new list differs from the current one or if the holder was not yet loaded.
Parameters
- chapters: Mp4Chapter[]
  Replacement chapter list.
Returns void
- Defined in mp4/mp4Chapter.ts:96

setModified

setModified(value: boolean): void
Sets _modified directly (used in tests / mock subclasses).
Parameters
- value: boolean
  New modified state.
Returns void
- Defined in mp4/mp4Chapter.ts:86

`Abstract`write

write(stream: IOStream): Promise<boolean>
Writes _chapters to disk.
Parameters
- stream: IOStream
  The file stream.
Returns Promise<boolean>
true on success.
- Defined in mp4/mp4Chapter.ts:72