chapterforge::ReadResult Struct Reference

Parse an existing M4A/MP4 file and return its chapter data. More...

#include <chapterforge.hpp>

Collaboration diagram for chapterforge::ReadResult:

Public Attributes
Status	status
std::vector< ChapterTextSample >	titles
std::vector< ChapterTextSample >	urls
std::vector< ChapterImageSample >	images
MetadataSet	metadata

Related Symbols
(Note that these are not member symbols.)
status returning without	images
status returning without	metadata

Detailed Description

Parse an existing M4A/MP4 file and return its chapter data.

Extracts chapter titles, optional URL samples (tx3g + href), chapter images (MJPEG samples), and top-level metadata (ilst if present). Does not decode audio.

On success status.ok == true and the vectors are filled; on failure status.ok == false and status.message contains a short description.

Friends And Related Symbol Documentation

images()

status returning without chapterforge::images

related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

metadata()

status returning without chapterforge::metadata ( reuses source ilst if  any )

related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Member Data Documentation

images

std::vector<ChapterImageSample> chapterforge::ReadResult::images

metadata

MetadataSet chapterforge::ReadResult::metadata

status

Status chapterforge::ReadResult::status

titles

std::vector<ChapterTextSample> chapterforge::ReadResult::titles

urls

std::vector<ChapterTextSample> chapterforge::ReadResult::urls

---

The documentation for this struct was generated from the following file:

• /home/runner/work/ChapterForge/ChapterForge/include/chapterforge.hpp