Classes | |
class | Sound |
Class that publishes messages to the sound_play node. More... | |
class | SoundClient |
This class is a helper class for communicating with the sound_play node via the sound_play::SoundRequest message. More... | |
Functions | |
def | builtinSound |
Create a builtin Sound. | |
def | play |
Play the Sound. | |
def | play |
Play a buildin sound. | |
def | playWave |
Plays a WAV or OGG file. | |
def | repeat |
Play the Sound repeatedly. | |
def | repeat |
Say a string repeatedly. | |
def | say |
Say a string. | |
def | sendMsg |
def | start |
Play a buildin sound repeatedly. | |
def | startWave |
Plays a WAV or OGG file repeatedly. | |
def | stop |
Stop Sound playback. | |
def | stop |
Stop playing a built-in sound. | |
def | stopAll |
Stop all currently playing sounds. | |
def | stopSaying |
Stop saying a string. | |
def | stopWave |
Stop playing a WAV or OGG file. | |
def | voiceSound |
Create a voice Sound. | |
def | waveSound |
Create a wave Sound. |
def sound_play.libsoundplay.builtinSound | ( | self, | |
id | |||
) |
Create a builtin Sound.
Creates a Sound corresponding to indicated builtin wave.
id | Identifier of the sound to play. |
Definition at line 117 of file libsoundplay.py.
def sound_play.libsoundplay.play | ( | self | ) |
Play the Sound.
This method causes the Sound to be played once.
Definition at line 64 of file libsoundplay.py.
def sound_play.libsoundplay.play | ( | self, | |
sound | |||
) |
Play a buildin sound.
Starts playing one of the built-in sounds. built-ing sounds are documented in SoundRequest::msg. Playback can be stopped by stopall.
sound | Identifier of the sound to play. |
Definition at line 196 of file libsoundplay.py.
def sound_play.libsoundplay.playWave | ( | self, | |
sound | |||
) |
Plays a WAV or OGG file.
Plays a WAV or OGG file once. The playback can be stopped by stopWave or stopAll.
sound | Filename of the WAV or OGG file. Must be an absolute path valid on the computer on which the sound_play node is running |
Definition at line 157 of file libsoundplay.py.
def sound_play.libsoundplay.repeat | ( | self | ) |
Play the Sound repeatedly.
This method causes the Sound to be played repeatedly until stop() is called.
Definition at line 72 of file libsoundplay.py.
def sound_play.libsoundplay.repeat | ( | self, | |
text | |||
) |
Say a string repeatedly.
The string is said repeatedly until stopSaying or stopAll is used.
text | String to say repeatedly |
Definition at line 136 of file libsoundplay.py.
def sound_play.libsoundplay.say | ( | self, | |
text, | |||
voice = '' |
|||
) |
Say a string.
Send a string to be said by the sound_node. The vocalization can be stopped using stopSaying or stopAll.
text | String to say |
Definition at line 127 of file libsoundplay.py.
def sound_play.libsoundplay.sendMsg | ( | self, | |
snd, | |||
cmd, | |||
s, | |||
arg2 = "" |
|||
) |
Definition at line 225 of file libsoundplay.py.
def sound_play.libsoundplay.start | ( | self, | |
sound | |||
) |
Play a buildin sound repeatedly.
Starts playing one of the built-in sounds repeatedly until stop or stopall is used. Built-in sounds are documented in SoundRequest::msg.
sound | Identifier of the sound to play. |
Definition at line 206 of file libsoundplay.py.
def sound_play.libsoundplay.startWave | ( | self, | |
sound | |||
) |
Plays a WAV or OGG file repeatedly.
Plays a WAV or OGG file repeatedly until stopWave or stopAll is used.
sound | Filename of the WAV or OGG file. Must be an absolute path valid on the computer on which the sound_play node is running. |
Definition at line 170 of file libsoundplay.py.
def sound_play.libsoundplay.stop | ( | self | ) |
Stop Sound playback.
This method causes the Sound to stop playing.
Definition at line 79 of file libsoundplay.py.
def sound_play.libsoundplay.stop | ( | self, | |
sound | |||
) |
Stop playing a built-in sound.
Stops playing a built-in sound started with play or start.
sound | Same sound that was used to start playback |
Definition at line 215 of file libsoundplay.py.
def sound_play.libsoundplay.stopAll | ( | self | ) |
Stop all currently playing sounds.
This method stops all speech, wave file, and built-in sound playback.
Definition at line 222 of file libsoundplay.py.
def sound_play.libsoundplay.stopSaying | ( | self, | |
text | |||
) |
Stop saying a string.
Stops saying a string that was previously started by say or repeat. The argument indicates which string to stop saying.
text | Same string as in the say or repeat command |
Definition at line 146 of file libsoundplay.py.
def sound_play.libsoundplay.stopWave | ( | self, | |
sound | |||
) |
Stop playing a WAV or OGG file.
Stops playing a file that was previously started by playWave or startWave.
sound | Same string as in the playWave or startWave command |
Definition at line 183 of file libsoundplay.py.
def sound_play.libsoundplay.voiceSound | ( | self, | |
s | |||
) |
Create a voice Sound.
Creates a Sound corresponding to saying the indicated text.
s | Text to say |
Definition at line 96 of file libsoundplay.py.
def sound_play.libsoundplay.waveSound | ( | self, | |
sound | |||
) |
Create a wave Sound.
Creates a Sound corresponding to indicated file.
s | File to play. Should be an absolute path that exists on the machine running the sound_play node. |
Definition at line 105 of file libsoundplay.py.