API reference

BaseAudioClipInput Class

Extends MonoBehaviour
Implements Meta.WitAi.Interfaces.IAudioInputSource, Meta.WitAi.Lib.IAudioLevelRangeProvider
An abstract class for IAudioInputSources that use audio clips

Fields

ActivateOnEnable : bool
Whether audio should be activated as soon as enabled
Signature 
virtual bool Meta.WitAi.Lib.BaseAudioClipInput.ActivateOnEnable
AudioChannels : int
The audio channels expected for this
Signature 
virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioChannels
AudioSampleRate : int
The audio sample rate that should be captured at
Signature 
virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioSampleRate
MaxAudioLevel : float
Allow max audio input magnitude
Signature 
virtual float Meta.WitAi.Lib.BaseAudioClipInput.MaxAudioLevel
MinAudioLevel : float
Ignore audio input below 0.5f magnitude
Signature 
virtual float Meta.WitAi.Lib.BaseAudioClipInput.MinAudioLevel

Properties

ActivationState : VoiceAudioInputState
[Get]
Whether audio is activated or not, independent of record state
Signature 
VoiceAudioInputState Meta.WitAi.Lib.BaseAudioClipInput.ActivationState
AudioEncoding : AudioEncoding
[Get]
Generates an audio encoding object using the existing settings
Signature 
AudioEncoding Meta.WitAi.Lib.BaseAudioClipInput.AudioEncoding
AudioSampleLength : int
[Get]
The total length in ms for the samples
Signature 
virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioSampleLength
CanActivateAudio : abstract bool
[Get]
Whether audio can be activated
Signature 
abstract bool Meta.WitAi.Lib.BaseAudioClipInput.CanActivateAudio
Clip : abstract AudioClip
[Get]
The audio clip generated
Signature 
abstract AudioClip Meta.WitAi.Lib.BaseAudioClipInput.Clip
ClipPosition : abstract int
[Get]
The current total samples written to the audio clip
Signature 
abstract int Meta.WitAi.Lib.BaseAudioClipInput.ClipPosition
IsRecording : bool
[Get]
Whether the audio has begun recording or not
Signature 
virtual bool Meta.WitAi.Lib.BaseAudioClipInput.IsRecording

Events

OnActivationStateChange : Action< VoiceAudioInputState >
Callbacks for audio activation, independent of record state
Signature 
Action<VoiceAudioInputState> Meta.WitAi.Lib.BaseAudioClipInput.OnActivationStateChange
OnSampleReady : Action< int, float[], float >
Callback for audio sample read from Audio Clip
Signature 
Action<int, float[], float> Meta.WitAi.Lib.BaseAudioClipInput.OnSampleReady
OnStartRecording : Action
Callback when successfully started recording
Signature 
Action Meta.WitAi.Lib.BaseAudioClipInput.OnStartRecording
OnStartRecordingFailed : Action
Callback if recording request failed
Signature 
Action Meta.WitAi.Lib.BaseAudioClipInput.OnStartRecordingFailed
OnStopRecording : Action
Callback when successfully stopped recording
Signature 
Action Meta.WitAi.Lib.BaseAudioClipInput.OnStopRecording

Protected Methods

HandleActivation ()
Perform audio activation in child class
Signature 
abstract IEnumerator Meta.WitAi.Lib.BaseAudioClipInput.HandleActivation()
Returns
abstract IEnumerator
HandleDeactivation ()
Deactivate current audio immediately
Signature 
abstract void Meta.WitAi.Lib.BaseAudioClipInput.HandleDeactivation()
Returns
abstract void
OnDisable ()
Stop recording if disabled
Signature 
virtual void Meta.WitAi.Lib.BaseAudioClipInput.OnDisable()
Returns
void
OnEnable ()
If activate on enable, begin activation immediately
Signature 
virtual void Meta.WitAi.Lib.BaseAudioClipInput.OnEnable()
Returns
void
SetActivationState ( newActivationState )
Setter for activation state changes
Signature 
void Meta.WitAi.Lib.BaseAudioClipInput.SetActivationState(VoiceAudioInputState newActivationState)
Parameters
newActivationState: VoiceAudioInputState
Returns
void

Methods

StartRecording ( sampleDurationMS )
Begins reading with a specified number of ms per sample
Signature 
virtual void Meta.WitAi.Lib.BaseAudioClipInput.StartRecording(int sampleDurationMS)
Parameters
sampleDurationMS: int
Returns
void
StopRecording ()
Stop recording audio from the provided mic source
Signature 
virtual void Meta.WitAi.Lib.BaseAudioClipInput.StopRecording()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta