NarrationCue

NarrationCue = Promise<void>

Defined in: cue.ts:330

A narration cue controller.

Example

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

// Hold the cue until an absolute position in the final video:
await narration.outro.until('1:05')   // until 1 minute 5 seconds
await narration.outro.until('90%')    // until 90% through

NarrationCue(): Promise<void>

No argument: play the line and block until its audio finishes.

Returns

Promise<void>

Methods

end()

end(): Promise<void>

Defined in: cue.ts:345

Returns

Promise<void>

---

start()

start(options?): Promise<void>

Defined in: cue.ts:344

Start the line now (non-blocking); pair with end(). delay offsets the recorded start (see StartDelayOptions).

Parameters

options?

StartDelayOptions

Returns

Promise<void>

---

until()

until(position): Promise<void>

Defined in: cue.ts:339

Start the line now and hold the cue window until this absolute point in the final video (a '<n>s'/timecode position, or a '<n>%' fraction). The audio is never cut: if it runs longer than the position, the window extends to let it finish. Successive .until(...) targets must be monotonic.

Parameters

position

TimelineOffset

Returns

Promise<void>