Audio Recording
Rust Quick Start

Platforms

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

Requirements

• Rust 1.54+
• Cargo

Quick Start

Setup

1. Download and install Rust.

2. Add pv_recorder to the Cargo.toml manifest:

[dependencies]
pv_recorder = "*"

Usage

Initialize and begin recording:

use pv_recorder::PvRecorderBuilder

let frame_length = 512;
let recorder = PvRecorderBuilder::new(frame_length).init()?;
recorder.start()?;

Read a frame of audio:

while recorder.is_recording() {
    let frame = recorder.read()?;
    // process audio frame
}

To stop recording:

recorder.stop()

Selecting an Audio Device

To get a list of available audio devices:

let audio_devices = PvRecorderBuilder::default().get_audio_devices()?;

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

let recorder = PvRecorderBuilder::new(frame_length).device_index(2).init()?;

Demo

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

Setup

Clone the PvRecorder GitHub Repository:

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

Usage

Use the --help flag to see the usage options for the demo:

cd pvrecorder/demo/rust
cargo run --release -- --help

Run the following to see what devices are available for audio capture:

cargo run --release -- --show_audio_devices

Run the demo with the desired audio device (or -1 for the default one) and an output file path:

cargo run --release -- --audio_device_index ${DEVICE_INDEX} --output_wav_path ${OUTPUT_WAV_PATH}

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

Resources