Home | Trees | Indices | Help |
---|
|
object --+ | RoboComm
Provides all methods required to operate the SpeakEasy ROS node remotely. Intention is for GUIs or other programs to use one instance of this class to control all text-to-speech, sound effects, and music play functions if those functions are provided by a SpeakEasy ROS node. <p> For an exmple to use if these three functions are provided locally, without using ROS, see speakeasy_controller.py.
|
|||
ReplayDemon Abstract class of all repeat demons: text-to-speech, sound effects, and music. |
|||
SoundReplayDemon Responsible for repeating sound effects at appropriate intervals. |
|||
MusicReplayDemon Responsible for repeating songs at appropriate intervals. |
|||
SpeechReplayDemon Responsible for repeating text-to-speech utterances at appropriate intervals. |
|
|||
|
|||
bool |
|
||
SpeakEasyStatus |
|
||
[string] |
|
||
[bool] |
|
||
[string] |
|
||
[string] |
|
||
int |
|
||
float |
|
||
float |
|
||
PlayStatus |
|
||
bool |
|
||
bool |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
float |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
STATUS_MSG_TIMEOUT = 5
|
|||
PLAYHEAD_MSG_TIMEOUT = 0.5
|
|
|||
Inherited from |
|
Initialize sound to play at the robot. Initializes self.sound_file_names to a list of sound file names for use with play-sound calls to the Robot via ROS.
|
Return True if a SpeakEasy service is available, i.e. if a SpeakEasy ROS node is running. Else return False.
|
Return a SpeakEasy status message instance as received from a live SpeakEasy node. See msg.SpeakEasyStatus.msg for field details.
|
Return a list of the sound effects that the SpeakEasy node is offering. These effects may be invoked via the playSound() method.
|
Return a list of the music files that the SpeakEasy node is offering. These songs may be played via the playMusic() method.
|
Return array of text-to-speech engines that are available at the SpeakEasy node. Examples: Festival, the Linux open source engine, or Cepstral, the commercial engine.
|
Return a list of text-to-speech voices that the SpeakEasy node provides. If a particular text-to-speech engine is specified, only that engine's voices are returned, else all voices of all available engines are returned in one list.
|
Return the number of simultaneous sound effects that the SpeakEasy node provides. Note that SpeakEasy nodes can be configured to provide many sound effect channels, though this API does not provide such control. Default is eight.
|
Return default sound effect volume level. Note that sound volume can be set on a case-by-case basis in calls to playSound();
|
Return default music volume level. Note that music volume can be set on a case-by-case basis in calls to playMusic();
|
Return current music play state. These states are defined in music_player.py. For reference, at the time of this writing: class PlayStatus:
|
Convenience method to determine whether music is currently either playing or paused.
|
Return whether SpeakEasy node is currently generating speech from text.
|
Given a piece of text, generate corresponding speech at the SpeakEasy node site.
|
Stop text-to-speech utterance. No effect if text-to-speech is currently inactive. |
Play a sound effect at the SpeakEasy node.
|
Stop the all currently playing sound effects. Method has no effect if no sound is currently playing. |
Pause the all currently playing sound effects. Method has no effect if no sound is currently playing. |
Un-pause all currently paused sound effects. Method has no effect if no sound is currently paused. |
Change the sound effect default volume.
|
Play a piece of music (a sound file) at the SpeakEasy node.
|
Stop currently playing music. No effect if nothing playing. |
Pause currently playing music. No effect if nothing playing. |
Un-pause currently playing music. No effect if nothing paused or playing. |
Set default volume of music playback.
|
Change the music playhead position to a particular time within a song. Time may be specified absolute (i.e. relative to the start of the song), or relative to the current playhead. The playhead may be changed during playback, or while a song is paused.
|
Return song position in fractional seconds. Return None if no music is currently playing.
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Mon Nov 26 18:08:31 2012 | http://epydoc.sourceforge.net |