Table of Contents
voice-presentation-control is a tool that allows you to control your presentation using voice when you don't have a presentation pen or when it's inconvinient to use the keyboard.
pip install voice-presentation-control
See releases.
⚠️ If you encounter an error while installingPyAudio(which is in our dependencies):
- For Windows users, visit here to pick appropriate
.whlto install.- For OS X users, run
brew install portaudio, thenpip install pyaudio.- For Debian-derived Linux distributions (like Ubuntu and Mint) users, run
sudo apt-get install libasound-dev libportaudio2 libportaudiocpp0 portaudio19-dev && pip install pyaudio.
Just open your terminal, simply type vpc start and boom, it works!
To check the default configuration of actions, see actions.json.
To edit actions.json, use vpc config.
In actions.json, the left-hand side is the sentence that triggers the action, and the right-hand side is the keyboard action to be triggered.
For more actions you can configure, head over to pyautogui.
vpc [OPTIONS] COMMAND
| Option | Description |
|---|---|
-v, --verbose |
Show the detailed log of voice-presentation-control. |
--version |
Show the version of voice-presentation-control. |
--help |
Show help and exit. |
| Command | Description |
|---|---|
config |
Edit the config file. |
mic |
Check the settings for the microphone input. |
start |
Start vpc. |
vpc mic [OPTIONS] COMMAND
| Option | Description |
|---|---|
--help |
Show help and exit. |
| Command | Description |
|---|---|
list |
List all audio input devices. You can check the device index you want to use by using this command. |
test |
Test audio environment. Talk and determine the volume threshold by using this command. |
vpc mic test [OPTIONS]
| Option | Description |
|---|---|
-i, --input-device-index |
Set input device index. Check your devices by vpc mic list. [default: 1] |
-c, --chunk |
Set record chunk. [default: 4096] |
-r, --rate |
Set input stream rate. [default: 44100] |
--help |
Show help and exit. |
vpc start [OPTIONS]
| Option | Description |
|---|---|
-i, --input-device-index |
Set input device index. Check your devices by vpc mic list. [default: 1] |
-v, --vol-threshold |
Set volume threshold. Test your environment by vpc mic test. [default: 1000] |
-z, --zcr-threshold |
Set zcr threshold. [default: 0.075] |
-c, --chunk |
Set record chunk. [default: 4096] |
-r, --rate |
Set input stream rate. [default: 44100] |
-s, --max-record-seconds |
Set max record seconds if your custom command is long. [default: 2] |
-l, --language [en, zh] |
Set language to recognize. [default: en] |
--strict |
Use this option for strict mode. |
--help |
Show help and exit. |
- Add more tests.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/amazing-feature) - Commit your Changes with Conventional Commits
- Push to the Branch (
git push origin feat/amazing-feature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
- HSING-HAN, WU (Xyphuz)
- Mail me: xyphuzwu@gmail.com
- About me: https://about.xyphuz.com
- GitHub: https://github.com/wst24365888