streamlit-audiorec


Namestreamlit-audiorec JSON
Version 0.1.3 PyPI version JSON
download
home_pagehttps://github.com/stefanrmmr/streamlit-audio-recorder
SummaryRecord audio from the user's microphone in apps that are deployed to the web. (via Browser Media-API) [GitHub ☆ 160+: steamlit-audio-recorder]
upload_time2023-09-11 17:42:11
maintainer
docs_urlNone
authorStefan Rummer
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Streamlit Audio Recorder

[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://audiorecorder.streamlit.app/)
[![Generic badge](https://img.shields.io/badge/PyPI-pip_install_streamlit--audiorec-black.svg)](https://pypi.org/project/streamlit-audiorec/)
[![Generic badge](https://img.shields.io/badge/Package-v0.1.3-blue.svg)](https://pypi.org/project/streamlit-audiorec/)
[![GitHub license](https://img.shields.io/badge/Licence-MIT-gr.svg)](https://github.com/stefanrmmr/streamlit-audio-recorder/blob/main/LICENCE)


Custom component, implemented by [Stefan Rummer](https://www.linkedin.com/in/stefanrmmr/), <br/>
based on [doppelgunner](https://github.com/doppelgunner/audio-react-recorder/) 's [Audio-React-Recorder](https://www.npmjs.com/package/audio-react-recorder/) <br/>


![Screenshot 2022-05-16 at 16 58 36](https://user-images.githubusercontent.com/82606558/168626886-de128ffa-a3fe-422f-a748-395c29fa42f9.png) <br/>

## Features & Specs
- Manage access to the user's microphone via the **browser's Media-API**
- Record, playback and revert audio-recordings in apps **deployed to the web**
- Download the final recording to your local system! - **WAV, 16 bit, 44.1 kHz**
- Directly return audio recording-data to Python backend! - **arrayBuffer format**<br>

## Setup & How to Use
**1.** PIP Install the component (download from PyPI)
```
pip install streamlit-audiorec
```
**2.** Import and Initialize the component (at the top of your script)
```python
from st_audiorec import st_audiorec
```
**3.** Add an Instance of the audio recorder to your streamlit app's code.
```python 
wav_audio_data = st_audiorec()

if wav_audio_data is not None:
    st.audio(wav_audio_data, format='audio/wav')
```
**4. Enjoy recording audio inside your streamlit app! 🎈**

Feel free to reach out to me in case you have any questions! <br>
Pls consider leaving a `star` ☆ with this repository to show your support.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stefanrmmr/streamlit-audio-recorder",
    "name": "streamlit-audiorec",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Stefan Rummer",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/7b/ad/6bb8db00e816d52a804c451f86784b3606f25561f9921829d549499b4eb1/streamlit-audiorec-0.1.3.tar.gz",
    "platform": null,
    "description": "# Streamlit Audio Recorder\n\n[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://audiorecorder.streamlit.app/)\n[![Generic badge](https://img.shields.io/badge/PyPI-pip_install_streamlit--audiorec-black.svg)](https://pypi.org/project/streamlit-audiorec/)\n[![Generic badge](https://img.shields.io/badge/Package-v0.1.3-blue.svg)](https://pypi.org/project/streamlit-audiorec/)\n[![GitHub license](https://img.shields.io/badge/Licence-MIT-gr.svg)](https://github.com/stefanrmmr/streamlit-audio-recorder/blob/main/LICENCE)\n\n\nCustom component, implemented by [Stefan Rummer](https://www.linkedin.com/in/stefanrmmr/), <br/>\nbased on [doppelgunner](https://github.com/doppelgunner/audio-react-recorder/) 's [Audio-React-Recorder](https://www.npmjs.com/package/audio-react-recorder/) <br/>\n\n\n![Screenshot 2022-05-16 at 16 58 36](https://user-images.githubusercontent.com/82606558/168626886-de128ffa-a3fe-422f-a748-395c29fa42f9.png) <br/>\n\n## Features & Specs\n- Manage access to the user's microphone via the **browser's Media-API**\n- Record, playback and revert audio-recordings in apps **deployed to the web**\n- Download the final recording to your local system! - **WAV, 16 bit, 44.1 kHz**\n- Directly return audio recording-data to Python backend! - **arrayBuffer format**<br>\n\n## Setup & How to Use\n**1.** PIP Install the component (download from PyPI)\n```\npip install streamlit-audiorec\n```\n**2.** Import and Initialize the component (at the top of your script)\n```python\nfrom st_audiorec import st_audiorec\n```\n**3.** Add an Instance of the audio recorder to your streamlit app's code.\n```python \nwav_audio_data = st_audiorec()\n\nif wav_audio_data is not None:\n    st.audio(wav_audio_data, format='audio/wav')\n```\n**4. Enjoy recording audio inside your streamlit app! \ud83c\udf88**\n\nFeel free to reach out to me in case you have any questions! <br>\nPls consider leaving a `star` \u2606 with this repository to show your support.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Record audio from the user's microphone in apps that are deployed to the web. (via Browser Media-API) [GitHub \u2606 160+: steamlit-audio-recorder]",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/stefanrmmr/streamlit-audio-recorder"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d4bb3a0f70283264ed42587b5cc23189ccd3ef0ed94c0cf18fe204f6b7b4d36f",
                "md5": "7635f7c754ce29fcee2b2c942e4de27d",
                "sha256": "ade3e880ed072733e129438f06c40516304598c7439ecbf8406dbdcd6bd4ac66"
            },
            "downloads": -1,
            "filename": "streamlit_audiorec-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7635f7c754ce29fcee2b2c942e4de27d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 872814,
            "upload_time": "2023-09-11T17:42:08",
            "upload_time_iso_8601": "2023-09-11T17:42:08.730902Z",
            "url": "https://files.pythonhosted.org/packages/d4/bb/3a0f70283264ed42587b5cc23189ccd3ef0ed94c0cf18fe204f6b7b4d36f/streamlit_audiorec-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7bad6bb8db00e816d52a804c451f86784b3606f25561f9921829d549499b4eb1",
                "md5": "5121f9d7cbcf08ec0eb01fb76030f3bf",
                "sha256": "0d1bf9490a7cd2c90529262f309a59fa566f0b2e83eecf03f26e5c42d241eb51"
            },
            "downloads": -1,
            "filename": "streamlit-audiorec-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "5121f9d7cbcf08ec0eb01fb76030f3bf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3362,
            "upload_time": "2023-09-11T17:42:11",
            "upload_time_iso_8601": "2023-09-11T17:42:11.148899Z",
            "url": "https://files.pythonhosted.org/packages/7b/ad/6bb8db00e816d52a804c451f86784b3606f25561f9921829d549499b4eb1/streamlit-audiorec-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-11 17:42:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stefanrmmr",
    "github_project": "streamlit-audio-recorder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "streamlit-audiorec"
}
Stefan Rummer
Elapsed time: 0.29599s