Chapters

chapters

Write chapters (markers, scene changes, transcript, or a list) into an mp4/mkv/mov copy without re-encoding; returns YouTube chapter text. Can mux an SRT as soft subtitles.

producewritesdestructivesince v0.45.0

00:00PARAMETERS

Name	Type	Description
`input`	`string`	Path to the video.
`sessionId`	`string`	Or a stopped recording's id.
`from`	`"markers" \| "scenes" \| "transcript"`	markers (default; add_marker, else the file's chapters), scenes (screen changes), or transcript (SRT sections).
`chapters`	`object[]`	Or explicit { start, title } chapters. at least 1 items, at most 200 items
`chapters[].start` required	`number`	≥ 0
`chapters[].title` required	`string`	at most 100 characters
`transcript`	`string`	The .srt for from: transcript.
`minChapterSec`	`number`	Shortest chapter (default 1; scenes 10, transcript 30). ≥ 0
`subtitles`	`string`	Also mux this .srt/.vtt/.ass as a soft subtitle track.
`subtitleLanguage`	`string`	ISO 639-2, e.g. "eng".
`textOnly`	`boolean`	Return chapters and YouTube text only; write no file.
`output`	`string`	Optional .mp4/.mkv/.mov path. Defaults under SCREENCAST_HOME/edits.
`overwrite`	`boolean`	Allow replacing an existing output file.

00:05A MINIMAL CALL

chapters {}

The required arguments only, with placeholder values. Everything else takes its default.

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary:

Field	Type
`chapters` always	`object[]`
`chapters[].start` always	`number`
`chapters[].end` always	`number`
`chapters[].title` always	`string`
`youtube` always	`string`