Looking Glass Documentation
Buy Looking GlassDiscord
  • Looking Glass User Guide
  • NEW! ✨Looking Glass Go✨
  • Displays
    • 🔮Looking Glass Go
      • ⚡Get Started with Looking Glass Go
      • 📱Using the Go Mobile App
      • 🔆Liteforms™
      • 🖥️Standalone and Desktop Modes
      • 🔌Power and LED States
      • 🪄Default Playlist
      • ⏭️What's Next?
      • 👜Accessories
      • ⚙️Advanced Playlist Creation
      • ⚙️Manual Firmware Update
      • ❓Common Troubleshooting Issues
    • 🔮Looking Glass 16" Light Field Displays
      • 🪄Looking Glass 16" Light Field Display (Landscape)
      • 🪄Looking Glass 16" Light Field Display (Portrait)
      • ❓Common Troubleshooting Issues
    • 🔮Looking Glass 32" Light Field Displays
      • 🪄Looking Glass 32" Light Field Display (Landscape)
      • 🪄Looking Glass 32" Light Field Display (Portrait)
      • ❓Common Troubleshooting Issues
    • 🔮Looking Glass 65" Light Field Display
    • 🔮Looking Glass Portrait
      • ⚡Get Started with Looking Glass Portrait
      • 🎇Demo Holograms
      • ❓Common Troubleshooting Issues
  • Software Tools
    • 📚Overview
    • 🌉Looking Glass Bridge
      • ✨Using Looking Glass Bridge
      • 🪟Display Settings on Windows
      • 🍎Display Settings on macOS
      • 🐧Display Settings on Linux
      • 👷Troubleshooting
    • 📽️Looking Glass Studio
      • 📚Using Looking Glass Studio
      • RGB-D Photo / Video
      • Quilt Images / Video
      • iPhone Portrait Photos
      • Android Depth Photos
        • Samsung Portrait Mode
      • Light Field Photosets
      • Exporting Holograms
      • Troubleshooting
    • 🧊Looking Glass Blocks
      • ✨Convert any image into a hologram
      • ⬆️Uploading, editing and sharing Quilts
      • 🥽Viewing your holograms on different platforms
    • 🎬Hologram Video
    • 🔆Liteforms™
      • 🪟Get Started on Windows
      • 🍎Get Started on MacOS
      • 🧙Making Custom Liteforms
      • 🏪Configure Liteforms for Kiosk Setup
    • 👀Looking Glass Model Viewer
    • 🧪Experiments
      • 📽️Media Encoder
      • ⏩Looking Glass Media Encoder
  • Key Concepts
    • 🔑Hologram 101
      • 🎉Making great holograms
      • 🌎Holograms in the real world
      • 👾Holograms, but virtual
    • 🔍How does Looking Glass Work?
    • 📸Virtual Camera
    • 🧊3D Design Guidelines
      • Lighting
      • Post-Processing
      • Scene Composition
      • Materials & Textures
      • Performance
    • 💡Quilts
      • 🎬Quilt Video Encoding
    • 💡Light Fields
      • ⚡Linear Light Field Capture
    • 📽️Filming a Looking Glass
  • Creator Tools
    • 🎨Overview
    • 🔌Unity
      • ⚡Using Unity with Looking Glass
      • Setting up your Development Environment
      • Example Scenes
      • Prefabs
        • Hologram Camera
        • 3D Cursor
        • Dual Monitor Application
      • Script Reference
        • HologramCamera.cs
        • LKGDisplaySystem.cs
        • QuiltCapture.cs
        • Cursor3D.cs
        • OrbitControls.cs
        • BlockUploader.cs
        • MobileDMAController.cs
        • iOS Sample Scene Scripts
          • ChangeInteractionModality.cs
          • XYSlider.cs
          • XYSpotlight.cs
          • AudioRotateControl.cs
          • ModelController.cs
          • DemoIOSUIController.cs
          • PageHandler.cs
          • PageConnectHandler.cs
          • PageCalibrateHandler.cs
          • PageTestHandler.cs
          • DynamicAlcove.cs
      • Package Integrations
        • Built-in Render Pipeline Post-Processing
      • Developing for iOS
      • Depth of Field and Other Post-Processing Effects
      • Quilt Video Audio and Playback
      • Developing for Ultraleap Hand Tracking on Looking Glass
      • Looking Glass Pro (Legacy)
      • Additional Support
      • Change Log
    • 🍹Blender
    • 🔌Unreal Engine
      • 🗒️Change Log and Old Versions
      • 💽Installing the Unreal Engine plugin
      • 🎥Using the Unreal Engine Plugin
        • Using the HoloPlay Capture
        • Exporting Quilt Images and Video with Sequencer
      • Accessing HoloPlay Data with Blueprint Scripting
      • Packaging the Project
      • Unreal Engine 4 (Legacy Support)
        • Unreal Engine 4 Quick Start
          • Using the HoloPlay Capture
          • Exporting Quilt Images and Video with Sequencer
    • 🌐WebXR
      • 🔶PlayCanvas
      • 3️⃣3️⃣ Three.JS
      • ⚛️React-Three-Fiber
      • 🌈Spline
  • Tutorials
    • 📱Running Looking Glass Displays with iOS Devices
    • Ⓜ️Capturing Light Fields in Maya
    • 🧑‍🔬Using ShaderToy with Looking Glass
    • 🎨Sculpting with Adobe Medium and Looking Glass
    • 🔍Turn Videogames Holographic with Refract
    • 🖐️Building with Leap Motion
  • Developer Docs
    • ⚙️Looking Glass Bridge SDK
      • 🪛Web Application Integration
      • 🔌Integrating Native Applications
      • 📓Native Function Reference
    • 🐦Looking Glass Core Migration Guide
  • Third Party Software
    • 🗡️3D Slicer
    • 🔬VTK (Visualization Toolkit)
    • 🗺️ParaView
    • 🔩Community Made Tools & Projects
  • Legacy Software
    • 📡3D Model Importer
      • 3D Model Importer App Guide
      • 3D Model Importer App Reference
    • 🎭Diorama
      • Change Log
    • 🎞️Depth Recorder
    • 📸Lightfield Photo App
    • 🍍Looking Glass Core Overview
    • 🍽️Looking Glass Core SDK
      • C API Overview
        • HoloPlayCore.h
          • State Functions
          • General-Query-Functions
          • Device-Query-Functions
        • libHoloPlayCore.h
        • HoloPlayShaders.h
    • 🔰Looking Glass Core JS
      • API
        • HoloPlayCore.Client
        • HoloPlayCore.Message
        • HoloPlay Service Related
        • examples
  • Legacy Hardware
    • 🔻Looking Glass 8.9"
    • 🔻Looking Glass 15.6"
    • 🔻Looking Glass 8K
    • 🔻Looking Glass 16"
    • 🔻Looking Glass 32"
    • 🔻Looking Glass Pro
  • 💬Contact Us
  • 🛠️FAQ & Troubleshooting
