Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

AudioClipAudioSource

SourceCodeMapper

IWitVRequestFactory

WitVRequestFactory

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

NativeWebSocket

NativeWebSocket

WaitForBackgroundThread

MainThreadAwaiter

WebSocketException

WebSocketFactory

WebSocketHelpers

WebSocketInvalidArgumentException

WebSocketInvalidStateException

WebSocketUnexpectedException

INLPRequestOptions

INLPRequestResponseDecoder

INLPRequestResults

ITranscriptionRequestOptions

ITranscriptionRequestResults

IVoiceRequestOptions

IVoiceRequestResults

NLPRequestEvents

NLPRequestResponseEvent

NLPRequestResponseValidatorEvent

TelemetryUtilities

TelemetryUtilities

TelemetryConsentManager

TranscriptionRequest

TranscriptionRequestEvent

TranscriptionRequestEvents

VoiceHubConstants

VoiceRequestEvents

SettingsWindowPage

WitConfigWindowPage

ArrayNodeReference

ButtonAttribute

DropDownAttribute

HiddenTextAttribute

HideIfAttribute

HideWhenSetAttribute

ObjectTypeAttribute

ShowIfAttribute

TooltipBoxAttribute

WitConfigurationAssetRefreshAttribute

AudioDurationTracker

BaseSpeechService

CallbackHandlers

CallbackHandlers

ConfidenceRange

FormattedValueEvents

OutOfScopeUtteranceHandler

SimpleIntentHandler

SimpleIntentHandlerEditor

SimpleStringEntityHandler

SimpleStringEntityHandlerEditor

ValuePathMatcher

ValuePathMatcherPropertyDrawer

WitIntentMatcher

WitIntentMatcherEditor

WitResponseHandler

WitResponseMatcher

WitUtteranceMatcher

ComponentExtensions

ComponentExtensions

ComponentCopyData

WitDictationRuntimeConfiguration

WitEndpointConfig

WitRequestOptions

WitRuntimeConfiguration

CoroutineUtility

CoroutineUtility

CoroutinePerformer

AudioBufferConfiguration

WitConfigurationApplicationTab

WitConfigurationEditorTab

WitConfigurationEntitiesTab

WitConfigurationIntentsTab

WitConfigurationTraitsTab

WitConfigurationVoicesTab

WitConfiguration

WitConfigurationAssetData

WitConfigurationUtility

DynamicEntityDataProvider

DynamicEntityKeywordRegistry

DynamicEntityProvider

RegisteredDynamicEntityKeyword

WitDynamicEntities

WitDynamicEntitiesData

WitDynamicEntity

WitEntityDataBase

WitEntityFloatData

WitEntityIntData

WitSimpleDynamicEntity

WitContextMapInfo

WitEntityKeywordInfo

WitEntityRoleInfo

WitIntentEntityInfo

WitTraitValueInfo

WitVersionTagInfo

SimulatedResponse

SimulatedResponseMessage

ValueReferences

ValueReferences

IStringReference

StringReference

WitDataCreation

DictationSession

DictationService

DictationEvents

IDictationService

MultiRequestTranscription

ButtonAttributeDrawer

DynamicRangeAttributeDrawer

HiddenTextAttributeDrawer

StringReferenceDrawer

TooltipBoxDrawer

EditorUtilities

EditorUtilities

SerializedPropertyExtensions

EnumerableExtensions

IExportParserPlugin

ITelemetryEventsProvider

IVoiceActivationHandler

IVoiceEventProvider

IWitRequestConfiguration

IWitRequestEndpointInfo

IWitRuntimeConfigProvider

IWitRuntimeConfigSetter

CustomTranscriptionProvider

IAudioEventProvider

IAudioInputEvents

IAudioInputSource

IAudioUploadHandler

IDataUploadHandler

IDynamicEntitiesProvider

IPlatformIntegrationOverride

ITranscriptionEvent

ITranscriptionEventProvider

ITranscriptionProvider

IVoiceServiceRequestProvider

IWitConfigurationProvider

IWitConfigurationSetter

IWitInspectorTools

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

