adam-sdk
    Preparing search index...

    Interface SpeakPayload

    Object payload for the speak({ text, ... }) command form. Supports known fields and allows arbitrary additional properties such as backgroundUrl, sceneId, etc.

    interface SpeakPayload {
        animation?: string | { name: string };
        expression?: string | { intensity?: number; name: string };
        text: string;
        voice?: string | { id: string };
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Any additional custom key/value pairs to forward to the iframe payload.

    Index

    Properties

    animation? expression? text voice?

    Properties

    animation?: string | { name: string }

    Animation can be a simple name string or an object with a name

    expression?: string | { intensity?: number; name: string }

    Expression can be a simple name string or an object with a name/intensity

    text

    text: string

    The text for the avatar to speak.

    voice?: string | { id: string }

    Voice can be a simple id string or an object with an id

    Settings

    Member Visibility

    On This Page

    Properties