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

ILoggerRegistry

LogCategoryAttribute

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

IWitConfigurationProvider

IWitInspectorTools

IWitRequestProvider

BaseAudioClipInput

IAudioLevelRangeProvider

VoiceLipSyncMic

MatchIntentRegistry

ObjectNodeReference

RegisteredMatchIntent

ServiceReferences

ServiceReferences

AudioInputServiceReference

CombinedAudioEventReference

DictationServiceAudioEventReference

VoiceServiceAudioEventReference

ISpeechEventProvider

VoiceSpeechEvents

TTSDiskCacheSettings

TTSEventContainer

TTSPhonemeEvent

TTSVoiceSettings

TTSDownloadEvents

TTSServiceEvents

TTSStreamEvents

TTSWebRequestEvents

TTSEventAnimator

TTSRuntimeCache

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

ISpeaker Interface

Overview

Properties

bool	IsSpeaking`[Get]` Whether a clip is currently playing for this speaker
bool	IsPaused`[Get]` Whether a clip is currently paused
TTSSpeakerEvents	Events`[Get]` Events related to the playback of
TTSVoiceSettings	VoiceSettings`[Get]` The specific voice properties used by this speaker
IAudioPlayer	AudioPlayer`[Get]` The script used to perform audio playback of IAudioClipStreams.

Public Member Functions

void	Speak ( string textToSpeak, TTSSpeakerClipEvents playbackEvents ) Load a tts clip using the specified text & playback events. Adds clip to playback queue and will speak once queue has completed all playback.
void	SpeakQueued ( string textToSpeak, TTSSpeakerClipEvents playbackEvents ) Load a tts clip using the specified text & playback events. Adds clip to playback queue and will speak once queue has completed all playback.
IEnumerator	SpeakAsync ( string textToSpeak ) Load a tts clip using the specified text and then waits for the file to load & play. Cancels all previous clips when loaded & then plays.
bool	Speak ( WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents ) Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays.
IEnumerator	SpeakQueuedAsync ( WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents ) Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
IEnumerator	SpeakQueuedAsync ( string [] textsToSpeak, TTSSpeakerClipEvents playbackEvents ) Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback.
void	Stop ( ) Stops loading & playback immediately
void	Pause ( ) Pause any current or future loaded audio playback
void	Resume ( ) Resume playback for current and future audio clips
void	PrepareToSpeak ( ) Call before sending speech data to warm up system
void	StartTextBlock ( ) Call at the start of a larger text block to indicate many queued requests will be coming
void	EndTextBlock ( ) Call at the end of a larger text block to indicate a block of text is complete.

Details

Properties

bool Meta.WitAi.TTS.Interfaces.ISpeaker.IsSpeaking
Whether a clip is currently playing for this speaker

bool Meta.WitAi.TTS.Interfaces.ISpeaker.IsPaused
Whether a clip is currently paused

TTSSpeakerEvents Meta.WitAi.TTS.Interfaces.ISpeaker.Events
Events related to the playback of

TTSVoiceSettings Meta.WitAi.TTS.Interfaces.ISpeaker.VoiceSettings
The specific voice properties used by this speaker

IAudioPlayer Meta.WitAi.TTS.Interfaces.ISpeaker.AudioPlayer
The script used to perform audio playback of IAudioClipStreams.

Member Functions

void Meta.WitAi.TTS.Interfaces.ISpeaker.Speak ( string textToSpeak, TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text & playback events. Adds clip to playback queue and will speak once queue has completed all playback. Parameters textToSpeak The text to be spoken playbackEvents Events to be called for this specific tts playback request

void Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakQueued ( string textToSpeak, TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text & playback events. Adds clip to playback queue and will speak once queue has completed all playback. Parameters textToSpeak The text to be spoken playbackEvents Events to be called for this specific tts playback request

IEnumerator Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakAsync ( string textToSpeak )
Load a tts clip using the specified text and then waits for the file to load & play. Cancels all previous clips when loaded & then plays. Parameters textToSpeak The text to be spoken

bool Meta.WitAi.TTS.Interfaces.ISpeaker.Speak ( WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified response node & playback events Cancels all previous clips when loaded & then plays. Parameters responseNode Parsed data that includes text to be spoken & voice settings playbackEvents Events to be called for this specific tts playback request Returns True if responseNode is decoded successfully

IEnumerator Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakQueuedAsync ( WitResponseNode responseNode, TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback. Parameters responseNode Parsed data that includes text to be spoken & voice settings playbackEvents Events to be called for this specific tts playback request

IEnumerator Meta.WitAi.TTS.Interfaces.ISpeaker.SpeakQueuedAsync ( string [] textsToSpeak, TTSSpeakerClipEvents playbackEvents )
Load a tts clip using the specified text phrases & playback events and then waits for the files to load & play. Adds clip to playback queue and will speak once queue has completed all playback. Parameters textsToSpeak Multiple texts to be spoken playbackEvents Events to be called for this specific tts playback request

void Meta.WitAi.TTS.Interfaces.ISpeaker.Stop ( )
Stops loading & playback immediately

void Meta.WitAi.TTS.Interfaces.ISpeaker.Pause ( )
Pause any current or future loaded audio playback

void Meta.WitAi.TTS.Interfaces.ISpeaker.Resume ( )
Resume playback for current and future audio clips

void Meta.WitAi.TTS.Interfaces.ISpeaker.PrepareToSpeak ( )
Call before sending speech data to warm up system

void Meta.WitAi.TTS.Interfaces.ISpeaker.StartTextBlock ( )
Call at the start of a larger text block to indicate many queued requests will be coming

void Meta.WitAi.TTS.Interfaces.ISpeaker.EndTextBlock ( )
Call at the end of a larger text block to indicate a block of text is complete.

Did you find this page helpful?