---
version: "2.0.0"
language: "en"
---
# Igloo Core Engine Documentation

*

  ## [Core Concepts](https://docs.igloovision.com/documentation/current/core-concepts.md)

### [Tutorials](https://docs.igloovision.com/documentation/current/tutorials.md)

### [Reference Guides](https://docs.igloovision.com/documentation/current/reference-guides.md)

### [What's New?](https://docs.igloovision.com/documentation/current/what-s-new.md)

---
version: "2.0.0"
language: "en"
---
# 1.1.0

## Igloo Core Engine

See [Upgrade Process](https://docs.igloovision.com/documentation/current/upgrade-process.md) for guidance on updating Igloo Core Engine

### Core

* Added a screen window minimize function to layers, making it easier to display 3rd party applications in fullscreen mode. [Misc \| Hide/Show windows](https://docs.igloovision.com/documentation/current/misc.md#Hide/Show-windows)

* Cursor position now maps correctly with True Perspective and Cubemap to Equirectangular Effects applied. Does not support Composition layers yet.

* Canvas rotation is now available. [Canvas Configuration](https://docs.igloovision.com/documentation/current/canvas-configuration.md)

* Touchscreen support has been added to Desktop UI.

* Custom head position setting for True Perspective effect per layer is now possible. [Effects \| Custom Head Position](https://docs.igloovision.com/documentation/current/effects.md#Custom-Head-Position)

* Fixed True Perspective head position scaling issue

You may need to reconfigure the head position setting after updating

* The tags system has been improved.

* Set layout is now visible on Desktop UI. [Layouts \& Regions Window \| Show Layout](https://docs.igloovision.com/documentation/current/layouts-window.md#Show-Layout)

* License expiration warning is now displayed using Windows system notifications

* Added support for DDS Cubemap format.

* Scale is now reset to 1.0 when Resize mode is changed

* Performance has been improved.

* Content library filtering is now available.

* Default volume setting for new layers added

* Access Igloo Control Panel download page via help menu

* Access program data folder via help menu

* Configure logging level for Log files and Console logging [Logging](https://docs.igloovision.com/documentation/current/logging.md)

### Layers

* WebView - updated to Chromium 103 version

* Home - now has a switch active Home layout using a Tile component. [Home Components \| Layout Tile](https://docs.igloovision.com/documentation/current/home-components.md#Layout-Tile)

### Canvas UI

* Content Bank UI is now available for moving to the next/previous clip and controlling playback of a video tile. [Canvas UI - Content Bank Control](https://docs.igloovision.com/documentation/current/canvas-ui-content-bank-control.md)

* Custom options when creating a new WebView are now available.

* Waiting for sender information has been added to NDI and Spout layers.

* WebView Login form has been added.

* Home button remains visible when Canvas toolbar is collapsed

## Igloo Control Panel

* Added PlayStation 5 Dual Sense controller support with Gyroscope data for Realtime applications.

## Igloo Setup

* Added the ability to export canvas settings and Unity settings. [Igloo Setup \| Export](https://docs.igloovision.com/documentation/current/igloo-setup.md#Export)

* Auto-arranging of floor screens is now available.

* UI theme has been updated.

* Dome screen type has been added.

---
version: "2.0.0"
language: "en"
---
# 1.2.x

See [Upgrade Process](https://docs.igloovision.com/documentation/current/upgrade-process.md) for guidance on updating Igloo Core Engine

## 1.2.1

### Bug Fixes

* **Gyroscope Calibration**: Fixed the Control Panel calibration issue

* **Datapath Capture Layer**: Resolved an issue caused by deleting Datapath layers

* **Content Bank Loading**: Addressed a crash issue when loading content with a true perspective effect applied.

* **True Perspective Output**: Rectified the visible seam which occurred at certain resolutions

* **License Version**: Updated version number tracking.

* **Iglo Control Panel (Desktop)** : Fixed connection issue related to network address. Requires updating Igloo control panel. See [Upgrade Process](https://docs.igloovision.com/ice-documentation/1.2.0/upgrade-process)

*** ** * ** ***

### **Release Highlights**

* **Current session editing :**now you can seamlessly edit your current session in Igloo Core Engine without interruption.

* **Canvas recording**

* **Content Bank updates** **:** we have made significant updates to the Content Bank, enhancing its usability and functionality.

* **Layer API :**introducing the Layer API for developers and system integrators, enabling seamless integration with Igloo Core Engine.

* **Content Bank app on Igloo Control Panel :**access the Content Bank directly from the Igloo Control Panel

* **Model Viewer app - Beta version :**try out the beta version of our new Model Viewer app.

* **Desktop UI updates :**an updated user interface on the desktop with various improvements and new features.

* **Interactive Shader Format support :**Igloo Core Engine now supports Interactive Shader Format, allowing for more advanced shader effects.

## Igloo Core Engine

### Core

* Layer API : Developers can now leverage the Layer API for seamless integration with Igloo Core Engine.

* Canvas Recording and Screenshot : [Canvas Recording \| Screenshot](https://docs.igloovision.com/documentation/current/canvas-recording.md)

* Cursor "Lock to Region" functionality : easily restrict the cursor movement to a specific region within the Canvas. [Initial Setup \| Lock Cursor To Region](https://docs.igloovision.com/documentation/current/setup.md#Lock-Cursor-To-Region)

* Current Session editing - [Sessions](https://docs.igloovision.com/documentation/current/sessions.md)

* Desktop UI : introducing a new toolbar in the desktop interface for easy control of properties like the mini-map and volume.

* Desktop UI : canvas mini map and interaction with the layer tab

* Upsampling and downsampling image filters: to reduce image aliasing on images and home components

* Auto-mute hidden layers: optionally set hidden layers to be automatically muted [General \| Enabled](https://docs.igloovision.com/documentation/current/general.md#Enabled)

* Interactive Shader Format support: Igloo Core Engine now supports Interactive Shader Format, allowing for more advanced shader effects. [Interactive Shader Format (ISF)](https://docs.igloovision.com/documentation/current/interactive-shader-effects-isf.md)

* Scalable SDK: integration of the Scalable SDK for camera-based warping and blending.

### Layers

#### YouTube

* YouTube 'share' formatted URL's are now correctly handled - <https://youtu.be/dpwsDMkab_o>

* Presets : Quickly configure the layer for different YouTube video formats, including non-360 videos and 360 3D videos [YouTube - 360 \| Presets](https://docs.igloovision.com/documentation/current/youtube-360.md#Presets)

#### Content Bank

[Content Bank](https://docs.igloovision.com/documentation/current/content-bank.md)

* Streamlined for usability: we have improved the Content Bank's usability based on user feedback. Refer to the updated documentation for detailed information.

  * Easily access and modify settings for the active clip without entering "edit" mode

  * 'Bank' \| 'Tile' \| 'Settings' tab system

* Configurable number of grid rows and columns

* Custom and Dynamic content bank resolution settings

* Launch sessions from a Content Bank tile: Start sessions directly from a Content Bank tile.

* Images and Sessions in Playlist mode: images and sessions in playlist mode, with configurable duration periods.

### Canvas UI

* Improved session management via toolbar

## Igloo Control Panel

### Core

#### Mouse \& Keyboard

* Presentation mode: show 'back' and 'forward' buttons to easily navigate through a presentation

### Apps

#### Content Bank

* View and control Content Bank layers from within Igloo Control Panel [Content Bank App](https://docs.igloovision.com/documentation/current/content-bank-app.md)

#### Model Viewer

* Beta version: try out the beta version of our new Model Viewer app, designed to provide a simple workflow for viewing basic 3D models in Igloo Core Engine. [Simple Model Viewer (deprecated)](https://docs.igloovision.com/documentation/current/simple-model-viewer-deprecated.md)

## Integrations

### Revit \& Navis

* NDI output

* Support for version 2024

---
version: "2.0.0"
language: "en"
---
# 1.3.x

## 1.3.1 - Hotfix

### Bug Fixes

* **NDI :** Corrected an issue in which the NDI mDNS finder thread impeded proper shutdown under certain network conditions, resulting in residual process instances remaining active

<!-- -->

* **WebView:** Mitigated a crash/hang caused by WebView layer removal

* **Audio:** Resolved an issue where ASIO audio devices disconnecting led to unexpected disruptions.

<!-- -->

* **TUIO :** Optimised message input handling to prevent overloading due to multiple concurrent devices.

* **Watch Folders:** Resolved an issue in which scanning for changes in large media file libraries could cause a crash.

## 1.3.0

### Highlights

* **Stereo 3D** : Enables output to stereo 3D displays [Stereo 3D](https://docs.igloovision.com/documentation/current/stereo-3d.md)

* **Import \| Export system** : Allows the sharing of layers and sessions between different systems, including all associated assets. [Import \& Export System](https://docs.igloovision.com/documentation/current/import-export-system.md)

* **Annotation (Beta):** Annotate the Canvas through the use of Pen, Text and Shape tools. [Canvas UI - Annotation](https://docs.igloovision.com/documentation/current/canvas-ui-annotation.md)

* **Control Panel - Layer Management**: View and edit layers in the workspace, including geometry adjustment and layer removal

* **Example Sessions:** a range of example sessions files are now included with the installation and can be found in C*:\\ProgramData\\Igloo Vision\\IglooCoreEngine\\example sessions.* These can be imported using the Session**Import Folder** functionality - [Import \& Export System \| Import folder](https://docs.igloovision.com/documentation/current/import-export-system.md#Import-folder)

## Igloo Core Engine

### Core

* **Stereo 3D** : Enables output to stereo 3D displays [Stereo 3D](https://docs.igloovision.com/documentation/current/stereo-3d.md)

* **Import \| Export system** : Allows the sharing of layers and sessions between different systems, including all associated assets. [Import \& Export System](https://docs.igloovision.com/documentation/current/import-export-system.md)

* **Workspace Templates** : Predefined configurations for workspaces that serve as a starting point for creating new workspaces. [Workspace \| Templates](https://docs.igloovision.com/documentation/current/workspace.md#Templates)

* **TUIO** : Enables the canvas cursor to be controlled using the TUIO protocol, supporting TUIO-based touchscreen devices. [Touch Screen Support](https://docs.igloovision.com/documentation/current/touch-screen-support.md)

* **Always on Top**: Forces screen windows to remain visible on top of other application windows.

* **Dynamic Console Window**: Show and Hide console window at runtime.

* **Desktop UI updates**: new UI widgets and improved styling throughout

* **File Browser improvements**: Favorites are saved

* **Igloo Setup**: Simplifies the process with a drag-and-drop functionality for Screen model and True Perspective files directly into Igloo Core Engine

*** ** * ** ***

### Layers

#### All

* **Layer Duplication**

* **Move to Region**: New feature to move a layer to a region without also locking it to that region. Possible via both Canvas and Desktop UI

* **New Effects:**

  * Plane to Equirectangular: Transform flat images into 360-degree equirectangular projections

  * Fisheye (ISF)

  * Advanced Cropping (ISF)

  * Vertical Stretch (ISF)

* **Metadata** : Enhance your layers with additional context and information [Misc \| Metadata](https://docs.igloovision.com/documentation/current/misc.md#Metadata)

#### Content Bank

* **Improved Drag and Drop from explorer**: Enhanced multi-file drag and drop support from Windows Explorer onto a Content Bank grid.

* **Drag between Tiles**: drag content to different tiles

#### WebView

* **Additional Desktop Controls**: New controls including refresh, page forward, and page back accessible via the Desktop UI.

* **Clear Cookies**: Option to clear cookies during runtime.

* **New Immersive Mode Apps**: Integration of both Google Maps and Matterport.

* **Zoom Level** : the zoom level is now stored as a property of a layer when saving

#### YouTube 360

* **Auto-Detection of YouTube Video Resolution** : This feature automatically determines and adjusts to the optimal resolution for YouTube videos.[YouTube - 360 \| Presets](https://docs.igloovision.com/documentation/current/youtube-360.md#Presets)

* **Handling of Video URLs with Start Times**: process YouTube video URLs that include specific start times.

#### Home

* **Theme Duplication**: Ability to duplicate Home themes.

* **Grid Fill Type Warning**: A new warning dialogue appears when changing the Grid fill type.

* **Layout Reordering**: functionality for reordering Home layouts

* **Geometry Labels**: pixel values displayed for position and resolution of components

### Canvas UI

* **URL Opening in WebView**: A new contextual menu allows URLs to be opened within a new WebView layer.

* **Widget Position Saving**: Positions of Video and YouTube widgets are now automatically saved.

* **Toolbar State**: The collapsed state of the toolbar is now remembered between workspaces.

* **Menu Grouping**: Improved navigation with grouped menu items for NDI sources and Layer Regions.

* **Annotation (Beta):** Annotate the Canvas through the use of Pen, Text and Shape tools. [Canvas UI - Annotation](https://docs.igloovision.com/documentation/current/canvas-ui-annotation.md)

* **New Immersive Mode Apps**: Integration of both Google Maps and Matterport.

*** ** * ** ***

### Media Library

* **Enhanced Media File Deletion** : More options and clearer interface for deleting media files. [Media Files \| Removing Media Files](https://docs.igloovision.com/documentation/current/media-files.md#Removing-Media-Files)

* **Tree View Context Menu**: Enhanced context menu for more efficient file management.

* **Improved Styling**: Updated widget styling

* **Improved File Detection**: Advanced detection of media file properties when dragging files from Windows Explorer.

### API

* **Workspace API**

  * **New Functions**: The API now supports a broader range of workspace management capabilities, including the creation, modification, and deletion of workspaces.

* **Session API**

  * **Persistent UUIDs**: In a significant update, sessions now utilise persistent UUIDs, replacing the previous ID system. This enhancement ensures greater consistency across different installations and facilitates easier sharing and transferability of sessions.

* **Canvas Share API**

  * **Introducing**: The newly introduced Canvas Share API gives users the capability to control their canvas sharing properties with control over Spout, NDI, and Canvas recording features. The API allows the selection of specific regions of the canvas for sharing or recording.

*** ** * ** ***

## Igloo Control Panel

### Mouse Tab

* **Auto Enable / Disable Canvas UI**: Optional setting to automate enabling and disabling the Canvas UI mode within Igloo Core Engine when starting and stopping casting.

### Layers Tab (New!)

* **Layer Management**: View and edit layers in the workspace, including geometry adjustment and layer removal

* **Contextual Controls**: Custom controls for different layers, such as YouTube and video playback, and content banks.

* **Embedded App Controls**: Integrated controls for Google Street View, Matterport, and model viewer apps

## Integrations

### Street View

* Moved to Igloo Core Service

### Matterport

* Moved to Igloo Core Service

## Upgrade Notes

### Integration of Streetview and Matterport into Igloo Core Service

The Streetview and Matterport integrations are now included within the igloo-core-service. This means there is no longer a need for separate installations for these services.

We have moved away from using multiple ports for different integrations. Both Streetview and Matterport can now be accessed through a single port, port 800, on the igloo-core-service.

The updated URLs for accessing these services are e.g.

* Streetview Control: `http://localhost:800/streetview/control/`

* Matterport Control: `http://localhost:800/matterport/control/`

For a full list of updated URLs, refer to:

* [Google Street View - Documentation](http://atlassian.net/)

* [Matterport - Documentation](http://atlassian.net/)

#### **Automatic Migration with 1.3 Installation**

The installation of 1.3 includes an automatic migration process to help with the transition to the updated system. This migration includes:

* **Service Removal**: The standalone Streetview and Matterport services will be removed. No settings are deleted during this process.

* **API Key Migration** : If existing API keys for Streetview and Matterport are found, they will be transferred to the igloo-core-service configuration file located at `C:\igloo\igloo-core-service\config.json`.

* **Favorites**: Favorites, along with Streetview and Matterport sessions, will be updated to reflect the new port 800 access point. This ensures all your saved data remains intact and easily accessible under the new system.

* **sessions**: any relevant URL's within the database are updated to use the new 800 port

* **Redirects for Old URLs** : old URLs (such as `http://localhost:9070/control/`) will automatically redirect to the new corresponding igloo-core-service URLs, in this case `http://localhost:800/streetview/control/`

### API Breaking changes

* load session message

#### `session/load?id= `

Previously the id parameter was the database ID of the session. In 1.3 this has been changed such that the id expects the UUID of the session. This can be found via the Edit Session window.

Sessions can still be loaded using the database ID using the following

#### `session/load?databaseId=10`

### Known Issues

* **WebView audio:** after prolonged usage the audio output from a WebView layer can sometimes stop outputting under certain hardware configurations

---
version: "2.0.0"
language: "en"
---
# 1.4.x

## Highlights

* **Triggers and Actions (New!)** : Allows users and integrators to create customisable experiences by defining events (Triggers) that initiate specific Actions [Triggers and Actions](https://docs.igloovision.com/documentation/current/triggers-and-actions.md)

* **Control Panel Content Library Browser:**Browse and open Sessions and media files

* **PDF Layer (New!)** : A dedicated layer for displaying PDF files, previously requiring a WebView layer [PDF](https://docs.igloovision.com/documentation/current/pdf.md)

* **AppView Layer (New!)** : Capture and display locally running applications. [AppView](https://docs.igloovision.com/documentation/current/appview.md)

* **Loopback Layer (New!)** : Capture and re-display existing layers [Loopback](https://docs.igloovision.com/documentation/current/loopback.md)

* **KRPano**:

  * Streamlined integration workflow. [KRPano viewer](https://docs.igloovision.com/documentation/current/krpano-viewer.md)

  * Control page view syncronisation

*** ** * ** ***

## Igloo Core Engine

### Core

* **Triggers and Actions (New!)** : Allows users and integrators to create customisable experiences by defining events (Triggers) that initiate specific Actions [Triggers and Actions](https://docs.igloovision.com/documentation/current/triggers-and-actions.md)

* **Desktop UI:**

  * Updated styling:

  * Tooltips

  * Copy paste context menu for text fields:

  * ISF effect names appended to labels

  * Workspace search added

  * Condensed 'Add Content' with grouped types

  * Warning before going Home

  * Content Library

    * Import new files from folder

    * Missing Files

    * Reveal in Explorer

* **Session Thumbnail Library:**A new library to manage session thumbnails for easier navigation and identification.

* **TUIO:**

  * Regions are shown on canvas

  * Optimisation improvements when using multiple devices.

* **Layouts**:

  * 'Show Layout' now shows on canvas

* **Touch Screen Input:**

  * Improved input handling for smoother drag events

* **Command Line Arguments**

  * Serval commands are available to control custom behavior when Igloo Core Engine is started [Command Line Arguments](https://docs.igloovision.com/documentation/current/command-line-arguments.md)

*** ** * ** ***

### Effects

* **Equirectangular to Domemaster:**: Transform 360-degree equirectangular content into Domemaster format.

* **True Perspective stretch:**Pre-stretch equirectangular input to account for non-360 content.

* **(ISF) Domemaster to Equirectangular**: Transform Domemaster content to 360-degree equirectangular format.

* **(ISF) Horizontal stretch:** Allows horizontal stretching of a layer, providing more control over the aspect ratio

* **(ISF) Wrap:**Allows wrap to be applied at any point in the effects chain

* **ISF Parameter Affecters:**Animate parameter values over time

*** ** * ** ***

### Layers

#### PDF (New!)

* **Dedicated layer:**previously PDF required a WebView layer

* **Media Library support:**PDF files are now managed by the media library

#### AppView (New!)

* **Capture and display local running applications**

* **Powerpoint navigation controls:**previous and next buttons for Powerpoint presentation navigation

#### Loopback (New!)

* **Capture and re-display layers**

#### Home

* **Home Warning**: Optionally display a warning message when going Home to prevent accidental loss of Session data.

#### Video

* **Audio File Support**: Playback of audio files now supported

* **End Time:**Set a custom end time

#### Image

* **Improved loading times for JPEG files**: Implemented TurboJPEG for significantly faster loading times

* **Support for .webp image format:** We now support .webp images

#### Webview

* **Transparency:**new setting to set background as transparent

#### YouTube

* **360 and Non 360 layer initialisation**: Support for both 360 and non-360 layer initialisation, allowing layers to be created ready to display either type of YouTube video.

* **Auto Max Resolution:** Control maximum resolution playback [YouTube - 360 \| Auto Max Resolution](https://docs.igloovision.com/documentation/current/youtube-360.md#Auto-Max-Resolution)

#### NDI

* **Updated to NDIv6**

#### Datapath

* **Updated SDK to version v7.29.0**

*** ** * ** ***

### Media Library

* **Delete all missing files** : [Media Files \| Delete all missing](https://docs.igloovision.com/documentation/current/media-files.md#Delete-all-missing)

* **Improved Styling**: Updated widget styling

* **Multi Selection**: Multi selection of Session and media files items

*** ** * ** ***

### Canvas UI

* **Edit Session Tags**: Session Tags can now be set via the Canvas UI

* **Dynamic WebView Toolbar:**Moveable and Collapsible WebView Toolbar

* **Home Warning:**Optionally display a warning before going home to prevent loss of Session data

*** ** * ** ***

### API

* **Media Library API**: Enhanced the API to provide detailed information about the contents of the media library, including sessions, images, and videos.

*** ** * ** ***

## Igloo Control Panel

### Core

* **Renamed Application:**Application renamed from 'ICE Control Panel' to Igloo Control Panel

*** ** * ** ***

### Layers Tab

* **Content Bank Thumbnails :**Session tiles now display thumbnails

* **Content Library Browser:**Browse and open Sessions and media files

*** ** * ** ***

### Casting Tab

* **Gyro cursor control:**Optionally adjust control the canvas cursor movement using the devices gyroscope

*** ** * ** ***

### Model Viewer

* **Touch screen navigation**: Added touch screen control for player navigation

*** ** * ** ***

### Warping Tab

* **Number of Projectors**: Projector count is now read from config.json, it no value it set it will fallback to the Warpers AppSettings.xml setting.

### Integrations

* **Barco Clickshare**: Detects connections and disconnections, enabling automated actions in Igloo Core Engine, such as loading a Layer file or sending an Igloo Core Engine API command.

* **Streetview:**

  * Camera locking settings are now saved

* **Matterport:**

  * Camera locking settings are now saved

  * Video Mattertag: Improved positioning within Canvas and extended list of support YouTube URL formats

* **KRPano**:

  * Streamlined integration workflow. [KRPano viewer](https://docs.igloovision.com/documentation/current/krpano-viewer.md)

  * Control page view syncronisation

* **Kuula**

*** ** * ** ***

## Upgrade Notes

### Requirements

* **Mandatory****:** If you are using Datapath capture cards, you must update to the latest Datapath drivers (VisionInstall v7.29.0 or higher). Download here: [Datapath Drivers](https://www.datapathsoftware.com/downloads/?_sft_file_type=drivers).

* **Recommended****:** It is also suggested to update to the latest NVidia drivers for optimal performance.

If you experience any issues following updating refer to the steps here [Common Issues](https://docs.igloovision.com/documentation/current/common-issues.md)

---
version: "2.0.0"
language: "en"
---
# 1.5.x

## Highlights

* **Updated playback engine**

  * Improved playback performance for H264, H265 codecs

  * Support for HLS, RTMP and RTSP streaming protocols

* **Triggers and Actions:**

  * **Projector Control (PJLink Device):**Integrated projector control using the PJLink protocol. Set up actions to power projectors on/off, select input sources, and manage other projector functions available with the PJLink protocol

* **Usability Improvements**:

  * Resize Layers directly within the Canvas Viewport

  * Layer context menu for common actions such as Move To Region, Duplicate, Delete etc.

* **Lock Cursor to Canvas Viewport**

*** ** * ** ***

## Igloo Core Engine

### Core

* **Layer Geometry Usability Improvements**:

  * Resize Layers directly within the Canvas Viewport

  * Layer context (right-click) menu for common actions such as Move To Region, Duplicate, Delete etc.

* **True Perspective**:

  * **True Perspective Manager:** for creating and switching between multiple head positions. Head positions can also now be configured per Workspace.

* **Layouts**: Auto-configure a set of regions using the True Perspective settings

* **Desktop DPI Scaling**: The user interface to automatically adjust for varying desktop DPI settings. Allows the desktop interface to be run on a 4k console monitor.

* **Warping**:

  * **Black Level Compensation** : Uplift non overlap warp regions (Requires Igloo Setup application) [Black Level Tab](https://docs.igloovision.com/documentation/current/black-level-tab.md)

  * **Auto Reload Warps**: Optional setting to automate reloading of Warp and Blend files within ICE following an export from Igloo Setup

* **Layer Fading System:**Automatically fade layers in and out.

* **Import / Export System:**

  * **Default Export Folder:**Set default location for the export of session and layer files

* **Installer:**Automated removal of legacy archive data

* **Canvas Share:** Frame-pack Spout output when resolution exceeds 16k

*** ** * ** ***

### Effects

* **True Perspective**

  * **Output Quality Settings:**Adjust resolution to balance visual quality with performance

  * **Drag Canvas to Rotate:**Dragging the canvas will adjust the True Perspective heading direction

  * **Animate Heading:**Rotate the heading automatically over time, with settings for Speed, Direction and Looping

* **ISF**

  * **Unpack Top Bottom**: Utility for simple unpacking of custom Top/Bottom to Left/Right content

  * **Chrome Key:** A utility that makes pixels of a chosen color (e.g., green) transparent, allowing background replacement or compositing for effects such as green screen.

*** ** * ** ***

### Layers

#### Loopback

* **Input Forwarding**: Keyboard and Mouse events are now forwarded from the loopback layer to it's source layer

#### Home

* **Select Components on Canvas**: Select active Home component for editing it's properties by clicking it on the canvas viewport

* **Grid NxN Sizing:**Set Grid component size using fixed number of rows and columns

* **Trigger Tile:** Link a **Triggers and Actions** Trigger to a Home tile, see [Home Components \| Trigger Tile](https://docs.igloovision.com/documentation/current/home-components.md#Trigger-Tile)

#### Video

* **Updated playback engine**

  * Improved playback performance for H264, H265. Details on supported formats can be found here - [Video](https://docs.igloovision.com/documentation/current/video.md)

  * Support for HLS and RTMP streaming protocols. Allows Igloo Core Engine to display live streams from 360 cameras, such as the insta360 [Video \| Streaming](https://docs.igloovision.com/documentation/current/video.md#Streaming)

  * Guide to HAP encoding - [HAP Encoding](https://docs.igloovision.com/documentation/current/hap-encoding.md)

#### WebView

* **Chromium Update**: Updated to Chromium version 130

* **Popup Handling**: A new 'Allow Popups' property has been added to the WebView layer. When enabled, if a website attempts to open a popup it will be displayed instead of the current WebView.

* **Custom Clear Colour:**Allows websites with transparent backgrounds to be displayed correctly

*** ** * ** ***

### Media Library

* **Audio File Management:**Audio files can now be managed within the content library

*** ** * ** ***

### Input Device System

* **Replaces 'Controller' System**

  * Settings such as canvas ROI will be automatically migrated

  * All Workspaces are auto configured to allow control via Igloo Control Panel. There's no longer a need to add a Controller.

  * Controller system OSC API is still supported

<!-- -->

* **Input Device API**: New API for managing input to the Canvas, allowing control of the canvas cursor as well as sending of keyboard and mouse events.

* **OptiTrack Support:**Motion tracking data from the Optitrack Motive software can be used to manage the on canvas cursor via ray casting.

*** ** * ** ***

### Triggers and Actions

* **Layer Actions**:

  * **All Layers**

    * Modify layers order in the layer list with Move Up, Move Down, Move Top, Move Bottom actions

  * **YouTube**

    * Control YouTube Layer playback with actions for Play, Pause, etc.

  * **WebView**

    * Set URL

  * **Content Bank**

    * Active Tile

* **Lerp from Current Value**: Transition from the current value towards a target value

* **System Time Trigger**: Schedule a Trigger to repeat at the same time every day

* **PJLink Device:**Integrated projector control using the PJLink protocol. Set up actions to power projectors on/off, select input sources, and manage other projector functions available with the PJLink protocol

  * [Device - PJLink](https://docs.igloovision.com/documentation/current/device-pjlink.md)

* **OSC Device:**Send Open Sound Control (OSC) messages to compatible devices and applications.

  * [Device - OSC](https://docs.igloovision.com/documentation/current/device-osc.md)

* **Igloo Core Engine (Remote) Device:**Control other instances of Igloo Core Engine on the local network

  * [Device - Igloo Core Engine (Remote)](https://docs.igloovision.com/documentation/current/device-igloo-core-engine-remote.md)

*** ** * ** ***

### Bug Fixes

* Home - Crash When Loading Missing Layout Tile

* Home - Unable to click a Home tile if it shares space with a grid

* Canvas UI - Prevent Inactivity Timeout When Drawing Regions

* Warping - Wall Rotation Not Applied When Stereo3D is enabled

* Layers - Fixed reordering issue

## Igloo Control Panel

### Core

* **Improved Android Keyboard**: Key events now widely supported

* **Kiosk Mode:** A new `--kiosk` command-line option is now available to launch in fullscreen mode. In this mode, window controls (close, maximize, minimize) are hidden by default, and exiting requires using `Alt+Tab` or `Alt+F4`. [Igloo Control Panel Configuration \| Command line arguments](https://docs.igloovision.com/documentation/current/igloo-control-panel-configuration.md#Command-line-arguments)

*** ** * ** ***

### Controller Tab

* **(BETA) Canvas Interaction**: Use the PlayStation Dual Sense controller to interact with the canvas.

  * **Click:** Interact with canvas UI elements and WebViews

  * **Scroll:** Navigate WebViews and canvas UI components.

  * **Move:** Use the controller's gyroscope to move the canvas cursor via 3D model Raycasting.

*** ** * ** ***

### Integrations

* **3D Vista**

* **Pano2VR**

If you experience any issues following updating refer to the steps here [Common Issues](https://docs.igloovision.com/documentation/current/common-issues.md)

---
version: "2.0.0"
language: "en"
---
# 2.0.x

Igloo Core Engine 2.0 introduces a number of updates to the Desktop UI and Control Panel, along with new systems such as Launchpad and Session Collections. If you're upgrading from 1.5 or older, we recommend that as well as reviewing this page, you also review this overview of key UI and workflow changes.

[Before You Update to 2.0 -- Key Changes](https://docs.igloovision.com/documentation/current/before-you-update-to-2-0-key-changes.md)

After upgrading, import the updated example sessions from `C:\ProgramData\Igloo Vision\IglooCoreEngine\example sessions`

## Highlights

* **Desktop UI** -- Updated layout, improved usability

  [Desktop UI - The Desktop User Interface](https://docs.igloovision.com/documentation/current/desktop-ui-the-desktop-user-interface.md)

* **Control Panel UI** -- Completely rebuilt to align with 2.0

  [Control Panel UI Overview](https://docs.igloovision.com/documentation/current/control-panel-ui-overview.md)

* **Launchpad** -- Customisable tile-based system for launching Sessions and Triggers

  [Launchpad](https://docs.igloovision.com/documentation/current/launchpad.md)

* **3D Model Layer** -- Native support for viewing 3D model files

  [3D Model](https://docs.igloovision.com/documentation/current/3d-model.md)

* **Session Collections** -- Organise sessions into structured collections

  [Session Library](https://docs.igloovision.com/documentation/current/session-library.md)

* **Layer Presets** -- Save and reuse single layer configurations

  [Layer Presets](https://docs.igloovision.com/documentation/current/layer-templates.md)

* **Workspace Masking** -- Dynamically control visible areas of the canvas

  [Workspace - Masking](https://docs.igloovision.com/documentation/current/workspace-masking.md)

* **DirectShow Layer** -- Added video input support

  [DirectShow](https://docs.igloovision.com/documentation/current/directshow.md)

* **AI Image Generation (Beta)** -- Generate images directly within Igloo Core Engine

  [AI - Asset Generation (Beta)](https://docs.igloovision.com/documentation/current/ai-asset-generation-beta.md)

*** ** * ** ***

## Igloo Core Engine

### Core Updates

* **GPU Selection** -- Automatically targets NVIDIA GPU in multi-GPU systems

* **Safe Mode** -- Launch into in a minimal recovery state

  [Command Line Arguments](https://docs.igloovision.com/documentation/current/command-line-arguments.md)

* **Improved Fading** -- Layers now wait until ready before fading in

* **Workspace Masking System** -- Real-time control of canvas masking

  [Workspace - Masking](https://docs.igloovision.com/documentation/current/workspace-masking.md)

* **Logging Improvements** -- Enhanced log file size management

  [Logging](https://docs.igloovision.com/documentation/current/logging.md)

* **Input Device** -- Sticky Regions

  [Workspace - Input Device](https://docs.igloovision.com/documentation/current/workspace-input-device.md)

*** ** * ** ***

### Desktop UI

* Updated styling and colour scheme

* Dedicated **Session Toolbar**

* Improved widgets and interaction patterns

### Usability Improvements

* Drag-and-drop layer reordering

* Collapsible layers

* Zoom to selected layer

* Light / Dark modes

### Status Bar

* System utilisation

* NDI status and management

* Triggers \& Actions status

UI Overview:

[Desktop UI Overview](https://docs.igloovision.com/documentation/current/desktop-ui-overview.md)

Tutorials:

[Desktop UI](https://docs.igloovision.com/documentation/current/desktop-ui.md)

*** ** * ** ***

### Launchpad (New)

A new system for managing, displaying, and launching a customisable set of tiles. These tiles represent functionalities such as Sessions and Triggers.

[Launchpad](https://docs.igloovision.com/documentation/current/launchpad.md)

*** ** * ** ***

### Layers

**Default Properties for New Layers -** [Workspace - Layer Default Settings](https://docs.igloovision.com/documentation/current/workspace-layer-default-settings.md)

* Default Layer Enabled

* Default True Perspective Quality

* WebView Zoom

#### 3D Model Layer (New)

* Native Viewer for 3D Model Files - [3D Model](https://docs.igloovision.com/documentation/current/3d-model.md)

#### Loopback

#### Home

* **Tile Styling Option -** New 'Maximise Thumbnail' style option for Tile and Grid components [Home Components \| Tile Style](https://docs.igloovision.com/documentation/current/home-components.md#Tile-Style)

#### PDF

* **Touch Support -**Swipe and press to navigate between pages

#### Video

* **Auto Play on Drag from Explorer -** Videos dragged directly into the workspace from File Explorer will now respect the default Auto Play setting in Workspace Properties [Workspace - Layer Default Settings](https://docs.igloovision.com/documentation/current/workspace-layer-default-settings.md)

* **HAP-R Format Support -**Added support for the new HAP 'flavour' HAP-R. Note that we currently do not have alpha channel support with this option yet.

#### WebView

* Default Zoom Level Workspace Property - [Workspace - Layer Default Settings](https://docs.igloovision.com/documentation/current/workspace-layer-default-settings.md)

* Utility Browser

  * Allows chrome extensions to installed for use with WebViews [WebView](https://docs.igloovision.com/documentation/current/webview.md)

#### AppView

* **Powerpoint Mode -** [AppView](https://docs.igloovision.com/documentation/current/appview.md)

  * Track PPT files within the media library

  * Automate the launch and capture of a Powerpoint Presentation Window

*** ** * ** ***

### Effects

* **True Perspective**

  * Configure Head Position Preset Per Layer [True Perspective](https://docs.igloovision.com/documentation/current/true-perspective.md)

*** ** * ** ***

### Media Library

* Session Collections - [Session Library](https://docs.igloovision.com/documentation/current/session-library.md)

* Sort Sessions by the time they were last loaded

* Layer Presets - [Layer Presets](https://docs.igloovision.com/documentation/current/layer-templates.md)

*** ** * ** ***

### Input Device System

* Lock to Region - Horizontal Wrap Setting [Workspace - Input Device](https://docs.igloovision.com/documentation/current/workspace-input-device.md)

* Configurable OSC Port for Input Device

*** ** * ** ***

### Triggers and Actions

* Triggers

  * Tile Triggers - for use with Launchpad and Home Tiles [Triggers and Actions](https://docs.igloovision.com/documentation/current/triggers-and-actions.md)

  * Added 'Contains' Comparison function for string value triggers

  * PowerPoint Presentation Slide Number

  * PDF Page Number

* Actions

  * Set Floor Mask Enabled State

  * Workspace Mask States

  * Set Workspace True Perspective Head Position

  * Control PowerPoint Slides (Next / Previous / Set Slide Number)

*** ** * ** ***

### Warping \& Blending

* **MPCDI Support** - [Screen Windows](https://docs.igloovision.com/documentation/current/screen-windows.md)

*** ** * ** ***

## Igloo Control Panel 2.0

Igloo Control Panel 2.0 is a **completely rebuilt application** , designed to align with Igloo Core Engine 2.0. For full details see [Before You Update to 2.0 -- Key Changes](https://docs.igloovision.com/documentation/current/before-you-update-to-2-0-key-changes.md)

UI Overview:

[Control Panel UI Overview](https://docs.igloovision.com/documentation/current/control-panel-ui-overview.md)

Tutorials:

[Control Panel UI](https://docs.igloovision.com/documentation/current/control-panel-ui.md)

If you experience any issues following updating refer to the steps here [Common Issues](https://docs.igloovision.com/documentation/current/common-issues.md)

---
version: "2.0.0"
language: "en"
---
# 3D Model

The 3D Modellayer inIgloo Core Engine is designed for viewing 3D objects rather than loading full 3D environments. It is ideal for showcasing smaller, optimised assets and supports camera controls, lighting adjustments, animation playback, and turntable style model rotation.  
Recommendation: For best performance, we advise using models under 50MB. Very large assets may impact performance.

*** ** * ** ***

## **Supported File Types**

`3DS`, `DXF`, `GLTF`, `FBX`, `STL` `OBJ`, `SMD`, `GLB`  
GLB recommended if planning to export session to another system

*** ** * ** ***

## **User Interface Overview**

### **Model Tab**

![image-20250909-085048.png](https://docs.igloovision.com/__attachments/a_c10c2153a4c5eb2d13f7d0d5f8bc0ab1f944c5f7e6be055aec878638d0507d1e/image-20250909-085048.png?cb=b7cef40fd82c7064d41dd1b797ba32e5)

* **Filepath** -- Select your 3D model file from the local storage. Alternatively load already added models from the media library, or simply drag file in from windows explorer

* **Transform** -- Adjust the position, rotation, and scale of the model

* **Animation** -- Control playback of any animations embedded in the model

### **Camera Tab**

![image-20250909-085129.png](https://docs.igloovision.com/__attachments/a_3cf6e10005ba5b1b900b00ecc0db0d05840820ee5662bc502859ca886c283dcf/image-20250909-085129.png?cb=d498b5bd7be60db916ba5198e74355d7)

The 3D Model Layer uses an orbit camera, allowing you to rotate around the object and adjust framing.

* **Rotation Controls**

  * **Yaw** - Rotate the camera horizontally around the model

  * **Pitch** - Tilt the camera up or down

* **Field of View (FOV)** - Adjusts the viewing angle for a wider or narrower perspective

* **Distance** - Controls how far the camera is from the model

* **Viewport Size** -- Set the output resolution for the model view

You can also use the mouse in Canvas UI mode to control the camera. Drag to rotate and scroll to zoom.

### **Lighting Tab**

![image-20250909-085332.png](https://docs.igloovision.com/__attachments/a_02f906d3ebfa18308aa4b61b6447b0ef45049b9c8689840e6c5c41486433b283/image-20250909-085332.png?cb=4fbc4c14cca9977fe3dc8f9b34820a26)

* **Add Light** -- Add multiple light sources for better model highlighting.

* **Light Types**

  * **Directional** - Parallel rays, similar to sunlight

  * **Point** - Emits light in all directions from a single point

  * **Area** - Soft, diffused lighting for more natural shading

* **Colour Controls**

  * **Ambient** - Base lighting applied to the entire model

  * **Diffuse** - Direct light colour and intensity

  * **Specular** - Highlights and reflections

* **Light Rotation** - Adjust yaw and pitch to control light direction

*** ** * ** ***

## **Animations**

![image-20250909-085726.png](https://docs.igloovision.com/__attachments/a_df3a7a0c3ba7af59276f58dc70078ef4754e026d22c4823b2e5941832caa6c94/image-20250909-085726.png?cb=df80959a2916942a61526effa1d1053a)

If your model contains embedded animations, the Animation section panel lets you:

* Play / Pause animations

* Scrub through keyframes

* Loop modes

*** ** * ** ***

## **Turntable Rotation**

![image-20250909-091706.png](https://docs.igloovision.com/__attachments/a_f8bc372b25675ae49d251363e032210cffb0e196fa5127bab80d830fd0f305e6/image-20250909-091706.png?cb=6199e3b7afdc687440d9489b9cf7d0a1)

For continuous, automated display, the animate Yaw option allows you to slowly spin the model in place

---
version: "2.0.0"
language: "en"
---
# 3DVista

Create interactive 360º virtual tours in the most easy and pleasant way: 360º views (panoramas), 360º videos, embedded sounds, videos and photos, floorplans and fully customizable frames.

<https://www.3dvista.com/en/products/virtualtour>

## Integration

This integration is built by the Igloo Vision development team utilising the WebXR compatibility feature of 3DVista Virtual Tour Pro.

## Usage

Ensure your virtual tour is compatible:

* Publish your tour to Web/Mobile or 3DVista Hosting Service using the latest version of 3DVista Virtual Tour Pro (release 2025.0.2)

* Include the VR button in your tour skin <https://www.youtube.com/watch?v=oLVJ9hH21tw>

Follow these steps in Igloo Core Engine:

* Create a WebView layer.

* Allow popups in this layer.

* Add the metadata keys:

  * webxr

  * webxr/cubeFaceSize - set this to an appropriate pixel resolution e.g. 1000, 1500 or 2000.

* Paste the URL of your 3DVista virtual tour into the WebView URL.

* TIP: this is a good point to save the WebView as a session.

![image-20250509-130910.png](https://docs.igloovision.com/__attachments/a_e9da4a310d558b8626a4302c88f5520e4f2699f5f7493033eee7d7f3e23d2742/image-20250509-130910.png?cb=fe186ac6b3fd179fb70a07e44005c556)
WebView properties for 3DVista integration.

* When the tour has loaded, click the VR button to activate the integration. The WebView layer will render the tour as a cubemap and the required effects will be automatically added (Cubemap to Equirectangular and TruePerspective).

![vrbutton1.png](https://docs.igloovision.com/__attachments/a_ed0886926547af300af4605f32c696470a41acf8c5b210d8818ceb8ad817307c/vrbutton1.png?cb=58e0d1d9c11def40a07c8de5d1cc04b0)
VR button shown on the tour skin (bottom centre). The location for this button may be in a submenu and is defined in the tour.  
![vrbutton2.png](https://docs.igloovision.com/__attachments/a_5f563126c9462bd91deca36cb35621b1723d5f02b93cd3cc49f2b2280a97df01/vrbutton2.png?cb=2fecece7e61677ccdd64ce981606bb79)  
![image-20250509-132010.png](https://docs.igloovision.com/__attachments/a_a1cb02adf4ca38ae4dded3104ec6292a8cdb6923d799815c0f41aa840567fc70/image-20250509-132010.png?cb=4afc03faf97862ce4d657f635b999e41)
Cubemap view of the tour after the VR button has been pressed. Effects are automatically added.

## Example Tours

The 3DVista team provide an excellent set of sample tours (<https://www.3dvista.com/en/samples/>).

Here are some selected ones which work with our integration:

* <https://storage.net-fs.com/hosting/2727323/487/>

* <https://storage.net-fs.com/hosting/2727323/5/index.htm>

* <https://storage.net-fs.com/hosting/2727323/396/index.htm>

* <https://storage.net-fs.com/hosting/2727323/271/>

* <https://storage.net-fs.com/hosting/2727323/108/>

* <https://storage.net-fs.com/hosting/2727323/361/index.htm>

## Limitations

* Virtual Tours built using earlier versions of 3DVista will not be compatible with this integration.

* The position of popups may need to be adjusted in the tour so they appear in the desired location on the Igloo canvas.

## WebXR metadata keys

Here is a list of the metadata keys which can be used with webxr compatible sites.  

|              **Key**              | **Default Value** |                                                                              **Description**                                                                               |
|-----------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| webxr                             |                   | Enables webxr integration. No value is required, just the metadata key.                                                                                                    |
| webxr/cubeFaceSize                | 1000              | Pixel size of each cubemap face. A value of 1000 will give a cubemap of 6000px x 1000px.                                                                                   |
| webxr/customCullingCameraPosition | 1000,1000,1000    | Comma-separated x,y,z position of camera. This camera position is required to prevent culling of objects in the scene but can also affect the size of hotspots and popups. |
|                                   |                   |                                                                                                                                                                            |

## I have an Issue!

For issues with the 3DVista integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# AI - Asset Generation (Beta)

This beta version is a preview and is subject to change. This feature may be disabled depending on your license - please get in touch if you'd like to request access.

## **Setup**

Before using the AI Asset Generation features, you must configure at least one AI vendor with and API key. Igloo Core Engine supports multiple vendors, each offering one or more models:

### **Supported Vendors \& Models**

**OpenAI**

* **GPT Image**

* **DALL·E 2**

* **DALL·E 3**

**Google**

* **Gemini 2.5 (Nano Banana)**

* **Gemini 3.1 (Nano Banana 2)**

**Blockade Labs**

* **Skybox 3**

You may enable as many or as few vendors as you like. Each vendor is optional---if you only have an API key for one service, you can still use that vendor's models exclusively.

*** ** * ** ***

### **API Key Configuration**

To activate a model, you must supply your own API key for its vendor.

1. Locate the file:

   `AIUserSettings.json`

   This file is stored in the installation Directory

   `C:\ProgramData\Igloo Vision\IglooCoreEngine\settings\AI` directory.

2. Open the file in a text editor.

3. Each vendor has a field inside `"apiKeys"` configuration block.

   Add your API key to the appropriate field. For example:

JSON

    "appSettings": {
        "apiKeys": {
          "blockadelabs": "YOUR_OPENAI_API_KEY",
          "googleai": "",
          "openai": ""
        },

        ......
    ]

4. Save the file and restart the application.

![image-20251114-200317.png](https://docs.igloovision.com/__attachments/a_164d561991cfe2573894410b6261e595a07e875e2eb17eec03d40955fc13a3f0/image-20251114-200317.png?cb=69348757b458a98d48fde5652ee0066d)
Once configured, the models associated with vendors that contain valid keys will appear in the AI Generation tab in the Settings wind.  

### Next: [Image Generation](https://docs.igloovision.com/documentation/current/image-generation.md)

### Notes on API Keys

API key generation differs per vendor and must be completed via each provider's platform:

* OpenAI: <https://platform.openai.com/api-keys>

* Google AI (Gemini): <https://aistudio.google.com/app/apikey>

* Blockade Labs: [Integrations (List) \| Skybox AI](https://www.blockadelabs.com/integrations)

API usage is typically billed separately from any subscription plans. Ensure billing is enabled on the vendor platform, otherwise requests may fail even if a key is present.

---
version: "2.0.0"
language: "en"
---
# Apps

The apps page shows a configurable list of applications that are available on the target media server.  
![image-20260414-125201.png](https://docs.igloovision.com/__attachments/a_3845953e652fe3f5ef0e943dd00f0711b8d6352e4e7d97a125f0d7502118a0c1/image-20260414-125201.png?cb=48727dbb3417b1c9751394d2aa4d4254)

Click an application to open it in Igloo Control Panel.  
![image-20260414-125051.png](https://docs.igloovision.com/__attachments/a_74e3752a71c39a149e3b3444afdd524f4c8c16afdb1d3adfb917d127653778ce/image-20260414-125051.png?cb=f92b25212793bdabfe8340f306542d8a)

The default apps are documented on this site, but any custom apps added to your installation may not have a dedicated page here.

## Apps

Default apps:

* [Matterport](https://docs.igloovision.com/documentation/current/matterport.md)

* [Google Street View](https://docs.igloovision.com/documentation/current/google-street-view.md)

* [Igloo FileDrop](https://docs.igloovision.com/documentation/current/ice-drop.md)

Pre-configured apps:

* [Open Stage Control](http://openstagecontrol.ammd.net/docs/getting-started/introduction/). See [Open Stage Control](https://docs.igloovision.com/documentation/current/open-stage-control.md) for details.

## Configuration

See [Igloo Control Panel browsers](https://docs.igloovision.com/documentation/current/ice-control-panel-browsers.md)

---
version: "2.0.0"
language: "en"
---
# AppView

![image-20251104-122119.png](https://docs.igloovision.com/__attachments/a_0b56f788e478c6704c2b8b6eb3015c239f11e0d3faed550117b90182f1ef090a/image-20251104-122119.png?cb=615153eae44309ed2a5750478bd6e338)

The AppView Layer can be used to capture and display local desktop applications and desktop displays in Igloo Core Engine.

## Settings

### Capture Mode

Pick Default or PowerPoint mode. PowerPoint mode is described in the separate section below.

### Select Capture

Choose from a drop-down list of currently running applications and desktop displays available for capture.

### Pick App

Click the "Pick App" button to open the window picker, which shows all available windows and applications.

### Show Cursor

Enable this option to display the mouse cursor over the captured application.

* Enabled: The mouse cursor is shown in the capture.

* Disabled: The mouse cursor is not shown in the capture.

### Exact Title Match

Determine how the layer identifies the window to capture based on its title.

* Enabled: The layer captures a window only if its title matches exactly.

* Disabled: If an exact match is not found, the layer captures the closest match with the same application name (e.g., Chrome running a different tab name).

## PowerPoint mode

**Prerequisites and limitations**

* PowerPoint must be installed, licensed, and signed in

* PowerPoint files must be stored locally on the machine

* It is highly recommended that PowerPoint files have edit access enabled

* Only a single PowerPoint presentation can be captured at a time i.e. multiple concurrent AppView layers capturing PowerPoint is not supported

In PowerPoint mode you can choose a PowerPoint presentation that the layer will load for you.  
![image-20260218-085901.png](https://docs.igloovision.com/__attachments/a_2531c723871999826e73232498eda40c9425475bd9567374f438cb79fa7e95cd/image-20260218-085901.png?cb=c676c3f5518427d5e2ea8216db5c8489)

Once loaded the layer will display the presentation in a window on your desktop and capture it so that it will be shown on the canvas. You will then see the navigation buttons to move between slides and animations.  
![image-20260218-091227.png](https://docs.igloovision.com/__attachments/a_37344c0137aa103e868cbd73eead944d8439510233f61b2433a2627864391ea3/image-20260218-091227.png?cb=3f5b4be445f450acacaf1c8e8cc724ff)

## PowerPoint Mode Advanced Settings

![image-20260218-091939.png](https://docs.igloovision.com/__attachments/a_e6d1e60bbd7c314fba848a14bc381bc69dad7b8ffb3e56230fc3f475339382ec/image-20260218-091939.png?cb=5961e12978796eaa6ad3de656da3bd0d)

### Start Slide

This is the slide that will be shown on opening the presentation. There is also a button which can be used to return to it at any time.

### Presentation Geometry

* The presentation window has to remain fully contained within a display for it to be captured i.e. it cannot span multiple windows displays

* The presentation window must also be positioned on a display which is connected to the same GPU as Igloo Core Engine

The geometry settings control its position and size. You can also move and resize it like any other desktop window.

But you will not be able to change it so that any portion is off the desktop  
To prevent the PowerPoint presentation window from appearing in front of the Igloo Core Engine output, enable "Always on Top" in the Screens settings. This ensures the output windows remain above the presentation during usage.

### Read-only fallback

Due to the limitations imposed by a file that is set to be read-only. Igloo Core Engine can't force the slideshow to be windowed. Read-only files will be shown in the default mode which is full screen. This makes the slideshow window pop up on top for a brief moment before eventually being put behind the Igloo Core Engine window. For the best experience, consider changing the file to be editable and save it.

*** ** * ** ***

---
version: "2.0.0"
language: "en"
---
# Audio Window

The Audio Settings window is opened via the toolbar **Settings \> Audio Settings**

## Sources

![image-20260211-151614.png](https://docs.igloovision.com/__attachments/a_baf1a4ea1d54557a617aef86758e4b055945b867b874e5aa43cb3ee2e7eb062b/image-20260211-151614.png?cb=43692469ad97554a159ae7d9539c57e5)

Every audio capable Layer will show within the sources menu, where the volume and mute settings can be configured. These settings are also available within the Playback tab of the Layer.  
![image-20260211-151628.png](https://docs.igloovision.com/__attachments/a_7162c202e776f577cbf080edc590bcf637a4b2e2b747095557cfbb133779c74f/image-20260211-151628.png?cb=029737a4f73e1aa136cb1322e5371fe1)

Layer types which can contain multiple sublayers, such as Compositions or Clip Banks, will have an Audio Bus, providing independent audio controls for the Bus and its sources.  
![image-20260211-151731.png](https://docs.igloovision.com/__attachments/a_346a2045471ce957f8c4ca5820bdbdf0235fd1ce415b9e90e088a2f3ec4594dc/image-20260211-151731.png?cb=1bbdc777cdb2ea749c1d08994ecbc287)

### Channel Mappings

![image-20260211-151752.png](https://docs.igloovision.com/__attachments/a_f799536411b94bd28ec3b4a19f2e68cc3e519a6abca9c8fcc01af5fc7a937173/image-20260211-151752.png?cb=eb2f8e25a04cfaf981ac86dc2bdf436a)

When audio sources are routed to the output device, the channel mappings dictate how the channels will be mapped. By default,

* A 5.1 signal is routed to a 5.1 bus, as a 1:1 mapping

* A 5.1 signal is routed to a stereo bus, by downmixing to stereo.

### Output Device

![image-20260211-151810.png](https://docs.igloovision.com/__attachments/a_86ae1874c5927f92ead9d9f453b4c99315c61e8aea9d41782976f6ca7b9951c8/image-20260211-151810.png?cb=99a924311eae2227cd4161cbf69b0cc6)

Igloo Core Engine supports WASAPI and ASIO audio devices. Select the output device from the list.

**Please notice:**

1. On some systems, then a bug within the audio driver has been identified, that causes only Igloo Core Engine to output audio, blocking the audio from other apps. This issue is caused by the audio driver, forcing the audio device to enter exclusive mode, when Igloo Core Engine is registering the installed ASIO devices. This issue is not depending on whatever an ASIO audio device is installed or not.

2. For multiuser systems, where multiple users is logged in at the very same time, then it's recommended to ***disable the ASIO interfaces*** as stated below. Using ASIO audio devices in setup's like these, then Igloo Core Engine can crash - due to the exclusive nature of ASIO.

For systems, where this issue is happening, then open the audioSettings.xml. Go to the \<output\> tag, and change the attribute ***disableAsio="0"*** to ***disableAsio="1"***. This will force Igloo Core Engine to only use the Windows WASAPI audio devices, by disabling the ASIO devices in Igloo Core Engine.

---
version: "2.0.0"
language: "en"
---
# Autodesk Navisworks and Revit

**Autodesk Revit** ([https://www.autodesk.co.uk/products/revit/overview?term=1-YEAR\&tab=subscription](https://www.autodesk.co.uk/products/revit/overview?term=1-YEAR&tab=subscription) ) is a [building information modelling](https://en.wikipedia.org/wiki/Building_information_modeling) software for architects, landscape architects, structural engineers, [mechanical, electrical, and plumbing](https://en.wikipedia.org/wiki/Mechanical,_electrical,_and_plumbing) (MEP) engineers, designers and contractors (<https://en.wikipedia.org/wiki/Autodesk_Revit> ).

**Autodesk Navisworks** ([https://www.autodesk.co.uk/products/navisworks/overview?term=1-YEAR\&tab=subscription](https://www.autodesk.co.uk/products/navisworks/overview?term=1-YEAR&tab=subscription) ) is a 3D design review package used primarily in the architecture, engineering, and construction (AEC) industries to complement 3D design packages (such as [Autodesk Revit](https://en.wikipedia.org/wiki/Autodesk_Revit), [AutoCAD](https://en.wikipedia.org/wiki/AutoCAD), and [MicroStation](https://en.wikipedia.org/wiki/MicroStation)) (<https://en.wikipedia.org/wiki/Navisworks> ).

## Integration

This integration is built by the Igloo software development team using the Navisworks and Revit API to create plugins to the native application. A menu appears in Navisworks/Revit to enable sharing of a 360 degree image of the current camera location with Igloo Core Engine. The image is received via NDI or Spout protocol.

## Configuration

The configuration file for the plugin is located in the AppData folder of the current user in '\\Igloo Vision\\Navisworks\\Navisworks.xml' or '\\Igloo Vision\\Revit\\Revit.xml'. The resolution of the image which is sent to Igloo Core Engine can be modified in this file (width and height are in pixels and must be the same value). Also the protocol can be specified here as either NDI or Spout.

    <Revit>
      <ImageElementWidth Type="int" Default="2048" Description="The with of each image">2048</ImageElementWidth>
      <ImageElementHeight Type="int" Default="2048" Description="The height of each image">2048</ImageElementHeight>
      <TransmitterName Type="string" Default="Revit" Description="The sender name for the transmitter">Revit</TransmitterName>
      <TransmitterUseDirectX Type="bool" Default="False" Description="Enables the transmitter to use DirectX">False</TransmitterUseDirectX>
      <TransmitterUseOpenGLBuffering Type="bool" Default="False" Description="Enables the transmitter to use OpenGL buffering">False</TransmitterUseOpenGLBuffering>
      <TransmitterShareMode Type="string" Default="CPU" Description="Sets the shared mode for the transmitter - possible values: CPU, Texture or Memory">CPU</TransmitterShareMode>
      <TransmitterType Type="string" Default="NDI" Description="Sets the transmitter mode, default: NDI - possible values: Spout, NDI">NDI</TransmitterType>
    </Revit>

## Using the Igloo Plugin

A button called 'Display in Igloo' will appear in the Add-ins menu as shown below in Revit 2022.  
![revit1.png](https://docs.igloovision.com/__attachments/a_b624ef4a2f982a98e03b8a70ca3481ca0daced632006e161952b20b3b01ead5b/revit1.png?cb=02fc6751ee43135432cf9d29eea1d9c6)
Display in Igloo button.

Pressing the 'Display in Igloo' button starts the image generation process and this is displayed with a progress pop-up.  
![revit2.png](https://docs.igloovision.com/__attachments/a_0d781ad731aeacb14c5181a8dad2da5cc0b16278199b4ea6dd7f7cbdb4bb5931/revit2.png?cb=db4312b5709f5acefb29dde20c777456)
Progress popup for generating the 360 image.

When the process is completed the pop-up disappears and an NDI or Spout sender called Revit is now available. This can then be viewed in Igloo Core Engine using an NDI or Spout layer and applying the Cubemap to Equirectangular and True Perspective effects.  
![revit3.png](https://docs.igloovision.com/__attachments/a_6c33af94e131d0bf496b9af3fa39b4eb61042d976dc194b8c9c0f98c46e23721/revit3.png?cb=a0efa1f0b94c7dd499dd88ec6025c7e5)
Receiving the NDI sender in Igloo Core Engine.  
![revit4.png](https://docs.igloovision.com/__attachments/a_292fdff5cdf904e9011f2ceeeb9653610340c80ca681cf3f041ff15ae68e9c7b/revit4.png?cb=5ce5ca285a39909d506e490a58a9e8ed)
Applying the effects to the NDI Layer.  
Save this as a Session to easily reload the layer with these settings applied - [Sessions - Igloo Core Engine Documentation](https://docs.igloovision.com/documentation/current/sessions.md)

## Notes

**Lighting** - the lighting model used for the rendering the 360 image (cubemap) is inherited from the lighting model in the current view. Each cubemap face is rendered independently and this can produce some slight colour differences between adjacent faces.  
![revit5.png](https://docs.igloovision.com/__attachments/a_39ead59c275c1ed05fed958f4297bf97017b44a54c777666811fb0eeedcebdde/revit5.png?cb=607e317fc2f62e65127a9743f180c2b8)
Lighting settings in Graphic Display Options for the current view.

---
version: "2.0.0"
language: "en"
---
# Avatour

Avatour ([http://avatour.com](http://avatour.com/)) is the 360° video communication platform enabling teams to collaborate on site - virtually.  
[https://www.youtube.com/watch?reload=9\&app=desktop\&v=g6jpjMfboww](https://www.youtube.com/watch?reload=9&app=desktop&v=g6jpjMfboww)

## Integration

This integration is built by the Avatour development team supported by the Igloo application integration team. The integration enables the 360 video output to be displayed in a suitable format for Igloo immersive spaces. The integration can be activated using a button in the Avatour user interface and it can also be specified with a URL parameter.

### Igloo Core Engine Session

From version 1.3.0 onwards, your Igloo Core Engine installation will have a ready-made session in the content library called 'Avatour'.  
If the session is not there, then you can import it from `C:\ProgramData\Igloo Vision\IglooCoreEngine\example sessions\Avatour`

After loading the Avatour session, select 360 movies and screenshots from the assets list on the left hand side.  
![image-20240411-160358.png](https://docs.igloovision.com/__attachments/a_af5c668db39a1b4c48f4728e94c1e6ed0c1440fb433c9e8784bf575debc2cd9e/image-20240411-160358.png?cb=403c644bb1426c333cee6ee9c1c1cc30)
Assets view in Avatour.

For instance, select the Museum Tour asset and view the 360 tour.  
![ice8.png](https://docs.igloovision.com/__attachments/a_ed49f538ca6927945721d266a7e7b388f0efbcbf39788bfc5d0b38c406de8bf4/ice8.png?cb=0bfa6096b550c7439e9f516dfc00cc66)
Museum tour example asset.

### URL Parameters

The following URL template may be used to auto join a session in igloo mode:

[https://avatour.live/autojoin?s=*\<session id\>* \&user=*\<user name\>*\&igloo=1](https://avatour.live/autojoin?s=IGLOO&user=igloo&igloo=1)

The **s** parameter is the session id, the **user** parameter is the user name and **igloo=1** enables igloo mode.

### Detailed Session Setup

When connected to an Avatour session, the button bar at the bottom of the screen has a button called 'Enable Igloo'. When this is enabled, any 360 content which is shared will be rendered as a cubemap. This can then be viewed in a WebView and have the Cubemap to Equirectangular and TruePerspective effects applied.

Create a WebView and set the URL to <https://avatour.live/join> . Enter your name in the Your Name field and enter your meeting code. Then press the Join Meeting button.  
![ice1.png](https://docs.igloovision.com/__attachments/a_8db89516c561970c0aba38f83a1f5a3319cf3a2176372c289f036fe721e2e69f/ice1.png?cb=a8ca7645ac5ba339b94f38a2eb164b9f)
WebView with URL for joining an Avatour meeting/session.  
![ice2.png](https://docs.igloovision.com/__attachments/a_dcf6ed874aac650c62ea6a72bd83129c94d549fb861949e261cf8581121bd06a/ice2.png?cb=8a42abed695f2e3809581cbbcdf0c25d)
Logged in and ready to join the meeting.  
![ice3.png](https://docs.igloovision.com/__attachments/a_580e2f211aad2b7aa28c5b3780ff23f9e177b8b1442514dc7df51c8ac173780b/ice3.png?cb=58ea008dfb4ba0f8977162e6dff99264)
Meeting display with content, participants and options.

Once in the meeting, select one of the Workspace files e.g. the Museum Tour. This will display as an orbitview style of 360 movie, allowing you to move the camera view by click-dragging the left mouse button over the content.  
![ice4.png](https://docs.igloovision.com/__attachments/a_5bd9dc0fb5bcda770141f03378349898d029d90702f6c1b94b286f5cd7126062/ice4.png?cb=3d685fffa0aae2b5e7e2d76bea84b05b)
Museum Tour shown in orbitview style.

Next, click on the More button at the bottom of the screen and select 'Enable igloo' from the pop-up menu.  
![ice5.png](https://docs.igloovision.com/__attachments/a_e828c6ffc0ebfffbbcfc81735667ef81d0d31c16292ebd930c71bba12868ff5c/ice5.png?cb=1b8fedab9482cc39c9b8b6ee539e6ae9)
Enabling Igloo mode from the More menu.

The 360 content is now displayed as a cubemap.  
![ice6.png](https://docs.igloovision.com/__attachments/a_4f707b36a647d94a408bc37ab9737ec1bf713ca58cd0e42fe42aacffbb8d30b5/ice6.png?cb=67ce2825e9a8d436ff0bb4084f45b214)
Museum Tour shown in cubemap style.

Make the following changes to the layer to display the cubemap correctly. Untick the Dynamic Resolution option and set the WebView resolution to be 6000 x 1000. Untick the Show UI option.  
![ice7.png](https://docs.igloovision.com/__attachments/a_1e57b691f0b56138df7bae10424b36c361173257ed9317ef25053155764862cf/ice7.png?cb=39c5374388bb0e96097e0e02176cf718)
WebView with fixed resolution.

Finally, add the Cubemap to Equirectangular and TruePerspective effects so that the cubemap will display correctly in the Igloo.  
![ice8.png](https://docs.igloovision.com/__attachments/a_ed49f538ca6927945721d266a7e7b388f0efbcbf39788bfc5d0b38c406de8bf4/ice8.png?cb=0bfa6096b550c7439e9f516dfc00cc66)
WebView with effects applied.

## Further Reading

### Cameras

<https://support.avatour.co/en/which-360-camera-should-i-use-with-avatour>

### Links

Avatour [support site is here.](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Ft.sidekickopen01.com%2Fs3t%2Fc%2F5%2Ff18dQhb0S7kF8bGj8zW10xWTy59hl3kW7_k2847sCVdpW3KTqHd1HmRvNVVmGrz8nrDYM102%3Fte%3DW3R5hFj26QkHhW4hKKYc49RFx1W4kB1GX4hLs4m348V2%26si%3D7000000000761877%26pi%3D1181b50b-fcbe-4e8c-9be3-6f0ebff41c34&data=04%7C01%7Cgareth%40igloovision.com%7C53c3a13ab8604202aa9408d94d8dab53%7Ca2479d8092d24419baff3cc4aef913e7%7C0%7C0%7C637626093132539600%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=sjv24JEEokteO4suFMcFkQqzW44rpsdoIn%2BwQJmtkus%3D&reserved=0)

Some get-started links:

* [Quick start instructions](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Ft.sidekickopen01.com%2Fs3t%2Fc%2F5%2Ff18dQhb0S7kF8bGj8zW10xWTy59hl3kW7_k2847sCVdpW3KTqHd1HmRvNVVmGrz8nrDYM102%3Fte%3DW3R5hFj4cm2zwW4cQKj043Whb6W3zjgpg43XxrxW3FbmHX41pRT3W4m7X4w1GCmtZW4cHYRn3Q-Yg_W4kB1GX4hLr_KF43WJGLTQ1h1%26si%3D7000000000761877%26pi%3D1181b50b-fcbe-4e8c-9be3-6f0ebff41c34&data=04%7C01%7Cgareth%40igloovision.com%7C53c3a13ab8604202aa9408d94d8dab53%7Ca2479d8092d24419baff3cc4aef913e7%7C0%7C0%7C637626093132549598%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=MP2xtGsPSV0WgaVftdoupoJ7Ze1X2iKH0%2FqlZ7ssWeA%3D&reserved=0)

* [Hardware quickstart](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Ft.sidekickopen01.com%2Fs3t%2Fc%2F5%2Ff18dQhb0S7kF8bGj8zW10xWTy59hl3kW7_k2847sCVdpW3KTqHd1HmRvNVVmGrz8nrDYM102%3Fte%3DW3R5hFj4cm2zwW4cQKj043Whb6W3zjgpg43XxrxW3FbmHX41pRSQW49K5l149Kpk7W4hGPt54cQgwjW4fdj893H4T29n3P77Fn1V3%26si%3D7000000000761877%26pi%3D1181b50b-fcbe-4e8c-9be3-6f0ebff41c34&data=04%7C01%7Cgareth%40igloovision.com%7C53c3a13ab8604202aa9408d94d8dab53%7Ca2479d8092d24419baff3cc4aef913e7%7C0%7C0%7C637626093132559591%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=3JrLhl9CwJR4afPOQDovWaYOBF4XGEYX7mzZN9Gxcgg%3D&reserved=0) video

* [Avatour app quickstart](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Ft.sidekickopen01.com%2Fs3t%2Fc%2F5%2Ff18dQhb0S7kF8bGj8zW10xWTy59hl3kW7_k2847sCVdpW3KTqHd1HmRvNVVmGrz8nrDYM102%3Fte%3DW3R5hFj4cm2zwW4cQKj043Whb6W3zjgpg43XxrxW3FbmHX41pRdWW45l5JZ3SYMh9W4fDYv81GJTXgW3K7swS4hGPyL0%26si%3D7000000000761877%26pi%3D1181b50b-fcbe-4e8c-9be3-6f0ebff41c34&data=04%7C01%7Cgareth%40igloovision.com%7C53c3a13ab8604202aa9408d94d8dab53%7Ca2479d8092d24419baff3cc4aef913e7%7C0%7C0%7C637626093132559591%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=igwdLpyoncADFPdTR7TiiR3b7Jk12XdTH9KyeaQnq40%3D&reserved=0) video

* [Guest device requirements](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Ft.sidekickopen01.com%2Fs3t%2Fc%2F5%2Ff18dQhb0S7kF8bGj8zW10xWTy59hl3kW7_k2847sCVdpW3KTqHd1HmRvNVVmGrz8nrDYM102%3Fte%3DW3R5hFj4cm2zwW4cQKj043Whb6W3zjgpg43XxrxW3FbmHX41pT92W3zhlVb3Kbt5DW3K96qf41QPRVW3K22lz49PHzhW3K8R3w3F4FyLW3W0hjl1Gy7mLW3zjgpg43XxrwW4cJ2-c3T1McGW3zgYpw1GBFSL3bd32%26si%3D7000000000761877%26pi%3D1181b50b-fcbe-4e8c-9be3-6f0ebff41c34&data=04%7C01%7Cgareth%40igloovision.com%7C53c3a13ab8604202aa9408d94d8dab53%7Ca2479d8092d24419baff3cc4aef913e7%7C0%7C0%7C637626093132569583%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=FKJfyviImqjecXvRwzvTWaH7iLMu1browSXMvLPz8Sc%3D&reserved=0)

## I have an Issue!

For issues with the Revizto integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# Barco ClickShare

The Igloo Core Service provides low-level integration with Barco ClickShare devices, utilising the ClickShare API.

## Summary

When configured correctly, the service will listen for events from the target device(s). When the device goes in or out of use (as defined by the device itself) the service will undertake the configured actions. For ease, the service can load and remove a `.iceLayer` file when the device goes in or out of use. If more complexity is required, it can also execute arbitrary shell commands when the same events occur.

### Example (after correct configuration)

1. Open the ClickShare app and select the target device.

2. The configured `.iceLayer` file will be added to the workspace.

3. The sharing code becomes visible on-canvas after addition of the layer.

4. Enter the code into the ClickShare app and start screen sharing

5. When the app is closed or sharing is stopped, the layer will be removed.

## Configuration

In `config.json` under the `clickshare` key, provide an array of clickshare device descriptors.
JSON

      "clickshare": {
        "devices": [
          {
            "enabled": false,
            "loadLayer": true,
            "removeLayer": true,
            "layer": "C:\\dev\\igloo\\igloo-core-service\\dist\\layers\\clickshare.iceLayer",
            "ip": "",
            "enabledAction": {
              "cmd": "",
              "args": []
            },
            "disabledAction": {
              "cmd": "",
              "args": []
            }
          }
        ]
      }

* `enabled` - whether to subscribe to device events.

* `loadLayer` - whether to add the configured `.iceLayer` file when the clickshare device starts being used.

* `removeLayer` - whether to remove the configured layer when the device goes out of use.

* `layer` - path to `.iceLayer` file

* `ip` - IP address of the target ClickShare device on the local network.

* `enabledAction`

  * `cmd` - shell command to execute when the device starts being used.

  * `args` - arguments to that shell command

* `disabledAction`

  * `cmd` - shell command to execute when the device stops being used.

  * `args` - arguments to that shell command.

---
version: "2.0.0"
language: "en"
---
# BaselineZ

BaselineZ ([https://baselinez.com](https://baselinez.com/)/) is a real-time VR application for Geoscience data visualisation and collaboration.

"Imagine visualizing your geoscience models and data in augmented reality while interacting with your colleague's 3D Avatars. BaselineZ accelerates experiences, knowledge sharing and decision making. Enhance your 2D screen workflows, with immersive and fun ways to work, share knowledge, and collaborate on 3D Subsurface Projects from anywhere."

Watch the video: <https://vimeo.com/927506528>

## Integration

An Igloo-compatible build of BaselineZ is available from the BaselineZ website at <https://baselinez.com/downloads/> .

The integration is developed by the BaselineZ development team with support from the Igloo application integration team and the Igloo Unity Plugin.

A Getting Started guide is provided by the BaselineZ team:

[BaselineZ IGLOO Getting Started.pdf](https://docs.igloovision.com/__attachments/a_d8a73f83fa74c16ebfcb208e3b7dea74167a3d4d4ae18de15deb4265214cb906/BaselineZ%2520IGLOO%2520Getting%2520Started.pdf.md?cb=bea1334f014e65e4320c8f3e38a648b9)

### Settings

Here are the settings to apply when creating a BaselineZ session:

Layer type: Spout

Spout sender name: IglooUnity

Effects: TruePerspective

Misc: exe path - path to Baselinez app  
![baselinez_layer.png](https://docs.igloovision.com/__attachments/a_d27910debe39aece7c6d69e89b284072e4dee4bd81e358251c07046c3d0e9a0e/baselinez_layer.png?cb=9c27dbd9ce689ac0fef3eba7974bf035)

### Startup

When BaselineZ starts up, it is necessary to Login with your username and password, or use the Explore option on the startup screen.  
![image-20260612-083430.png](https://docs.igloovision.com/__attachments/a_a14393dd802f6e47c0ae16ff8a91a709f5f9fcf2b09c2a7fe23e57924554f245/image-20260612-083430.png?cb=de14dd7cd544a6008690c59bca18bfd2)

The Explore option displays a number of sample projects to choose from:  
![baselinez_projects.png](https://docs.igloovision.com/__attachments/a_662c11468c9519710f5e41ddff5b9f6f2b7010ce53d075fa3a0b87671557580d/baselinez_projects.png?cb=1e5116fda6ad02344dd599a3faf31ae3)

The 3D Stories feature is a powerful presentation tool which combines slides, animations and 3D data. The view in the scene can be changed while the presentation is running. The Welcome Tour is an example 3D Story.

### Navigation

BaselineZ has an on-canvas user interface which can be controlled from Igloo Control Panel or a Game Controller.

From the console you can use keyboard control WASD to move forward, left, back, right.

Use the Game Controller tab in Igloo Control Panel to move around in the scene. If available, this will utilise the gyro mechanism to adjust the cursor position. Use the joystick to navigate around the scene. Direct the cursor at an object or a floating menu item and press B to select it. There is a mode selection using the A, X and Y buttons. Toggle each mode on and off using the appropriate button: A (pan mode), X (scale mode) and Y (rotation mode) and use the joystick to adjust the pan, scale and rotation values.  
See the Getting Started guide for more detailed navigation info.

## I have an Issue!

For issues with the BaselineZ integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# Before You Update to 2.0 – Key Changes

# Before You Update to 2.0 -- Key Changes

This page outlines a number of key user interface and workflow changes to be aware of when updating from Igloo Core Engine 1.5 to 2.0.

For a complete list of changes, please refer to the full release notes here - [2.0.x](https://docs.igloovision.com/documentation/current/2-0-x.md)

We have also updated our set of introductory tutorial videos which you can find here:

* Igloo Core Engine - [Desktop UI](https://docs.igloovision.com/documentation/current/desktop-ui.md)

* Igloo Control Panel - [Control Panel UI](https://docs.igloovision.com/documentation/current/control-panel-ui.md)

*** ** * ** ***

## Igloo Core Engine

The Desktop UI has received significant updates and refinements. While the overall layout remains familiar, a number of visual, usability, and organisational improvements have been made.  
![image-20251215-161222.png](https://docs.igloovision.com/__attachments/a_356e96a708309470b14be019dcbf8c6f0c41fec8badccae3268284ea136d89ca/image-20251215-161222.png?cb=ff6a3a4496614710ae83ebd97548cb05)

Key changes include:

* Updated colour scheme and overall styling

* The Contextual and Generic layer property panel ordering has been switched

* Dedicated Session Toolbar

* Drag drop reordering of layers

* Collapsible layers

* Light and Dark mode support

* Status Bar (View \> Status Bar to show / hide) which includes

  * System utilisation information

  * NDI management visibility

  * Triggers \& Actions status feedback

For a high-level overview of the updated Desktop UI see:

[Desktop UI Overview](https://docs.igloovision.com/documentation/current/desktop-ui-overview.md)

Tutorial videos covering the changes in more detail are available here:

[Desktop UI](https://docs.igloovision.com/documentation/current/desktop-ui.md)

*** ** * ** ***

## Igloo Control Panel 2.0

![image-20260410-131953.png](https://docs.igloovision.com/__attachments/a_ea25820bdc92e87aa733968ae68e1371b3cefe898d684782b3382109196decfb/image-20260410-131953.png?cb=1f3e1b510d71e2b575236ea0f6ca6b92)

Igloo Control Panel 2.0 is a **completely rebuilt application**, designed to align with Igloo Core Engine 2.0 and modern workflows.

While it retains core functionality such as casting, layer control, and session management, it introduces a new unified interface, improved responsiveness, and streamlined workflows across desktop, tablet, and mobile devices.

For a high-level overview of the updated Control Panel UI see:

[Control Panel UI Overview](https://docs.igloovision.com/documentation/current/control-panel-ui-overview.md)

Tutorial videos covering the changes in more detail are available here:

[Control Panel UI](https://docs.igloovision.com/documentation/current/control-panel-ui.md)

### Key Features

#### Connecting \& System Switching

* Quickly switch between multiple systems within the same interface

#### Casting

* Control content from from your device

* Supports common workflows previously split across multiple tabs/pages

#### Launchpad Integration

* Access and trigger Launchpad tiles directly from Control Panel

* Designed for simple operator and kiosk-style control

#### Session Management

* Save, load, and edit sessions directly from the Control Panel

#### Layer Control

* View and control active layers within a session

* Adjust visibility, ordering, and key properties

* Fully usable on mobile devices

#### New File Upload Process (Media Library)

* Upload files directly from your device to the media server

* Integrated into the Media Library UI

* Replaces the file drop app

#### Apps

* HTTPS is now required for Apps to function within the Control Panel

* Unsupported apps can be opened externally in a browser

#### Blocks \& Configuration

* Modular UI built around reusable "blocks"

* Enables user configuration for what is displayed within the control panel UI for layers

*** ** * ** ***

### UI \& Workflow Improvements

* **Completely new application structure**

  Replaces the previous tab-based layout (Key + Mouse, Layers, Apps) with a unified, streamlined interface

* **Single URL access**

  All functionality is now accessible via one URL, simplifying access and allowing use directly in a browser

  *(Help → Control Panel → Open in Browser)*

* **Responsive design**

  Improved support across mobile, tablet, and desktop devices

* **Light and Dark modes**

* **Improved navigation and usability**

  Faster access to core functionality with reduced context switching

*** ** * ** ***

### New Applications \& Installers

These can all be access from within Igloo Core Engine following installation of 2.0 via `Help > Igloo > Control Panel > Get App`

* **iOS / Android**

  Available as **Igloo Control Panel 2.0** on the App Store and Google Play

* [‎App Store](https://apps.apple.com/us/app/igloo-control-panel-v2/id6759917924)

* **Desktop (Windows)**

  New standalone installer which is installed to a new path in window:

  `C:\Program Files\Igloo Vision\IglooControlPanel`

*** ** * ** ***

### Backwards Compatibility

To support a smooth transition:

* Previous Control Panel versions remain compatible with **Igloo Core Engine 2.0**

We strongly recommend upgrading to Control Panel 2.0 for the best experience and full feature support, but this approach allows flexibility during the transition period.

*** ** * ** ***

## New UI Systems You'll Notice

Several new UI driven systems have been introduced in 2.0 and may be immediately visible when upgrading.

### Launchpad (New)

A tile-based system for managing, displaying, and launching Sessions and Triggers.

Launchpad is designed for operator-friendly and kiosk-style workflows.

[Launchpad](https://docs.igloovision.com/documentation/current/launchpad.md)

### Session Collections (New)

A new way to organise and browse sessions, used across the Desktop UI and Media Library.

Sessions can be grouped into collections and sorted by when they were last loaded.

[Session collections](https://360igloo.atlassian.net/wiki/display/STD/Session+collections)

---
version: "2.0.0"
language: "en"
---
# Black Level Tab

Requires Igloo Core Engine version 1.5.0+

Projectors tend to leak some light, even when displaying a completely black image. This light becomes very noticeable in the areas where projectors are overlapping.

To hide this noticeable light leak in the projector overlap areas, it helps to raise the light level in the areas where the projectors do not overlap.

When setting up the black level adjustment, then it is critical that the Warping and Blending has been correctly set, and the projectors have been turned on for at least 10mins.

This warm up period is critical, as the projectors mechanical and electrical parameters will change during this warm up period.

**Some of the issues you might encounter are**

* Misaligned projector overlap areas -- due to the mechanical properties of the projector optics.

* Misaligned black level values, as the electrical properties of the lamp, DLP or SXRD chips changes.

**Pre black level adjustment checklist**

1. Make sure all the projectors are at normal operating temperature

2. Make sure all projectors are outputting the same luminance, using a bright image.

3. Make sure all Warp and Blend adjustments are done properly

## Configuration

### **Setup the projector non overlap areas**

1. Enable the 'Black Level' tab: The Black level tab is hidden by default. To Enable, from the main menu bar 'view \> Black Level Tab'

2. Within the Black Level tab enable the***Regioning Mode.***

3. Enable the warping control points, they should now appear blue.

4. Using the normal Warping controls, mark the areas where the projectors***do not overlap***.

### **Setup the black level blending**

Blending should only be used in cases where the projector has overscanning which cannot be disabled. Disabling projector overscan will provide much better results and will be significantly easier to maintain.

While the Black level regioning mode is enabled, then you can configure the blending using the normal blending tool's. When using the Blending, a small overlap can be used to hide/smear out the sharp edge between the non-overlapped, and the overlapped area. This is achieved by defining the non-overlapped area a few pixels into the projector overlap area. If the blend area is too wide, then this can cause some unwanted artefacts within the blend area.

### **Configure the Black Level uplift parameter**

1. Using the ***Uplift Amount***, adjust the value to match the luminance of the center of the overlapped area.

2. Depending on the projector setup used in the installation, you maybe need to adjust the amount of uplift by different amounts to match the corners of the overlapped area. This can be done with the ***Upper left*** **,** ***Lower left*** , ***Upper right*** , ***Lower right*** and ***Right center compensation***. Adjust these values to get the a uniform black level uplift.

### **Configure the Black Level roll off parameters**

1. At higher luminance values, the adjustment at the non-overlapped regions can overshoot their luminance artificially as a result of the ***Black level*** adjustment at low luminance values. The parameters **Threshold** and**Width** correct the **Black level** adjustment for higher luminance values by gradually scaling its value to zero after a threshold luminance value.

2. The parameter **Threshold** controls the luminance value after which the **Black level** adjustment decays to zero. The parameter **Width** controls how fast the adjustment falls off to zero.

3. Figure 1 illustrates the shape of the **Blacklevel rolloff** as a function of image luminance. The x-axis represents the image luminance and the y-axis represents the scaling of the ***Black level*** adjustment. The **Blacklevel Threshold** value is 0.5 and the **Blacklevel Width** is 0.1.

   ![Sigmoid_avg05_sig01.png](https://docs.igloovision.com/__attachments/a_1b0bbaf3d4c12f1c07d086d5d07a9438bb5490a6bf0623d3e1d97cd1323020f3/Sigmoid_avg05_sig01.png?cb=3d346ae58a0e558dafc85f8a08446dcc)
4. Figure 2 shows the effect of changing the **Blacklevel Threshold** value to a lower value 0.2. The code snippet below can be used to visualise different **Blacklevel rolloff**shapes.

   ![Sigmoid_avg02_sig01.png](https://docs.igloovision.com/__attachments/a_71e9768241c52c79173f651480d94ff5298f7b104c26b86fefba5f382ce69ede/Sigmoid_avg02_sig01.png?cb=bac6c0b049f0193d2d20a2d574e71ad3)

### **Export Black Level Settings**

When done, enabled the **Black Level** checkbox in the **Export** Tab. Igloo Setup will then export a set of black level image masks and settings for Igloo Core Engine to use.

---
version: "2.0.0"
language: "en"
---
# Blackmagic

Igloo Core Engine has support for the Blackmagic cards which are compatible with the Blackmagic Desktop Video drivers. These cards include the Decklink and Intensity series. The Blackmagic Layer enables users to select from available video inputs to initialise video capture.

## Setup

1. Create a new Blackmagic layer. From the toolbar navigate to Layer \> Add Layer \> Blackmagic

2. With the Blackmagic layer selected in Igloo Core Engine, you will see a list of available video inputs for your capture card within the Layer properties panel.

3. Simply select the input you wish to capture from. You can change this selection at any point.

4. Once the input is selected, the software will initialise video capture from that input.

### Troubleshooting

Should you encounter any issues while using a Blackmagic capture card in Igloo Core Engine, please take the following steps:

1. Ensure that the capture card is correctly installed and recognised by your system, this can be verified within windows device manage and the Blackmagic Media Express application.

2. Check that the appropriate drivers for the card are up-to-date.

3. Make sure the video source connected to the selected input of the capture card is sending out the signal correctly

---
version: "2.0.0"
language: "en"
---
# Blending Tab

## Edge Blend to Soften Aliasing

A small edge blend can be used counteract aliasing. Typically, you may see this on the top edge of the Warp after exporting for a cylindrical screen.

* In the Warpers blend settings, set the Top Global Gamma to 0

* Increase the Top Width setting until the blend covers between 1-5 pixels

* Increase the Top Global Gamma until you see a smooth transition to black

* Repeat for all Projectors

---
version: "2.0.0"
language: "en"
---
# Blockade Labs Skybox

This integration enables 360 images to be generated using Blockade Labs Skybox AI and viewed in an Igloo.  
Please note there is a new method for generating images using AI models, introduced in IglooCoreEngine 2.0, see [Image Generation](https://docs.igloovision.com/documentation/current/image-generation.md)

Scroll down for a description of the legacy method for using Blockade Labs Skybox.

**Integration within Image Layer properties**

We have integrated with a number of different AI models for image generation. These integrations can be accessed via the Igloo Desktop UI and Igloo Control Panel.

Set the default models to be used in the System Settings dialog (Desktop UI):  
![image-20260415-123454.png](https://docs.igloovision.com/__attachments/a_efd9193ac1f76875ce5aad514b8cc1a34e4b72ccfcd2170ee294c25c9f32df15/image-20260415-123454.png?cb=db0b37a243ac6b69cd816e7aff8f5f0b)

The Generate Image button will appear in the layer properties section when an Image layer is created.  
![image-20260415-122335.png](https://docs.igloovision.com/__attachments/a_e630a0798fe6a4130109b46e50502da453343ca6af07e5f3eb1e6dc1109d2e0b/image-20260415-122335.png?cb=559e37cfb202bbe248f0383a296e37ff)
Generate Image button in Igloo Control Panel.

When the Generate Image button is pressed, the dialog below is shown with advanced properties depending on the default model. In this case the Skybox style dropdown is available.  
![image-20260415-124132.png](https://docs.igloovision.com/__attachments/a_30e558f96a0b66840fb4bb8290bae186d6c215a37766039338d05c9d58e00fca/image-20260415-124132.png?cb=74f52409d47b1ebb4f6beb674d70df44)

**Example 360 Image**

Using prompt 'Alpine village'. The prompt widget changes to 'Generating..' while the AI model is running.  
![image-20260415-125552.png](https://docs.igloovision.com/__attachments/a_55fb067f33aab097bc3932879172638358c834ed7e41c8322874cdd834d861c9/image-20260415-125552.png?cb=ca544140a7f944a010fbc1414b54f500)
After prompt has been entered, waiting for AI image to be generated.  
![image-20260415-125926.png](https://docs.igloovision.com/__attachments/a_d9c42201d670073d9ae12541f07ca991ead17466345bd7f480b4f3882c5fe9d6/image-20260415-125926.png?cb=abed995f511b635e6a10c05b9d0a6f25)
Following generation, the image is stored on the media player (e.g. C:\\ProgramData\\Igloo Vision\\IglooCoreEngine\\images\\generated\\BlockadeLabs\\)  
![image-20260415-125843.png](https://docs.igloovision.com/__attachments/a_0961bb96ed2e8ee2386979b5196b9af42ba990e5dea29cd1e55feb4a11912977/image-20260415-125843.png?cb=8e4656ea1731f58ed3a732582e809867)
The Blockade Labs Skybox generated image displayed in Igloo Desktop.

**Legacy Interface**

The AI prompt and image style are entered in Igloo Control Panel. Select the style, type in the prompt and press Enter. The image typically takes between 30 and 90 seconds to generate.  
![control_panel1.png](https://docs.igloovision.com/__attachments/a_0b5d50c131db192a30a19df9b5d91312f15f946e2f6ab50311f5171a287b1269/control_panel1.png?cb=e5e4bfd808d1d8a08cc43ff3d6a15e42)
Enter prompt in Igloo Control Panel e.g. "Classic landscape with country house, tree-lined drive and green hills"  
![equirect.png](https://docs.igloovision.com/__attachments/a_ec4be9a0e354857c3bb72d406accd1a65998b7febf7272a378dcbf601ffec0d7/equirect.png?cb=770e59a04d162b5bde66c8100d742444)
Equirectangular image generated by Blockade Labs Skybox.

## Requirements

An APIKey is required to use this integration. Keys can be obtained from <https://skybox.blockadelabs.com/membership>

Once obtained, insert the APIKey in the config.json file in C:\\igloo\\igloo-core-service.

     "skybox": {
        "apiKey": "<insert apikey here>"
      },

## Control panel

The URL endpoint for the control page is: `https://[media server ip]:801/skybox/control/` (https is required for clipboard functionality).

Enter the section below in `C:\igloo\igloo-core-service\custom_browsers.json`

    {
      "blockade": {
        "name": "BlockadeLabs",
        "url": "$remoteIP:800/skybox/control/",
        "https": true,
        "icon": "$ai/blockade.png",
        "description": "AI-generated panoramas"
      }
    }

Include `blockade` as an item in the apps list in `config.json`

    "apps": [
          "matterport",
          "streetview",
          "warping",
          "blockade",
          "default"
        ],

![control_panel2.png](https://docs.igloovision.com/__attachments/a_21b47d4a7c4fa20ed598a8b0cf77c8d2dce3725490d127a603fbf5c746821774/control_panel2.png?cb=cf6eb529ad30ada724501f6693f99084)
The Blockade Labs integration appears as a tile in the Apps tab.

## Igloo Core Engine

The URL endpoint for the AI generated image is: `http://localhost:800/skybox/viewFrame/`

Generated images will be automatically displayed in a WebView with the above URL. The WebView resolution should be set to 8000x4000 and true perspective should be added to the effects.  
![ice1.png](https://docs.igloovision.com/__attachments/a_1b8cc150dae9452f0750081cd5dcd3f3d11a00c04a785b181f5d58a6cae48588/ice1.png?cb=d9205d968788f3cdc819239485ae73c7)
WebView layer in Igloo Core Engine with 8000 x 4000 resolution and TruePerspective effect.

## Logo

Place blockade.png (below) in `C:\igloo\igloo-core-service\app-icons`  
![blockade.png](https://docs.igloovision.com/__attachments/a_23ec2099988f38b10621debad23684f2b9c8522c63edf2d8f111d33f13846340/blockade.png?cb=09dcdaa5f19a283ebb76f97a938350b2)

---
version: "2.0.0"
language: "en"
---
# BlockadeLabs skybox generator

See [Blockade Labs Skybox](https://docs.igloovision.com/documentation/current/blockade-labs-skybox.md)

---
version: "2.0.0"
language: "en"
---
# Blocks (Control Panel)

![image-20260414-125302.png](https://docs.igloovision.com/__attachments/a_a619457c7232867ed6408fff4d74af173aa06a27a9bbf43fd290a9f461c489b9/image-20260414-125302.png?cb=e4fa61af9eafbeb4527e0ddb16416f05)

You can modify most aspects of a layer's UI in Igloo Control Panel using layer metadata [Misc \| Metadata](https://docs.igloovision.com/documentation/current/misc.md#Metadata)

## Why?

Some layers are better controlled using custom UI rather than the default controls.

You may also want to:

* Simplify the UI for end-users

* Hide controls that shouldn't be modified

* Provide a custom interface tailored to a specific workflow

Metadata allows you to control exactly what is shown in the Control Panel.

*** ** * ** ***

## What can be done?

* Hide a layer from the Control Panel layer list

* Modify what elements of a layer's UI are displayed (the right hand side of the screen on desktop)

* Create and display new *blocks* within the layer's UI.

### Blocks

Three types of blocks can be created:

* `web`

  * Display a webpage

  * e.g. a control page (Streetview, etc.)

* `image`

  * Display an image from Igloo Core Service's `public/` directory

  * e.g. button map for a layer that uses a controller

* `builtin`

  * Display some additional predefined UI component on any layer type

  * e.g. presentation controls on a WebView showing [slides.com](http://slides.com/) or similar

* `text`

  * Display formatted text content using markdown

  * e.g. instructions for how to use the layer with description and links to external documentation

*** ** * ** ***

## How?

See the Igloo Core Engine metadata documentation [Misc \| Metadata](https://docs.igloovision.com/documentation/current/misc.md#Metadata) for information on how to add/edit metadata.

These are the available options in brief:
JSON

    {
      "hideFromLayerList": false,
      "hideEverything": false,
      "hideTopRow": false,
      "hideName": false,
      "hideMoveToRegion": false,
      "hideDelete": false,
      "hideLayerTypeUi": false,
      "hideLayerProperties": false,
      "hideGeneral": false,
      "hideGeometry": false,
      "hideTruePerspective": false,
      "block": {
        "streetview": {
          "type": "web",
          "url": "$ics/streetview/control",
          "title": "Streetview"
        }
      }
    }

Full documentation is accessible using the JSON schema methods discussed below.

You can provide this configuration to Control Panel in two ways:

*** ** * ** ***

### JSON

Configuration can be provided as JSON, as demonstrated above, using the metadata key `controlPanel`.

The available metadata configuration for your version of Igloo Control Panel is provided as a [JSON schema](https://json-schema.org/draft/2020-12/json-schema-core). You can make use of this in an editor that supports JSON schema validation by creating a JSON file containing the structure below, ensuring it refers to the address of an accessible instance of the Igloo Core Service. We recommend
JSON

    {
      "$schema": "http://localhost:800/api/control-panel/metadata-schema.json"
    }

Presuming that the text editor is set up correctly, it will provide autocomplete + validation of metadata declaration you're now writing (including documentation for each of the available properties).

You can view the same information in a browser, without the need for a text editor, using [json-schema.app](https://json-schema.app/start) -- paste the URL from above into the input field. ([This link](https://json-schema.app/view/%23?url=http%3A%2F%2Flocalhost%3A800%2Fapi%2Fcontrol-panel%2Fmetadata-schema.json) points to `localhost`, which will work locally on the media server).

Once you've built your configuration, you can copy paste it into the value of a layer metadata field with the key `controlPanel`.

### Flat (individual keys)

Any key from the above JSON format can be provided as a standalone key. This can be helpful when only minimal configuration is needed, or when testing.

Flat keys are merged with the JSON described above (i.e. both can be defined at once and the resulting properties will be merged).

For example, to hide the "move to region" button from a layer, you can provide the metadata key `controlPanel.hideMoveToRegion` with no value.

### `web` blocks

Two variables are available to blocks with the `web` type.

* `$ics` is replaced with the full URL pointing to the `igloo-core-service` on the machine that Control Panel is connected to (e.g. the equivalent of `http://localhost:800/`)

* `$imp` is replaced with the IP *only* of the same machine (e.g. the equivalent of `http://localhost`) -- this allows you to reference other web servers that might be running on that same machine.

*** ** * ** ***

## Examples

An example session demonstrating the capabilities of custom blocks and metadata is included with Igloo Core Engine.

You can import it from:

    C:\ProgramData\Igloo Vision\IglooCoreEngine\example sessions\Blocks Example

This session provides working examples of:

* Web, image, built-in, and text blocks

* UI customisation and layout control

* Practical configurations for real-world use cases

It's recommended to explore this session alongside the following examples to better understand how the configuration behaves in practice.

*** ** * ** ***

### Show Only Layer Type Controls

![image-20260414-113550.png](https://docs.igloovision.com/__attachments/a_2c70480ac4450d6c87b18b61a3308af9bbaeea68e91669fa33efaa9c3b327cc3/image-20260414-113550.png?cb=4a7184743f86687f213b4b049f11f887)

Hide General / Geometry but keep layer-specific controls (e.g. playback, PDF navigation):

    {
      "hideLayerProperties": true
    }

#### Flat

The following layer metadata:  

|              **Key**               |       **Value**       |
|------------------------------------|-----------------------|
| `controlPanel.hideLayerProperties` | `(no value required)` |

*** ** * ** ***

### Full UI Replacement (Maximised Web App)

You could embed the control page and hide all other built-in UI for a layer which provides its own frontend interface using the following configuration (using streetview as an example)

#### JSON

Layer metadata with key `controlPanel` and the value set to:
JSON

    {
      "block": {
        "streetview": {
          "type": "web",
          "url": "$ics/streetview/control",
    	  "features": {
    		"maximisable" : true
    	  }
        }
      },
      "hideEverything": true
    }

#### Flat

The following layer metadata:  

|               **Key**                |         **Value**         |
|--------------------------------------|---------------------------|
| `controlPanel.block.streetview.type` | `web`                     |
| `controlPanel.block.streetview.url`  | `$ics/streetview/control` |
| `controlPanel.hideEverything`        | (no value required)       |

*** ** * ** ***

### Button map

![image-20260414-113709.png](https://docs.igloovision.com/__attachments/a_9c4ab273f1d93f9c8491c5293333e88e14ac1c47c03f2e2b6c98e31159c55857/image-20260414-113709.png?cb=35f7bf4b1fd7cce8d790d67fcd112526)

Place your desired button map image in `C:\igloo\igloo-core-service\public\` (let's call it `ButtonMap.jpg` for now).

This will place the image at the top of the layer UI section, as well as hiding:

* the layer's built in UI (e.g. the Spout sender selection controls)

* the "general" and "geometry" layer property sections (leaving access to the "True Perspective" section)

But leaving everything else intact.

#### JSON

JSON

    {
      "block": {
        "button_map": {
          "type": "image",
          "path": "ButtonMap.jpg"
        }
      },
      "hideLayerTypeUi": true,
      "hideGeneral": true,
      "hideGeometry": true
    }

#### Flat

|               **Key**                |      **Value**      |
|--------------------------------------|---------------------|
| `controlPanel.block.button_map.type` | `image`             |
| `controlPanel.block.button_map.path` | `ButtonMap.jpg`     |
| `controlPanel.hideLayerTypeUi`       | (no value required) |
| `controlPanel.hideGeneral`           | (no value required) |
| `controlPanel.hideGeometry`          | (no value required) |

*** ** * ** ***

### Presentation Controls for a WebView (maybe displaying [slides.com](http://slides.com/))

![image-20260414-113843.png](https://docs.igloovision.com/__attachments/a_b6a498f2d313b8974bca8c20d5118506088d323d856cd3f89c93eb1c4d95c3e8/image-20260414-113843.png?cb=1cb38bbac979e506dbf02439ef53bf4b)

Add the presentation controls, but don't change anything else about how the layer's UI is displayed

#### JSON

JSON

    {
      "block": {
        "c": {
          "type": "builtin",
          "builtin": "presentationControls"
        }
      }
    }

#### Flat

|            **Key**             |       **Value**        |
|--------------------------------|------------------------|
| `controlPanel.block.c.type`    | `builtin`              |
| `controlPanel.block.c.builtin` | `presentationControls` |

*** ** * ** ***

### Text Instructions Block

![image-20260414-114537.png](https://docs.igloovision.com/__attachments/a_ebaa6aa4c5be8bdef8efd2bce097adc11eb4040de24f2f3795e11caa393ab488/image-20260414-114537.png?cb=9ec0380b74d2b4e433a9b7bad59753d2)

Provide inline instructions for users include link to external documentation@
JSON

    {
      "block": {
        "info": {
          "type": "text",
          "title": "WebView Controls",
          "body": "**Navigation**\n- Enter a URL and press **→** to load a page\n- Use **←** / **→** to navigate\n- Press refresh to reload\n\n---\n\n[WebView documentation](https://docs.igloovision.com/documentation/current/webview)"
        }
      }
    }

### Maximisable Web Block with True Perspective

![image-20260429-152014.png](https://docs.igloovision.com/__attachments/a_2bbde3e679d8eff387ec13bab07682ba1a0f9d004fac08e7165c5f772d1b4124/image-20260429-152014.png?cb=6b251d5a46b8a1469f21fd7c76332662)

Use this approach when the main control UI should be an embedded, maximisable web block, while still keeping the True Perspective settings available.

This is useful for app-style layers such as Kuula, where the user mostly interacts with the custom web controls but may still need to adjust True Perspective.

Layer metadata with key `controlPanel` and the value set to:

    {
      "hideGeometry": true,
      "hideGeneral": true,
      "block": {
        "controls": {
          "type": "web",
          "url": "$ics/kuula/control",
          "title": "App Controls",
          "features": {
            "maximisable": true
          }
        }
      }
    }

This shows the embedded web controls as a maximisable block and hides the General and Geometry sections, leaving True Perspective visible alongside the custom controls.

---
version: "2.0.0"
language: "en"
---
# Canvas Configuration

## Output rotation

The output canvas rotation can be adjusted to suit your needs. This feature is particularly useful when the projectors or Igloo Setup regions result in the canvas centre being located in a corner of the room. By default, new layers in Igloo Core Engine are placed at the centre of the canvas. However, in most cases, it is more desirable to have the canvas centre positioned in the middle of the room.  
![image-20230310-153407.png](https://docs.igloovision.com/__attachments/a_7a8f22a6d67925d2068e3257068f0bf1036f652018c1fac4c7c0cef2ddec4e5a/image-20230310-153407.png?cb=5c1d3b20557b06361a403d42bcd158e9)
Not ideal  
![image-20230310-153442.png](https://docs.igloovision.com/__attachments/a_877b134d21baaf5ef8d063944cbfb1adb0ead673c65fe8cb7f066c0e3c5dac7a/image-20230310-153442.png?cb=0b3baa04f0ba83c3c0de3aa7506d880e)
Better output orientation

When adjusting the output rotation, it is important to note that the changes will only impact the output before warping is applied. This means that the desktop canvas tab view will remain unchanged. To see the effects of the new rotation, navigate to the Screen tab. Here, you can observe how the canvas is applied to the 3D preview of your screen.

### Floors and walls

In the Igloo Setup app, you have the option to export both a wall and a floor region. While a wall region is always exported, the floor region is optional. This will create two separate regions in the output settings file named CanvasSettings.xml.

The rotation of the wall is applied horizontally, causing the output to shift accordingly. On the other hand, when you apply rotation to the floor region, it will rotate around its own center.

### CanvasSettings.xml

The output settings file named CanvasSettings.xml is exported from Igloo Setup and is also where the default settings are saved. Please note that a wall "roi" (region of interest) is always exported. However, the floor region will only be included if it is selected in Igloo Setup.
XML

    <CanvasSettings>
    	<Resolution>
    		<width>4000</width>
    		<height>1000</height>
    	</Resolution>
    	<ScreenType>
    		<type>Box</type>
    		<rois>
    			<roi type="floor" x="0.365517318" y="0.500000000" w="0.249999970" h="0.500000000" />
    			<roi type="walls" x="0.000000000" y="0.000000000" w="1.000000000" h="0.500000000" />
    		</rois>
    		<IgnoreWallRotationTP>1</IgnoreWallRotationTP>
    		<IgnoreFloorRotationTP>1</IgnoreFloorRotationTP>
    		<defaultWallRotation>0</defaultWallRotation>
    		<defaultFloorRotation>0</defaultFloorRotation>
    	</ScreenType>
    </CanvasSettings>

![image-20260414-201341.png](https://docs.igloovision.com/__attachments/a_031e9957bbafc5200526b91ce77fbdb6b237de512d2f278171fb78fd086e8c73/image-20260414-201341.png?cb=2f1de64ef498f932156742e559725981)

## Ignore rotation for True Perspective

The two checkboxes named "Ignore wall/floor rotation TP" determine how layers using the TruePerspective (TP) effect behave in relation to the canvas rotation. Rotating the canvas output of a true perspective layer can disrupt the true perspective effect. For example, the true perspective effect expects the corners of the room to be in a fixed position, but changing the output rotation can cause the corners calculated by the true perspective shader to be misaligned with the physical corners of the room.

When "Ignore wall/floor rotation TP" is enabled, all layers that use true perspective will automatically adjust their output to compensate for the canvas rotation. As a result, even though other UI elements and non-TP layers may be rotated, the image of a TP layer will appear to remain in the same position. To change the orientation of a TP layer, you should adjust the "Heading" variable in the TP menu.

It is important to note that when "Ignore wall/floor rotation TP" is enabled, the TP layer texture will still be rotated in the console Canvas tab. However, what you see on the output is the compensation for the rotation being applied, which makes the TP layer appear stationary..

![image-20230313-104643.png](https://docs.igloovision.com/__attachments/a_a9e308ed7a708a48a117fc6c10186506e9d165ae86945e27553ef38796724b9f/image-20230313-104643.png?cb=9dfa74ecde1d1c5575d2dd9c0a68d01e)
Ignore rotation ON  
![image-20230313-105238.png](https://docs.igloovision.com/__attachments/a_f3aedae9106a15e2dfdd8974d053841867efcf1767be5f0f7031b29052bd5500/image-20230313-105238.png?cb=d318a930240fef27ec7c150b1b51b608)
Ignore rotation OFF

---
version: "2.0.0"
language: "en"
---
# Canvas Recording \| Screenshot

You have the capability to capture your workspace activities in the form of a video file, as well as take still snapshots.

To personalise the settings for video recording and screenshots, follow the steps below:

1. Navigate to the 'Workspace' menu.

2. Select the 'Canvas Share' option.

3. Open the 'Record' tab to access and configure the recording and screenshot settings.

All settings are saved per Workspace

You can also quick-access these setting via the toolbar  
![image-20230717-115144.png](https://docs.igloovision.com/__attachments/a_4fae4d11bafe325ce2470472c5b48c311abf1f97c650c01eb1d24661a55b7c0d/image-20230717-115144.png?cb=ba76f3459474de3481a5dc9c2ce9b81e)

*** ** * ** ***

![image-20230717-113958.png](https://docs.igloovision.com/__attachments/a_895587048bf032d99572d35cdb31f5cfda1376ab424ba81ac085237ae67c5e7d/image-20230717-113958.png?cb=8c729302b7d9981895115ad50e4e5d79)

## Record settings

### Filename

This field represents the beginning part of your output file's name. You can customize it to your preference.

#### Folder

This is the location where your recorded files will be stored. Choose a folder on your system where you want the recordings to be saved.

#### Format

You can choose the quality and corresponding format of your video from the following options:

1. High Quality (Hap): This option gives you superior video quality but results in larger file sizes.

2. Medium Quality (H.265): Offers moderate video quality with reasonable file sizes.

3. Low Quality (H.264): This choice provides lower video quality but ensures smaller file sizes.

#### Scale

This optional setting allows you to adjust the resolution of the video. You can specify a scaling value to alter the video resolution while keeping the original aspect ratio intact.

#### Frame rate

This is the desired frames-per-second (FPS) rate of your recording. Higher frame rates yield smoother video playback, but can result in larger files.

#### Audio

You can enable this setting if you wish to capture audio along with the video. If disabled, the output file will be a silent video.

#### Source

This setting determines the origin of the audio that will be recorded. By selecting 'App audio', you can capture the sound from the Igloo Core Engine application. Alternatively, you can choose any available connected audio devices from the list to record audio from those sources.

*** ** * ** ***

![image-20230717-114057.png](https://docs.igloovision.com/__attachments/a_141b0286123ccbb7e1a3ef1c286bd74ac7ae35fab8a8a1200f71b2ef6e466811/image-20230717-114057.png?cb=bc8b15053a25a08ead5b18808ee74361)

### Canvas Region

The Canvas Region is where you define a specific portion of your workspace to be captured when recording a video or taking a screenshot. You can customize the area to be captured using the following parameters:

#### Position X

This parameter specifies the horizontal position (left to right) of the top-left corner of your selected region on the workspace.

#### Position Y

This defines the vertical position (top to bottom) of the top-left corner of your chosen region on the workspace.

#### Width

This denotes the horizontal extent of the region to be captured. Adjust this to increase or decrease the breadth of the captured area.

#### Height

This sets the vertical extent of the region to be captured. Modify this to increase or decrease the height of the captured area.

### Screenshot

#### Folder

This setting represents the directory where your captured screenshots will be saved. You should select a suitable location on your system to store these images.

#### Image Format

You can choose the format for your screenshots from the following options:

1. PNG: Portable Network Graphics format, best for images requiring transparency.

2. JPEG: Joint Photographic Experts Group format, generally preferred for its balance of image quality and file size.

---
version: "2.0.0"
language: "en"
---
# Canvas Share Window

The Canvas can be shared using via <https://ndi.video/> and <https://spout.zeal.co/> .

* NDI - Streams the Canvas over the network to other machines and NDI-compatible applications.

* Spout - Shares the Canvas texture locally between applications on the same machine (GPU-to-GPU).

Open the Canvas Share Window from the settings menu. **Settings \> Canvas Share.**

The canvas can be shared using both protocols simultaneously. Check the **Enabled** box in the respective tabs to start sharing the canvas.

Position X Y, Width and Height settings are used to define which region of the Canvas to share.  
![image-20260217-164902.png](https://docs.igloovision.com/__attachments/a_1ca48f9fb018769d2bc72188004e18d0f4d9143acb56b51319911c4dac01b48d/image-20260217-164902.png?cb=c5de4e672eb28f6be8f211d6ef4fc95b)

---
version: "2.0.0"
language: "en"
---
# Canvas Tab

The **Canvas** tab displays a planar layout of the screens generated in the projection scene. The screenshots below illustrate examples of canvas layout for an immersive room and a cylinder projection scene respectively.  
![canvas_box.png](https://docs.igloovision.com/__attachments/a_1d4ced6322330d7188d4efa71dd00f2ad1e06b2ae0e7668748da951353c67038/canvas_box.png?cb=c5de0c236fbb9b4e6d583eb75d37d10b)
Canvas layout for an immersive room projection scene.  
![canvas_cylinder.png](https://docs.igloovision.com/__attachments/a_6b6e13ebc997d9515173b9cdea022ba2faed4811beee8fdf6f65905929dd80c9/canvas_cylinder.png?cb=bec3f385b47d011792dc15bfb057dbad)
Canvas layout for a cylinder projection scene.

The canvas region is a composition of all screens in the projection scene with empty space in between. The canvas border is an axis aligned bounding box whose purpose is to give a visual cue of the canvas region and is drawn as thick yellow line.

## Canvas Topology

The topology of the canvas can be adjusted to suit the installation. For a projection scene with no floor projection, the topology would typically be a horizontal row of screens. However, if the horizontal resolution is greater than 16k pixels, then moving some of the screens to form a grid instead of a row will allow the canvas to fit within the 16k x 16k limit.

For a projection scene with floor projection, it is common to have a grid arrangement, with the floor screens, positioned below the screens used for the walls. The advantage of this approach is that the width of the walls corresponds to the width of the canvas, and this has benefits when moving and scaling content. Also content can be moved from the walls to the floor with an intuitive 'downward' action. The illustration below shows how the floor screens can be repositioned using the left mouse button to drag them to a new location.  
![igloo_setup_canvas.gif](https://docs.igloovision.com/__attachments/a_0cb357e01f010b58d310ee3458ff1cac520a3cf619c5e280fb873e5100fd4544/igloo_setup_canvas.gif)
Moving the floor screen below the walls.  
For performance reasons it is recommended to adjust your canvas topology to minimise empty space. The larger the canvas resolution the more GPU memory will be required.

### Canvas Resolution

The **Canvas Resolution (px)** valuesgive the overall canvas resolution in pixels specified in width and height respectively. The canvas resolution is calculated using the resolution of one of the width and height parameters together with the aspect ratio of the screen. Enter the known value of one of the parameters, based on the immersive space design drawings. The other dimension will then be automatically calculated and updated.

The height and width values of each of the screens which make up the projection scene are also calculated automatically. These are displayed below the Canvas Resolution as width, height pairs and labelled **Left Resolution** , **Front Resolution** , **Right Resolution** etc.

---
version: "2.0.0"
language: "en"
---
# Canvas UI

![image-20260414-200707.png](https://docs.igloovision.com/__attachments/a_6f85150995dfa9ba198e0d0cf176c72c402a5c8c773e69bd54697d14019de510/image-20260414-200707.png?cb=8921f25bf4b81179b387d8e95bb24d5c)

The tutorials in this section are all based on using the Igloo Core Engine canvas user interface.  
* [Canvas UI - The Canvas User Interface](https://docs.igloovision.com/documentation/current/canvas-ui-the-canvas-user-interface.md)
* [Canvas UI - Layers and Sessions](https://docs.igloovision.com/documentation/current/canvas-ui-layers-and-sessions.md)
* [Canvas UI - Launching Sessions from the Homescreen](https://docs.igloovision.com/documentation/current/canvas-ui-launching-sessions-from-the-homescreen.md)
* [Canvas UI - Viewing YouTube 360 Movies](https://docs.igloovision.com/documentation/current/canvas-ui-viewing-youtube-360-movies.md)
* [Canvas UI - Video Conferencing](https://docs.igloovision.com/documentation/current/canvas-ui-video-conferencing.md)
* [Canvas UI - Viewing PDF Documents](https://docs.igloovision.com/documentation/current/canvas-ui-viewing-pdf-documents.md)
* [Canvas UI - Designing Dashboards](https://docs.igloovision.com/documentation/current/canvas-ui-designing-dashboards.md)
* [Canvas UI - Exploring Google Street View](https://docs.igloovision.com/documentation/current/canvas-ui-exploring-google-street-view.md)
* [Canvas UI - Using the Matterport App](https://docs.igloovision.com/documentation/current/canvas-ui-using-the-matterport-app.md)
* [Canvas UI - Canvas Sharing (Video Conferencing)](https://docs.igloovision.com/documentation/current/canvas-ui-canvas-sharing-video-conferencing.md)
* [Canvas UI - Content Bank Control](https://docs.igloovision.com/documentation/current/canvas-ui-content-bank-control.md)
* [Canvas UI - Additional Tutorial Videos](https://docs.igloovision.com/documentation/current/canvas-ui-additional-tutorial-videos.md)
* [Canvas UI - Annotation](https://docs.igloovision.com/documentation/current/canvas-ui-annotation.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Additional Tutorial Videos

**Creating Office Dashboards**
[Creating Office Dashboards.mp4](https://docs.igloovision.com/__attachments/a_c0928e839349292bfa8ca52f96ae7fdd79b87e4ffa32eb9f57bfc0a2af0a6134/Creating%2520Office%2520Dashboards.mp4.md)
Creating Office Dashboards

**Using Powerpoint**
[Using Powerpoint.mp4](https://docs.igloovision.com/__attachments/a_bb48c07d8645142859409f95069d289625cce5c5797f45853986009041ddbdbc/Using%2520Powerpoint.mp4.md)
Using Powerpoint

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Annotation

The Igloo Core Engine Annotation system provides a way to annotate directly on the Igloo Core Engine Canvas. It can be accessed from the canvas toolbar.

## Accessing Annotation System

**To Show/Hide Annotations** : On the canvas toolbar, click the **Annotation Button**. This action toggles the visibility of the annotation system on the canvas.  
![image-20240109-093416.png](https://docs.igloovision.com/__attachments/a_9ae8e183e7d0157d1d0ee0634c65f03142485eba401fcc4618ed5c0503b838e7/image-20240109-093416.png?cb=9564c01e3a2e30886995a9e4cbdcf025)

### Available Annotation Tools

The following tools are available in the annotation system:

1. **Pen:** For freehand drawing and writing on the canvas.

2. **Text:** To add text annotations.

3. **Shapes:** Insert various geometric shapes.

4. **Lines:** Draw straight lines.

5. **Undo:** Reverse the last action.

6. **Redo:** Reapply an action that was undone.

![image-20240109-093636.png](https://docs.igloovision.com/__attachments/a_af4bd2f6707af43c5b841c2681141c920fcfc618d2bbf49307a92db3c0ed052f/image-20240109-093636.png?cb=a62adcae38df8860bf3a3372f5018d1c)

### Important Notes

* **Going Home:** Navigating to the home screen in Igloo Core Engine will clear any current annotations.

* **New Session:** Loading a new session will also clear existing annotations.

### Configuration

The annotation tool can be tailored to specific preferences. This customisation is achieved by modifying the `config.json` file located in `C:\\igloo\\igloo-core-service`. Below is a guide on how to configure these settings.

#### Accessing the Configuration File

1. **Locate the File:** Navigate to `C:\\igloo\\igloo-core-service` on your system.

2. **Open** `config.json`

#### Customization Options

The `annotation` section of the `config.json` file contains several parameters that you can customize:

* `"defaultColour"`: Sets the default colour for the pen and shapes. For example, `"white"` sets the default color to white. You can change this to any valid color name or hexadecimal colour code e.g. "#ff0000" for red.

* `"defaultFontSize"`: Adjusts the default font size for text annotations.

* `"defaultStrokeWidth"`: Defines the default stroke width for the pen and shapes.

* **Position Settings:** These settings define the positions of various elements in the annotation interface. Each position is determined by `x` (horizontal) and `y` (vertical) coordinates:

  * `"eraserMenuPos"`: Position of the eraser menu.

  * `"sidebarPos"`: Position of the sidebar.

  * `"toolMenuPos"`: Position of the tool menu.

  * `"clearAllPos"`: Position of the 'Clear All' option.

  For example, `"x": 0, "y": 0` places the element at the top-left corner of the canvas and `"x": 50, "y": 50` places the element in the middle of the canvas top-left aligned.

#### Applying Changes

1. **Edit the Values:** Change the values in the `annotation` section as per your requirements.

2. **Save the File:** After making the changes, save the `config.json` file.

3. **Refresh the annotation page**

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Canvas Sharing (Video Conferencing)

The Igloo Core Engine Canvas can be shared using the NDI protocol [NDI.tv \| Your Official Destination for All Things NDI®](https://www.ndi.tv/)

This feature is particularly useful when using Igloo Core Engine in a Video Conferencing setting, as it allows a region of the Canvas to be shared back to the call.

## Enabling Share

From the Canvas Toolbar, click the Canvas Share toggle button.  
![canvas_share.png](https://docs.igloovision.com/__attachments/a_2039a9202b425ffa37e2cf2877ee30e6d2a2501919e1ea477f631faff3dca11d/canvas_share.png?cb=63be98f824699fcf532ba99617299019)

* Start/Stop Sharing

Creates or deletes the NDI sender.

* Show/Hide area

Controls whether the Canvas Share widget is visible on the canvas. The area is shown by a bounding red rectangle and a green/red circle indicator in the top-left for indicating if the sharing is currently started or stopped.

* Edit Controls

The remaining icons provide methods to draw and manipulate the sharing area of the canvas. These include: free draw, maximise, fit to a region, edit mode and shortcuts to set to a specific aspect ratio (16:9) and resolution (1920 x 1080).  
![canvasshare.gif](https://docs.igloovision.com/__attachments/a_b9ea5f96ce22c86edafe0e9a0c82e22996b8c3d3b241d9406a6f00891ae401f4/canvasshare.gif)
Using the Edit Controls for Canvas Sharing

### Receiving the Canvas Share

Run the NDI tool called Studio Monitor and select the Igloo Core Engine NDI source. This will display the canvas share in the Studio Monitor application window.

To share the canvas back to the VC call, select Share Screen or Present in the VC application and select the NDI Studio Monitor as the application to share or present.

Next Section: [Canvas UI - Additional Tutorial Videos](https://docs.igloovision.com/documentation/current/canvas-ui-additional-tutorial-videos.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Content Bank Control

A Content Bank layer can be used to trigger different content sources, this tutorial shows how this can be managed via the Canvas UI.  
This tutorial assumes you have already created a Content Bank.

The Content Bank UI widget provides controls for

## Previous / Next clip

![image-20230418-144228.png](https://docs.igloovision.com/__attachments/a_1ee69cff37828903eda62ed7b026c9a79b02e40ab3944d35c07bd44871777f60/image-20230418-144228.png?cb=f926db1d198c8d8f982d002b4350a1f8)

### Playback Controls

The widget will also display Playback controls if the content type of the active tile supports it, such as a video.  
![image-20230418-144242.png](https://docs.igloovision.com/__attachments/a_4a7fa9f76ead972d875ceaca2385cc7602ee5c2f70010c50b87bfd0975699887/image-20230418-144242.png?cb=69fa7e090ece224d3cde8bf284de60ff)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Designing Dashboards

Combining multiple layers together can be a powerful way to display different sources of related content side-by-side. These are known as **dashboards** and can give an at-a-glance view of the status of a complex design, project or system.

This tutorial uses the **Layouts** feature of Igloo Core Engine for defining regions on the canvas. Layouts can be created and modified using the Desktop UI.

**Tutorial Video**
[5. Viewing Dashboards.mp4](https://docs.igloovision.com/__attachments/a_d9bb703ec7e6f1006217e6a1f29b48eb8757def2298350c083f481def7ef3481/5.%2520Viewing%2520Dashboards.mp4.md)
Designing Dashboards

**Creating a Simple Dashboard**

This section will describe creating a simple dashboard consisting of 4 WebViews pointing to news channels.

Press the Add Content button and select New \> WebView. Repeat this 3 more times so that you have 4 WebViews.

For one of the WebViews, set the URL to <http://www.bbc.co.uk/news> .  
![dashboard1.png](https://docs.igloovision.com/__attachments/a_b45d82b44107b23390fe7faafb174486dadfe84e05a2952fd264f53ec3e8168e/dashboard1.png?cb=b9bdbd1636783ecb68d08cbce2bf818e)

In the **Layers action menu** on the Canvas Toolbar, set the BBC News layer to**Region 1** in the **Default Layout**. This will move the layer to a specific area of the Canvas.

![dashboard2.png](https://docs.igloovision.com/__attachments/a_e5ee6441fd88e110932c15a8f3cf326dd18068d16a271d5d140c4791e3a2f10b/dashboard2.png?cb=63ba46d28c76815094e79d57bf69e937)

Next, select **Maximise** from the **Geometry** menu. This will resize the WebView so that it fills the region it is contained in.

Set the URLs of the other WebViews to the following:

<http://www.bbc.co.uk/weather>

<http://www.bbc.co.uk/sport>

<http://www.bbc.co.uk/news/technology>

Set the WebViews to **Region 2** , **Region 3** and **Region 4** of the **Default Layout** and **Maximise** each one. This will give a WebView dashboard which fills the entire canvas.  
![dashboard3.png](https://docs.igloovision.com/__attachments/a_87dbb58aa6f534dee6fd35197ef7a6f7941722577d04e97c881501d6222697a2/dashboard3.png?cb=e19d8f0572cf24a045f3a36706bcd8b1)
News Dashboard consisting of 4 WebViews

Once completed, save all the WebViews into a single session, called 'News Dashboard'.

Next Section: [Canvas UI - Exploring Google Street View](https://docs.igloovision.com/documentation/current/canvas-ui-exploring-google-street-view.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Exploring Google Street View

We have developed an integration with Google Street View for viewing street panoramas in 360 degrees.  
This tutorial requires a session called Streetview to have been setup using the Desktop UI.

**Tutorial Video**
[7. Using Google Street View.mp4](https://docs.igloovision.com/__attachments/a_c82d2684ecfcb0d64c4f58255e174884306e5dd282f6533bb826f7e7eb47ec23/7.%2520Using%2520Google%2520Street%2520View.mp4.md)
Exploring Google Street View

**Loading a StreetView Panorama Layer**  
![add_content.png](https://docs.igloovision.com/__attachments/a_50a7dbdeff91dc55a83a94e5da41272992d072cab8803e8e2a101ac6d33b8000/add_content.png?cb=fa7df2663bcb722ab8c7bcf29aaa7fc7)

Press the **Add Content** button in the Canvas Toolbar and select **Content Library**.

![content_library2.png](https://docs.igloovision.com/__attachments/a_c3aa68a79affe26a7a7fd30de4894163d62ecf6172a0a1680bbf290add330276/content_library2.png?cb=615dc5123ec987f61f19d765ef6a2e7c)

Select the session named **'Streetview'**.

This will load a WebView layer pointing to the Igloo StreetView Service URL and with appropriate settings to display across the whole canvas.  
![streetview3.png](https://docs.igloovision.com/__attachments/a_357246ca6e5b7c523c341a03caec57db78b55bfd85e96e3c2880f6ad382bf017/streetview3.png?cb=e5025670c51bf2c4bc2a45ecd762862f)
Google Street View Layer

**Creating a StreetView Control Layer**

Create a new WebView and set the URL to `http://127.0.0.1:800/streetview/control `. This displays the control screen showing a map and an orbit view. Both the map and orbit view can be used to navigate by clicking the arrows in the top view or by clicking a new position on the map. A location can also be entered in the search text box above the orbit view. Use **Edit mode** to resize and position the control layer to a suitable area of the canvas, on top of the StreetView panorama layer.  
![streetview_control.png](https://docs.igloovision.com/__attachments/a_da60fb117762dc505c732afa5048f1436d45dbad2bf342dc3f52e987fcf77e9f/streetview_control.png?cb=a815efe05eaa9f36a8023157ef632a31)
Street View Control Layer  
The StreetView Control page can also be accessed in Igloo Control Panel. Go to the Apps tab and click the StreetView icon to load.

**Additional StreetView Layers**

The other available endpoints are:

`http://127.0.0.1:800/streetview/mapview `- displays the streetview map with pegman

`http://127.0.0.1:800/streetview/orbitview` - displays the streetview panorama in a click-drag view  
Exercise: add two WebView layers to display the streetview map and orbitview on top of the main iglooview.  
![streetview4.png](https://docs.igloovision.com/__attachments/a_974fe66d983efdf5fa17151bff8d5943808c46e6a5a1a4d6c333079ff1528fcc/streetview4.png?cb=3df5c0a68ffeb07800edae46ae09513e)  
TIP: Save a new Streetview session which includes the control layers.

Next Section: [Canvas UI - Using the Matterport App](https://docs.igloovision.com/documentation/current/canvas-ui-using-the-matterport-app.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Launching Sessions from the Homescreen

Igloo Core Engine has a special layer type called a **Home** layer. This can be used to display groups of tiles for quick and easy launching of sessions.  
This tutorial requires a Home layer to have been built using the Desktop UI. See [Desktop UI - Building a Homescreen, part 1](https://docs.igloovision.com/documentation/current/desktop-ui-building-a-homescreen-part-1.md)

**Tutorial Video**
[9 Launching and saving sessions.mp4](https://docs.igloovision.com/__attachments/a_1ec2d1adfe09412c8b97105a17ab28ef8f4e6a777e336c4ed2de826104da581f/9%2520Launching%2520and%2520saving%2520sessions.mp4.md)
Launching Sessions from the Homescreen

**Launching a Session**

Move the mouse pointer over one of the tiles and click. This will load the session and hide the Home layer.  
![home1.png](https://docs.igloovision.com/__attachments/a_73a6a07821023fde34df98a0d6261103ebf365ab6d60e8fe4f90b2e1bf7b32e6/home1.png?cb=7e4879a43d99bc3833aa1f2e3678c4ee)
Example Home Layer

**Returning to the Home Layer**  
![homebutton.png](https://docs.igloovision.com/__attachments/a_301937fdd562a82fd79fcf099a368ecd2042a71e67a8b768537df2099060a43a/homebutton.png?cb=65b427904c36218c814d1548ff07d598)

Click the Home icon on the Canvas Toolbar. This will remove all unpinned layers and show the Home layer. It also brings the Home layer to the front, i.e. on top of all the other layers.  
![homescreen2.gif](https://docs.igloovision.com/__attachments/a_1b0023b8bee3c0f51a572915a01e13cb513d51dbd3f1c73f7526644b4ee1832b/homescreen2.gif)
Launching sessions from Homescreen tiles

**Recent Sessions**

If your Home layer includes a grid with fill type **Recent**, it displays the most recently created sessions (with a defined limit such as 10). The most recent session is shown in the top-left of the grid.

**New session**

Your Home layer may include a single large tile with the label **'Start a new session'**. This will hide the Home layer and the Canvas Toolbar, together with any pinned layers, will be visible. If you save a new session then it will appear in the Recent sessions grid.  
TIP: Any sessions not displayed on the Home layer can be selected from the Content Library dialog (accessed from the Canvas Toolbar, Add Content \> Load).

Next Section: [Canvas UI - Viewing YouTube 360 Movies](https://docs.igloovision.com/documentation/current/canvas-ui-viewing-youtube-360-movies.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Layers and Sessions

In this section we explore more of the Canvas UI features, in particular relating to **layers** and **sessions**.

We are continuing from the previous section, which has one WebView layer already created.

**Tutorial Video**
[3. Sessions and layers.mp4](https://docs.igloovision.com/__attachments/a_0fad6add65666876a35e99aa6a93a3ebc8d92d8e749c746385f5051f7cd86302/3.%2520Sessions%2520and%2520layers.mp4.md)
Layers and Sessions

**Pinned Layers**  
![layermenu.png](https://docs.igloovision.com/__attachments/a_419dd0f0f1c9f5bc357cde6381037d47ca1dbdbd8bc17cb82482dcfda9e06a68/layermenu.png?cb=89995df1e80ef0477649272ee9eb2f43)

On the Canvas Toolbar, select the first layer in the Layers dropdown and then select **Pin Layer**.

The layer is now a pinned layer and this stops it from being removed when the Home button is pressed or a new session is started.

A button is dynamically added to the Canvas Toolbar for each pinned layer. The button acts as toggle to either **Show** the layer and **Bring to Front** or **Hide** the layer and **Send to Back**. Try pressing the toggle button to show and hide the layer.  
![pinnedlayerbutton.png](https://docs.igloovision.com/__attachments/a_6fcb7c2b67856dc02044bf99839f1be1583285489cf412bcbf9b93801c48e0ab/pinnedlayerbutton.png?cb=5c7c8c1959bf73b1109e5f908fd3c663)
Canvas Toolbar with pinned layer button highlighted (red square)

**Removing Layers**  
![unpinlayer.png](https://docs.igloovision.com/__attachments/a_75ddbfb75d7add0d017a5f834ce3dc48c067698eaccbce5f4f7b0c14a503df4d/unpinlayer.png?cb=b8d53dacfcf71aad3e7e10d90f6c21e4)

On the Canvas Toolbar, select the layer from the Layers dropdown and then select **Unpin layer**. Note how the toggle button disappears from the Canvas Toolbar.

Next, select the **Delete layer** item from the layer actions menu. This removes the layer from the canvas and also from the layers dropdown menu.

**Adding Layers**  
![image-20230418-150606.png](https://docs.igloovision.com/__attachments/a_9e46ee7f3d996fb6311e713133fd5dd96b93909eef4139f9fbafc3bbe9daf1b6/image-20230418-150606.png?cb=c8043549ddc4538910e0d40bdccc13c2)

Press the **Add Content** button and select **Web \> New**.

This will create a new WebView layer on the canvas and in the layer list. Modify the URL by clicking in the WebView toolbar and typing in a new URL e.g. `http://www.youtube.com`.  
![youtube_layer.png](https://docs.igloovision.com/__attachments/a_49182850cd62a3b6758a2d68cf9ec2f1ac265b7bf05ae7c1bd0a13d37557266c/youtube_layer.png?cb=4c0279462f561d36e243c583c67a3018)
New WebView Layer set to YouTube URL

**Settings**  
![ui_settings.png](https://docs.igloovision.com/__attachments/a_dd53dd69e5fe2b647bec5d64373c8df1b8b818a50df4ab76fb6e3a65f29bb1eb/ui_settings.png?cb=b9e72d9c6cd76b00acd0aba17ab5ccaa)

Press the **Settings** button to access controls for the master volume, cursor size, cursor sensitivity. There are also controls for sharing the canvas and these are described in a later section: [Canvas UI - Canvas Sharing (Video Conferencing)](https://docs.igloovision.com/documentation/current/canvas-ui-canvas-sharing-video-conferencing.md)

Play a YouTube movie and adjust the volume using the slider. Press the mute button to silence the audio.

Click on the '+' button for Cursor size and see how the mouse cursor size increases with each click.

The Cursor sensitivity setting determines how quickly the cursor moves across the canvas. The larger the sensitivity value - the further the cursor moves.

**Saving Sessions**  
![savesession.png](https://docs.igloovision.com/__attachments/a_b28295b90177aeefa1fa6fc54b4a8e16d3a6462359e1dcb516397ec12622ae2b/savesession.png?cb=1abc62d425b4f11e600569497662586d)

Press the **'...'** button on the Canvas Toolbar and then select **Save session as**.

![save_session.png](https://docs.igloovision.com/__attachments/a_244f34ab8b059089b6463de50eb25933e233b7a4d3c7fde104c1feaf975cd810/save_session.png?cb=d0df0b46e17d2c303e6c895cdc0d2c68)

Enter the name YouTube for the session name. You will be able to reload the layer at a later date by selecting this session. *(If a session with same name already exists, a dialog box will be displayed with suitable options.)*

Next select **New session** from the same menu. This will remove all unpinned layers and the Canvas Toolbar will still be accessible on the canvas.

**Loading Sessions**

Press the **Add Content** button and select **Content Library**.

The Content Library dialog will be displayed. The list of sessions are shown in a table. Click on the table headings to reorder the table.  
![contentlibrary.png](https://docs.igloovision.com/__attachments/a_c58b85a55b69601b526d3a9f39fa92e97922d22c502616032ac2a8a789e45049/contentlibrary.png?cb=b589d63ebaf46cecec498a79c99b5bf2)
Finding a session using the search field in the Content Library

Find the YouTube session and select it. This will load the session into the workspace.

Next Section: [Canvas UI - Launching Sessions from the Homescreen](https://docs.igloovision.com/documentation/current/canvas-ui-launching-sessions-from-the-homescreen.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - The Canvas User Interface

Igloo Core Engine offers the user another interaction method as an alternative to the Desktop UI. This is called the Canvas UI because it works directly on the Igloo canvas. This UI is designed to be simpler and easier to use, with less functionality than the Desktop UI but enough to enable the most commonly used features.  
The following tutorials assume that you are able to interact with the Canvas using the Casting feature of Igloo Control Panel or by using the mouse in the Canvas preview tab of the Desktop UI. For more info see: [Desktop UI - Controlling with a Keyboard and Mouse](https://docs.igloovision.com/documentation/current/desktop-ui-controlling-with-a-keyboard-and-mouse.md)

**Tutorial Video**
[2. Canvas User Interface.mp4](https://docs.igloovision.com/__attachments/a_ac46458edf9de93ac61c0a8a564c7d73536097b0937a62811ea921d002861bb6/2.%2520Canvas%2520User%2520Interface.mp4.md)
The Canvas User Interface

**Enabling the Canvas UI**

There is a toggle switch in the top right corner of the desktop UI called **Canvas UI**.  
![canvas_mode.png](https://docs.igloovision.com/__attachments/a_b9267e31a5a4089a296fb6ea4da43681f1da549764dc6225e028a72a8a54d327/canvas_mode.png?cb=6716d5f5a02ad7c0305b6d7502e01cf3)

Click this to enable or disable the Canvas UI.

**The Canvas Toolbar**

Once the Canvas UI is enabled and mouse movement is detected on the Canvas, the Canvas Toolbar is displayed. By default it will appear in the top left corner of the screen and it can be moved by left click-drag on the left edge of the toolbar.  
![canvastoolbar.png](https://docs.igloovision.com/__attachments/a_22d1bcf66b1d03bdecd17f61c26896fb9f827d148b81363ffe5acdeb35372484/canvastoolbar.png?cb=da309fd31e51152520b97de22326d0ad)

Click the left edge of the toolbar and drag it to the centre of the Igloo canvas.  
The position of the toolbar will be stored when saving a Workspace

**Add a New Layer**

Press the **Add Content** button on the Canvas Toolbar and select **New \> WebView** . This will display a web page defaulting to the [www.igloovision.com](http://www.igloovision.com/) web site. The name of the layer defaults to the title of the website.  
![webview_layer1.png](https://docs.igloovision.com/__attachments/a_8646e087a5bdcf0634f548e3df76d80370648d6a020cbf79bd6a53fe53d5e73a/webview_layer1.png?cb=24a0c20db7f832bcefb8a985daddaff9)

**Show/Hide a Layer**

Select the **Layers** button on the toolbar and move the mouse over the first menu item to display the menu of layer actions.  
![layermenu.png](https://docs.igloovision.com/__attachments/a_6fe083e552f419642f4a89188c0cf3fc3eacc04e4bbb900e491439a7a9abfbe9/layermenu.png?cb=89995df1e80ef0477649272ee9eb2f43)

Press the **Hide** button. This will stop the layer from being drawn on the canvas.

Bring back the layer by pressing **Show** via the layer actions menu.

**Edit mode**  
![editmodebutton.png](https://docs.igloovision.com/__attachments/a_198d3fe5e86541a335fa49e8850da08e38314a0fbed677e666ad090dcfb3652e/editmodebutton.png?cb=6c37c14c5101db08050045e706afe5e0)

Press the **Edit** button just to the right of the Layers button. This will switch to Edit mode and the currently selected layer will have resize handles drawn at each corner and along each edge.

Click on one of the handles and drag it so that the layer is reduced in size. Now click anywhere on the layer and drag it to a new position. When finished with positioning and sizing, click the **Exit edit mode** button.  
![editmode.png](https://docs.igloovision.com/__attachments/a_815b6ac4dbda2f2129edb82de030698bf5431e873d887671f63538f85320286f/editmode.png?cb=4eb81602fc229957e570eea44ddac9c4)
Selected layer in Edit mode

Next Section: [Canvas UI - Layers and Sessions](https://docs.igloovision.com/documentation/current/canvas-ui-layers-and-sessions.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Using the Matterport App

Using the Matterport API, we have developed an integration for viewing Matterport spaces in 360 degrees.  
This tutorial requires a session called Matterport to have been setup using the Desktop UI.

**Tutorial Video**
[8. Using Matterport .mp4](https://docs.igloovision.com/__attachments/a_51f25b99dcb4a1731929cd507382a3fc3747b8cfe8a41df26a888cf0fd8d8875/8.%2520Using%2520Matterport%2520.mp4.md)
Using the Matterport App

**Loading a Matterport Layer**  
![add_content.png](https://docs.igloovision.com/__attachments/a_0890a7bb2e28f9e06ca260e8ce98487b7e3357286f7bfd42f1833a35072d9eea/add_content.png?cb=fa7df2663bcb722ab8c7bcf29aaa7fc7)

Press the **Add Content** button in the Canvas Toolbar and select **Content Library**.

![content_library3.png](https://docs.igloovision.com/__attachments/a_be1e396e2f7f26052994fba85508faef13a2716db113336bc5de2b713ea852a8/content_library3.png?cb=dbe40837f5add02dca3441a2bb313807)

Select the session named **'Matterport'**.

This will load a Composition layer pointing to the Igloo Matterport Service URL and with appropriate settings to display across the whole canvas.  
![matterport3.png](https://docs.igloovision.com/__attachments/a_31b726159abfca970b241a15460a9a4e31c6a3f55f8d3a2abeed204d32d368d2/matterport3.png?cb=e77dc4b7b877131b5f7c350491a8402c)
Matterport Layer

**Creating a Control Layer**

Create a new WebView and set the URL to `http://127.0.0.1:800/matterport/control `. This displays the Matterport control screen showing an orbitview in the upper half of the page. A Floorplan can be generated in the lower half of the page. Navigation can be made by clicking on the disc positions in either the floorplan or the orbitview. Use **Edit mode** to resize and position the control layer to a suitable area of the canvas, on top of the Matterport layer.  
![matterport_control.png](https://docs.igloovision.com/__attachments/a_5cb4a9da321cd6005410fa97d65c63093575a980df82afe2dd9f321d163e00f8/matterport_control.png?cb=f7a1e752c5af5bbce36474067b1d0ef8)
Matterport Control Layer

**Additional Layers**

An additional endpoint is available to display the orbitview only, `http://127.0.0.1:800/matterport/orbitview`. This endpoint also allows the Matterport dollshouse mode to be viewed.  
![matterport2.png](https://docs.igloovision.com/__attachments/a_2c09771b349beca53d1fb27c5ea88f2dae69b2efc03b14be7d2bc9cd03d16184/matterport2.png?cb=425ea24bfa53267952d0e3b683833be1)

Next Section: [Canvas UI - Canvas Sharing (Video Conferencing)](https://docs.igloovision.com/documentation/current/canvas-ui-canvas-sharing-video-conferencing.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Video Conferencing

This tutorial works through presenting the gallery view of participants on a Video Conference using a VC tool such as Microsoft Teams or Zoom.

**Tutorial Video**
[10. Video Conferencing.mp4](https://docs.igloovision.com/__attachments/a_7abd673251058ff2a0be5eb348d695e946ecf63abffb55e7c72b338c8c97896b/10.%2520Video%2520Conferencing.mp4.md)
Video Conferencing

**Starting the Call**

Start or join the Video Conference on a separate Windows device such as a laptop or Surface Pro. The device should have a microphone and speakers attached.  
![vc_1.png](https://docs.igloovision.com/__attachments/a_b5462cdd5dfec79b63402a83679b29d81c6df366daf663cc43114aa8998af7ad/vc_1.png?cb=4375dacdf960346117d5c55ea2984a75)
Joining a scheduled Teams call

**Capturing the Call**  
NDI Tools will need to be installed on the Windows device (available from: <https://ndi.tv/about-ndi/> )  
![vc_2.png](https://docs.igloovision.com/__attachments/a_882ff300cb2e56d100faac225f1c42ca8ba5956f9b9fd1ee4f0cf0079ea93b58/vc_2.png?cb=4e00dde6f003a27eed181ed57b9cb451)
NDI Tools

The next step is to capture the VC application window. This can be done using the **Screen Capture** tool which is part of NDI Tools.

Screen Capture will create NDI senders of each of the monitors attached to the Windows device.

![vc_3.png](https://docs.igloovision.com/__attachments/a_3109119387ff28ceb0b9315dea54da0ee33bbad925c1003c6e38f39e09be208a/vc_3.png?cb=fddaa6ec6d210e6567d9f0c26f25f236)
NDI Region of Interest

The fullscreen captures can be refined to a specific area of the screen using the Region of Interest option in Screen Capture.

Click on the taskbar and show the hidden icons box (up arrow button). Right-click on the NDI Screen Capture logo and select **Configure RoI** from the Capture Settings menu. Position and resize the Region of Interest window over the gallery view in the VC application window.

**Presenting the Call**

Select **Add Content \> New \> NDI**on the Canvas Toolbar. This will show a list of available NDI senders. Select the item which corresponds to the Screen Capture of the VC call. The gallery view will now be displayed on the canvas and can be scaled and positioned using Edit mode.  
![vc_4.png](https://docs.igloovision.com/__attachments/a_34f3ea17bc8408d8f695442c12beca989621490a210538f91f9a5cbabd6c16ac/vc_4.png?cb=d7cc3f5586379c09e07b6e83234bff72)
Select the NDI sender from the Canvas Toolbar  
TIP: Set the gallery view layer to be a pinned layer so it is not deleted when returning to the homescreen or loading a session.  
TIP: In the Desktop UI, General tab, the layer can be set to 'Lock to Front', which will keep the layer in front of any other layer. This is especially useful for VC gallery layers.

Next Section: [Canvas UI - Viewing PDF Documents](https://docs.igloovision.com/documentation/current/canvas-ui-viewing-pdf-documents.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Viewing PDF Documents

Documents in PDF format can be viewed using the WebView layer type.  
This tutorial assumes the document to be viewed is stored on the Igloo Media Player. For instructions on copying a document to the IMP via the Igloo Control Panel refer to [Igloo FileDrop](https://docs.igloovision.com/documentation/current/ice-drop.md) .

**Tutorial Video**
[6. Viewing a PDF.mp4](https://docs.igloovision.com/__attachments/a_e6859c0252bde4a7ca2956502533f5a5424df28d39d06dc32d921d3330afe2f3/6.%2520Viewing%2520a%2520PDF.mp4.md)
Viewing PDF Documents

**Using the File Browser**  
![add_new_webview.png](https://docs.igloovision.com/__attachments/a_4c9f36fe99a1235dd1ea826e757eac918381c2125f4e36df4db27cbdd707d083/add_new_webview.png?cb=293dd0e81b2f8767fdd9adfcf26ba965)

Create a new WebView using the Canvas Toolbar.

In the WebView toolbar, set the URL to be **'C:\\'** and press Enter.  
![webview_url.png](https://docs.igloovision.com/__attachments/a_7c17ded8ab757f0dd0ef07d143d9fe96402b7f70eb2103a9232f570e708bc3b8/webview_url.png?cb=a295d44e87bbf6eb7fa7eb87e25b4dc7)

This will pop-up the **File Browser** dialog. From here, click on the directory names to navigate to the PDF file. Then click on one of the PDF documents to open it for viewing.  
![file_browser.png](https://docs.igloovision.com/__attachments/a_9b72fd8dd60cd96dffb919d872a43360d0f203ddaa1edb7d95ee498668419b30/file_browser.png?cb=0bba6bcc987ad1b9b687a84e6caccf0a)  
![file_browser2.png](https://docs.igloovision.com/__attachments/a_c8d1210d91f8e838b4940b0079eb17f9859541efa9c13752a03bf84718a6624e/file_browser2.png?cb=9d005cfcab3b8810f36c8776bdc24d06)

**Viewing the PDF Document**

Once selected, the PDF document will be opened for viewing in the WebView layer.  
![pdf_view1.png](https://docs.igloovision.com/__attachments/a_d83299c5d3c8c5d428ba90ddea076c18ec0eec7061f0bffef8e0fb731f2b63cb/pdf_view1.png?cb=3a1ec8aa2e67d348480657edb0de84ca)

Click the **up arrow button** (highlighted in the blue square) to hide the WebView toolbar.

This will enable the PDF viewing options to be accessed.

The PDF viewing options are displayed at the top of the page as shown below. The button on the far left enables the thumbnails view to toggled on and off. The button to the right of the scaling buttons enables auto scaling to fit the page to the height or the width of the WebView. It is also recommended to adjust the width of the WebView (using **Edit mode**) so that the aspect ratio of the layer is similar to the aspect ratio of the PDF page (e.g. roughly portrait or landscape). Finally, the Present option in the menu on the far right, gives a view of the page which fills the WebView layer and hides all thumbnails and menus.  
TIP: use the refresh button on the WebView toolbar to exit from Present mode.  
![pdf_view3.png](https://docs.igloovision.com/__attachments/a_fa538532376fa4d165eb49d955b449144ef76f6e133d5fccd258dd03e431d812/pdf_view3.png?cb=b42189278f2ee0eebff51e57bd3f93c8)
Highlighted features in PDF Viewer

Next Section: [Canvas UI - Designing Dashboards](https://docs.igloovision.com/documentation/current/canvas-ui-designing-dashboards.md)

---
version: "2.0.0"
language: "en"
---
# Canvas UI - Viewing YouTube 360 Movies

YouTube supports hosting of 360-degree movies. A special type of Igloo Core Engine layer can be used to view these movies across the whole Igloo canvas. This layer type can also be used to view non-360 and 3D movies. This tutorial shows how to find and display a YouTube 360 movie.

**Non-embeddable Movies**  
Some movies are restricted from embedding and these are not viewable using this layer. They can, however, be viewed in the normal way using a WebView.  
![image-20240213-104519.png](https://docs.igloovision.com/__attachments/a_2ec8a9a4488b544db78de37e7a81ecc0f3e579a936817593c3b34ccf4af5c3dc/image-20240213-104519.png?cb=7eec101a3845c2cacf67996e09162e21)
Pop-up error message shown in Canvas UI.

**Tutorial Video**
[4. YouTube 360 Videos.mp4](https://docs.igloovision.com/__attachments/a_8efb2c80a25f28863e6d9849acb14d223c45aab61f92b709b4cb4833e2f19e5b/4.%2520YouTube%2520360%2520Videos.mp4.md)
Viewing YouTube 360 Movies

**Add a WebView**  
(You can ignore this step if you still have your YouTube WebView from the previous tutorial.)

Create a new WebView Layer using the Canvas Toolbar **Add Content \> New \> WebView.** Set the URL of the Webview to [http://www.youtube.com](http://www.youtube.com/) .  
![yt.gif](https://docs.igloovision.com/__attachments/a_2b1a62baf2c6ed42a544e1b4c7650a2bcf785f07b0b8926a279e2b1ac8036c6c/yt.gif?cb=b69ddcb659d74694dad87a06d363233a)

**Find and select a YouTube 360 movie**

Enter '360 movies' in the search field in YouTube. Select one of the 360 movies from the search results.  
TIP: [Virtual Reality - YouTube](https://www.youtube.com/360) ( [www.youtube.com/360](http://www.youtube.com/360)) has a great selection of 360 video samples  
![yt1.gif](https://docs.igloovision.com/__attachments/a_ceeb613632ed88c1dea308de0d63792a2f612a26d0871e834dc82554c39791da/yt1.gif?cb=986fbbdb68084622ec7de21deadfb7a1)

**Display a YouTube 360 movie**

The WebView will detect that a YouTube video is playing, and a 'View in 360' button will be added to the WebView toolbar. Press this button to open the video in 360 mode.  
![viewin360.png](https://docs.igloovision.com/__attachments/a_57b2a51c69b3392ce4cd94a301013dbbb65586bd6b78fb094ded8ff8bebf1bf9/viewin360.png?cb=92f9123efb98d56ee00c1843462bbca1)
View in 360 button  
![yt3.gif](https://docs.igloovision.com/__attachments/a_bc24fc81bb22ffc9ecae003cbd4632b7c3c27541e461efbb8d4277802253cbaa/yt3.gif)

The video can be paused and played using the in-context GUI. This can also be used to scroll to different points in the movie.  
TIP: The movie in 360 mode is playing in a new layer and this can be saved to a session for reloading at a later date.  
TIP: The WebView layer can be set to pinned and used for further selection of 360 movies.

Next Section: [Canvas UI - Video Conferencing](https://docs.igloovision.com/documentation/current/canvas-ui-video-conferencing.md)

---
version: "2.0.0"
language: "en"
---
# CenarioVR

**CenarioVR** (<https://www.cenariovr.com/>) is a powerful and easy-to-use virtual reality training tool that enables you to drive engagement, retention, and performance.

## Integration

This integration is built by the CenarioVR development team supported by the Igloo application integration team. The integration enables the 360 video output to be displayed in a suitable format for Igloo immersive spaces. The integration can be activated using a URL parameter.

### Igloo Core Engine Session

From version 1.3.0 onwards, your Igloo Core Engine installation will have a ready-made session in the content library called 'CenarioVR'.  
If the session is not there, then you can import it from `C:\ProgramData\Igloo Vision\IglooCoreEngine\example sessions\CenarioVR`

This session loads an example health training scenario. Press the Play \> button to start the scenario.  
![image-20240412-103456.png](https://docs.igloovision.com/__attachments/a_2f7d02d4bd0f3137281c0efdd9c770d66b92f19a43fc24439633e24d9ef32e42/image-20240412-103456.png?cb=010986359c10ca78fd4fa4893e54b756)
Example health training scenario.

Interaction is made by clicking the UI elements directly on the Canvas using Igloo Control Panel \> Mouse \> Cast or in the Desktop UI by selecting in either the Canvas or Layer preview tabs.

### URL Parameters

The following URL template may be used to auto join a scenario in igloo mode:

[https://cenariovr.com/app/#/view?*\<scenario id\>*\&igloo=1](https://avatour.live/autojoin?s=IGLOO&user=igloo&igloo=1)

This URL works for published scenarios by including the scenario id and **igloo=1** enables igloo mode.

### Detailed Session Setup

Create a WebView and set the URL to <https://cenariovr.com/app/#/> . This will display the login page.  
![image-20240412-144922.png](https://docs.igloovision.com/__attachments/a_60e5d509796e5cd1ff8114125a9091db5f11276563bbdd084d59244953eac5fc/image-20240412-144922.png?cb=d90e29db7dacf0cc7926d7133218b1db)

Once logged in, you will be able to select from your own scenarios as well as public and shared scenarios.  
![image-20240412-144445.png](https://docs.igloovision.com/__attachments/a_1601e1b74b8f27b5eaf7824689d774f53b16c94455eacfd6358a64994d09f5f4/image-20240412-144445.png?cb=fd01e73c9a928f37db0116d920e58263)
Browsing large selection of public scenarios.

Select a scenario and it will be loaded into the browser.  
![image-20240412-151835.png](https://docs.igloovision.com/__attachments/a_47a3d9310770ca2ae74ff59b01a197cb3dc5de52272a678cf8a45b529dc905e5/image-20240412-151835.png?cb=6de9e965c743752b0e97b8c59b93c59f)
Scenario selected and loaded.

Append **?igloo=1** to the end of the URL. The scenario is now displayed as a cubemap.

Make the following changes to the layer to display the cubemap correctly. Untick the Dynamic Resolution option and set the WebView resolution to be 6000 x 1000. Untick the Show UI option.

Finally, add the Cubemap to Equirectangular and TruePerspective effects so that the cubemap will display correctly in the Igloo.  
![image-20240412-151514.png](https://docs.igloovision.com/__attachments/a_ea050021145da6d80323b8a541cfbfc88f6e9493fc947d98adbc98eb52a925f8/image-20240412-151514.png?cb=c0160d2b0ad9d5ba24170be8f191e28e)
WebView layer with properties for CenarioVR.

Save the WebView layer as a session so it can loaded easily next time.

## I have an Issue!

For issues with the CenarioVR integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# Chaos Cloud/Enscape

Enscape - Design, visualize, and iterate instantly inside your CAD and BIM tools. Simple to start. Easy to use. <https://www.chaos.com/enscape>

Chaos Cloud collaboration helps you share your work with your team and your clients. Invite them to review your images and share their feedback. This speeds up reviews, so you can get your projects done faster. <https://documentation.chaos.com/space/VCLOUD/126049555/Chaos+Cloud+Collaboration>

## Integration

This integration is built by the Igloo Vision development team utilising the WebXR compatibility feature of Chaos Cloud. This feature is documented here: <https://documentation.chaos.com/space/VCLOUD/126495776/Virtual+Reality> .

The integration supports both panoramas and virtual tours.

## Usage

Upload your rendered panoramas to Chaos Cloud. <https://blog.chaos.com/enscape-panoramas-meet-chaos-cloud>  
![image-20260511-133243.png](https://docs.igloovision.com/__attachments/a_297901bf06aea63090af1130c8701194b4963f43570b968bc0f12c405ca3625b/image-20260511-133243.png?cb=e636baddc575a939621135bf80361b72)
Uploading images and videos to Chaos Cloud.

Follow these steps in Igloo Core Engine:

* Create a WebView layer.

* Allow popups in this layer.

* Add the metadata keys:

  * webxr

  * webxr/cubeFaceSize - set this to an appropriate pixel resolution e.g. 1000, 1500 or 2000.

  * webxr/emulatedControllerType - set this to 'aframe/oculus-touch'.

* Enter [cloud.chaos.com](http://cloud.chaos.com/) into the URL box or paste the URL of an Enscape virtual tour into the WebView URL. You will need to login to your Chaos Cloud account.

* Save your session.

* Click on an image or video, and then click the 'Toggle VR' button to activate the integration. The WebView layer will render the image as a cubemap and the required effects will be automatically added (Cubemap to Equirectangular and TruePerspective).

![togglevr1.png](https://docs.igloovision.com/__attachments/a_8f60fbc774616a44548cf2f7033de7b52b1854fe87ec4d4a6f2f3821de6c5cde/togglevr1.png?cb=76d779127881d129d59b72bb8193b069)
Toggle VR button shown in the top right area of the screen.  
![image-20260511-134818.png](https://docs.igloovision.com/__attachments/a_23d3bac720495d585372ab2ede9870dfb45d4bc8311360e416837d214bbf7684/image-20260511-134818.png?cb=69bf86b5a963c41b36f1c7508ef9ca7f)
Toggle VR button (lowest on the right).  
![cubemap.png](https://docs.igloovision.com/__attachments/a_61062298d921c59636fedaea1d3c0256dec26a8d2b1faa26f530839b6a6b7dc5/cubemap.png?cb=d01c3e9eda6d9f4992db4429c09b1828)
Cubemap view of the panorama after the VR button has been pressed. Effects are automatically added.

## Virtual Tours

Panoramas can be grouped together into Virtual Tours complete with navigation and information hotspots. An example virtual tour (of a hotel room) in Chaos Cloud is here: <https://cloud.chaos.com/collaboration/virtual-tour/Hqu3ftGXqyY6nGkwzsciNm> . To enter the tour, click the 'Start virtual tour' button.  
![image-20260520-160043.png](https://docs.igloovision.com/__attachments/a_1d7e282dff91afbc6486c3ff9da72e3bb3996fc232828763b2ab1a5a61b77534/image-20260520-160043.png?cb=5e05928b8ac040de3ae7f675237c9d95)
Example virtual tour in Chaos Cloud.  
![image-20260520-160413.png](https://docs.igloovision.com/__attachments/a_2c1435bab22a4f14d23262bcf0d6be82bbc8a150a8e64242823f5a5b46751979/image-20260520-160413.png?cb=64bb8fa91af4b10523e12820979fef08)
Viewing the virtual tour.  
![image-20260520-160532.png](https://docs.igloovision.com/__attachments/a_041461384b7e51904f645394613cca05966322ea5b0dd8c5d478319aa47e5bca/image-20260520-160532.png?cb=8ff318a3868c0caba6bb79de18d41cf7)
Cubemap view after Toggle VR button pressed.
[enscape_virtual_tour.mp4](https://docs.igloovision.com/__attachments/a_02d11eaa9412d6a708a16c5c9ae72bfbe9a9ee611c38de17163fa0a3345d39e7/enscape_virtual_tour.mp4.md)
Video of the example virtual tour.

## WebXR metadata keys

Here is a list of the metadata keys which you will need for this integration.  

|           **Key**            |  **Default Value**  |                                     **Description**                                      |
|------------------------------|---------------------|------------------------------------------------------------------------------------------|
| webxr                        |                     | Enables webxr integration. No value is required, just the metadata key.                  |
| webxr/cubeFaceSize           | 1000                | Pixel size of each cubemap face. A value of 1000 will give a cubemap of 6000px x 1000px. |
| webxr/emulatedControllerType | aframe/oculus-touch | Emulated controller to enable clicking of hotspots.                                      |

## I have an Issue!

For issues with the Chaos Cloud/Enscape integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# Cintoo

**CenarioVR** (<https://www.cenariovr.com/>) is a powerful and easy-to-use virtual reality training tool that enables you to drive engagement, retention, and performance.

## Integration

This integration is built by the CenarioVR development team supported by the Igloo application integration team. The integration enables the 360 video output to be displayed in a suitable format for Igloo immersive spaces. The integration can be activated using a URL parameter.

### Igloo Core Engine Session

From version 1.3.0 onwards, your Igloo Core Engine installation will have a ready-made session in the content library called 'CenarioVR'.  
If the session is not there, then you can import it from `C:\ProgramData\Igloo Vision\IglooCoreEngine\example sessions\CenarioVR`

This session loads an example health training scenario. Press the Play \> button to start the scenario.  
![image-20240412-103456.png](https://docs.igloovision.com/__attachments/a_92a76877b6f2222101fc46836d72d728b6e70d3430cb05f686caa034231dc309/image-20240412-103456.png?cb=010986359c10ca78fd4fa4893e54b756)
Example health training scenario.

Interaction is made by clicking the UI elements directly on the Canvas using Igloo Control Panel \> Mouse \> Cast or in the Desktop UI by selecting in either the Canvas or Layer preview tabs.

### URL Parameters

The following URL template may be used to auto join a scenario in igloo mode:

[https://cenariovr.com/app/#/view?*\<scenario id\>*\&igloo=1](https://avatour.live/autojoin?s=IGLOO&user=igloo&igloo=1)

This URL works for published scenarios by including the scenario id and **igloo=1** enables igloo mode.

### Detailed Session Setup

Create a WebView and set the URL to <https://cenariovr.com/app/#/> . This will display the login page.  
![image-20240412-144922.png](https://docs.igloovision.com/__attachments/a_de44ad24a7b3e15f899d841261ac1dc71a19919539116dfaa9c6371138528333/image-20240412-144922.png?cb=d90e29db7dacf0cc7926d7133218b1db)

Once logged in, you will be able to select from your own scenarios as well as public and shared scenarios.  
![image-20240412-144445.png](https://docs.igloovision.com/__attachments/a_3b0ed8f07cfdf1fd74361ef78aa43c24fc549af9cd210b9c5edc0992c8999921/image-20240412-144445.png?cb=fd01e73c9a928f37db0116d920e58263)
Browsing large selection of public scenarios.

Select a scenario and it will be loaded into the browser.  
![image-20240412-151835.png](https://docs.igloovision.com/__attachments/a_363014aa0b625bbde64d3343b1e7f2b7684a16704ae0e7d53a766722d9576daa/image-20240412-151835.png?cb=6de9e965c743752b0e97b8c59b93c59f)
Scenario selected and loaded.

Append **?igloo=1** to the end of the URL. The scenario is now displayed as a cubemap.

Make the following changes to the layer to display the cubemap correctly. Untick the Dynamic Resolution option and set the WebView resolution to be 6000 x 1000. Untick the Show UI option.

Finally, add the Cubemap to Equirectangular and TruePerspective effects so that the cubemap will display correctly in the Igloo.  
![image-20240412-151514.png](https://docs.igloovision.com/__attachments/a_6e1ea1a1398fd8d0e0d5cbddaad7d4c06ce18307e98232f920518da9531eb89f/image-20240412-151514.png?cb=c0160d2b0ad9d5ba24170be8f191e28e)
WebView layer with properties for CenarioVR.

Save the WebView layer as a session so it can loaded easily next time.

## I have an Issue!

For issues with the CenarioVR integration, please contact [myadvocate@igloovision.com](mailto:myadvocate@igloovision.com) or use the [help desk.](https://360igloo.atlassian.net/servicedesk/customer/portals) A ticket will be generated for you, and an appropriate member of our tech support team will contact you as soon as possible to assist you with your problem.

---
version: "2.0.0"
language: "en"
---
# Command Line Arguments

Igloo Core Engine supports several command-line arguments that can be used to control its behavior.

*** ** * ** ***

## Startup Session

**Description** :

This argument is used to specify a session ID that Igloo Core Engine will load on start up

**Format** :

`sessionId=<id>`

*** ** * ** ***

### Chromium Remote Debug Port

See [WebView \| Dev Tools](https://docs.igloovision.com/documentation/current/webview.md#Dev-Tools) for more information about Chrome DevTools.

**Description** :

This argument specifies the port number for remote debugging of WebView layers. The program will use this port to allow establishment of a remote debugging connection.

**Format** :

`remoteDebugPort=<port>`

**Example**:

`remoteDebugPort=8080`

*** ** * ** ***

### Always on Top

**Description** :

This setting overrides the `alwaysOnTop` option found in the `EditorWindowsSettings.xml` file. It can be especially useful for systems without a dedicated console monitor. By configuring this setting, you can create a shortcut that launches the Igloo Core Engine with the desktop interface visible (i.e., setting `alwaysOnTop=0`).

**Format** :

`alwaysOnTop=<int>`

**Example** :

`alwaysOnTop=0`

### Safe Mode

**Description** :

This setting launches Igloo Core Engine in the following state

* No startup workspace is loaded.

* Triggers and Actions is disabled

**Format** :

`safeMode=<int>`

**Example** :

`safeMode=1`

---
version: "2.0.0"
language: "en"
---
# Command Line Options

`IglooSetup.exe` supports command-line arguments that allow for automatic exporting of project data without user interaction.

*** ** * ** ***

## **Usage**

`IglooSetup.exe [Project to load] -doAutoExport -autoExportOutputPath [Export path] `

*** ** * ** ***

### **Arguments**

#### `[Project to load]` *(Optional for auto export)*

The full path and filename of the IglooSetup project to load.

* Required when launching the application by double-clicking a project file.

* Optional when using `-doAutoExport`. If not specified, the **startup project** defined in the application settings will be used.

#### `-doAutoExport`

Initiates an **automatic export** of the loaded project and **automatically exits** the application once complete.

* If any errors occur during export, they are written to a **log file** for review.

* Use this flag to automate project exports in scripts or scheduled tasks.

#### `-autoExportOutputPath [Export path]` *(Optional)*

Specifies a custom **output directory** for the exported data.

* If omitted, the project's default export path is used.

*** ** * ** ***

### **Example**

`IglooSetup.exe "C:\Projects\MySetup.igloosetup" -doAutoExport -autoExportOutputPath "D:\Exports\MySetupExport" `

This command loads the specified project, performs an auto export to the defined directory, and closes the application when finished.

---
version: "2.0.0"
language: "en"
---
# Common Issues

## Startup Issues

### Update Nvidia Drivers

Outdated or incompatible Nvidia drivers can lead to issues, ensure that drivers are up-to-date:

Steps to Update Nvidia Drivers

1. Visit the [Nvidia website](https://www.nvidia.com/Download/index.aspx) and enter your GPU details.

2. Download and install the latest driver package.

3. Reboot the system after installation.

### Install Missing Redistributables

If the application fails to start or displays missing DLL errors, this is often due to missing Visual C++ Redistributables. The Igloo Core Engine Installer should install these automatically. The following are required

* Visual C++ 2015-2022 Redistributables (x86 and x64)

* Visual C++ 2013 (x86 and x64)

* Visual C++ 2010 (x86 and x64)

Steps to Install Redistributables:

1. Download Redistributables: Download the appropriate version from the official [Microsoft Download Center](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-160).

2. Install Both x86 and x64 Versions: Install both the 32-bit (x86) and 64-bit (x64) versions to ensure compatibility with different components.

3. Reboot the System after the installation is complete.

*** ** * ** ***

## Blank WebViews

If WebViews appear blank or Canvas layers don't load correctly, this could be a GPU configuration issue in systems with dual GPUs

### Laptops with Intel + Nvidia GPUs

Steps to Correct GPU Settings:

1. Open Nvidia Control Panel: Right-click on the desktop and select "Nvidia Control Panel."

2. Manage 3D Settings: Go to "Manage 3D settings" \> "Program Settings."

3. Select Igloo Core Engine Executable: Find or add the Igloo Core Engine executable to the list.

4. Preferred Graphics Processor: Set the preferred graphics processor to High-performance Nvidia GPU.

5. OpenGL Rendering GPU: Ensure the primary GPU is selected for OpenGL rendering.

6. Connect the Console to Primary GPU: Make sure the console display is connected to the primary GPU to avoid rendering issues.

### Machines with Dual Nvidia GPU's

* **Verify GPU Settings for Igloo Core Engine:** Ensure that the GPU assigned to the Igloo Core Engine profile in the Nvidia Control Panel matches the GPU selected in Windows Graphics settings. Mismatched GPU settings can cause rendering issues, such as the OpenGL and DirectX contexts being created on different GPUs, which can lead to blank WebViews.

* **Set GPU Preference to Auto-Select:** In the Nvidia Control Panel, set the GPU preference for Igloo Core Engine to "Auto-select." This will ensure that the GPU connected to the primary display is used for creating the OpenGL context. If Windows Graphics settings are using default settings (no custom profile), this configuration should resolve any rendering issues.

* **Manual GPU Assignment:** If you prefer to manually assign a specific GPU for the Igloo Core Engine in the Nvidia Control Panel, ensure that Windows Graphics settings also use the same GPU. Both OpenGL and DirectX contexts must be created on the same GPU to prevent rendering issues.

*** ** * ** ***

## Media Loading Delay on Network Drives

If you are using media files stored on network locations (UNC paths), you might notice that the application sometimes hangs or takes longer than expected to load your media list. This can happen when you open the Load Content window, switch to the Select Media Files tab, and click the Sync button.

### What's Happening

* **Network Latency:**

  When the application checks for media files on a network drive (for example, paths like `\\Server\Share\...`), slow or unresponsive network conditions can cause delays. This check may take over 20 seconds if the network drive is not responding promptly.

* **Temporary Hang:**

  During this time, the user interface may appear frozen. This is because the system is waiting for a response from the network drive before continuing.

#### What You Can Do

* **Check the Logs:**

  Detailed log files are generated during these operations. If you experience a hang, please review the logs for entries related to file or drive checks. These logs will provide information on how long the check took.

* **Network Drive Conditions:**

  Ensure that your network drive is online and accessible. If possible, verify that there are no network issues causing delays.

This delay is known behavior when working with UNC network paths, and monitoring the logs is the best way to understand what's causing the delay.

---
version: "2.0.0"
language: "en"
---
# Composition

A **Composition** groups multiple sources (called **sub-layers**) into a single layer. This is useful when you want to manage several items as one unit (move/scale/enable/effects together), while still being able to edit each source independently.

*** ** * ** ***

## Setup

### Add a Composition layer

Create a new **Composition** from the **Add Layer** menu (or File \> New \> Layer).

### Composition resolution

By default, a new composition uses the **Workspace Canvas resolution** .

You can change the composition resolution if needed (for example, if you want a lower-resolution composite for performance, or a fixed resolution such a compositing cubemap faces)  
![image-20260220-151807.png](https://docs.igloovision.com/__attachments/a_754d4ee1115dcc847c5df4429eb1a7622eabb8ce53e01a4adf246bd1bbb865b9/image-20260220-151807.png?cb=f297d43134e321f4e5b2144763765514)

*** ** * ** ***

## Managing sub-layers (sources)

Sub-layers are managed from the **Sublayers** list.

### Add a sub-layer

Select **Add Sublayer (+)**:

* **New**: create a new source inside the composition

* **Load**: add an existing source from the library

### Remove a sub-layer

Right-click a sub-layer in the list and select **Remove** .

This removes it from the composition (it does not delete the original item from your library).

### Edit a sub-layer

Right-click a sub-layer and select **Edit**.

When editing, you'll "enter" the sub-layer and the UI will update to show:

* A **breadcrumb trail** at the top (shows where you are: *Composition / Sub-layer*)

* The **Layer settings panel** for the selected sub-layer (so you can change its URL, resolution, sender, playback settings, etc.)

To stop editing the sub-layer and return to the composition, use the **breadcrumb** to go back to **Composition**.  
![image-20260220-151840.png](https://docs.igloovision.com/__attachments/a_4ce94e65c50c0c5b4bb16573176582df90f74851baac65c89686c85d4fffec0c/image-20260220-151840.png?cb=4326161c90303ca9b04a781aace1751e)

---
version: "2.0.0"
language: "en"
---
# Configuration

Most of the Igloo Core Service's settings are managed in the `config.json` file in its install directory. This is validated when the service is run, so there won't ever be unused or extra options present in this file. This means that if something is missing, it isn't supported by the version of the service that you have installed. Settings files from the `igloo-cast-sources` service can be automatically migrated to this format when installing the Igloo Core Service.

*** ** * ** ***

## config.json

This section is arranged according to the keys present in `config.json`. It'll probably make more sense if you're looking at a copy of the file; the default is shown at the bottom of this page.

Most settings don't require the service to be restarted for them to take effect; you'll generally just need to refresh the browser page that the setting will have an effect on. Anything which is used by the service at start-up is an exception to this; these options are annotated below.

### service

Configuration for the service's backend

* `httpPort` (number; default `800`)

  * insecure webserver port for all pages provided by the service

  * requires restart

* `httpsPort` (number; default `801`)

  * secure (HTTPS) webserver port for the same pages. Everything is served on both ports simultaneously.

  * requires restart

* `oscPort` (number; default `9003`) \[requires restart\]

  * port that the service listens on for incoming OSC. Needs to match Playback and Igloo Control Panel's OSC outport ports.

  * requires restart

* `computerName` (string; default empty) \[requires restart\]

  * name for the machine, shown only in Igloo Control Panel's discovery page.

  * requires restart

### ice

Configuration for interactions with Igloo Core Engine

* `udpPort` (number; default `10001`)

  * port on which to send UDP messages to Igloo Core Engine

  * requires restart

### controllers

Configuration for outgoing messages from the game engine page.

* `clients` (array of strings; default `['localhost:9007', 'localhost:9008']`

  * Hosts to send ximu/euler OSC to (Unity/Unreal).

* controllerServicePort (number; default `10000`).

  * Port that Igloo Controller Service is running on. (For movement/controller emulation messages).

### sources

Configuration for behaviour of the sources app (Sources tab in Igloo Control Panel).

* `ignoreList` (array of strings; default `["IGLOOHOME"]`)

  * list of Capture input names **not** to show in the Sources app. Change to `[]` to stop ignoring Igloo Home.

### cast

Configuration for keyboard/mouse casting app (Mouse tab in Igloo Control Panel).

* `behaviour` (`"ice"` or `"web"`; default `"ice"`)

  * Destination of keyboard/mouse events from the cast app - Igloo Core Engine or Igloo Web.

  * requires restart

### youTube

Configuration for **Warper Suite Igloo** Control Panel's YouTube app.

Position/scale are used to position the Capture channel somewhere other than the middle of the screen. The channel's position is reset whenever a new video is provided (to prevent 16:9 videos appearing initially with 360 settings).

* `captureName` (string; default `"YouTube"`)

  * the name of the Capture channel that has been set up to display incoming YouTube videos; the service uses this to tell Capture to set it to max resolution, reset its geometry, etc. at correct times.

  * requires restart

* `scale` (number; default `1`)

  * default scale for the above Capture channel

  * requires restart

* `position` (`[number, number]`; default `[0.5, 0.5]`)

  * default position for the above Capture channel

  * requires restart

### fileBrowser

Configuration for Igloo Web/Igloo Core Engine's built-in WebView file browser.

* `contentFolderPaths` (array of strings; default `["C:\\igloo\\Content\\"]`)

  * Filepaths that can't be navigated 'out of' using the GUI. These filepaths won't have the 'up a directory level' arrow added to their UI.

  * Paths need to use escaped backslashes as a separator.

### icedrop

Configuration for the ICEDrop file-share app

* `directory` (string; default `"C:\\content\\icedrop"`) \[requires restart\]

  * Target directory for file uploads from ICEdrop. No files will be uploaded if this doesn't exist

  * Paths need to use escaped backslashes as a separator.

  * requires restart

### spacewalk

Configuration for spacewalk app URL parameters

* `p` (string; default empty)

  * 'project' URL parameter provided to any spacewalk instances on pageload

  * updated by the spacewalk app when a user explicitly visits a new project using the bookmarklet

* `env` (string; default empty)

  * 'environment' URL parameter provided to any spacewalk instances on pageload

  * updated by the spacewalk app when a user explicitly visits a new environment using the bookmarklet

* `useQA` (boolean; default `false`)

  * whether to use QA or production environment for spacewalk instances

### projectorControl

Configuration for projector control capabilities of the backend. Set the target port and desired OSC message(s) here.

* `port` (number; default `9016`)

  * port for OSC to be sent to when requested

  * requires restart

* `on` (array of strings)

  * OSC message(s) to turn projectors on when requested

  * requires restart

* `off` (array of strings)

  * OSC message(s) to turn projectors off when requested

  * requires restart

### openStageControl

Open Stage Control configuration. See [the documentation for the app](https://docs.igloovision.com/documentation/current/open-stage-control.md) for more details.

* `launch` (boolean; default `false`)

  * whether to start bundled open stage control instance with the service

  * requires restart

* `port` (number; default `802`)

  * port for bundled open stage control instance

  * requires restart

* `theme` (string; default `<install directory>/open-stage-control/igloo.css`)

  * path to open stage control theme

  * requires restart

* `session` (string; default `<install directory>/open-stage-control/default_session.json`)

  * path to open stage control session

  * requires restart

* `parameters` (array of strings; default `[]`)

  * extra command line parameters to pass to bundled open stage control

  * these parameters are passed by default: `--no-gui --read-only --port <configured port> --theme <configured theme> --load <configured session> `

  * requires restart

### skybox

* `apiKey` (string; default empty)

  * BlockadeLabs API key.

### streetview

* `apiKey` (string; default empty)

  * Google Maps API key.

### matterport

* `apiKey` (string; default empty)

  * Matterport API key

* `useEmbedSdk` (boolean; default `false`)

  * For debugging; use Matterport embed SDK instead of default bundle SDK.

* `oAuthUrl` (string; default `https://auth.igloo.vision/matterport/`)

  * URL for Igloo Matterport Service oAuth proxy.

* `homePort` (number; default `9011`)

  * Igloo Home port; legacy.

* `homeTimeMinutes` (number; default `5`)

  * Time before returning to Igloo Home when opened with a specific URL; legacy.

### annotation

* `defaultColour` (string; default `black`).

  * Starting colour of pen tool on annotation page.

* `defaultFontSize` (number; default `90`).

  * Starting font size of text tool on annotation page.

* `defaultStrokeWidth` (number; default `6`).

  * Starting stroke width of pen tool on annotation page.

* `eraserMenuPos` (vector2; default `{x: 0, y: 90}`).

  * Position of top left corner of eraser menu on annotation page (in %).

* `sidebarPos`(vector2; default `{x: 0, y: 12}`).

  * Position of top left corner of sidebar menu on annotation page (in %).

* `toolMenuPos`(vector2; default `{x: 0, y: 0}`).

  * Position of top left corner of tools menu on annotation page (in %).

* `clearAllPos`(vector2; default `{x: 0, y: 80}`).

  * Position of top left corner of clear-all menu on annotation page (in %).

### controlPanel

Igloo Control Panel browser configuration. See [Igloo Control Panel browsers](https://docs.igloovision.com/documentation/current/ice-control-panel-browsers.md) for more details.

* `tabs` (array of strings; default `["default"]`)

  * tab identifiers to display in Igloo Control Panel instances connected to this service.

    Identifiers must be configured

* `apps` (array of strings; default `["matterport", "streetview", "warping", "default"]`)

  * list of app identifiers to display in Igloo Control Panel instances connected to this service.

    Identifiers must be configured

* `_defaultOverrides` (`object<BrowserIdentifier, Partial<BrowserDeclaration>>`)

  * override default properties of pre-set browsers

*** ** * ** ***

## Default config.json

This is created by the service as required. You don't need to manually create it, or manually add keys (as explained above)
JSON

    {
      "service": {
        "httpPort": 800,
        "httpsPort": 801,
        "oscPort": 9003,
        "computerName": ""
      },
      "ice": {
        "udpPort": 10001
      },
      "controllers": {
        "clients": [
          "localhost:9007",
          "localhost:9008"
        ],
        "controllerServicePort": 10000
      },
      "sources": {
        "ignoreList": [
          "IGLOOHOME"
        ]
      },
      "cast": {
        "behaviour": "ice"
      },
      "youTube": {
        "captureName": "YouTube",
        "scale": 1,
        "position": [
          0.5,
          0.5
        ]
      },
      "fileBrowser": {
        "contentFolderPaths": [
          "C:\\igloo\\Content\\"
        ]
      },
      "icedrop": {
        "directory": "C:\\content\\icedrop"
      },
      "spacewalk": {
        "p": "",
        "env": "",
        "useQA": false
      },
      "projectorControl": {
        "port": 9016,
        "on": [
          "/deviceControl/projectors/on"
        ],
        "off": [
          "/deviceControl/projectors/off"
        ]
      },
      "controlPanel": {
        "tabs": [
          "default"
        ],
        "apps": [
          "matterport",
          "streetview",
          "warping",
          "default"
        ],
        "_defaultOverrides": {}
      },
      "openStageControl": {
        "launch": false,
        "port": 802,
        "theme": "C:\\dev\\igloo-core-service\\dist\\open-stage-control\\igloo.css",
        "session": "C:\\dev\\igloo-core-service\\dist\\open-stage-control\\default_session.json",
        "parameters": []
      },
      "skybox": {
        "apiKey": ""
      },
      "streetview": {
        "apiKey": ""
      },
      "matterport": {
        "apiKey": "",
        "useEmbedSdk": false,
        "oAuthUrl": "https://auth.igloo.vision/matterport/",
        "homePort": 9011,
        "homeTimeMinutes": 5
      },
      "annotation": {
        "defaultColour": "black",
        "defaultFontSize": 90,
        "defaultStrokeWidth": 6,
        "eraserMenuPos": {
          "x": 0,
          "y": 90
        },
        "sidebarPos": {
          "x": 0,
          "y": 12
        },
        "toolMenuPos": {
          "x": 0,
          "y": 0
        },
        "clearAllPos": {
          "x": 0,
          "y": 80
        }
      }
    }

[Next Page](https://docs.igloovision.com/llms-full.txt/1)
