adam-sdk
    Preparing search index...

    Interface SpeakOptions

    Options for the speak(text, options) command form. These options allow for customization of the avatar's speech. Arbitrary additional key/value pairs are allowed and will be forwarded to the iframe payload.

    interface SpeakOptions {
        animation?: string | { name: string };
        expression?: string | { intensity?: number; name: string };
        pitch?: number;
        rate?: number;
        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? pitch? rate? voice?

    Properties

    animation?: string | { name: string }

    An optional animation to be played while the avatar is speaking. This should correspond to an animation available in the avatar's configuration.

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

    An optional expression to be set on the avatar while it is speaking. This should correspond to an expression available in the avatar's configuration.

    pitch?: number

    The pitch of the avatar's voice. This is a number that modifies the default pitch. A value of 1 is the default pitch. Values less than 1 are lower, and values greater than 1 are higher.

    rate?: number

    The rate at which the avatar speaks. This is a number that modifies the default speech rate. A value of 1 is the default rate. Values less than 1 are slower, and values greater than 1 are faster.

    voice?: string | { id: string }

    The voice to be used for the speech. This should correspond to a voice available in the avatar's configuration.

    Settings

    Member Visibility

    On This Page

    Properties