NarrationCue
NarrationCue =
Promise<void>
Defined in: cue.ts:353
A narration cue controller.
Example
Section titled “Example”await narration.intro()await page.goto('/dashboard')await narration.nextStep.start()await narration.nextStep.end()
// Continue once part of the line has been spoken (in every language):await narration.save.until('50%')await page.click('#save')await narration.save.end()NarrationCue():
Promise<void>
No argument: play the line and block until its audio finishes.
Returns
Section titled “Returns”Promise<void>
Methods
Section titled “Methods”end():
Promise<void>
Defined in: cue.ts:369
Returns
Section titled “Returns”Promise<void>
start()
Section titled “start()”start(
options?):Promise<void>
Defined in: cue.ts:368
Start the line now (non-blocking); pair with end(). delay offsets the
recorded start (see StartDelayOptions).
Parameters
Section titled “Parameters”options?
Section titled “options?”StartDelayOptions
Returns
Section titled “Returns”Promise<void>
until()
Section titled “until()”until(
percentage):Promise<void>
Defined in: cue.ts:363
Start the line if it is not playing yet, then hold the script until this
percentage of the line’s audio has been spoken (e.g. '50%'). Resolved
per language, so the same script lines up with every translation. The cue
stays open: call .until() again with a larger percentage, .end(), or
start the next cue.
Parameters
Section titled “Parameters”percentage
Section titled “percentage”`${number}%`
Returns
Section titled “Returns”Promise<void>