Class AvatarSDK

The main class for interacting with the A.D.A.M. 3D avatar. This class provides methods for connecting to the avatar, making it speak, and controlling its animations and expressions.

Example

import { AvatarSDK } from 'adam-sdk';

const iframe = document.getElementById('avatar-iframe');
const sdk = new AvatarSDK(iframe);

sdk.on('ready', () => {
  console.log('SDK is ready!');
  sdk.speak('Hello, world!');
});

sdk.connect();

Index

Constructors

constructor

Methods

connect destroy interrupt off on playAnimation setExpression speak

Constructors

constructor

new AvatarSDK(
iframeElement: HTMLIFrameElement,
options?: AvatarSDKOptions,
): AvatarSDK
Creates an instance of the AvatarSDK.
Parameters
- iframeElement: HTMLIFrameElement
  The HTMLIFrameElement that contains the avatar.
- options: AvatarSDKOptions = {}
  Configuration options for the SDK.
Returns AvatarSDK
- Defined in index.ts:38

Methods

connect

connect(): Promise<void>
Establishes a connection with the avatar iframe. This method must be called before any other commands can be sent to the avatar. It returns a promise that resolves when the connection is established.

Returns Promise<void>
A promise that resolves when the connection is established.

Throws
An error if the connection times out or the iframe fails to load.
- Defined in index.ts:54

destroy

destroy(): void
Cleans up resources and removes event listeners. This should be called when the SDK is no longer needed to prevent memory leaks.

Returns void
- Defined in index.ts:176

interrupt

interrupt(): Promise<any>
Interrupts the current speech or action.

Returns Promise<any>
A promise that resolves when the interrupt is complete.
- Defined in index.ts:135

off

off(eventName: AvatarEvent, callback: EventCallback): void
Removes an event listener for a specific event.
Parameters
- eventName: AvatarEvent
  The name of the event to remove the listener from.
- callback: EventCallback
  The callback function to remove.
Returns void
- Defined in index.ts:162

on

on(eventName: AvatarEvent, callback: EventCallback): void
Registers an event listener for a specific event.
Parameters
- eventName: AvatarEvent
  The name of the event to listen for.
- callback: EventCallback
  The callback function to execute when the event is triggered.
Returns void
Example
```
sdk.on('speech:start', (payload) => {
  console.log('Avatar started speaking:', payload.text);
});
```
- Defined in index.ts:150

playAnimation

playAnimation(name: string, loop?: boolean): Promise<any>
Triggers a specific animation by name.
Parameters
- name: string
  The name of the animation to play.
- loop: boolean = false
  Whether the animation should loop.
Returns Promise<any>
A promise that resolves with the command result.
- Defined in index.ts:118

setExpression

setExpression(name: string): Promise<any>
Sets the avatar's facial expression.
Parameters
- name: string
  The name of the expression to set.
Returns Promise<any>
A promise that resolves with the command result.
- Defined in index.ts:127

speak

speak(text: string, options?: SpeakOptions): Promise<any>
Makes the avatar speak the provided text.
Parameters
- text: string
  The text for the avatar to speak.
- options: SpeakOptions = {}
  Additional options for speech, such as voice, rate, and pitch.
Returns Promise<any>
A promise that resolves when the command is acknowledged by the iframe.

Throws
An error if the text is not a non-empty string.
- Defined in index.ts:104

Class AvatarSDK

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AvatarSDK

Methods

connect

Returns Promise<void>

Throws

destroy

Returns void

interrupt

Returns Promise<any>

off

Parameters

Returns void

on

Parameters

Returns void

Example

playAnimation

Parameters

Returns Promise<any>

setExpression

Parameters

Returns Promise<any>

speak

Parameters

Returns Promise<any>

Throws

Settings

On This Page