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

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 GetDeviceCaps(deviceName: string, minFreq: int, maxFreq: int): void;
public static void GetDeviceCaps(string deviceName, int minFreq, int maxFreq);
public static def GetDeviceCaps(deviceName as string, minFreq as int, maxFreq as int) as void

Parameters

deviceName The name of the device.
minFreq Returns the minimum sampling frequency of the device.
maxFreq Returns the maximum sampling frequency of the device.

Description

Get the frequency capabilities of a device.

Passing null or an empty string for the device name will select the default device. You can use the devices property to get a list of all available microphones.

When a value of zero is returned in the minFreq and maxFreq parameters, this indicates that the device supports any frequency.