Libraries.Sound.Speech

The speech class does effectively the same thing as the say command in Quorum, except that it provides for more advanced functionality. Specifically, by using the speech class, you can change the volume, pitch, speed, and other properties of the current text-to-speech engine. You can also issue blocking calls, that prevent the program from taking other action until the speaking is complete.

Example Code

use Libraries.Sound.Speech
class Main
   action Main
      //Gain access to the speech object
      Speech speech

      //Get the current volume
      number volume = speech:GetVolume()
      number speed = speech:GetSpeed()
      number pitch = speech:GetPitch()

      //issue a blocking speech call
      speech:Say("Hello, world!", true)
   end
end

Determines whether or not the currently loaded text-to-speech engine can issue a speech blocking call.

Example Code

Speech speech
    boolean block = speech:CanBlock()

Determines whether or not the currently loaded text-to-speech engine can issue a speech pause call.

Example Code

Speech speech
    boolean pause = speech:CanPause()

Determines whether or not the currently loaded text-to-speech engine can issue a speech resume call. This only matters if the speech engine is currently paused.

Example Code

Speech speech
    boolean resume = speech:CanResume()

Determines whether or not the currently loaded text-to-speech engine can have its speed changed.

Example Code

Speech speech
    boolean speed = speech:CanSetSpeed()

Determines whether or not the currently loaded text-to-speech engine can have its voice changed.

Example Code

Speech speech
    boolean voice = speech:CanSetVoice()

Determines whether or not the currently loaded text-to-speech engine can have its volume changed.

Example Code

Speech speech
    boolean volume = speech:CanSetVolume()

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Sets the current pitch of the text-to-speech engine. The legal values are from 0.0, lowest pitch, to 1.0 maximum pitch.

Example Code

Speech speech
    number pitch = speech:GetPitch()

Sets the current speed of the text-to-speech engine. The legal values are from 0.0, lowest speed, to 1.0 maximum speed. Each speech engine implementation calculates speed slightly different, but this speech engine should sound approximately equal across implementations.

Example Code

Speech speech
    number speed = speech:GetSpeed()

Sets the current volume of the text-to-speech engine. The legal values are from 0.0, no volume, to 1.0 maximum volume.

Example Code

Speech speech
    number volume = speech:GetVolume()

Instructs the system to speak a particular phrase through the current text-to-speech engine.

Example Code

Speech speech
    speech:Say("Hello, World!")

Instructs the system to speak a particular phrase through the current text-to-speech engine.

Example Code

Speech speech
    speech:Say("Hello, World!")

Sets the current pitch of the text-to-speech engine. The legal values are from 0.0, lowest pitch, to 1.0 maximum pitch.

Example Code

Speech speech
    speech:SetPitch(1.0)

Sets the current speed of the text-to-speech engine. The legal values are from 0.0, slowest speed, to 1.0 maximum speed. Each speech engine implementation calculates speed slightly different, but this speech engine should sound approximately equal across implementations.

Example Code

Speech speech
    speech:SetSpeed(1.0)

Sets the current volume of the text-to-speech engine. The legal values are from 0.0, no volume, to 1.0 maximum volume.

Example Code

Speech speech
    speech:SetVolume(1.0)