Powered by GitBook

Follow us

  • Twitter
  • Instagram
  • LinkedIn
On this page
  • Device Status
  • Example Response
  • Field Descriptions
  • Quilt Settings
  • Error Codes

Was this helpful?

  1. Legacy Software
  2. Looking Glass Core JS
  3. API

HoloPlay Service Related

Device Status

If HoloPlay Service receives an info command, it will respond with information about HoloPlay Service and any connected devices.

Example Response

{
  "error": 0,
  "version": "1.0.0",
  "devices": [
    {
      "hwid": "LKG030nffpp24",
      "state": "hidden",
      "windowCoords": [1920, 0],
      "hardwareVersion": "standard",
      "buttons": {
        [0, 0, 0, 0]
      }
      "calibration": {
        "pitch": 50.060001373291016,
        "slope": -7.7369561195373535,
        "center": 0.26147353649139404,
    ...
      }
    {
  ]
}

Field Descriptions

version

The version of HoloPlay Service installed on the machine.

devices

An array of all devices currently connected.

devices[idx].state

The state of the specified device. Can be one of the following states:

  • hidden — the window is not visible.

  • ok — the window exists and is ready to receive content.

  • nocalibration — there's an error reading calibration, please ensure your cables are connected.

devices[idx].windowCoords

Display position of the device as window coordinates. The position is relative to the top left-hand corner of the main monitor.

devices[idx].hardwareVersion

devices[idx].buttons

Whether or not each of the buttons is currently pressed for the specified device.

devices[idx].calibration

Calibration data for the specified device.

Quilt Settings

A description of quilt view count and tiling. All parameters are optional.

  • vx (int) - number of columns.

    • default value: 1.

  • vy (int) - number of rows.

    • default value: 1.

  • vtotal (int) - total number of views in quilt.

    • default value: vx * vy.

    • only necessary for quilts that have "missing" views in some positions.

  • aspect (float) - original aspect ratio of the quilt.

    • default value: if unspecified, will match aspect ratio of target display (16/10 for the 8.9" Looking Glass, 16/9 for the 15.6" Looking Glass, etc).

  • overscan (bool/int) - scaling setting when on a device with a different aspect ratio than the quilt. It only makes a difference when the quilt aspect is specified and its different than the aspect ratio of the Looking Glass.

    • default value: 0.

    • overscan=1 scales the image until it fills all possible space on the display, cutting out extra part of image.

    • overscan=0 scales the image until its largest side fits the display, leaving black edges on the other sides.

    • overscan has no effect if aspect is either unspecified or equal to the resolution of the target display.

  • invert (bool/int) - inverted view cone setting.

    • default value: 0.

    • invert=1 causes the views to be read in the opposite order as they are encoded in the texture, from the top right to the bottom left.

Error Codes

Every command issued to the driver has a corresponding response issued in CBOR format. At minimum, the response contains an error code, which may be one of the following:

Error

Description

0

No error, everything ok.

1

CBOR parser failure.

2

Driver could not understand the command.

3

Driver expected an image file in binary data, but could not read one.

4

Client attempted to draw to a Looking Glass that is not connected or has no calibration.

5

Client attempted to load a nonexistent key from the cache.

6

Client attempted to register an app ID after sending one or more messages.

7

Client attempted to do something that is not allowed (i.e., tried to take over a display currently occupied by a greedy process).

PreviousHoloPlayCore.MessageNextexamples

Last updated 4 years ago

Was this helpful?

Can be standard, large, pro, or 8k. Standard refers to the , large to the , pro to the , and 8K to the .

🔰
8.9" Looking Glass
15.6" unit
15.6" Pro
Looking Glass 8K