Class Sound

ev3dev2.sound.Sound

Support beep, play wav files, or convert text to speech.

Declaration

class Sound(object)

Documentation

Examples:

from ev3dev2.sound import Sound

spkr = Sound()

# Play 'bark.wav':
spkr.play_file('bark.wav')

# Introduce yourself:
spkr.speak('Hello, I am Robot')

# Play a small song
spkr.play_song((
    ('D4', 'e3'),
    ('D4', 'e3'),
    ('D4', 'e3'),
    ('G4', 'h'),
    ('D5', 'h')
))

In order to mimic EV3-G API parameters, durations used in methods exposed as EV3-G blocks for sound related operations are expressed as a float number of seconds.

Methods

▶ def beep(self, args='', play_type=PLAY_WAIT_FOR_COMPLETE)
Call beep command with the provided arguments (if any). See `beep man page`_ and google `linux beep music`_ for inspiration.
source link
Parameters
- args : string
  Any additional arguments to be passed to beep (see the `beep man page`_ for details)
  Docutils System Messages
  System Message: ERROR/3 (<string>, line 1); backlink
  Unknown target name: "beep man page".
- play_type : None
  The behavior of beep once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
▶ def get_volume(self, channel=None)
Gets the current sound volume by parsing the output of
source link
amixer get <channel>. If the channel is not specified, it tries to determine the default one by running amixer scontrols. If that fails as well, it uses the Playback channel, as that is the only channel on the EV3.
▶ def play_file(self, wav_file, volume=100, play_type=PLAY_WAIT_FOR_COMPLETE)
Play a sound file (wav format) at a given volume.
source link
Parameters
- wav_file : string
  The sound file path
- volume : int
  The play volume, in percent of maximum volume
- play_type : None
  The behavior of play_file once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
▶ def play_note(self, note, duration, volume=100, play_type=PLAY_WAIT_FOR_COMPLETE)
Plays a note, given by its name as defined in ``_NOTE_FREQUENCIES``.
source link
Parameters
- note : string
  The note symbol with its octave number
- duration : float
  Tone duration, in seconds
- volume : int
  The play volume, in percent of maximum volume
- play_type : None
  The behavior of play_note once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the PID of the underlying beep command; None otherwise