MatchIntentRegistry

ObjectNodeReference

RegisteredMatchIntent

ServiceReferences

ServiceReferences

AudioInputServiceReference

CombinedAudioEventReference

DictationServiceAudioEventReference

VoiceServiceAudioEventReference

ISpeechEventProvider

VoiceSpeechEvents

TTSDiskCacheSettings

TTSEventContainer

TTSPhonemeEvent

TTSVoiceSettings

TTSDownloadEvents

TTSServiceEvents

TTSStreamEvents

TTSWebRequestEvents

BaseTTSRuntimeCache

TTSEventAnimator

TTSRuntimeLRUCache

TTSRuntimePlaybackCache

TTSWitRequestSettings

TTSWitVoiceSettings

ISpeakerTextPostprocessor

ISpeakerTextPreprocessor

ITTSDiskCacheHandler

ITTSEventPlayer

ITTSRuntimeCacheHandler

ITTSVoiceProvider

BaseTextureFlipLipSync

BaseTextureFlipLipSync

VisemeTextureData

BaseVisemeBlendShapeLipSync

BaseVisemeBlendShapeLipSync

VisemeBlendShapeData

VisemeBlendShapeWeight

ILipsyncAnimator

IVisemeAnimatorProvider

VisemeBlendShapeLipSync

VisemeChangedEvent

VisemeLerpEvent

VisemeLipSyncAnimator

VisemeTextureFlipLipSync

TTSPreloadPhraseData

TTSPreloadSettings

TTSPreloadSettingsInspector

TTSPreloadUtility

TTSPreloadVoiceData

TTSStreamToggle

TTSEditorUtilities

TTSServiceInspector

TTSSpeakerInspector

TTSWitInspector

TTSSpeakerErrorLabel

TTSSpeakerObserver

TTSSpeakerStatusLabel

ITTSPhraseProvider

TTSSpeakerRequestData

TTSSpeakerAutoLoader

TTSSpeakerBodyAnimator

TTSSpeakerClipEvent

TTSSpeakerClipEvents

TTSSpeakerClipMessageEvent

TTSSpeakerEvents

TTSSpeechSplitter

TTSWitVoiceSettingsDrawer

UnityEventExtensions

UnityObjectExtensions

AssetDatabaseUtility

DictationServiceReference

DynamicRangeAttribute

FloatToStringEvent

GameObjectSearchUtility

ReflectionUtils

StringToStringEvent

VoiceServiceReference

WitRuntimeStyles

ValidatePartialIntent

WitAppInfoUtility

DefaultTokenValidatorProvider

ITokenValidationProvider

WitConduitParameterProvider

WitConfigurationEditorUI

WitEditorConstants

WitExportRetriever

WitRequestFactory

WitRequestSettings

WitResponseReference

WitResultUtilities

WitRuntimeRequestConfiguration

WrapHttpWebRequest

ZipArchiveExtensions

AppVoiceExperience

IVCBindingEvents

VoiceSDKBinding

VoiceSDKConfigBinding

VoiceSDKImplRequest

VoiceSDKListenerBinding

VoiceSDKDataCreation

AppVoiceExperienceWitConfigurationEditor

IPlatformVoiceService

TTSServiceLogging

ObjectVoiceExperience

HierarchySimplifier

HierarchySimplifierInspector

InspectorHelper

VoiceSDKVersion

VoiceSDKConstants

UnderstandingViewerWindow

VoiceApplicationDetailProvider

VoiceSDKTokenValidatorProvider

VoiceActivationButton

VoiceTranscriptionLabel

MicPermissionsManager

BaseAudioClipInput Class

An abstract class for IAudioInputSources that use audio clips

Meta::WitAi::Lib::BaseAudioClipInput extends MonoBehaviour.

Meta::WitAi::Lib::BaseAudioClipInput extends Meta.WitAi.Interfaces.IAudioInputSource.

Meta::WitAi::Lib::BaseAudioClipInput extends Meta.WitAi.Lib.IAudioLevelRangeProvider.

Overview

Properties

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

Data Fields

