Skip to main content
Version: 3.0.0

Audio Actions

note

Windows Voice and Amazon TTS are both supported. To use Amazon TTS, you should compile the WEAVR Settings and have a valid internet connection.

Play Audio Action​

Play Audio Action

PropertyDescription
Audio ClipAudio Clip to be played. You can set different audio clips to be played for different languages.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Play Audio on Target​

Play Audio on Target Action

The Play Audio on Target action plays the indicated audio from the referenced target Object of the scene.

PropertyDescription
Audio ClipAudio Clip to be played. You can set different audio clips to be played for different languages.
TargetObject for which the audio is played.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Play Audio at Position​

Play Audio at Position Action

The Play Audio at Position action plays the indicated audio when you are in the needed position in the scene.

PropertyDescription
Audio ClipAudio Clip to be played. You can set different audio clips to be played for different languages.
PointPosition in the coordinate system where to play the audio in respect to the center of the scene. If disabled, the audio is heard on the background of the scene.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Text to Speech​

Text to Speech Action

The Text to Speech action converts the text into audio that will be reproduced on the background of the scene.

The voice is no longer chosen on the action itself: it is defined by a Role. Roles and their per-language voices are configured in the Text To Speech tab of the Procedure Graph Toolbar, and the audio clip is generated automatically from the text using the role's voice.

PropertyDescription
RoleThe Text-to-Speech role that provides the voice. Selecting a role determines, per language, which voice reads the text. Roles are created and configured in the Text To Speech tab.
TextThe text to be synthesized. You can enter different text for different languages.
Play BehaviourHow this narration interacts with other narrations. For example Stop Same Role Narrations (default) stops other narrations of the same role before playing; other options let it wait for or pause same-role/all narrations, or continue playing after the node finishes.
Listen inPick a language and press the play button to preview the synthesized speech directly in the editor.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Text to Speech on Target​

Text to Speech on Target Action

The Text to Speech on Target action converts the text into audio that will be reproduced from the referenced Object of the scene.

PropertyDescription
RoleThe Text-to-Speech role that provides the voice (per language).
TextThe text to be synthesized. You can enter different text for different languages.
TargetObject for which the audio is played. If null, the audio is heard on the background of the scene.
DistanceIf enabled, the audio becomes 3D and the value is the maximum distance from which it can be heard.
Play BehaviourHow this narration interacts with other narrations (stop / wait / pause same-role or all narrations).
Listen inPick a language and press play to preview the synthesized speech in the editor.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Text to Speech at Position​

Text to Speech at Position Action

The Text to Speech at Position action converts the text into audio when you are in the needed position in the scene.

PropertyDescription
RoleThe Text-to-Speech role that provides the voice (per language).
TextThe text to be synthesized. You can enter different text for different languages.
PointPosition in the coordinate system where to play the audio in respect to the center of the scene. If disabled, the audio is heard on the background of the scene.
DistanceIf enabled, the audio becomes 3D and the value is the maximum distance from which it can be heard.
Play BehaviourHow this narration interacts with other narrations (stop / wait / pause same-role or all narrations).
Listen inPick a language and press play to preview the synthesized speech in the editor.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Advanced​

The advanced section contains some of the previous actions with more settings to customize.

Play Audio Expert​

Play Audio Expert Action

The Play Audio Clip Expert action plays the indicated audio. You can customize the reproduction of the clip in different ways.

PropertyDescription
Audio ClipAudio Clip to be played. You can set different audio clips to be played for different languages.
VolumeVolume of the audio clip.
TargetObject for which the audio is played. If null, the audio is heard on the background of the scene.
PointPosition in the coordinate system where to play the audio in respect to the center of the scene. If disabled, the audio is heard on the background of the scene.
PitchIf enabled, the pitch of the audio can be customized. You can animate it.
DistanceIf enabled, the audio becomes 3D, and the distance is the maximum distance from which you can hear the audio. You can animate it.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).

Text to Speech Expert​

Text to Speech Expert Action

The Text to Speech Expert action plays the indicated TTS. You can customize the reproduction of the TTS in different ways.

PropertyDescription
RoleThe Text-to-Speech role that provides the voice (per language).
TextThe text to be synthesized. You can enter different text for different languages.
Play BehaviourHow this narration interacts with other narrations (stop / wait / pause same-role or all narrations).
VolumeVolume of the audio clip.
TargetObject for which the audio is played. If null, the audio is heard on the background of the scene.
PointPosition in the coordinate system where to play the audio in respect to the center of the scene. If disabled, the audio is heard on the background of the scene.
PitchIf enabled, the pitch of the audio can be customized. You can animate it.
DistanceIf enabled, the audio becomes 3D, and the distance is the maximum distance from which you can hear the audio. You can animate it.
LoopIf enabled, the audio is reproduced in a loop (this parameter is invisible if the action is not Async).