Unity - Scripting API: Microphone.GetPosition
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Declaration
public static int GetPosition(string deviceName);
Parameters
| Parameter | Description |
|---|---|
| deviceName | The name of the device. |
Returns
int The current position in the recording buffer, in samples. To convert to seconds, divide by the clip's sample rate (frequency).
Description
Get the current recording position in samples.
If you pass a null or empty string for the device name then the default microphone will be used. You can get a list of available microphone devices from the devices property.
You can use this to control latency. For example, to achieve roughly 30 ms latency, poll GetPosition until the returned value advances by the number of samples that equal 30 ms at the clip's sample rate. Then start playing the audio.