💬

Play Voice

Speaks a voice line for the specified text using text-to-speech. Shows subtitles automatically.

image

Usages

Narrate your experience with the voice guidance, and give feedback to the user on right and wrong actions.

Can also be used to periodically remind user of the assignment, if the user is lost (see the description of Repeat mode below).

Behavior

When In is called, Out is called immediately.

image

After the voice line is done playing, Done is called.

Behavior: Repeat Mode

Sometimes it’s useful to give users a reminder of a certain action, if they missed the instruction. For this, Voiceline Type dropdown can be set to Repeat mode.

image
image

As you see, more inputs and outputs appear in this case.

There are additional parameters for repeat mode.

A repeated voice will continue repeating for an indefinite amount of times. The thinking is that while user hasn’t done the next step, we will continue to remind him - for example, every 15 or every 30 seconds. To stop this node from doing more repetitions, one of the following needs to happen:

  1. A Stop input is called on this Voice node
  2. Another Play Voice node with Repeat mode is executed in flow
  3. A Checkpoint node is executed in flow (Checkpoints are meant to separate logical groups of your flow, so it’s safe to assume that when you’re reaching a Checkpoint you no longer need any repeated voices around)

Parameters for Repeat mode:

  • Repeating Timer: time between repetitions
  • Initial Delay: how long to wait until first playback
  • Playback Start: called every time a repeated voiceline starts playing
  • Playback End: called every time a repeated voiceline ends playing

Advanced

In order to modify how the voice is played (for example add cool radio effect for voices played on UHF radios and such), you can specify a custom Audio Mixer Group for this node.

This parameter is set to None by default, and thus doesn’t apply any effect unless you change that.

States

Busy while the voiceline is played.

Notes

Any other voice will stop the playback of the current one. To play one voiceline after another use Done output, or use ⌛Wait for Last Voice node.