PvRecorder 1.1.1

PV_Recorder

A cross platform audio recorder that captures single-channel audio at a sample rate of 16kHz.

Requirements

• .NET Standard 2.0, .NET Core 3.1, .NET 6.0

Compatibility

• Windows (amd64)
• macOS (x86_64, arm64)
• Linux (x86_64)
• Raspberry Pi:
  • 2
  • 3 (32 and 64 bit)
  • 4 (32 and 64 bit)
• NVIDIA Jetson Nano
• BeagleBone

Installation

dotnet add package PvRecorder

Usage

Getting the list of input devices does not require an instance:

using Pv;

string[] devices = PvRecorder.GetAudioDevices();

To start recording initialize the instance and run start:

PvRecorder recorder = PvRecorder.Create(
    deviceIndex: -1, // uses default index
    frameLength: 512,
);

recorder.Start();

Get the pcm frames by calling the read function:

while (true) {
    pcm = recorder.Read();
    // do something with pcm
}

To stop recording just run stop on the instance:

recorder.Stop();

Once you are done, free the used resources. You do not have to call stop before Dispose:

recorder.Dispose();

To have to resources freed immediately after use without explicitly calling the Dispose function, wrap PvRecorder in a using statement:

using(PvRecorder recorder = PvRecorder.Create(deviceIndex: -1, frameLength: 512)) {
    // PvRecorder usage
}

Demo

NOTE: The demo is built on .Net Core 3.1.

For more detailed information on how to use the pv_recorder .NET sdk, please that a look at Demo/Demo.cs.

In the following instructions we will refer to {AUDIO_DEVICE_INDEX} as the index of the audio device to use, and {RAW_OUTPUT_PATH} as the path to save the raw audio data

{AUDIO_DEVICE_INDEX} defaults to -1 and {RAW_OUTPUT_PATH} can be empty if you wish to not save any data.

To build the demo:

dotnet build -c Release

To show the available audio devices run:

dotnet run --project Demo -c Release -- --show_audio_devices

To run audio recorder run:

dotnet run --project Demo -c Release
-- --audio_device_index {AUDIO_DEVICE_INDEX} --raw_output_path {RAW_OUTPUT_PATH}