API reference
API reference
Select your platform
No SDKs available
No versions available

Mic Class

Extends MonoBehaviour, Meta.WitAi.Lib.BaseAudioClipInput, ILogSource
Implements Meta.WitAi.Interfaces.IAudioInputSource
A simple mic playback class

Fields

ActivateOnEnable : override bool
Due to Microphone.Start & Microphone.End taking so long, activate on enable
Signature 
override bool Meta.WitAi.Lib.Mic.ActivateOnEnable
AudioEncoding : AudioEncoding
Signature 
AudioEncoding Meta.WitAi.Lib.Mic.AudioEncoding
AudioSampleRate : override int
Getter for audio mic sample audio capture in samples per second
Signature 
override int Meta.WitAi.Lib.Mic.AudioSampleRate
CanActivateAudio : override bool
Always allow initial activation
Signature 
override bool Meta.WitAi.Lib.Mic.CanActivateAudio
Clip : override AudioClip
The audio clip obtained from Microphone.Start
Signature 
override AudioClip Meta.WitAi.Lib.Mic.Clip
ClipPosition : override int
The current clip position of the
Signature 
override int Meta.WitAi.Lib.Mic.ClipPosition
IsInputAvailable : bool
Signature 
bool Meta.WitAi.Lib.Mic.IsInputAvailable
IsRecording : bool
Signature 
bool Meta.WitAi.Lib.Mic.IsRecording
MicBufferLength : int
Total amount of seconds included within the mic audio clip buffer
Signature 
int Meta.WitAi.Lib.Mic.MicBufferLength
MicStartTimeout : float
Searches for mics for this long following an activation request.
Signature 
float Meta.WitAi.Lib.Mic.MicStartTimeout

Properties

AudioClipSampleRate : int
[Get][Set]
Signature 
int Meta.WitAi.Lib.Mic.AudioClipSampleRate
CurrentDeviceIndex : int
[Get]
Index of the current Mic device in m_Devices
Signature 
int Meta.WitAi.Lib.Mic.CurrentDeviceIndex
CurrentDeviceName : string
[Get]
Gets the name of the Mic device currently in use
Signature 
string Meta.WitAi.Lib.Mic.CurrentDeviceName
Devices : List< string >
[Get]
List of all the available Mic devices
Signature 
List<string> Meta.WitAi.Lib.Mic.Devices
IsMuted : bool
[Get]
Signature 
virtual bool Meta.WitAi.Lib.Mic.IsMuted
Logger : IVLogger
[Get]
Signature 
IVLogger Meta.WitAi.Lib.Mic.Logger

Events

OnMicMuted : Action
Signature 
Action Meta.WitAi.Lib.Mic.OnMicMuted
OnMicUnmuted : Action
Signature 
Action Meta.WitAi.Lib.Mic.OnMicUnmuted
OnSampleReady : Action< int, float[], float >
Signature 
Action<int, float[], float> Meta.WitAi.Lib.Mic.OnSampleReady
OnStartRecording : Action
Signature 
Action Meta.WitAi.Lib.Mic.OnStartRecording
OnStartRecordingFailed : Action
Signature 
Action Meta.WitAi.Lib.Mic.OnStartRecordingFailed
OnStopRecording : Action
Signature 
Action Meta.WitAi.Lib.Mic.OnStopRecording

Protected Methods

HandleActivation ()
Wait for devices to exist & then start mic
Signature 
override IEnumerator Meta.WitAi.Lib.Mic.HandleActivation()
Returns
override IEnumerator
HandleDeactivation ()
Stop microphone for deactivation
Signature 
override void Meta.WitAi.Lib.Mic.HandleDeactivation()
Returns
override void
SetMuted ( muted )
Signature 
virtual void Meta.WitAi.Lib.Mic.SetMuted(bool muted)
Parameters
muted: bool
Returns
void

Methods

ChangeMicDevice ( index )
Changes to a Mic device for Recording
Signature 
void Meta.WitAi.Lib.Mic.ChangeMicDevice(int index)
Parameters
index: int  The index of the Mic device. Refer to Devices
Returns
void
CheckForInput ()
Signature 
void Meta.WitAi.Lib.Mic.CheckForInput()
Returns
void
SetAudioSampleRate ( newSampleRate )
Sets the new audio sample rate if possible
Signature 
void Meta.WitAi.Lib.Mic.SetAudioSampleRate(int newSampleRate)
Parameters
newSampleRate: int  New sample rate
Returns
void
StartRecording ( sampleDurationMS )
Begins reading with a specified number of ms per sample
Signature 
void Meta.WitAi.Lib.Mic.StartRecording(int sampleLen)
Parameters
sampleDurationMS: int
Returns
void
StopRecording ()
Stop recording audio from the provided mic source
Signature 
void Meta.WitAi.Lib.Mic.StopRecording()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta