https://github.com/stefanrmmr/streamlit-audio-recorder

Record Audio from the User's Microphone in Apps that are Deployed to the Web. (via Browser Media-API, REACT-based, Streamlit Custom Component)
https://github.com/stefanrmmr/streamlit-audio-recorder

audio audio-recorder custom-component react-audio-recorder streamlit streamlit-application streamlit-audio-recorder streamlit-component streamlit-components streamlit-custom-component streamlit-webapp

Last synced: 7 days ago
JSON representation

Record Audio from the User's Microphone in Apps that are Deployed to the Web. (via Browser Media-API, REACT-based, Streamlit Custom Component)

• Host: GitHub
• URL: https://github.com/stefanrmmr/streamlit-audio-recorder
• Owner: stefanrmmr
• License: mit
• Created: 2022-05-04T12:56:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-11T17:41:11.000Z (about 1 year ago)
• Last Synced: 2024-09-24T13:33:52.168Z (9 days ago)
• Topics: audio, audio-recorder, custom-component, react-audio-recorder, streamlit, streamlit-application, streamlit-audio-recorder, streamlit-component, streamlit-components, streamlit-custom-component, streamlit-webapp
• Language: TypeScript
• Homepage:
• Size: 54.4 MB
• Stars: 423
• Watchers: 1
• Forks: 75
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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/), 


based on [doppelgunner](https://github.com/doppelgunner/audio-react-recorder/) 's [Audio-React-Recorder](https://www.npmjs.com/package/audio-react-recorder/) 


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


## 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**


## 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! 


Pls consider leaving a `star` ☆ with this repository to show your support.