Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Start(string, bool, int, int)

Start Recording with device.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AudioModule
public static AudioClip Start(string deviceName, bool loop, int lengthSec, int frequency)

Parameters

deviceName

string
The name of the device.

loop

bool
Indicates whether the recording should continue recording if lengthSec is reached, and wrap around and record from the beginning of the AudioClip.

lengthSec

int
Is the length of the AudioClip produced by the recording.

frequency

int
The sample rate of the AudioClip produced by the recording. Use _outputSampleRate so the recording matches the project's output sample rate.

Returns

Type

Description

AudioClipThe function returns null if the recording fails to start.

Remarks

If you pass a null or empty string for the device name then the default microphone is used. You can get a list of available microphone devices from the _devices property and the range of sample rates supported by a microphone from the Microphone.GetDeviceCaps property.

Examples

using UnityEngine;public class Example : MonoBehaviour{    // Start recording with built-in Microphone and play the recorded audio right away    void Start()    {        AudioSource audioSource = GetComponent<AudioSource>();        audioSource.clip = Microphone.Start("Built-in Microphone", true, 10, AudioSettings.outputSampleRate);        audioSource.Play();    }}