Streamlit Audio Recorder 技术文档

Streamlit Audio Recorder 技术文档

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://gitcode.com/gh_mirrors/st/streamlit-audio-recorder

安装指南

1. 安装依赖

要使用 Streamlit Audio Recorder，首先需要安装该组件。你可以通过 pip 命令来安装：

pip install streamlit-audiorec

2. 导入组件

在你的 Streamlit 应用脚本中，导入 st_audiorec 组件：

from st_audiorec import st_audiorec

项目的使用说明

1. 初始化音频录制器

在你的 Streamlit 应用中，添加一个音频录制器的实例：

wav_audio_data = st_audiorec()

2. 处理录制的音频数据

如果用户录制了音频数据，你可以通过以下代码来处理和播放录制的音频：

if wav_audio_data is not None:
    st.audio(wav_audio_data, format='audio/wav')

3. 运行应用

确保你的 Streamlit 应用已经正确配置并运行。你可以通过以下命令启动应用：

streamlit run your_app_script.py

项目API使用文档

st_audiorec()

• 功能: 初始化并返回一个音频录制器组件。
• 返回值: 如果用户录制了音频，返回录制的音频数据（arrayBuffer 格式）；否则返回 None。

st.audio()

• 功能: 播放音频数据。
• 参数:
  • data: 音频数据（arrayBuffer 格式）。
  • format: 音频格式（例如 'audio/wav'）。

项目安装方式

1. 通过 PyPI 安装

你可以通过 pip 命令从 PyPI 安装 Streamlit Audio Recorder：

pip install streamlit-audiorec

2. 手动安装

如果你需要手动安装，可以从 GitHub 仓库下载源码并进行安装：

git clone https://github.com/stefanrmmr/streamlit-audio-recorder.git
cd streamlit-audio-recorder
pip install .

通过以上步骤，你可以成功安装并使用 Streamlit Audio Recorder 组件，轻松地在你的 Streamlit 应用中实现音频录制功能。

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://gitcode.com/gh_mirrors/st/streamlit-audio-recorder