README.md

Microphone

Provides a simple interface for configuring and utilizing a microphone in Python.

This package has been tested using Python 3.7, using conda 4.7.5, on both Mac and Windows 10.

Installing pyaudio (required dependency)

conda install pyaudio

Installing this package

Once you have installed the dependencies, clone this repository, navigate to it, and run

pip install -e .

It is important that you use this develop install option, as the microphone configuration requires that this package is installed in-place.

Configuring Your Microphone

Now we will configure microphone to use the appropriate microphone on your computer. Navigate to Microphone/microphone and run:

python configure_input.py

and follow the selection prompt. This will save your microphone preference for future use. The resulting configuration file will be saved to Microphone/microphone/config.ini. The contents of the file will look something like this

[input device]
name = Desktop Microphone (RØDE NT-USB)
index = 1

You can edit this file to change the recording settings (e.g. the sampling rate) used to sampled audio from your microphone.

Testing Your Microphone

Navigate to Microphone and run:

python test_input.py

This should record and play back a brief audio clip using the microphone selected during configuration.

Recording Audio

from microphone import record_audio

# Record 10 seconds of audio
byte_encoded_signal, sampling_rate = record_audio(10)

Playing Audio

from microphone import play_audio

# Play 10 seconds of audio
play_audio(byte_encoded_signal, 10)