Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Microphone.GetPosition

Suggest a change

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function GetPosition(deviceName: string): int;
public static int GetPosition(string deviceName);
public static def GetPosition(deviceName as string) as int

Parameters

deviceName The name of the device.

Description

Get the position in samples of the recording.

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. If you want a 30ms latency, poll getRecordPosition() until 30ms (in samples) has gone and then start the audio.