RT-Voice Setup

Follow these steps to set up the Dialogue System with RT-Voice.

Import the package Third Party Support ► RTVoice Support. This will unpack files into the folder Assets ► Pixel Crushers ► Dialogue System ► Third Party Support ► RTVoice Support.
Add the RTVoice prefab to your scene as described in the RT-Voice manual.
Add an RT Voice Actor component to your characters (Component → Pixel Crushers → Dialogue System → Third Party Support → RT-Voice → RT Voice Actor). This will make the character use RT-Voice whenever it barks or speaks a conversation line.
- Expand Voice Preferences to specify voice preferences for different languages based on voice name, gender, and/or age. The RT Voice Actor will match any fields that you've specified. If you leave Language blank, it will attempt to use the preferences for all languages. In the screenshot above, the RT Voice Actor will try to use a male voice aged 0-100 for all languages. The actual voice used depends on the voices that are available on the player's system.
  - If you set Gender to Any, it will match any gender.
  - It will perform partial matches of voice names. For example, if you specify "Caitlyn" it will match names including "CereVoice Caitlin - English (Ireland) (en-GB, FEMALE)".
- Tick Wait For Voice In Conversations to automatically add the RTVoiceWait() sequencer command in conversations. This will cause dialogue entries to wait until RT-Voice is done playing.
You don't need to add any special sequencer commands for RT-Voice. However, if you want a sequencer command to wait until RT-Voice is done playing a line, you can use the RTVoiceWait() command.

RT-Voice + SALSA Setup

To use SALSA LipSync Suite:

Set up your character as described on the SALSA LipSync Suite Support page.
Add the Scripting Define Symbol USE_SALSA
Add an RT Voice Actor component. Increase the SALSA trigger values to these ranges:
- SaySmall Trigger: 0.0001
- SayMedium Trigger: 0.0005
- SayLarge Trigger: 0.001
- Note: In newer versions of SALSA, these values are in the SALSA component's Viseme Configuration foldout.

Example Scenes

RT-Voice Example Scene

The Example folder contains an example scene that uses RT-Voice. This is a variation of the main Demo scene. The only difference is that Private Hart and Sergeant Graves have RT Voice Actor components, which makes them automatically speak their lines using RT-Voice instead of the precorded voiceover.

Sergeant Graves also has a Range Trigger that enables his Bark On Idle component only when the player is near him.

RT-Voice + SALSA Example Scene

The RTVoice SALSA Example folder contains an example scene that demonstrates an RT Voice Actor component on a SALSA actor.

Sequencer Commands

RTVoiceWait()

Syntax: RTVoiceWait( [subject] )

Description: Waits for RT-Voice to finish playing on a subject. You normally don't need to include this sequencer command in your sequences because the RT Voice Actor component will add it automatically when playing a conversation or bark line. However, you can add it manually to allow another sequencer command to wait until RT-Voice is done playing, as shown in the example below.

Parameters:

subject: The name of the RT-Voice actor. Default: speaker.

Example:

RTVoiceWait()->Message(Done); Camera(Closeup,listener)@Message(Done)

How to Save RT-Voice Audio Files

If you want to generate and save audio files at design time, instead of allowing RT-Voice to generate audio at runtime, you can use the Save Audio utility. Select menu item Tools → Pixel Crushers → Dialogue System → Third Party Support → RT-Voice → Save Audio Files....

Specify a dialogue database and entrytag format. (If the open scene has a Dialogue Manager, the utility will grab this info from it.) Then click Save Files... and select a Resources folder in your project. This will generate audio files named using the entrytag format you specified. Depending on the speed of the audio generation, you may need to reimport the folder to see the files.

You can then use this sequence to play the audio:

AudioWait(entrytag)

Since you'll be playing pre-generated audio files and not asking RT-Voice to generate them at runtime, remove the RT Voice Actor component from your characters.

How to Specify Voices for Actors

You can specify voices for each actor by adding any of the custom actor fields below:

Actor Field	Type	Description
VoiceName	Text	An available voice name as reported by RT-Voice. Can also add localized versions such as "VoiceName es" for Spanish
Gender	Text	"Male" or "Female
MinAge	Number	Minimum voice age to use. If MinAge & MaxAge are zero, any age is acceptable
MaxAge	Number	Maximum voice age to use. If MinAge & MaxAge are zero, any age is acceptable

For an example, see the Actors tab in the example scene's database.

<< Third Party Integration

Table of Contents