Introduction¶
Advanced synthio voices
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.
Installing from PyPI¶
Note
This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install circuitpython-synthvoice
To install system-wide (this may be required in some cases):
sudo pip3 install circuitpython-synthvoice
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-synthvoice
Installing to a Connected CircuitPython Device with Circup¶
Make sure that you have circup
installed in your Python environment.
Install it with the following command if necessary:
pip3 install circup
With circup
installed and your CircuitPython device connected use the
following command to install:
circup install synthvoice
Or the following command to update an existing version:
circup update
Usage Example¶
import audiopwmio
import board
import synthio
import time
from synthvoice.oscillator import Oscillator
audio = audiopwmio.PWMAudioOut(board.A0)
synth = synthio.Synthesizer()
audio.play(synth)
voice = Oscillator(synth)
voice.press(60)
time.sleep(1.0)
voice.release()
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
Examples
API Reference
synthvoice
AREnvelope
LerpBlockInput
Voice
Oscillator
Oscillator.amplitude
Oscillator.attack_level
Oscillator.attack_time
Oscillator.bend
Oscillator.bend_range
Oscillator.blocks
Oscillator.coarse_tune
Oscillator.decay_time
Oscillator.filter_amount
Oscillator.filter_attack_time
Oscillator.filter_delay
Oscillator.filter_depth
Oscillator.filter_rate
Oscillator.filter_release_time
Oscillator.fine_tune
Oscillator.frequency
Oscillator.glide
Oscillator.notes
Oscillator.pan
Oscillator.pan_delay
Oscillator.pan_depth
Oscillator.pan_rate
Oscillator.pitch_slew
Oscillator.pitch_slew_time
Oscillator.press()
Oscillator.release()
Oscillator.release_time
Oscillator.sustain_level
Oscillator.tremolo_delay
Oscillator.tremolo_depth
Oscillator.tremolo_rate
Oscillator.vibrato_delay
Oscillator.vibrato_depth
Oscillator.vibrato_rate
Oscillator.waveform
Oscillator.waveform_loop
Sample
fft()
fftfreq()
normalize()
ClosedHat
Cymbal
FloorTom
HighTom
Kick
MidTom
OpenHat
Ride
Snare
Tom
Voice