microsoft-cognitiveservices-speech-sdk/distrib/lib/src/sdk/AvatarSceneConfig.d.ts

Microsoft Cognitive Services Speech SDK for JavaScript

/**
 * Defines the avatar scene configuration for controlling avatar positioning and orientation.
 * @class AvatarSceneConfig
 * Added in version 1.44.0
 *
 * @experimental This feature is experimental and might change or have limited support.
 */
export declare class AvatarSceneConfig {
    /**
     * The zoom level of the avatar. Value should be between 0 and 1, where 1 is the default (no zoom).
     * @default 1.0
     */
    zoom: number;
    /**
     * The horizontal position offset of the avatar. Value should be between -1 and 1, where 0 is centered.
     * @default 0.0
     */
    positionX: number;
    /**
     * The vertical position offset of the avatar. Value should be between -1 and 1, where 0 is centered.
     * @default 0.0
     */
    positionY: number;
    /**
     * The rotation around the X axis (pitch) in radians.
     * @default 0.0
     */
    rotationX: number;
    /**
     * The rotation around the Y axis (yaw) in radians.
     * @default 0.0
     */
    rotationY: number;
    /**
     * The rotation around the Z axis (roll) in radians.
     * @default 0.0
     */
    rotationZ: number;
    /**
     * The amplitude of the avatar's movements. Value should be between 0 and 1, where 1 is the default (full amplitude).
     * @default 1.0
     */
    amplitude: number;
    /**
     * Creates and initializes an instance of this class with default values.
     * @constructor
     * @param {number} zoom - The zoom level (0-1, default 1.0).
     * @param {number} positionX - The horizontal position offset (-1 to 1, default 0.0).
     * @param {number} positionY - The vertical position offset (-1 to 1, default 0.0).
     * @param {number} rotationX - The rotation around the X axis in radians (default 0.0).
     * @param {number} rotationY - The rotation around the Y axis in radians (default 0.0).
     * @param {number} rotationZ - The rotation around the Z axis in radians (default 0.0).
     * @param {number} amplitude - The amplitude of the avatar's movements (0 to 1, default 1.0).
     */
    constructor(zoom?: number, positionX?: number, positionY?: number, rotationX?: number, rotationY?: number, rotationZ?: number, amplitude?: number);
}