Explore Usages »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
   • Try It
3. Actions
4. Usages
5. Roadmap
6. Contributing
7. License
8. Contact

About The Project

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.

(back to top)

Getting Started

Installation

Using pip

pip install voice-presentation-control

Using .whl

See releases.

⚠️ If you encounter an error while installing PyAudio (which is in our dependencies):

• For Windows users, visit here to pick appropriate .whl to install.
• For OS X users, run brew install portaudio, then pip 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.

Try It

Just open your terminal, simply type vpc start and boom, it works!

Actions

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.

Usages

Usage of vpc

vpc [OPTIONS] COMMAND

Options

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.

Commands

Command	Description
config	Edit the config file.
mic	Check the settings for the microphone input.
start	Start vpc.

Usage of vpc mic

vpc mic [OPTIONS] COMMAND

Options

Option	Description
--help	Show help and exit.

Commands

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.

Usage of vpc mic test

vpc mic test [OPTIONS]

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.

Usage of vpc start

vpc start [OPTIONS]

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.

(back to top)

Roadmap

• Add more tests.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/amazing-feature)
3. Commit your Changes with Conventional Commits
4. Push to the Branch (git push origin feat/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Author

• HSING-HAN, WU (Xyphuz)
  • Mail me: xyphuzwu@gmail.com
  • About me: https://about.xyphuz.com
  • GitHub: https://github.com/wst24365888

Project Link

• https://github.com/wst24365888/voice-presentation-control

(back to top)