CaptionController

Defined in: caption.ts:70

Methods

end()

end(): Promise<void>

Defined in: caption.ts:103

Hides the caption overlay and stops voiceover playback. Always call this after every start().

Returns

Promise<void>

---

start()

start(): Promise<void>

Defined in: caption.ts:81

Begins voiceover audio and shows the caption overlay.

Returns

Promise<void>

Example

await captions.intro.start()
await page.goto('/dashboard')
await captions.intro.end()

---

waitUntil()

waitUntil(progress): Promise<void>

Defined in: caption.ts:98

Pauses execution until the voiceover audio reaches the given playback position.

Use this to time a page interaction to a specific moment in the narration — for example, clicking a button right as the voiceover mentions it.

Parameters

progress

string

Playback position as a percentage string, e.g. '50%'.

Returns

Promise<void>

Example

await captions.intro.start()
await captions.intro.waitUntil('70%')  // wait until 70% of audio has played
await page.locator('#cta').click()     // then click
await captions.intro.end()