Raises
- ValueError
  is invalid parameter (note, duration,...)
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the PID of the underlying beep command; None otherwise
▶ def play_song(self, song, tempo=120, delay=0.05)
Plays a song provided as a list of tuples containing the note name and its value using music conventional notation instead of numerical values for frequency and duration.
source link
It supports symbolic notes (e.g. A4, D#3, Gb5) and durations (e.g. q, h). You can also specify rests by using R instead of note pitch.
For an exhaustive list of accepted note symbols and values, have a look at the _NOTE_FREQUENCIES and _NOTE_VALUES private dictionaries in the source code.
The value can be suffixed by modifiers:
a divider introduced by a / to obtain triplets for instance (e.g. q/3 for a triplet of eight note)
a multiplier introduced by * (e.g. *1.5 is a dotted note).
Shortcuts exist for common modifiers:
3 produces a triplet member note. For instance e3 gives a triplet of eight notes, i.e. 3 eight notes in the duration of a single quarter. You must ensure that 3 triplets notes are defined in sequence to match the count, otherwise the result will not be the expected one.
. produces a dotted note, i.e. which duration is one and a half the base one. Double dots are not currently supported.
Example:
>>> # A long time ago in a galaxy far, >>> # far away... >>> from ev3dev2.sound import Sound >>> spkr = Sound() >>> spkr.play_song(( >>> ('D4', 'e3'), # intro anacrouse >>> ('D4', 'e3'), >>> ('D4', 'e3'), >>> ('G4', 'h'), # meas 1 >>> ('D5', 'h'), >>> ('C5', 'e3'), # meas 2 >>> ('B4', 'e3'), >>> ('A4', 'e3'), >>> ('G5', 'h'), >>> ('D5', 'q'), >>> ('C5', 'e3'), # meas 3 >>> ('B4', 'e3'), >>> ('A4', 'e3'), >>> ('G5', 'h'), >>> ('D5', 'q'), >>> ('C5', 'e3'), # meas 4 >>> ('B4', 'e3'), >>> ('C5', 'e3'), >>> ('A4', 'h.'), >>> ))
Important
Only 4/4 signature songs are supported with respect to note durations.
Parameters
- song : iterable[tuple(string,string)]
  the song
- tempo : int
  the song tempo, given in quarters per minute
- delay : float
  delay between notes (in seconds)
Returns
- None
  When python3 is used the spawn subprocess from subprocess.Popen is returned; None otherwise
Raises
- ValueError
  if invalid note in song or invalid play parameters
Return
When python3 is used the spawn subprocess from subprocess.Popen is returned; None otherwise
▶ def play_tone(self, frequency, duration, delay=0.0, volume=100, ...)
Play a single tone, specified by its frequency, duration, volume and final delay.
def play_tone(
self,
frequency,
duration,
delay=0.0,
volume=100,
play_type=PLAY_WAIT_FOR_COMPLETE,
)
source link
Parameters
- frequency : int
  the tone frequency, in Hertz
- duration : float
  Tone duration, in seconds
- delay : float
  Delay after tone, in seconds (can be useful when chaining calls to play_tone)
- volume : int
  The play volume, in percent of maximum volume
- play_type : None
  The behavior of play_tone once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the PID of the underlying beep command; None otherwise
Raises
- ValueError
  if invalid parameter
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the PID of the underlying beep command; None otherwise
▶ def set_volume(self, pct, channel=None)
Sets the sound volume to the given percentage [0-100] by calling
source link
amixer -q set <channel> <pct>%. If the channel is not specified, it tries to determine the default one by running amixer scontrols. If that fails as well, it uses the Playback channel, as that is the only channel on the EV3.
▶ def speak(self, text, espeak_opts='-a 200 -s 130', volume=100, ...)
Speak the given text aloud.
def speak(
self,
text,
espeak_opts='-a 200 -s 130',
volume=100,
play_type=PLAY_WAIT_FOR_COMPLETE,
)
source link
Uses the espeak external command.
Parameters
- text : string
  The text to speak
- espeak_opts : string
  espeak command options (advanced usage)
- volume : int
  The play volume, in percent of maximum volume
- play_type : None
  The behavior of speak once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
▶ def tone(self, *args, play_type=PLAY_WAIT_FOR_COMPLETE)
.. rubric:: tone(tone_sequence)
source link
Play tone sequence.
Here is a cheerful example:
my_sound = Sound() my_sound.tone([ (392, 350, 100), (392, 350, 100), (392, 350, 100), (311.1, 250, 100), (466.2, 25, 100), (392, 350, 100), (311.1, 250, 100), (466.2, 25, 100), (392, 700, 100), (587.32, 350, 100), (587.32, 350, 100), (587.32, 350, 100), (622.26, 250, 100), (466.2, 25, 100), (369.99, 350, 100), (311.1, 250, 100), (466.2, 25, 100), (392, 700, 100), (784, 350, 100), (392, 250, 100), (392, 25, 100), (784, 350, 100), (739.98, 250, 100), (698.46, 25, 100), (659.26, 25, 100), (622.26, 25, 100), (659.26, 50, 400), (415.3, 25, 200), (554.36, 350, 100), (523.25, 250, 100), (493.88, 25, 100), (466.16, 25, 100), (440, 25, 100), (466.16, 50, 400), (311.13, 25, 200), (369.99, 350, 100), (311.13, 250, 100), (392, 25, 100), (466.16, 350, 100), (392, 250, 100), (466.16, 25, 100), (587.32, 700, 100), (784, 350, 100), (392, 250, 100), (392, 25, 100), (784, 350, 100), (739.98, 250, 100), (698.46, 25, 100), (659.26, 25, 100), (622.26, 25, 100), (659.26, 50, 400), (415.3, 25, 200), (554.36, 350, 100), (523.25, 250, 100), (493.88, 25, 100), (466.16, 25, 100), (440, 25, 100), (466.16, 50, 400), (311.13, 25, 200), (392, 350, 100), (311.13, 250, 100), (466.16, 25, 100), (392.00, 300, 150), (311.13, 250, 100), (466.16, 25, 100), (392, 700) ])
Have also a look at :py:meth:`play_song` for a more musician-friendly way of doing, which uses the conventional notation for notes and durations.
System Message: ERROR/3 (<string>, line 27); backlink
Unknown interpreted text role "py:meth".
Parameters
- tone_sequence : list[tuple(float,float,float)]
  The sequence of tones to play. The first number of each tuple is frequency in Hz, the second is duration in milliseconds, and the third is delay in milliseconds between this and the next tone in the sequence.
- play_type : None
  The behavior of tone once playback has been initiated
- frequency : float
  The frequency of the tone in Hz
- duration : float
  The duration of the tone in milliseconds
- play_type : None
  The behavior of tone once playback has been initiated
Returns
- None
  When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
  tone(frequency, duration)
  Play single tone of given frequency and duration.
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise
tone(frequency, duration)
Play single tone of given frequency and duration.
Return
When python3 is used and Sound.PLAY_NO_WAIT_FOR_COMPLETE is specified, returns the spawn subprocess from subprocess.Popen; None otherwise

Reexports

Imported in ev3dev2.control.GyroBalancer.

ev3dev2

Class Sound

Declaration

Documentation

Methods

Parameters

Docutils System Messages

Returns

Return

Parameters

Returns

Return

Parameters

Returns

Raises

Return

Parameters

Returns

Raises

Return

Parameters

Returns

Raises

Return

Parameters

Returns

Return

Parameters

Returns

Return

Return

Reexports