bool	ActivateOnEnable`[Get]` Whether audio should be activated as soon as enabled
int	AudioChannels`[Get]` The audio channels expected for this
int	AudioSampleRate`[Get]` The audio sample rate that should be captured at
float	MinAudioLevel`[Get]` Ignore audio input below 0.5f magnitude
float	MaxAudioLevel`[Get]` Allow max audio input magnitude

Events

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

Object Data

void	SetActivationState ( VoiceAudioInputState newActivationState ) Setter for activation state changes
void	OnEnable ( ) If activate on enable, begin activation immediately
abstract IEnumerator	HandleActivation ( ) Perform audio activation in child class
void	OnDisable ( ) Stop recording if disabled
abstract void	HandleDeactivation ( ) Deactivate current audio immediately

Public Member Functions

void	StartRecording ( int sampleDurationMS ) Begins reading with a specified number of ms per sample
void	StopRecording ( ) Stop recording audio from the provided mic source

Details

Properties

abstract AudioClip Meta.WitAi.Lib.BaseAudioClipInput.Clip
The audio clip generated

abstract int Meta.WitAi.Lib.BaseAudioClipInput.ClipPosition
The current total samples written to the audio clip

abstract bool Meta.WitAi.Lib.BaseAudioClipInput.CanActivateAudio
Whether audio can be activated

virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioSampleLength
The total length in ms for the samples

AudioEncoding Meta.WitAi.Lib.BaseAudioClipInput.AudioEncoding
Generates an audio encoding object using the existing settings

VoiceAudioInputState Meta.WitAi.Lib.BaseAudioClipInput.ActivationState
Whether audio is activated or not, independent of record state

virtual bool Meta.WitAi.Lib.BaseAudioClipInput.IsRecording
Whether the audio has begun recording or not

Fields

virtual bool Meta.WitAi.Lib.BaseAudioClipInput.ActivateOnEnable
Whether audio should be activated as soon as enabled

virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioChannels
The audio channels expected for this

virtual int Meta.WitAi.Lib.BaseAudioClipInput.AudioSampleRate
The audio sample rate that should be captured at

virtual float Meta.WitAi.Lib.BaseAudioClipInput.MinAudioLevel
Ignore audio input below 0.5f magnitude

virtual float Meta.WitAi.Lib.BaseAudioClipInput.MaxAudioLevel
Allow max audio input magnitude

Events

Action<VoiceAudioInputState> Meta.WitAi.Lib.BaseAudioClipInput.OnActivationStateChange ( )
Callbacks for audio activation, independent of record state

Action Meta.WitAi.Lib.BaseAudioClipInput.OnStartRecording ( )
Callback when successfully started recording

Action Meta.WitAi.Lib.BaseAudioClipInput.OnStartRecordingFailed ( )
Callback if recording request failed

Action Meta.WitAi.Lib.BaseAudioClipInput.OnStopRecording ( )
Callback when successfully stopped recording

Action<int, float[], float> Meta.WitAi.Lib.BaseAudioClipInput.OnSampleReady ( )
Callback for audio sample read from Audio Clip

Object Data

void Meta.WitAi.Lib.BaseAudioClipInput.SetActivationState ( VoiceAudioInputState newActivationState )
Setter for activation state changes

virtual void Meta.WitAi.Lib.BaseAudioClipInput.OnEnable ( )
If activate on enable, begin activation immediately

abstract IEnumerator Meta.WitAi.Lib.BaseAudioClipInput.HandleActivation ( )
Perform audio activation in child class

virtual void Meta.WitAi.Lib.BaseAudioClipInput.OnDisable ( )
Stop recording if disabled

abstract void Meta.WitAi.Lib.BaseAudioClipInput.HandleDeactivation ( )
Deactivate current audio immediately

Member Functions

virtual void Meta.WitAi.Lib.BaseAudioClipInput.StartRecording ( int sampleDurationMS )
Begins reading with a specified number of ms per sample

virtual void Meta.WitAi.Lib.BaseAudioClipInput.StopRecording ( )
Stop recording audio from the provided mic source

Did you find this page helpful?