Interface DeckConfig

Configuration object that is fetched when component mounts

interface DeckConfig {
    brand?: Brand;
    cameraFlightOnStart?: boolean;
    dayEnvironment?: string;
    enableAnimationSpots?: boolean;
    environments?: string[];
    exteriorCameras?: string[];
    features?: Partial<{
        animationSpots: boolean;
        animations: boolean;
        cameraFlight: boolean;
        cameraNavigation: boolean;
        close: boolean;
        environments: boolean;
        fullscreen: boolean;
        interior: boolean;
        zoom: boolean;
    }>;
    inactivityTimeout?: number;
    initialCamera?: string;
    initialEnvironment?: string;
    interiorCameras?: string[];
    market?: string;
    nightEnvironment?: string;
    reconnectGracePeriod?: number;
    service?: string;
    streamingStage?: StreamingStage;
    template?: DeckTemplate;
}

Properties

brand? cameraFlightOnStart? dayEnvironment? enableAnimationSpots? environments? exteriorCameras? features? inactivityTimeout? initialCamera? initialEnvironment? interiorCameras? market? nightEnvironment? reconnectGracePeriod? service? streamingStage? template?

Properties

Optional brand

brand?: Brand

The brand to provide the stream of.

Optional cameraFlightOnStart

cameraFlightOnStart?: boolean

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

Optional dayEnvironment

dayEnvironment?: string

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

Optional enableAnimationSpots

enableAnimationSpots?: boolean

Optional environments

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.

Optional exteriorCameras

exteriorCameras?: string[]

Exterior cameras that users can use.

Optional features

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

Enabled features

Type declaration

  • animationSpots: boolean
  • animations: boolean
  • cameraFlight: boolean
  • cameraNavigation: boolean
  • close: boolean
  • environments: boolean
  • fullscreen: boolean
  • interior: boolean
  • zoom: boolean

Optional inactivityTimeout

inactivityTimeout?: number

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

Optional initialCamera

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.

Optional initialEnvironment

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.

Optional interiorCameras

interiorCameras?: string[]

Interior camera is used with the camera switching button.

Optional market

market?: string

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

Optional nightEnvironment

nightEnvironment?: string

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

Optional reconnectGracePeriod

reconnectGracePeriod?: number

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

Optional service

service?: string

The name of service to provide the stream for.

Optional streamingStage

streamingStage?: StreamingStage

Optional template

template?: DeckTemplate

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

See

DeckTemplate

Settings

Member Visibility

Theme

On This Page

brandcameraFlightOnStartdayEnvironmentenableAnimationSpotsenvironmentsexteriorCamerasfeaturesinactivityTimeoutinitialCamerainitialEnvironmentinteriorCamerasmarketnightEnvironmentreconnectGracePeriodservicestreamingStagetemplate