Audio Recording
Go Quick Start

Platforms

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

Requirements

• Go 1.16+
• Windows only: a gcc compiler like Mingw in $PATH

Quick Start

Setup

1. Download and install Go language.

2. Install the Porcupine Go Package using the Go CLI:

go get github.com/Picovoice/pvrecorder/binding/go

Usage

Initialize and begin recording:

import . "github.com/Picovoice/pvrecorder/sdk/go"

recorder = NewPvRecorder(512)
recorder.Init()
if err != nil {
    // handle init error
}
defer recorder.Delete()

err = recorder.Start()
if err != nil {
    // handle start error
}

Read a frame of audio:

for {
    frame, err := recorder.Read()
    if err != nil {
        // handle error
    }
    // do something with frame
}

To stop recording:

recorder.Stop()

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

recorder.Delete()

Selecting an Audio Device

To get a list of available audio devices:

devices = GetAvailableDevices() // select index of device

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

frameLength := 512
recorder := NewPvRecorder(frameLength)
recorder.DeviceIndex = 0
recorder.Init()
if err != nil {
    // handle init error
}
defer recorder.Delete()

Demo

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

Setup

Clone the Porcupine GitHub Repository:

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

Usage

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

cd pvrecorder/demo/go
go run demo.go -h

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

go run demo.go --show_audio_devices

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

go run demo.go --audio_device_index ${DEVICE_INDEX} --output_wav_path ${OUTPUT_WAV_PATH}

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

Resources