Create streamlit-audiorecorder_An_audio_Recorder_for_streamlit.txt

streamlit-audiorecorder_An_audio_Recorder_for_streamlit.txt

@@ -0,0 +1,57 @@
+streamlit-audiorecorder_An_audio_Recorder_for_streamlit.txt
+
+streamlit-audiorecorder
+An audio Recorder for streamlit
+Description
+Audio recorder component for streamlit.
+It creates a button to start the recording and takes three arguments: the start button text, the stop button text, and the pause button text.
+If the pause button text is not specified, the pause button is not displayed.
+
+Parameters
+The signature of the component is:
+
+audiorecorder(start_prompt="Start recording", stop_prompt="Stop recording", pause_prompt="", key=None):
+The prompt parameters are self-explanatory, and the optionnal key parameter is used internally by streamlit to properly distinguish multiple audiorecorders on the page.
+
+Return value
+The component's return value is a pydub AudioSegment.
+All AudioSegment methods are available, in particular you can:
+
+Play the audio in the frontend with st.audio(audio.export().read())
+Save the audio to a file with audio.export("audio.wav", format="wav")
+Installation:
+pip install streamlit-audiorecorder
+Note: This package uses ffmpeg, so it should be installed for this audiorecorder to work properly.
+
+On ubuntu/debian: sudo apt update && sudo apt install ffmpeg
+On mac: brew install ffmpeg
+
+Usage:
+import streamlit as st
+from audiorecorder import audiorecorder
+
+st.title("Audio Recorder")
+audio = audiorecorder("Click to record", "Click to stop recording")
+
+if len(audio) > 0:
+    # To play audio in frontend:
+    st.audio(audio.export().read())  
+
+    # To save audio to a file, use pydub export method:
+    audio.export("audio.wav", format="wav")
+
+    # To get audio properties, use pydub AudioSegment properties:
+    st.write(f"Frame rate: {audio.frame_rate}, Frame width: {audio.frame_width}, Duration: {audio.duration_seconds} seconds")
+Troubleshooting:
+Error: No record button is shown and you get the following error message in the console:
+
+Component Error
+Cannot read properties of undefined (reading 'getUserMedia')
+Reason: To record the audio, this component is using the MediaDevices interface.
+For security reasons, the getUserMedia() method is available only in secure contexts (HTTPS), as explained in the MDM documentation :
+
+As an API that may involve significant privacy concerns, getUserMedia()'s specification lays out a wide array of privacy and security requirements that browsers are obligated to meet.
+
+getUserMedia() is a powerful feature that can only be used in secure contexts; in insecure contexts, navigator.mediaDevices is undefined, preventing access to getUserMedia(). A secure context is, in short, a page loaded using HTTPS or the file:/// URL scheme, or a page loaded from localhost.
+
+Solution: Serve your website using HTTPS. If you are serving your website locally, make sure to access it using localhost, not an IP address.