Voice Processor
Unity API

API Reference for the Voice Processor Unity SDK.

VoiceProcessorFrameListener

delegate void VoiceProcessorFrameListener(short[] frame);

Listener type that can be added to VoiceProcessor with .addFrameListener(). Captures audio frames that are generated by the recording thread.

VoiceProcessor

class VoiceProcessor { }

Class for capturing audio and delivering audio data.

VoiceProcessor.Instance

public static VoiceProcessor Instance

Gets the singleton instance of VoiceProcessor.

VoiceProcessor.CurrentDeviceIndex

public int CurrentDeviceIndex

The index of the currently selected audio recording device.

VoiceProcessor.CurrentDeviceName

public string CurrentDeviceName

The name of the currently selected audio recording device.

VoiceProcessor.Devices

public List<string> Devices

A list of available audio recording devices on the current system.

VoiceProcessor.FrameLength

public int FrameLength

Gets the number of samples per frame that the VoiceProcessor will deliver.

VoiceProcessor.SampleRate

public int SampleRate

Gets the audio sample rate that the VoiceProcessor will record with.

VoiceProcessor.IsRecording

public bool IsRecording

Gets whether the VoiceProcessor is capturing audio or not.

VoiceProcessor.NumFrameListeners

public int NumFrameListeners

Gets number of registered VoiceProcessorFrameListeners.

VoiceProcessor.AddFrameListener()

public void AddFrameListener(VoiceProcessorFrameListener listener)

Add a frame listener that will receive audio frames generated by the VoiceProcessor.

Parameters

• listener VoiceProcessorFrameListener : Listener for processing frames of audio.

VoiceProcessor.AddFrameListeners()

public void AddFrameListeners(VoiceProcessorFrameListener[] listener)

Add multiple frame listeners that will receive audio frames generated by the VoiceProcessor.

Parameters

• listeners VoiceProcessorFrameListener[] : Listeners for processing frames of audio.

VoiceProcessor.RemoveFrameListener()

public void RemoveFrameListener(VoiceProcessorFrameListener listener)

Remove a frame listener from the VoiceProcessor. It will no longer receive audio frames.

Parameters

• listener VoiceProcessorFrameListener : Listener to remove.

VoiceProcessor.RemoveFrameListeners()

public void RemoveFrameListeners(VoiceProcessorFrameListener[] listener)

Remove frame listeners from the VoiceProcessor. They will no longer receive audio frames.

Parameters

• listeners VoiceProcessorFrameListener[] : Listeners to remove.

VoiceProcessor.ClearFrameListeners()

public void ClearFrameListeners()

Clears all registered frame listeners.

VoiceProcessor.StartRecording()

public void StartRecording(int frameLength, int sampleRate)

Starts audio recording with the specified audio properties.

Parameters

• frameLength int : The length of each audio frame, in number of samples.
• sampleRate int : The sample rate to record audio at, in Hz.

Throws

• VoiceProcessorException : if an error is encountered while trying to start the recorder.

VoiceProcessor.StopRecording()

public void StopRecording()

Stops audio recording and releases audio resources.

VoiceProcessor.UpdateDevices()

public void UpdateDevices()

Updates list of available audio devices.

Throws

• VoiceProcessorException : if an error is encountered while trying to update devices.

VoiceProcessor.ChangeDevice()

public void ChangeDevice(int deviceIndex)

Change the active audio recording device.

Parameters

• deviceIndex int : Index of the new audio capture device.

Throws

• VoiceProcessorException : if an error is encountered while trying to change device.

VoiceProcessorException

public class VoiceProcessorException : Exception

Exception thrown if an error occurs within the VoiceProcessor.

Exceptions:

public class VoiceProcessorArgumentException : VoiceProcessorException { }
public class VoiceProcessorStateException    : VoiceProcessorException { }