Package: ipyaudioworklet
ipyaudioworkletA Jupyter Widget for Web Audio Recording using Audio WorkletThis extension will be enable us to record PCM audio using AudioWorkletNode of Web Audio API.
For the security constraints of major web-browsers, you need to run JupyterLab with HTTPS context.InstallationYou can install usingpip:Prebuildpipinstall-Uipyaudioworkletor, you may find some prebuilt packages in GitHub releases. Eg.pipinstall-Uhttps://github.com/naoh16/ipyaudioworklet/releases/download/v0.1.3/ipyaudioworklet-0.1.3-py3-none-any.whlSelf-build from master branchpipinstallgit+https://github.com/naoh16/ipyaudioworklet.gitUsagequickstartYou can see the interface as following cell:importipyaudioworkletasipyaudioipyaudio.AudioRecorder()Then you can find three buttons in the widget.Boot RECORDERAs first, you need to push the button to boot up the recorder.Please allow your web browser access to your PC's microphone.RecordYou can record audio.StopYou can stop the recording.audio control (HTML5's<audio>)You can preview the recroded sound.You may download the sound as WAV file through option menu of the control. (depend on your web browser)ExamplesSee examples:examples/introduction.ipynbYou can try them on Binder:For developers and Audio/Sound reserchers!!Please check the following files. They are the core modules of this extension.JupyterLab/ipywidgets interfacesrc/widgets.ts... Frontend of the widgetipyaudioworklet/audio.py... Backend of the widgetAudio Recordingsrc/audio.ts... Utility functions using Web Audio APIsrc/_static/audio-processor.js... AudioWorkletNode definition. This node is ping pong the recording audio fragments to the callback function defined inaudio.ts.TODO: The following lines are not modified from cookie-cutter templates.MiscsIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:jupyternbextensionenable--py[--sys-prefix|--user|--system]ipyaudioworkletDevelopment InstallationCreate a dev environment:condacreate-nipyaudioworklet-dev-cconda-forgenodejsyarnpythonjupyterlab
condaactivateipyaudioworklet-devInstall the python. This will also build the TS package.pipinstall-e".[test, examples]"When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:jupyter labextension develop --overwrite .
yarn run buildFor classic notebook, you need to run:jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyaudioworklet
jupyter nbextension enable --sys-prefix --py ipyaudioworkletNote that the--symlinkflag doesn't work on Windows, so you will here have to run
theinstallcommand every time that you rebuild your extension. For certain installations
you might also need another flag instead of--sys-prefix, but we won't cover the meaning
of those flags here.How to see your changesTypescript:If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.# Watch the source directory in one terminal, automatically rebuilding when neededyarnrunwatch# Run JupyterLab in another terminaljupyterlabAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.Python:If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.Updating the versionTo update the version, install tbump and use it to bump the version.
By default it will also create a tag.pipinstalltbump
tbump<new-version>