Script Objects
Script Objects represent script data.
Anchor
An object containing the position of an object relative to a LocationAsset.
Anchor
AnimationClip
Animation Clip is what an Animation Player uses to manage playback for a specific animation. It defines that animation by referencing an Animation Asset and providing start and end points, playback speed and direction, and blending information.
AnimationClip
AnimationClip.PostInfinity
, AnimationClip.RangeType
AnimationCurve
A curve that contains a set of keyframes and can evaluate values at specific timestamps.
AnimationCurve
AnimationKeyFrame
A keyframe with time and respective value. Could be added to Animation Curve.
AnimationKeyFrame
[DEPRECATED] AnimationMixerLayer
Controls animation playback for a single animation layer. See also: AnimationMixer.
AnimationMixerLayer
AnimationPlayerOnEventArgs
Args used for AnimationPlayer's event, which is triggered every time the animation playback passes the given time in the event.
AnimationPlayerOnEventArgs
AnimationPropertyEventRegistration
The event registration returned by AnimationAsset
's createEvent
.
AnimationPropertyEventRegistration
AnimationPropertyLayer
A layer containing different properties. Examples include position, rotation, scale or any other arbitrary properties a user would like to add and sample from.
AnimationPropertyLayer
BackgroundSettings
Settings for rendering the background on a Text component.
Accessible through the Text component's backgroundSettings
property.
BackgroundSettings
BaseMultiplayerSessionOptions
Base class for MultiplayerSession options. This class is not used directly - use ConnectedLensSessionOptions instead.
BaseMultiplayerSessionOptions
DirectMultiplayerSessionOptions
BasePlaceholder
Base class for Input and Output Placeholders used by MLComponent.
BasePlaceholder
InputPlaceholder
, OutputPlaceholder
BasicTransform
Provides basic information about a transformation. See also: DeviceTracking
BasicTransform
Bitmoji2DOptions
The options used with requestBitmoji2DResource
.
Bitmoji2DOptions
Bitmoji2DResource
The DynamicResource
of a 2D Bitmoji which can be loaded with RemoteMediaModule
.
Bitmoji2DResource
Bitmoji3DOptions
The options used with requestBitmoji3DResource
Bitmoji3DOptions
Bitmoji3DResource
Provides information about the current user's 3D Bitmoji avatar to be downloaded via the RemoteMediaModule.
Bitmoji3DResource
Camera.BaseRenderTarget
The base class from which ColorRenderTarget and DepthStencilRenderTarget are derived from
BaseRenderTarget
Camera
Camera.ColorRenderTarget
, Camera.DepthStencilRenderTarget
Camera.ColorRenderTarget
Color based RenderTarget.
ColorRenderTarget
Camera
Camera.DepthStencilRenderTarget
This class inherits from the BaseRenderTarget class. BaseRenderTarget class is not available for creation and is used like the base class for DepthStencilRenderTarget class to provide access to targetTexture, inputTexture and maskTexture properties.
DepthStencilRenderTarget
Camera
CapsuleShape
A capsule collision shape. Also known as a capped cylinder.
CapsuleShape
CloudStorageListOptions
Options associated with the listValues method call.
CloudStorageListOptions
CloudStorageOptions
Used to configure Cloud Storage Module
with various options. Note: if session
scoped storage is required, this option must be provided.
CloudStorageOptions
CloudStorageReadOptions
Options associated with the getValue/deleteValue methods for Cloud Storage.
CloudStorageReadOptions
CloudStorageWriteOptions
Options associated with the setValue method for Cloud Storage.
CloudStorageWriteOptions
CloudStore
An instance of Cloud Storage that can store data in a multiplayer experience.
CloudStore
Collision
A state generated for ColliderComponent collision events.
Physics.Collision
CollisionEnterEventArgs
Args used for ColliderComponent.onCollisionEnter, which is triggered when a collision begins.
Physics.CollisionEnterEventArgs
CollisionExitEventArgs
Args used for ColliderComponent.onCollisionExit, which is triggered when a collision ends.
Physics.CollisionExitEventArgs
CollisionStayEventArgs
Args used for ColliderComponent.onCollisionStay, which is triggered every frame while a collision continues.
Physics.CollisionStayEventArgs
ConnectedLensModule.ConnectionInfo
Information that is bootstrapped to the user who just connected to the session.
ConnectionInfo
ConnectedLensModule
ConnectedLensModule.HostUpdateInfo
Information about the host update.
HostUpdateInfo
ConnectedLensModule
ConnectedLensModule.RealtimeStoreCreationInfo
Provides extra context about a RealtimeStore's creation.
RealtimeStoreCreationInfo
ConnectedLensModule
ConnectedLensModule.RealtimeStoreDeleteInfo
Gives information about the Realtime Store delete operation.
RealtimeStoreDeleteInfo
ConnectedLensModule
ConnectedLensModule.RealtimeStoreKeyRemovalInfo
Provides information about a key being removed from a RealtimeStore.
RealtimeStoreKeyRemovalInfo
ConnectedLensModule
ConnectedLensModule.RealtimeStoreOwnershipUpdateInfo
Provides information about a RealtimeStore's ownership being updated.
RealtimeStoreOwnershipUpdateInfo
ConnectedLensModule
ConnectedLensModule.RealtimeStoreUpdateInfo
Gives information about the Realtime Store update operation.
RealtimeStoreUpdateInfo
ConnectedLensModule
ConnectedLensModule.UserInfo
Provides information about a user in a Connected Lens session.
UserInfo
ConnectedLensModule
ConnectedLensSessionOptions
Settings for configuring a Connected Lens session.
ConnectedLensSessionOptions
ConnectedLensSessionOptions.SessionCreationType
Constraint
Constraints body motion in configurable ways, for simulating physical objects such as joints and hinges.
Physics.Constraint
Contact
Contact point between two colliding objects. See also: ColliderComponent, CollisionEnterEventArgs, CollisionExitEventArgs, CollisionStayEventArgs.
Physics.Contact
CylinderShape
A cylinder collision shape.
CylinderShape
Delay
Creates a buffer for the audio data.
Delay
DelayBuilder
Builder class for the Delay.
DelayBuilder
Delta
Local estimate of the derivative of the input data along the selected axis. Outputs the derivative of the input features along the window.
Delta
DeltaBuilder
Builder class for Delta.
DeltaBuilder
DeviceCamera
Provides information about the device's camera.
DeviceCamera
DeviceInfoSystem
Provides information about the device running the Lens. Accessible through global.deviceInfoSystem
.
DeviceInfoSystem
Dialog.Answer
Provides answer information in response to DialogModule.askQuestions()
.
Answer
DirectMultiplayerSessionOptions
DirectMultiplayerSessionOptions
ConnectedLensSessionOptions
DirectivityEffect
An Audio Component effect that simulates sound attenuation based on the orientation of the transform relative to the AudioListenerComponent.
DirectivityEffect
DistanceEffect
An audio effect that simulates sound attenuation based on the distance between the Audio and the AudioListenerComponent.
DistanceEffect
DropshadowSettings
Used in Text's dropShadowSettings
property.
Configures how dropshadow will appear on a Text component.
DropshadowSettings
DynamicResource
A resource that is resolved at runtime.
DynamicResource
Bitmoji2DResource
, Bitmoji3DResource
Filter
Intersection filter settings. Unifies settings for world probes and collider overlap tests. See also: ColliderComponent, Physics.
Physics.Filter
FixedConstraint
Fully constrain rotation and translation. See also: ConstraintComponent.
Physics.FixedConstraint
FocusEndEventArgs
Arguments used with the InteractionComponent.onFocusEnd
event.
FocusEndEventArgs
FocusStartEventArgs
Arguments used with the InteractionComponent.onFocusStart
event.
FocusStartEventArgs
GeneralDataStore
Class for storing and retrieving data based on keys. Used by PersistentStorageSystem. For more information, see the Persistent Storage guide.
GeneralDataStore
GeoPosition
The location of the device.
GeoPosition
GltfSettings
Settings for importing a glTF Asset.
Use this with GltfAsset component's tryInstantiateWithSetting
method.
GltfSettings
HandSpecificData
Provides additional data for the tracked hand. You can figure out whether the tracked hand is the left hand by accessing the isLeft property [true/false], as well as the probability of this data through the isLeftProbability property [0-1].
HandSpecificData
HapticFeedbackSystem
Triggers haptic feedback on the device. (iOS Devices only)
HapticFeedbackSystem
HingeConstraint
Constraints translation and a single axis of rotation. See also: ConstraintComponent.
Physics.HingeConstraint
InputBuilder
Builds InputPlaceHolders for MLComponent.
InputBuilder
InputPlaceholder
Controls input data for a neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.
InputPlaceholder
Leaderboard
A leaderboard which can contain scores and information about participating users. Accessible through the LeaderboardModule
asset.
Leaderboard
Leaderboard.CreateOptions
, Leaderboard.OrderingType
, Leaderboard.RetrievalOptions
, Leaderboard.UserRecord
, Leaderboard.UsersType
Leaderboard.CreateOptions
The options for the leaderboard to be made.
CreateOptions
Leaderboard
Leaderboard.RetrievalOptions
Describes the context for the leaderboard to be requested.
RetrievalOptions
Leaderboard
Leaderboard.UserRecord
Information for a user who submitted a score to the leaderboard.
UserRecord
Leaderboard
LevelsetShape
A levelset collision shape. A levelset is an asset that is generated to approximate a mesh.
LevelsetShape
LocalizationSystem
Helps convert data types to localized string representations. Accessible through global.localizationSystem
.
Note that formatted or localized strings may appear differently to users depending on their region. The example results given here are representative of a user in the United States, but may appear differently for users in other regions.
LocalizationSystem
LocationCloudStorageOptions
Used to configure LocationCloudStorage module with various options.
LocationCloudStorageOptions
LocationCloudStore
Instance of location cloud store which has a similar interface as cloud store.
LocationCloudStore
LocationService
The LocationService allows the user to provide their location to Lens applications if they so desire. For privacy reasons, the user is asked for permission to report location information.
Spectacles: Users should be logged in and paired with Snapchat account and also location permission should be enabled. Users are expected to be connected to the internet to make use of aided information for indoor locations and challenging scenarios.
LocationService
MFCC
Mel-frequency cepstral coefficients.
MFCC
MFCCBuilder
Builder class for the MFCC (Mel Frequency Cepstral Co-efficients).
MFCCBuilder
ManipulateEndEventArgs
Arguments used with the ManipulateComponent.onManipulateEnd
event.
ManipulateEndEventArgs
ManipulateStartEventArgs
Arguments used with the ManipulateComponent.onManipulateStart
event.
ManipulateStartEventArgs
MappingOptions
Used with MappingSession
to describe the session to be created.
MappingOptions
MappingSession
Used with the LocatedAtComponent
to map the current physical location.
MappingSession
MappingSession.MappingThrottling
MelSpectrogram
Computes a mel scale spectrogram - a spectrogram where the frequencies are converted to the mel scale.
MelSpectrogram
MelSpectrogramBuilder
A builder class for MelSpectrogram.
MelSpectrogramBuilder
MeshShape
Allows meshes to be used as collision shapes, for ColliderComponent and BodyComponent.
MeshShape
MultiplayerSession
An instance of a Connected Lens session among a group of participants who were successfully invited into the experience.
MultiplayerSession
NoiseReductionBuilder
NoiseReductionBuilder
ObjectSpecificData
Provides additional data for the tracked object. For example, with hand tracking, you can figure out whether the tracked hand is the left hand by accessing the isLeft
property [true/false], as well as the probability of this data through the isLeftProbability
property [0-1].
ObjectSpecificData
HandSpecificData
OutlineSettings
Used in Text's outlineSettings
property.
Configures how text outlining will appear on a Text component.
OutlineSettings
OutputBuilder
Builds OutputPlaceholders for MLComponent.
OutputBuilder
OutputPlaceholder
Provides output data from the neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.
OutputPlaceholder
Overlap
Exposes state generated for ColliderComponent overlap events. See also: ColliderComponent, OverlapEnterEventArgs, OverlapExitEventArgs, OverlapStayEventArgs.
Physics.Overlap
OverlapEnterEventArgs
Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. Typically used for volume triggers.
Physics.OverlapEnterEventArgs
OverlapExitEventArgs
Args used for ColliderComponent.onOverlapEnd, which is triggered when the collider stops overlapping another object. Typically used for volume triggers.
Physics.OverlapExitEventArgs
OverlapStayEventArgs
Args used for ColliderComponent.onOverlapStay, which is triggered every frame while the collider continues overlapping another object. Typically used for volume triggers.
Physics.OverlapStayEventArgs
Pass
Controls how a mesh will get rendered. Each Pass acts as an interface for the shader it's associated with.
Any properties on a Pass's shader will automatically become properties on that Pass.
For example, if the shader defines a variable named baseColor
, a script would be able to access that property as material.mainPass.baseColor
.
Asset.Pass
PassWrapper
Similar to Pass, except used by VFX Assets.
PassWrapper
PassWrappers
Allows for retrieval of a collection of Pass objects used by VFXAsset
PassWrappers
PersistentStorageSystem
Allows data to be stored and retrieved between Lens sessions.
In other words, data can be saved on device and loaded back in the next time the Lens is opened.
Can be accessed with global.persistentStorageSystem
.
See the Persistent Storage guide for more information.
PersistentStorageSystem
PitchShifterBuilder
PitchShifterBuilder
PointCloud
Represents 3D locations of stationary features in the environment. The resulting cloud of points provides a sparse description of the 3D environment.
PointCloud
PointConstraint
A type of constraint that only allows rotation. See also: ConstraintComponent.
Physics.PointConstraint
PositionEffect
An Audio Component effect that allows the Lens to simulate sound based on the direction of the Audio Listener relative to the Audio Component.
PositionEffect
Probe
Performs collision tests (such as ray casts) in one or more world. See Physics.createGlobalProbe(), Physics.createRootProbe(), WorldComponent.createProbe().
Physics.Probe
PropertyOnEventArgs
PropertyOnEventArgs
RayCastHit
Hit results of a ray-cast provided to script. See Probe.
Physics.RayCastHit
RealtimeStoreCreateOptions
The options for the realtime store.
RealtimeStoreCreateOptions
Rect
An axis aligned rectangle.
Used by anchors
and offsets
in ScreenTransform to represent screen boundaries.
Rect can only store finite numbers in the range Number.MIN_VALUE to Number.MAX_VALUE.
Rect
RotationOptions
Used with DeviceTracking.rotationOptions to change settings for Rotation tracking mode.
RotationOptions
SamplerBuilder
Class for building Sampler.
SamplerBuilder
SamplerWrapper
An accessor for Pass.samplers when using PassWrappers
SamplerWrapper
SceneObject
An object in the scene hierarchy, containing a Transform and possibly Components.
A script can access the SceneObject holding it through the method script.getSceneObject()
.
SceneObject
ScriptObject
Base class for objects representing Script data.
ScriptObject
Anchor
, AnimationClip
, AnimationCurve
, AnimationKeyFrame
, AnimationMixerLayer
, AnimationPlayerOnEventArgs
, AnimationPropertyEventRegistration
, AnimationPropertyLayer
, BackgroundSettings
, BaseMultiplayerSessionOptions
, BasePlaceholder
, BasicTransform
, Bitmoji2DOptions
, Bitmoji3DOptions
, Camera.BaseRenderTarget
, CloudStorageListOptions
, CloudStorageOptions
, CloudStorageReadOptions
, CloudStorageWriteOptions
, CloudStore
, Collision
, CollisionEnterEventArgs
, CollisionExitEventArgs
, CollisionStayEventArgs
, ConnectedLensModule.ConnectionInfo
, ConnectedLensModule.HostUpdateInfo
, ConnectedLensModule.RealtimeStoreCreationInfo
, ConnectedLensModule.RealtimeStoreDeleteInfo
, ConnectedLensModule.RealtimeStoreKeyRemovalInfo
, ConnectedLensModule.RealtimeStoreOwnershipUpdateInfo
, ConnectedLensModule.RealtimeStoreUpdateInfo
, ConnectedLensModule.UserInfo
, Constraint
, Contact
, Delay
, DelayBuilder
, Delta
, DeltaBuilder
, DeviceCamera
, DeviceInfoSystem
, Dialog.Answer
, DirectivityEffect
, DistanceEffect
, DropshadowSettings
, DynamicResource
, EventRegistration
, Filter
, FocusEndEventArgs
, FocusStartEventArgs
, GeneralDataStore
, GeoPosition
, GltfSettings
, HapticFeedbackSystem
, IEventParameters
, InputBuilder
, Leaderboard
, Leaderboard.CreateOptions
, Leaderboard.RetrievalOptions
, Leaderboard.UserRecord
, LocalizationSystem
, LocationCloudStorageOptions
, LocationCloudStore
, LocationService
, ManipulateEndEventArgs
, ManipulateStartEventArgs
, MappingOptions
, MappingSession
, MelSpectrogram
, MelSpectrogramBuilder
, MFCC
, MFCCBuilder
, MultiplayerSession
, NoiseReduction
, NoiseReductionBuilder
, ObjectSpecificData
, OutlineSettings
, OutputBuilder
, Overlap
, OverlapEnterEventArgs
, OverlapExitEventArgs
, OverlapStayEventArgs
, Pass
, PassWrapper
, PassWrappers
, PersistentStorageSystem
, PitchShifter
, PitchShifterBuilder
, PointCloud
, PositionEffect
, Probe
, Properties
, PropertyOnEventArgs
, Provider
, RayCastHit
, RealtimeStoreCreateOptions
, Rect
, RemoteApiRequest
, RemoteApiResponse
, RotatedRect
, RotationOptions
, Sampler
, SamplerBuilder
, SamplerWrapper
, SamplerWrappers
, ScriptScene
, SelectEndEventArgs
, SelectStartEventArgs
, SerializableWithUID
, Shape
, SnapchatUser
, SpatialAudio
, Spectrogram
, SpectrogramBuilder
, StencilState
, StorageOptions
, SurfaceOptions
, TapEventArgs
, TextFill
, TextInputSystem
, TextToSpeech.Options
, TextToSpeech.PhonemeInfo
, TextToSpeech.WordInfo
, TouchDataProvider
, TouchEndEventArgs
, TouchMoveEventArgs
, TouchStartEventArgs
, TrackedMesh
, TrackedMeshHistogramResult
, TrackedMeshHitTestResult
, TrackedPlane
, TrackedPoint
, Transform
, Transformer
, TransformerBuilder
, TriangleHit
, TriggerPrimaryEventArgs
, UserContextSystem
, VertexSimulationSettings
, VoiceML.AdditionalParam
, VoiceML.BaseNlpModel
, VoiceML.BaseNlpResponse
, VoiceML.KeywordModelGroup
, VoiceML.ListeningErrorEventArgs
, VoiceML.ListeningOptions
, VoiceML.ListeningUpdateEventArgs
, VoiceML.NlpResponseStatus
, VoiceML.PostProcessingAction
, VoiceML.PostProcessingActionResponse
, VoiceML.PostProcessingActionResponseStatus
, VoiceML.SpeechContext
, WorldOptions
, WorldQuery
, WorldTrackingCapabilities
ScriptScene
Represents the Lens scene. Accessible through global.scene
.
ScriptScene
SelectEndEventArgs
Arguments used with the InteractionComponent.onSelectEnd
event.
SelectEndEventArgs
SelectStartEventArgs
Arguments used with the InteractionComponent.onSelectStart
event.
SelectStartEventArgs
SerializableWithUID
Low-level data class.
SerializableWithUID
Shape
Base type for collision shapes.
Shape
BoxShape
, CapsuleShape
, ConeShape
, CylinderShape
, LevelsetShape
, MeshShape
, SphereShape
SnapchatUser
Represents a Snapchat user in order to pass to other APIs or to retrieve certain details about the user like display name.
SnapchatUser
Spectrogram
Representation the signal strength over time at various frequencies present in a particular waveform. Created by applying Fast Fourier Transform (FFT) on the overlapping segments of the audio data.
Spectrogram
SpectrogramBuilder
The builder class for Spectrogram.
SpectrogramBuilder
SphereShape
A sphere collision shape.
SphereShape
StencilState
The stencil test state for Pass.
StencilState
StorageOptions
Settings for saving values in a MultiplayerSession.
StorageOptions
SurfaceOptions
Used with DeviceTracking.surfaceOptions to change settings for Surface tracking mode.
SurfaceOptions
TapEventArgs
Arguments used with the InteractionComponent.onTap
event.
TapEventArgs
TextFill
Fill settings used by several text related classes.
Used in Text's textFill
property, DropshadowSettings' fill
property, and OutlineSettings' fill
property.
TextFill
TextInputSystem
Provides access to the device's input system. Accessible through global.textInputSystem
.
TextInputSystem
TextInputSystem.KeyboardOptions
, TextInputSystem.KeyboardType
, TextInputSystem.ReturnKeyType
TextToSpeech.Options
Provides the configuration for the Text to Speech Module. It is used to control the language of the generated voice, the voice’s style and pace.
Options
TextToSpeech
TextToSpeech.PhonemeInfo
Provides a map of what phoneme is said at what time in the synthesized speech.
PhonemeInfo
TextToSpeech
TextToSpeech.WordInfo
Parameter returned in the onTTSCompleteHandler
callback providing timing details for word pronunciation.
WordInfo
TextToSpeech
TouchDataProvider
This provider is returned by global.touchSystem
and allows your lens to handle any touches on the screen, and optionally let certain touch types to pass through (let Snapchat handle the touch).
Possible TouchType exception values:
- "TouchTypeNone"
- "TouchTypeTouch"
- "TouchTypeTap"
- "TouchTypeDoubleTap"
- "TouchTypeScale"
- "TouchTypePan"
- "TouchTypeSwipe"
TouchDataProvider
TouchMoveEventArgs
Arguments used with the InteractionComponent.onTouchMove
event.
TouchMoveEventArgs
TouchStartEventArgs
Arguments used with the InteractionComponent.onTouchStart
event.
TouchStartEventArgs
TrackedMesh
Represents a mesh generated by world tracking. Only available when world mesh tracking is supported and enabled.
TrackedMesh
TrackedMeshHistogramResult
Provides histogram information about tracked world mesh faces in a given area. Returned by DeviceTracking.calculateWorldMeshHistogram()
.
TrackedMeshHistogramResult
TrackedMeshHitTestResult
Provides information about a TrackedMesh surface hit during a raycast. Is returned in an array when calling DeviceTracking.hitTestWorldMesh()
or DeviceTracking.raycastWorldMesh()
.
TrackedMeshHitTestResult
TrackedPlane
A representation for plane detected by native tracking. Can be used with TrackedPoint.
TrackedPlane
TrackedPoint
A point on the real world not attached to any detected plane.
TrackedPoint
Transform
Controls the position, rotation, and scale of a SceneObject. Every SceneObject automatically has a Transform attached.
Transform
Transformer
Applies additional transform processing on data for InputPlaceholders and OutputPlaceholders used with MLComponent. For more information, see the MLComponent Overview.
Transformer
TransformerBuilder
Builds Transformer objects for MLComponent.
TransformerBuilder
TriangleHit
Triangle hit information, available when a ray cast intersects a collision mesh.
Physics.TriangleHit
TriggerPrimaryEventArgs
Arguments used with the InteractionComponent.onTriggerPrimary
event.
TriggerPrimaryEventArgs
UserContextSystem
Provides information about the user such as display name, birthday, and current weather. Accessible through global.userContextSystem
.
All callbacks will execute as soon as the requested information is available. In some rare cases, the requested information may be completely unavailable, and the callback will never occur.
Note that formatted or localized strings may appear differently to users depending on their region.
UserContextSystem
VertexSimulationSettings
Provides settings for vertex physics in the ClothVisual component.
VertexSimulationSettings
VoiceML.AdditionalParam
Additional parameters are used to provide additional data for NlpModels and NlpResponses.
AdditionalParam
VoiceML
VoiceML.BaseNlpModel
NlpModels are used to provide the VoiceML NLP engine information about how the transcript of the input audio should be processed. BaseNlpModels is the abstract base class all NlpModels (NlpKeywordModel, NlpIntentModel) inherit from.
You can specify multiple NlpModels to process the same audio, all of their results will be returned in ListeningUpdateEventArgs
BaseNlpModel
VoiceML
VoiceML.NlpIntentModel
, VoiceML.NlpKeywordModel
VoiceML.BaseNlpResponse
The abstract base class all NlpResponses inherit from. NlpResponses are used as the result from the VoiceML NLP engine with information after processing the transcript of the input audio.
BaseNlpResponse
VoiceML
VoiceML.KeywordModelGroup
An NLP model used to detect keywords in the transcript of the input audio. For example, you can have keyword detection which will trigger every time the word "red" is said, and another trigger for the word "yellow".
KeywordModelGroup
VoiceML
VoiceML.ListeningErrorEventArgs
ListeningErrorEventArgs object returns in onListeningError callback. It contains the error code and description of the error.
ListeningErrorEventArgs
VoiceML
VoiceML.ListeningOptions
Provides the configuration for the audio input processing output. This can either include NLP processing using the (nlpModels) or directly retrieving the transcription. speechContext
provides the ability to further improve the transcription accuracy given an assumed context.
ListeningOptions
VoiceML
VoiceML.ListeningUpdateEventArgs
The parameter when the callback registered on from VoiceMLModule.onListeningUpdate
is called. This is to mark the input audio transcription (and possibly NlpModels as a result) was updated.
ListeningUpdateEventArgs
VoiceML
VoiceML.NlpCommandResponse
May be returned when enableSystemCommands() API is used. The NlpCommandResponse contains the results of the servers' NLP command model classification on the last sentence and indicates that a predetermined system command was detected. Current supported commands:
- “Take a Snap”: takes a snapshot.
- “Start Recording”: starts a video recording if not already started.
- "Stop Recording”: stops an ongoing video recording, if applicable.
NlpCommandResponse
VoiceML
VoiceML.NlpIntentModel
Specifies which NLP Intent model should run to classify the transcription of the input audio. NLP Intent classification meant to extract the meaning of a sentence rather than detecting certain keywords. Multiple intent models can be used on the same transcription, and will run only on complete sentences (isFinalTranscription = True
). Supported intent models: VOICE_ENABLED_UI
.
NlpIntentModel
VoiceML
VoiceML.NlpIntentResponse
Returned when NlpIntentModel was specificed in the ListeningOptions, it contains the results of the NLP Intent model classification on the last sentence. NlpIntentResponse
will only run on complete sentences (isFinalTranscription = true
).
NlpIntentResponse
VoiceML
VoiceML.NlpKeywordModel
Used to detect usage of certain keywords from the input audio.
Keyword detection (whose results will be returned in NlpKeywordResponse in the ListeningUpdateEventArgs) can happen in the mid input sentence (and in such case the the isFinalTranscription=false) or can happen at the end of the sentence (isFinalTranscription=true). Mid sentence detection have closer proximity to the time the word was spoken, but might be less accurate.
NlpKeywordModel
VoiceML
VoiceML.NlpKeywordResponse
NlpKeywordResponse will be returned if KeywordModel has been supplied as an input model in the ListeningOptions. The keyword model allows detection of keywords (or short phrases) in an input audio.
NlpKeywordResponse
VoiceML
VoiceML.NlpResponseStatus
The NLP Response Status indicates wether the NLP was successful in parsing the sentence.
NlpResponseStatus
VoiceML
VoiceML.PostProcessingAction
The PostProcessingAction
is the base class for QnaAction
and other post processing actions that need to processed after the transcription phase.
PostProcessingAction
VoiceML
VoiceML.QnaAction
VoiceML.PostProcessingActionResponse
The PostProcessingActionResponse
is the base class for QnaActionRespose
and other post processing actions responses. It holds the id and status properties for all deriving objects.
PostProcessingActionResponse
VoiceML
VoiceML.QnaResponse
VoiceML.PostProcessingActionResponseStatus
PostProcessingActionResponseStatus
VoiceML
VoiceML.QnaAction
QnaAction
VoiceML
VoiceML.QnaResponse
QnaResponse
VoiceML
VoiceML.SpeechContext
Speech context is used in cases where specific words are expected from the users, the transcription accuracy of these words can be improved, by straightening their likelihood in context. The strength is scaled 1-10 (10 being the strongest increase) the default value is 5.
SpeechContext
VoiceML
WorldOptions
Holds settings for world mesh tracking in DeviceTracking component. Accessible through DeviceTracking.worldOptions.
WorldOptions
WorldTrackingCapabilities
Provides information about whether certain world tracking features are supported by the device.
WorldTrackingCapabilities