Skip to main content

smwebsdk

Home > @soulmachines/smwebsdk

smwebsdk package

Classes

ClassDescription
ConnectionStateDetermines and stores Connection State.
ContentAwareness

ContentAwareness class

An instance of this class is used to enable CUE behaviors in the digital human. This is achived by measuring tagged HTML elements and sending their coordinates back to the server

See documentation on GitHub for further reference on how to use this API https://github.com/soulmachines/smwebsdk/blob/cue-content-awareness-api/guide/content-awareness.md

ContentCardFormatterFormats content card data in a consistent structure
ConversationStores content cards and conversation state
ConversationStateDetermines and stores Conversation State.
PersonaPersona class to control a scene persona
SceneScene class to hold a webrtc connection to a scene containing a persona.
SceneResponseError
SmEventAn event which can have a set of listeners registered against it using addListener().

Enumerations

EnumerationDescription
ConnectionStateTypes
ConversationStateTypes
NLPIntent
UserMediaRepresents the different combinations of User Media that are supported
WebsocketKind

Interfaces

InterfaceDescription
AnimateToNamedCameraRequestBody
ConnectionStateData
ConnectOptionsConfiguration to use when connecting to a Scene
ConversationResultResponseBody
ConversationSendRequestBody
ConversationSetVariablesRequestBody
GetModelChildrenRequestBody
GetModelFilterSearchResultRequestBody
GetModelVariableFilterSearchResultRequestBody
GetModelVariablesListRequestBody
GetVariablesRequestBody
PersonaRequestBody
PlayAnimationRequestBody
RecognizeResultsResponseBody
RetryOptions
SceneOptionsConfiguration to use when constructing a Scene
SceneRequest
SceneResponse
SetVariablesRequestBody
SpeechMarkerResponseBody
StartRecognizeRequestBody
StartSpeakingOptionalArgs
StartSpeakingRequestBody
StateResponseBody
StopBlProfilingRequestBody
UpdateContentAwarenessRequestBody

Variables

VariableDescription
smwebsdk

Type Aliases

Type AliasDescription
ContentCard
ContentCardFormattedData
ContentCardRawData
DemoModeResponseBody
GetVariablesListRequestBody
LoggingConfig
LogLevel
MediaDeviceOptions
SceneRequestBody