Audio Recording
.NET Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• Raspberry Pi (3, 4, 5)

Requirements

.NET Framework 4.6.1+ / .NET Standard 2.0+ / .NET Core 3.0+:

• Windows (x86_64)

.NET Standard 2.0+ / .NET Core 3.0+:

• Linux (x86_64)
• macOS (x86_64)

.NET Core 3.0+:

• Raspberry Pi (3, 4, 5)

.NET 6.0+:

• macOS (arm64)

Quick Start

Setup

1. Install .NET.

2. Install the PvRecorder NuGet package in Visual Studio or using the .NET CLI:

dotnet add package PvRecorder

Usage

Initialize and begin recording:

using Pv;

PvRecorder recorder = PvRecorder.Create(frameLength: 512);
recorder.Start();

Read a frame of audio:

while (true) {
    short[] frame = recorder.Read();
    // do something with audio frame
}

To stop recording:

recorder.Stop();

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

recorder.Dispose();

To have resources freed immediately after use without explicitly calling Dispose(), wrap PvRecorder in a using statement:

using (PvRecorder recorder = PvRecorder.Create(frameLength: 512)) {
    // PvRecorder usage
}

Selecting an Audio Device

To print a list of available audio devices:

string[] devices = PvRecorder.GetAvailableDevices();

The index of the device in the returned list can be used in Create() to select that device for audio capture:

PvRecorder recorder = PvRecorder.Create(
    frameLength: 512,
    deviceIndex: 2);

Demo

For the PvRecorder .NET SDK, we offer a demo application that demonstrates how use PvRecorder to record audio to an output audio file.

Setup

1. Clone the repository:

git clone --recurse-submodules https://github.com/Picovoice/pvrecorder.git

2. Build the project:

cd pvrecorder/demo/dotnet
dotnet build

Usage

To show the available audio devices run:

dotnet run -- --show_audio_devices

To run the demo, give it a file to record audio to:

dotnet run -- --output_wav_path ${OUTPUT_WAV_FILE}

You can also select the audio device index to use for recording (use --show_audio_devices to see options):

dotnet run -- --output_wav_path ${OUTPUT_WAV_FILE} --audio_device_index ${DEVICE_INDEX}

For more information about our PvRecorder demo, head over to our GitHub repository.

Resources