| org.gtk.gespeaker | 
        
          | Prev | gespeaker dbus interfaces | Next | 
      
    
    
    
    
      Interface /org/gtk/gespeaker/voice
      Manage the espeak and mbrola voices.
     
    
   
  
  
    
    org.gtk.gespeaker.voice.get_delay
    int org.gtk.gespeaker.voice.get_delay()
    
      
        | Returns: | An integer for the current voice delay | 
    
    The 
get_delay method returns the voice delay between words. 
  
 
  
    
    org.gtk.gespeaker.voice.get_pitch
    int org.gtk.gespeaker.voice.get_pitch()
    
      
        | Returns: | An integer for the current pitch | 
    
    The 
get_pitch method returns the voice pitch. 
  
 
  
    
    org.gtk.gespeaker.voice.get_speed
    int org.gtk.gespeaker.voice.get_speed()
    
      
        | Returns: | An integer for the current voice speed | 
    
    The 
get_speed method returns the voice speed. 
  
 
  
    
    org.gtk.gespeaker.voice.get_voice
    int org.gtk.gespeaker.voice.get_voice()
    
      
        | Returns: | An integer for the index of the currently selected voice | 
    
    The 
get_voice method returns an index for the currently selected voice.
  
 
  
    
    org.gtk.gespeaker.voice.get_voice_is_mbrola
    bool org.gtk.gespeaker.voice.get_voice_is_mbrola(int index)
    
      
        | index: | The index of the voice to check | 
      
        | Returns: | True if the voice is a mbrola voice, False if the voice is not mbrola or is not a valid voice index. | 
    
    The 
get_voice_is_mbrola method check if the requested voice is a mbrola voice. 
  
 
  
    
    org.gtk.gespeaker.voice.get_voice_name
    QString org.gtk.gespeaker.voice.get_voice_name(int index)
    
      
        | index: | The index of the voice to check | 
      
        | Returns: | A string for the voice name | 
    
    The 
get_voice_name method return the name of the requested voice. 
  
 
  
    
    org.gtk.gespeaker.voice.get_voice_short
    QString org.gtk.gespeaker.voice.get_voice_short(int index)
    
      
        | index: | The index of the voice to check | 
      
        | Returns: | A string for the voice short name | 
    
    The 
get_voice_short method return the short name of the requested voice. 
  
 
  
    
    org.gtk.gespeaker.voice.get_voice_type
    QString org.gtk.gespeaker.voice.get_voice_type()
    
      
        | Returns: | A string as following: disabled for mbrola voices which doesn't support type, male for non-mbrola male voice, female for non-mbrola female voice | 
    
    The 
get_voice_type method return the type of the selected voice. 
  
 
  
    
    org.gtk.gespeaker.voice.get_voices_count
    int org.gtk.gespeaker.voice.get_voices_count()
    
      
        | Returns: | The number of the available voices | 
    
    The 
get_voices_count method returns the number of the available voices. 
  
 
  
    
    org.gtk.gespeaker.voice.get_volume
    int org.gtk.gespeaker.voice.get_volume()
    
      
        | Returns: | An integer for the current volume | 
    
    The 
get_volume method returns the current volume. 
  
 
  
    
    org.gtk.gespeaker.voice.list_all_voices
    QStringList org.gtk.gespeaker.voice.list_all_voices()
    
      
        | Returns: | A string list with all the available voices | 
    
    The 
list_all_voices method returns the list with all the available voice names. 
  
 
  
    
    org.gtk.gespeaker.voice.list_mbrola_voices
    QStringList org.gtk.gespeaker.voice.list_mbrola_voices()
    
      
        | Returns: | A string list with all the available mbrola voices | 
    
    The 
list_mbrola_voices method returns the list with all the available mbrola voice names. 
  
 
  
    
    org.gtk.gespeaker.voice.set_delay
    bool org.gtk.gespeaker.voice.set_delay(int delay)
    
      
        | delay: | The new delay to assign | 
      
        | Returns: | True if the delay was assigned or False if it wasn't assigned | 
    
    The 
set_delay method assign the new value for delay between words. Valid values are between 0 and 100. 
  
 
  
    
    org.gtk.gespeaker.voice.set_pitch
    bool org.gtk.gespeaker.voice.set_pitch(int pitch)
    
      
        | pitch: | The new pitch to assign | 
      
        | Returns: | True if the pitch was assigned or False if it wasn't assigned | 
    
    The 
set_pitch method assign the new value for voice pitch. Valid values are between 0 and 99. 
  
 
  
    
    org.gtk.gespeaker.voice.set_speed
    bool org.gtk.gespeaker.voice.set_speed(int speed)
    
      
        | speed: | The new delay to assign | 
      
        | Returns: | True if the delay was assigned or False if it wasn't assigned | 
    
    The 
set_speed method assign the new value for voice speed. Valid values are between 80 and 390. 
  
 
  
    
    org.gtk.gespeaker.voice.set_voice
    bool org.gtk.gespeaker.voice.set_voice(int voice)
    
      
        | voice: | Index of the new voice to choose | 
      
        | Returns: | True if the voice was chosen or False if it wasn't chosen | 
    
    The 
set_voice method changes the active voice using a voice index. Valid values are between 0 and the value returned by 
org.gtk.gespeaker.voice.get_voices_count() method. 
  
 
  
    
    org.gtk.gespeaker.voice.set_voice_by_name
    bool org.gtk.gespeaker.voice.set_voice_by_name(QString voice)
    
      
        | voice: | A string with the name of the new voice to choose | 
      
        | Returns: | True if the voice was chosen or False if it wasn't chosen | 
    
    The 
set_voice_by_name method changes the active voice using a voice name. 
  
 
  
    
    org.gtk.gespeaker.voice.set_voice_type
    bool org.gtk.gespeaker.voice.set_voice_type(QString voice_type)
    
      
        | voice_type: | A string with the voice type: it must be male or female | 
      
        | Returns: | True if the voice type was chosen or False if it wasn't chosen | 
    
    The 
set_voice_type method changes the voice type for the active non-mbrola voice. 
  
 
  
    
    org.gtk.gespeaker.voice.set_volume
    bool org.gtk.gespeaker.voice.set_volume(int volume)
    
      
        | volume: | The new volume to assign | 
      
        | Returns: | True if the volume was assigned or False if it wasn't assigned | 
    
    The 
set_volume method assign the new value for volume. Valid values are between 0 and 200.