adam-sdk
    Preparing search index...

    Interface SpeakOptions

    Options for the speak command. These options allow for customization of the avatar's speech.

    interface SpeakOptions {
        animation?: string;
        expression?: string;
        pitch?: number;
        rate?: number;
        voice?: string;
    }
    Index

    Properties

    animation? expression? pitch? rate? voice?

    Properties

    animation?: 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

    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

    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