Looking Glass Autostart API

Playlists that auto-play when Bridge starts

OpenAPI Specification

looking-glass-autostart-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Looking Glass Bridge Autostart API
  version: '1.0'
  description: 'HTTP REST API exposed by Looking Glass Bridge, the local runtime application that connects a host machine to Looking Glass holographic (light field) displays. Web and native applications call this local API to query connected displays, open the Bridge media player, build and control playlists of Quilt and RGBD holograms, and drive playback. The API is served on the loopback interface only (http://localhost:33334/); every operation is an HTTP POST with a JSON request body and returns a JSON envelope of the shape { "success": boolean, "response": object|null }. The official, typesafe way to consume this API is the @lookingglass/bridge (bridge.js) client library. This description was generated by the API Evangelist enrichment pipeline from Looking Glass''s public documentation and the open-source bridge.js client; endpoint signatures are, per the vendor, under active development.'
  contact:
    name: Looking Glass Factory
    url: https://lookingglassfactory.com
  x-generated-by: API Evangelist enrichment pipeline
  x-source:
  - https://docs.lookingglassfactory.com/software/looking-glass-bridge-sdk/web-application-integration
  - https://github.com/Looking-Glass/bridge.js
servers:
- url: http://localhost:33334/
  description: Looking Glass Bridge local loopback server (default port)
tags:
- name: Autostart
  description: Playlists that auto-play when Bridge starts
paths:
  /get_autostart_playlist:
    post:
      operationId: get_autostart_playlist
      summary: Get the playlist configured to auto-play when Bridge starts
      tags:
      - Autostart
      requestBody:
        $ref: '#/components/requestBodies/Orchestrated'
      responses:
        '200':
          $ref: '#/components/responses/Envelope'
  /set_autostart_playlist:
    post:
      operationId: set_autostart_playlist
      summary: Set the playlist to auto-play when Bridge starts
      tags:
      - Autostart
      requestBody:
        $ref: '#/components/requestBodies/PlaylistRef'
      responses:
        '200':
          $ref: '#/components/responses/Envelope'
  /set_named_autostart_playlist:
    post:
      operationId: set_named_autostart_playlist
      summary: Set a named playlist to auto-play when Bridge starts
      tags:
      - Autostart
      requestBody:
        $ref: '#/components/requestBodies/PlaylistRef'
      responses:
        '200':
          $ref: '#/components/responses/Envelope'
components:
  requestBodies:
    PlaylistRef:
      description: References a playlist by name within an orchestration.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlaylistRef'
    Orchestrated:
      description: Requires the orchestration token for the session.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrchestrationRef'
  schemas:
    ResponseEnvelope:
      type: object
      description: Standard Bridge response envelope returned by every endpoint.
      properties:
        success:
          type: boolean
          description: Whether the operation succeeded.
        response:
          description: Operation payload when successful, otherwise null.
          type:
          - object
          - 'null'
      required:
      - success
    PlaylistRef:
      type: object
      properties:
        orchestration:
          type: string
        playlist_name:
          type: string
          description: Name of the target playlist.
    OrchestrationRef:
      type: object
      properties:
        orchestration:
          type: string
          description: Orchestration token returned by enter_orchestration.
      required:
      - orchestration
  responses:
    Envelope:
      description: Standard Bridge response envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnvelope'