AVP 3DWS Deck Documentation
    Preparing search index...

    Interface DeckConfig

    Configuration object that is fetched when component mounts

    interface DeckConfig {
        animations?: string[];
        aveMessageTimeout?: number;
        brand?: Brand;
        cameraFlight?: string;
        cameraFlightOnStart?: boolean;
        dayEnvironment?: string;
        enableAnimationSpots?: boolean;
        environments?: string[];
        exteriorCameras?: string[];
        features?: Partial<
            {
                animations: boolean;
                animationSpots: boolean;
                cameraFlight: boolean;
                cameraNavigation: boolean;
                close: boolean;
                environments: boolean;
                fullscreen: boolean;
                interior: boolean;
                lightAnimations: boolean;
                showroomPro: boolean;
                trunkAnimations: boolean;
                zoom: boolean;
            },
        >;
        inactivityTimeout?: number;
        initialCamera?: string;
        initialEnvironment?: string;
        interiorCameras?: string[];
        lightAnimations?: string[];
        market?: string;
        nightEnvironment?: string;
        reconnectGracePeriod?: number;
        service?: string;
        showroomPro?: { cameras?: Record<string, string[]> };
        streamingStage?: DeckStage;
        template?:
            | "default"
            | "ngc"
            | "vw"
            | "vw-exhibition"
            | "alpha"
            | "alpha-exhibition"
            | "alpha-customizer"
            | "lamborghini-exhibition";
        trunkAnimations?: string[];
    }
    Index
    animations? aveMessageTimeout? brand? cameraFlight? cameraFlightOnStart? dayEnvironment? enableAnimationSpots? environments? exteriorCameras? features? inactivityTimeout? initialCamera? initialEnvironment? interiorCameras? lightAnimations? market? nightEnvironment? reconnectGracePeriod? service? showroomPro? streamingStage? template? trunkAnimations?
    animations?: string[]

    Animation IDs that are allow-listed for the existing animations menu.

    • If undefined (omitted), all AVE-installed animations are shown (current behavior).
    • If an empty array, the animations menu is hidden (empty allow-list).
    • Matching is case-insensitive against AVE-installed animation IDs.
    aveMessageTimeout?: number

    The duration in seconds that 3D Showroom will wait for a response from the AVE before throwing an error

    brand?: Brand

    The brand to provide the stream of.

    cameraFlight?: string

    Defines the camera flight to be used for the "play" button

    cameraFlightOnStart?: boolean

    Defines if the camera flight should be started automatically on stream start

    dayEnvironment?: string

    Providing a day and a night environment will show a button that toggles between the two environments.

    enableAnimationSpots?: boolean

    Defines if the animation spots should be enabled automatically on stream start

    environments?: string[]

    Environment IDs that are whitelisted for the current brand If this is provided, the user will be able to select environments from the gallery. Also, this configuration property cancels out DeckProperties | dayEnvironment and DeckProperties | nightEnvironment environments.

    exteriorCameras?: string[]

    Exterior cameras that users can use.

    features?: Partial<
        {
            animations: boolean;
            animationSpots: boolean;
            cameraFlight: boolean;
            cameraNavigation: boolean;
            close: boolean;
            environments: boolean;
            fullscreen: boolean;
            interior: boolean;
            lightAnimations: boolean;
            showroomPro: boolean;
            trunkAnimations: boolean;
            zoom: boolean;
        },
    >

    Enabled features

    inactivityTimeout?: number

    The duration in seconds that the session remains active with no inputs from the user

    initialCamera?: string

    Default camera that loads with the app. If not provided, the first camera from DeckProperties | cameras will be used. Alternatively, DeckProperties | exteriorCamera is used if it is provided. Finally, if none provided, the AVE default camera is loaded.

    initialEnvironment?: string

    Default environment that loads with the app. If not provided, the first environment from DeckProperties | environments will be used. Alternatively, DeckProperties | dayEnvironment is used if it is provided. Finally, if none provided, the AVE default environment is loaded.

    interiorCameras?: string[]

    Interior camera is used with the camera switching button.

    lightAnimations?: string[]

    Animation IDs that are allow-listed for the light animations menu. Light animations are a subset of regular AVE animations - the same ID may appear in both animations and lightAnimations and will be shown in both menus, sharing toggle state via the same AVE animation backend.

    • If undefined or empty array, the trunk animations menu is hidden.
    • Matching is case-insensitive against AVE-installed animation IDs.
    market?: string

    The market to provide the stream for as an alpha 3 country code.

    nightEnvironment?: string

    Providing a day and a night environment will show a button that toggles between the two environments.

    reconnectGracePeriod?: number

    The duration in seconds that the session remains active after the last client disconnects

    service?: string

    The name of service to provide the stream for.

    showroomPro?: { cameras?: Record<string, string[]> }

    Per-option-group camera configuration for Showroom Pro. Keys are API section names (paints, wheels, mainHides, secondaryHides). Values are arrays of camera IDs to cycle through.

    streamingStage?: DeckStage

    The Stage | 3d web streaming stage to use for the stream.

    template?:
        | "default"
        | "ngc"
        | "vw"
        | "vw-exhibition"
        | "alpha"
        | "alpha-exhibition"
        | "alpha-customizer"
        | "lamborghini-exhibition"

    Design template. Audi defaults to NGC, and others use the default design.

    DeckTemplate

    trunkAnimations?: string[]

    Animation IDs that are allow-listed for the trunk animations menu. Trunk animations are a subset of regular AVE animations - the same ID may appear in both animations and trunkAnimations and will be shown in both menus, sharing toggle state via the same AVE animation backend.

    • If undefined or empty array, the trunk animations menu is hidden.
    • Matching is case-insensitive against AVE-installed animation IDs.

    Settings
    Member Visibility

    On This Page
    Properties