# PvRecorder Binding for Python
## PvRecorder
PvRecorder is an easy-to-use, cross-platform audio recorder designed for real-time speech audio processing. It allows developers access to an audio device's input stream, broken up into data frames of a given size.
## Compatibility
- Python 3.5+
- Runs on Linux (x86_64), macOS (x86_64 and arm64), Windows (x86_64), Raspberry Pi (all variants), NVIDIA Jetson (Nano), and BeagleBone.
## Installation
pip3 install pvrecorder
## Usage
Initialize and begin recording:
```python
from pvrecorder import PvRecorder
recorder = PvRecorder(frame_length=512)
recorder.start()
```
(or)
Use `get_available_devices()` to get a list of available devices and then initialize the instance based on the index of a device:
```python
from pvrecorder import PvRecorder
devices = PvRecorder.get_available_devices()
recorder = PvRecorder(frame_length=512, device_index=0)
recorder.start()
```
Read frames of audio:
```python
while recorder.is_recording:
frame = recorder.read()
# process audio frame
```
To stop recording, call `stop()` on the instance:
```python
recorder.stop()
```
Once you are done, free the resources acquired by PvRecorder. You do not have to call `stop()` before `delete()`:
```python
recorder.delete()
```
## Demos
[pvrecorderdemo](https://pypi.org/project/pvrecorderdemo/) provides command-line utilities for recording audio to a file.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/pvrecorder",
"name": "pvrecorder",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "Audio Recorder",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/88/7c/46ced00059e6153e0d815745f2b03b5bb8101fc58634bb754f56c93fe6b6/pvrecorder-1.2.2.tar.gz",
"platform": null,
"description": "# PvRecorder Binding for Python\n\n## PvRecorder\n\nPvRecorder is an easy-to-use, cross-platform audio recorder designed for real-time speech audio processing. It allows developers access to an audio device's input stream, broken up into data frames of a given size.\n\n## Compatibility\n\n- Python 3.5+\n- Runs on Linux (x86_64), macOS (x86_64 and arm64), Windows (x86_64), Raspberry Pi (all variants), NVIDIA Jetson (Nano), and BeagleBone.\n\n## Installation\n\npip3 install pvrecorder\n\n## Usage\n\nInitialize and begin recording:\n\n```python\nfrom pvrecorder import PvRecorder\n\nrecorder = PvRecorder(frame_length=512)\nrecorder.start()\n```\n\n(or)\n\nUse `get_available_devices()` to get a list of available devices and then initialize the instance based on the index of a device:\n\n```python\nfrom pvrecorder import PvRecorder\n\ndevices = PvRecorder.get_available_devices()\n\nrecorder = PvRecorder(frame_length=512, device_index=0)\nrecorder.start()\n```\n\nRead frames of audio:\n\n```python\nwhile recorder.is_recording:\n frame = recorder.read()\n # process audio frame\n```\n\nTo stop recording, call `stop()` on the instance:\n\n```python\nrecorder.stop()\n```\n\nOnce you are done, free the resources acquired by PvRecorder. You do not have to call `stop()` before `delete()`:\n\n```python\nrecorder.delete()\n```\n\n## Demos\n\n[pvrecorderdemo](https://pypi.org/project/pvrecorderdemo/) provides command-line utilities for recording audio to a file.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Recorder library for Picovoice.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/Picovoice/pvrecorder"
},
"split_keywords": [
"audio",
"recorder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cfd02931e67c64f719789b645e652f7d093d93f9fb62504922bcf365a8d0213c",
"md5": "af3ffd567db226e445ef9e9340c9a0c1",
"sha256": "6ac2fd7ddc74fadd097ef538a3556da1bb540d7f039a8e43dccfbf8c015a9bb1"
},
"downloads": -1,
"filename": "pvrecorder-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af3ffd567db226e445ef9e9340c9a0c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 4772767,
"upload_time": "2024-01-30T19:16:09",
"upload_time_iso_8601": "2024-01-30T19:16:09.517145Z",
"url": "https://files.pythonhosted.org/packages/cf/d0/2931e67c64f719789b645e652f7d093d93f9fb62504922bcf365a8d0213c/pvrecorder-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "887c46ced00059e6153e0d815745f2b03b5bb8101fc58634bb754f56c93fe6b6",
"md5": "6f45f48edfae85cc026652cc71351e9f",
"sha256": "11ee421fbf764d73f1503c6047f159ff46329bb7fa2f0ace7aa2eb423d8838ce"
},
"downloads": -1,
"filename": "pvrecorder-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "6f45f48edfae85cc026652cc71351e9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 4768714,
"upload_time": "2024-01-30T19:16:12",
"upload_time_iso_8601": "2024-01-30T19:16:12.260162Z",
"url": "https://files.pythonhosted.org/packages/88/7c/46ced00059e6153e0d815745f2b03b5bb8101fc58634bb754f56c93fe6b6/pvrecorder-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 19:16:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "pvrecorder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvrecorder"
}
JSON
