LiveScopes.tv PRO Features

LiveScopes.tv PRO Features

This article outlines the additional features available in LiveScopes.tv PRO. For information on the basic features of LiveScopes.tv, see the LiveScopes.tv Getting Started article.

License Activation

One activation method is using a license file in JSON format. The license file is provided by the LiveScopes.tv team. Some license types are connected to your hardware using a hardware ID. You might need to provide this ID to the LiveScopes.tv team to generate the license file.

The hardware ID is displayed at the bottom of the activation window.

You can either drag and drop the license file onto the LiveScopes.tv window or manually put it in the C:\Users\%USERNAME%\AppData\Roaming\MindStudio\LiveScopes.tv Pro\ folder.

HTTP API

🚧 Since version 2.1.4 of LiveScopes.tv PRO, an experimental HTTP API is available. This API allows you to control LiveScopes.tv PRO from external applications or scripts via HTTP requests.

The API is in an experimental state, and the endpoints may change in future releases.

Overview

• Default Port: 22022
• Base URL: http://localhost:22022 (replace localhost with the machine’s IP if accessing remotely)
• Content Type: All responses are in application/json unless otherwise noted.
• Stability: Endpoints and parameters may change. Use with caution in production environments.

---

Endpoints

Retrieve Sources

GET /api/sources

Returns a JSON object with all available video sources and their metadata.
Sources are grouped by type (ndi, camera, decklink).

UI Actions

POST /api/ui/<action>

Performs an action on the UI. Actions toggle specific panels or menus inside LiveScopes.tv PRO.

Available actions:

• toggleSettings - Opens/closes the settings panel.
• toggleFrameBrowser - Opens/closes the frame browser.
• toggleLogsMenu - Opens/closes the logs menu.
• toggleColorFilterMenu - Opens/closes the color filter menu.
• toggleToolbar - Opens/closes the toolbar.
• toggleMetadata - Opens/closes the metadata panel.

Example:

curl -X POST http://localhost:22022/api/ui/toggleSettings

Response:

{ "status": "success", "action": "toggleSettings" }

Tools Actions

POST /api/tools/<action>?<key>=<value>&...

Performs an action on tools or updates tool parameters.

Available actions:

• toggleFalseColor - Toggles the false color overlay.
• toggleGrid - Toggles the alpha-transparency grid.
• toggleMask - Toggles the mask.
• disableOverlay - Disables the reference frame overlay.
• toggleSplitDirection - Toggles the split-screen split direction.
• toggleSplitSide - Toggles the split-screen side.
• toggleTimecode - Toggles the timecode display.
• toggleLUT - Toggles the LUT (Look-Up Table).
• toggleColorPicker - Toggles the color picker.
• toggleFocusPeaking - Toggles focus peaking.
• toggleZebra - Toggles the zebra overlay.
• captureRefFrame - Captures a reference frame.

Actions with parameters:

• setPeakingData - Sets focus peaking parameters.
  • threshold=<value> (0.0 - 1.0) - Threshold for when to highlight edges.
  • gain=<value> (0.0 - 20.0) - Gain applied to the peaking effect.
  • color=<hex> - Focus peaking color in hex format (RGB or RGBA, e.g. FF0000 or FF0000FF).
  • edgeDetectionMethod=<sobel|laplacian> - Edge detection method (Convolution kernel).
  • enable=<true|false> - Enable or disable focus peaking. (same as toggleFocusPeaking)

Example:

curl -X POST "http://localhost:22022/api/tools/setPeakingData?threshold=0.5&gain=1.0&color=FF0000&edgeDetectionMethod=sobel&enabled=true"

Response:

{
  "status": "success",
  "action": "setPeakingData",
  "threshold": 0.5,
  "edgeDetectionMethod": "sobel",
  "gain": 1.0,
  "color": "#FF0000",
  "enabled": true
}

• setZebraThreshold - Sets the zebra threshold.
  • threshold=<value> (0.0 - 1.0) - Threshold for the zebra stripes.

Example:

curl -X POST "http://localhost:22022/api/tools/setZebraThreshold?threshold=0.7"

Response:

{
  "status": "success",
  "action": "setZebraThreshold",
  "threshold": 0.7
}

Webcam Sources

🚧 Under Construction

DeckLink Sources

🚧 Under Construction

Zebra

🚧 Under Construction

Custom False Color Maps

🚧 Under Construction

LUTs

🚧 Under Construction

Color Picker

🚧 Under Construction

Focus Peaking

🚧 Under Construction