PixelCrushers.DialogueSystem.RTVoiceActor Class Reference

Inheritance diagram for PixelCrushers.DialogueSystem.RTVoiceActor:

Collaboration diagram for PixelCrushers.DialogueSystem.RTVoiceActor:

Classes
class	VoicePreference

Public Types
enum	Gender { Gender.Female, Gender.Male }
enum	VoiceState { VoiceState.Silent, VoiceState.Starting, VoiceState.Speaking }

Public Member Functions
virtual void	Awake ()
virtual void	Start ()
virtual void	OnEnable ()
virtual void	OnDisable ()
void	OnConversationLine (Subtitle subtitle)
	When a conversation line is spoken, speak it through RT-Voice. More...
void	OnBarkLine (Subtitle subtitle)
	When a bark line is spoken, speak it through RT-Voice. More...
void	SpeakSubtitle (Subtitle subtitle, bool wait)
virtual void	Speak (string text)
	Speak the specified text using RT-Voice. More...
Voice	GetVoice ()
	Gets the system's closest match voice to the preferred voice for the current language. More...

Public Attributes
VoicePreference[]	voicePreferences = new VoicePreference[0]
	The voice preferences to try to match. More...
bool	waitForVoiceInConversations = true
	In conversations, make the dialogue entry wait until RT-Voice is done playing. More...
VoiceState	voiceState = VoiceState.Silent

Protected Member Functions
virtual void	RegisterRTVoiceCallbacks ()
virtual void	UnregisterRTVoiceCallbacks ()
virtual void	OnSpeakStart (Crosstales.RTVoice.Model.Wrapper wrapper)
virtual void	OnSpeakComplete (Crosstales.RTVoice.Model.Wrapper wrapper)
bool	MatchesVoicePreference (Voice voice, VoicePreference voicePreference)

Protected Attributes
AudioSource	m_audioSource = null
bool	m_started = false

Member Enumeration Documentation

Gender

enum PixelCrushers.DialogueSystem.RTVoiceActor.Gender

strong

Enumerator
Female
Male

VoiceState

enum PixelCrushers.DialogueSystem.RTVoiceActor.VoiceState

strong

Enumerator
Silent
Starting
Speaking

Member Function Documentation

Awake()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.Awake ( )

virtual

GetVoice()

Voice PixelCrushers.DialogueSystem.RTVoiceActor.GetVoice

(

)

Gets the system's closest match voice to the preferred voice for the current language.

Returns

The voice.

MatchesVoicePreference()

bool PixelCrushers.DialogueSystem.RTVoiceActor.MatchesVoicePreference ( Voice  voice, VoicePreference  voicePreference  )

protected

OnBarkLine()

void PixelCrushers.DialogueSystem.RTVoiceActor.OnBarkLine

(

Subtitle

subtitle

)

When a bark line is spoken, speak it through RT-Voice.

Parameters

subtitle

Subtitle.

OnConversationLine()

void PixelCrushers.DialogueSystem.RTVoiceActor.OnConversationLine

(

Subtitle

subtitle

)

When a conversation line is spoken, speak it through RT-Voice.

Parameters

subtitle

Subtitle.

OnDisable()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.OnDisable ( )

virtual

OnEnable()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.OnEnable ( )

virtual

OnSpeakComplete()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.OnSpeakComplete ( Crosstales.RTVoice.Model.Wrapper  wrapper )

protectedvirtual

OnSpeakStart()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.OnSpeakStart ( Crosstales.RTVoice.Model.Wrapper  wrapper )

protectedvirtual

RegisterRTVoiceCallbacks()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.RegisterRTVoiceCallbacks ( )

protectedvirtual

Speak()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.Speak ( string  text )

virtual

Speak the specified text using RT-Voice.

You can override this if you need to do anything extra.

Parameters

text

Text.

SpeakSubtitle()

void PixelCrushers.DialogueSystem.RTVoiceActor.SpeakSubtitle	(	Subtitle	subtitle,
		bool	wait
	)

Start()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.Start ( )

virtual

UnregisterRTVoiceCallbacks()

virtual void PixelCrushers.DialogueSystem.RTVoiceActor.UnregisterRTVoiceCallbacks ( )

protectedvirtual

Member Data Documentation

m_audioSource

AudioSource PixelCrushers.DialogueSystem.RTVoiceActor.m_audioSource = null

protected

m_started

bool PixelCrushers.DialogueSystem.RTVoiceActor.m_started = false

protected

voicePreferences

VoicePreference [] PixelCrushers.DialogueSystem.RTVoiceActor.voicePreferences = new VoicePreference[0]

The voice preferences to try to match.

voiceState

VoiceState PixelCrushers.DialogueSystem.RTVoiceActor.voiceState = VoiceState.Silent

waitForVoiceInConversations

bool PixelCrushers.DialogueSystem.RTVoiceActor.waitForVoiceInConversations = true

In conversations, make the dialogue entry wait until RT-Voice is done playing.

---

The documentation for this class was generated from the following file:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/RT-Voice Integration/Assets/Dialogue System/Third Party Support/RTVoice/Scripts/RTVoiceActor.cs