Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetPosition(string)

Get the current recording position in samples.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AudioModule
public static int GetPosition(string deviceName)

Parameters

deviceName

The name of the device.

Returns

Type

Description

intThe current position in the recording buffer, in samples. To convert to seconds, divide by the clip's sample rate (frequency).

Remarks

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 Microphone.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.