# Cobra Voice Activity Detection Engine
Made in Vancouver, Canada by [Picovoice](https://picovoice.ai)
Cobra is a highly accurate and lightweight voice activity detection (VAD) engine.
## Compatibility
- Python 3.7+
- Runs on Linux (x86_64), macOS (x86_64), Windows (x86_64), Raspberry Pi, NVIDIA Jetson (Nano), and BeagleBone.
## Installation
```console
pip3 install pvcobra
```
## AccessKey
Cobra requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Cobra SDKs.
You can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.
Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.
## Usage
Create an instance of the engine
```python
import pvcobra
handle = pvcobra.create(access_key=${AccessKey})
```
Replace `${AccessKey}` with your AccessKey obtained from [Picovoice Console](https://console.picovoice.ai/). `handle` is
an instance of Cobra.
When initialized, the valid sample rate is given by `handle.sample_rate`. Expected frame length (number of audio samples
in an input array) is `handle.frame_length`. The engine accepts 16-bit linearly-encoded PCM and operates on
single-channel audio.
```python
def get_next_audio_frame():
pass
while True:
voice_probability = handle.process(get_next_audio_frame())
```
When done, resources have to be released explicitly:
```python
handle.delete()
```
## Demos
[pvcobrademo](https://pypi.org/project/pvcobrademo/) provides command-line utilities for processing real-time
audio (i.e. microphone) and files using Cobra.
Raw data
{
"_id": null,
"home_page": "https://github.com/Picovoice/cobra",
"name": "pvcobra",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "voice activity detection engine,VAD",
"author": "Picovoice",
"author_email": "hello@picovoice.ai",
"download_url": "https://files.pythonhosted.org/packages/45/4f/0f2efd90b21a473c4ead262655ce2108f11d9ec8f28ee069af1f1940b0af/pvcobra-2.0.2.tar.gz",
"platform": null,
"description": "# Cobra Voice Activity Detection Engine\n\nMade in Vancouver, Canada by [Picovoice](https://picovoice.ai)\n\nCobra is a highly accurate and lightweight voice activity detection (VAD) engine.\n\n## Compatibility\n\n- Python 3.7+\n- Runs on Linux (x86_64), macOS (x86_64), Windows (x86_64), Raspberry Pi, NVIDIA Jetson (Nano), and BeagleBone.\n\n## Installation\n\n```console\npip3 install pvcobra\n```\n\n## AccessKey\n\nCobra requires a valid Picovoice `AccessKey` at initialization. `AccessKey` acts as your credentials when using Cobra SDKs.\nYou can get your `AccessKey` for free. Make sure to keep your `AccessKey` secret.\nSignup or Login to [Picovoice Console](https://console.picovoice.ai/) to get your `AccessKey`.\n\n## Usage\n\nCreate an instance of the engine\n\n```python\nimport pvcobra\n\nhandle = pvcobra.create(access_key=${AccessKey})\n```\nReplace `${AccessKey}` with your AccessKey obtained from [Picovoice Console](https://console.picovoice.ai/). `handle` is\nan instance of Cobra.\n\nWhen initialized, the valid sample rate is given by `handle.sample_rate`. Expected frame length (number of audio samples\nin an input array) is `handle.frame_length`. The engine accepts 16-bit linearly-encoded PCM and operates on\nsingle-channel audio.\n\n```python\ndef get_next_audio_frame():\n pass\n\nwhile True:\n voice_probability = handle.process(get_next_audio_frame())\n```\n\nWhen done, resources have to be released explicitly:\n\n```python\nhandle.delete()\n```\n\n## Demos\n\n[pvcobrademo](https://pypi.org/project/pvcobrademo/) provides command-line utilities for processing real-time\naudio (i.e. microphone) and files using Cobra.\n",
"bugtrack_url": null,
"license": "",
"summary": "Cobra voice activity detection (VAD) engine",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/Picovoice/cobra"
},
"split_keywords": [
"voice activity detection engine",
"vad"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78ce632f3587e4a813b1f99f622f45dcc0dda0470d20bcc274b4c5fece569071",
"md5": "96bb0d9cc9f4dbdf9b8115ec9bb86ef7",
"sha256": "b585b5adfbf5e762d60a66165de718c62affe2b243f71ca2138ef7798e7e044c"
},
"downloads": -1,
"filename": "pvcobra-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96bb0d9cc9f4dbdf9b8115ec9bb86ef7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2207387,
"upload_time": "2024-01-30T23:32:16",
"upload_time_iso_8601": "2024-01-30T23:32:16.430800Z",
"url": "https://files.pythonhosted.org/packages/78/ce/632f3587e4a813b1f99f622f45dcc0dda0470d20bcc274b4c5fece569071/pvcobra-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "454f0f2efd90b21a473c4ead262655ce2108f11d9ec8f28ee069af1f1940b0af",
"md5": "a7d53f045a48ff5c6c29e2d244a5bc38",
"sha256": "ed80b0b9b58eb6873500f00826c6685a417e164e23adf9b5805c716a1a0721c1"
},
"downloads": -1,
"filename": "pvcobra-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "a7d53f045a48ff5c6c29e2d244a5bc38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2213549,
"upload_time": "2024-01-30T23:32:18",
"upload_time_iso_8601": "2024-01-30T23:32:18.995174Z",
"url": "https://files.pythonhosted.org/packages/45/4f/0f2efd90b21a473c4ead262655ce2108f11d9ec8f28ee069af1f1940b0af/pvcobra-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 23:32:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Picovoice",
"github_project": "cobra",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pvcobra"
}
JSON
