API reference

IAudioInputSource Interface

This interface defines the methods and properties required for an audio input source. It is used to start and stop recording, check if recording is in progress, and handle events related to recording.

Properties

AudioEncoding : AudioEncoding
[Get]
Settings determining how audio is encoded by the source.
NOTE: Default values for AudioEncoding are server optimized to reduce latency.
Signature 
AudioEncoding Meta.WitAi.Interfaces.IAudioInputSource.AudioEncoding
IsMuted : bool
[Get]
Returns true if the audio source is currently muted
Signature 
bool Meta.WitAi.Interfaces.IAudioInputSource.IsMuted
IsRecording : bool
[Get]
Returns true if the audio input source is currently recording.
Signature 
bool Meta.WitAi.Interfaces.IAudioInputSource.IsRecording

Events

OnMicMuted : Action
Invoked when the user mutes their input to this audio source
Signature 
Action Meta.WitAi.Interfaces.IAudioInputSource.OnMicMuted
OnMicUnmuted : Action
Invoked when the user unmutes their input to this audio source
Signature 
Action Meta.WitAi.Interfaces.IAudioInputSource.OnMicUnmuted
OnSampleReady : Action< int, float[], float >
Invoked everytime an audio frame is collected. Includes the frame.
Signature 
Action<int, float[], float> Meta.WitAi.Interfaces.IAudioInputSource.OnSampleReady
OnStartRecording : Action
Invoked when the instance starts Recording.
Signature 
Action Meta.WitAi.Interfaces.IAudioInputSource.OnStartRecording
OnStartRecordingFailed : Action
Invoked when an AudioClip couldn't be created to start recording.
Signature 
Action Meta.WitAi.Interfaces.IAudioInputSource.OnStartRecordingFailed
OnStopRecording : Action
Invoked when the instance stop Recording.
Signature 
Action Meta.WitAi.Interfaces.IAudioInputSource.OnStopRecording

Methods

StartRecording ( sampleLen )
Starts recording audio with the specified sample length.
Signature 
void Meta.WitAi.Interfaces.IAudioInputSource.StartRecording(int sampleLen)
Parameters
sampleLen: int  The length of the audio sample to record.
Returns
void
StopRecording ()
Stops recording audio.
Signature 
void Meta.WitAi.Interfaces.IAudioInputSource.StopRecording()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta