Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 4.77 KB

README.md

File metadata and controls

100 lines (71 loc) · 4.77 KB

Version License Contributions Welcome All Contributors Code of Conduct

VuMeterGG

readme_cover

VuMeterGG is a Qt Designer widget developed with PySide6. It captures audio from the microphone and displays it through a graphical representation. It includes many parameters to customize how the graphical representation of the sound is displayed and to calibrate it.

Installation

You can use VuMeterGG, directly with PySide6 in your Python project, or you can integrate it into your graphical interface by promoting custom widgets from Qt Designer.

QT Designer

  1. Place the vu_meter_gg.py file in your project. In the demo, it is located in demo/view/qt_ui/promoted/vu_meter_gg.py.
  2. From QT Designer, insert a QWidget.
  3. Promote the QWidget to VuMeterGG:
    • Insert VUMeterGG in the name field.
    • Use the file path without its extension in the header file field. In the demo, it is view/qt_ui/promoted/vu_meter_gg.

Directly

Create an instance of VUMeterGG and place it in your layout.

To configure the vu meter call the methods through the name you gave to the widget or modify the attributes directly from the vu_meter_gg.py file

Config

To configure the vu meter, call the methods through the name you gave to the widget or modify the attributes directly in the vu_meter_gg.py file.

Documentation

A manual for version v0.1.0-beta is available in Spanish. You can download it here.

Requirements

  • PyAudio
  • PySide6
  • PySide6-Addons
  • PySide6-Essentials
  • shiboken6

Contributors ✨

Thanks go to these wonderful people (emoji key):

David García González
David García González
🚧 💻		 José Valentino
José Valentino
🤔		 Sarish Chavan
Sarish Chavan
📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

How to contribute

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch
  3. Make your changes and commit them
  4. Push to the branch.
  5. Open a pull request.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Thank you for your contributions!

Please read the CONTRIBUTING.md file for details on how to contribute to this project.

Code of Conduct

Please read the CODE_OF_CONDUCT.md file for more details on our code of conduct.

Third-Party Licenses

For more details, see the THIRD_PARTY_LICENSES.md file.

License

VuMeterGG is distributed under the GNU Lesser General Public License v3.0 only.

For more details, see the LICENSE.md file.