← Back to Developer Portal TECHNICAL INTEGRATION REFERENCE

Technical Integration Guide

OpticLink Pro is designed to be an open, highly integratable video and audio orchestrator. This document specifies the integration protocols, local network standards, and deep-linking APIs that enable external systems, custom dashboards, and smart home systems to seamlessly interface with OpticLink Pro.

1. The ip-camera:// URI Protocol Specification

OpticLink Pro registers as the default client for the custom ip-camera:// URI protocol at the OS level. This deep-linking standard allows external web portals, native apps, or scripting engines to command OpticLink Pro to instantly establish connection parameters, spawn stream controllers, and render camera feeds.

URI Schema Structure

The query string requires four primary connection parameters to configure a camera pipeline on the fly:

PARAMETER TYPE REQUIRED DESCRIPTION
ip String Yes Local IPv4 address or hostname of the camera hardware (e.g., 192.168.1.100).
port Integer Yes HTTP control / discovery port of the camera (default ONVIF ports: 80, 8080, 2020).
username String Yes Username for local camera RTSP and ONVIF authentication.
password String Yes Cryptographic or standard access password for authentication (must be URL-encoded).

Single-Instance Lifecycle Handling

When an ip-camera:// URI is triggered, the application manages the system lifecycle seamlessly:

2. Local Network & Stream Integration Standards

OpticLink Pro operates locally to ensure extreme security, high throughput, and zero external dependency. It utilizes standard open networking protocol layers:

ONVIF WS-Discovery

The application incorporates local subnetwork discovery using standard ONVIF WS-Discovery multicast probes (IP 239.255.255.250, port 3702). External configuration systems can expect the application to automatically discover all local ONVIF-compliant cameras and return their key endpoint data:

// Discovered Node Schema Returned by Local Search:
{
    "ip": "192.168.1.108",
    "name": "TP-Link CW61",
    "manufacturer": "TP-Link"
}

RTSP Stream Direct Integration

Once connection parameters are established via the protocol or UI, OpticLink Pro directly requests and pulls camera feeds via local RTSP (Real-Time Streaming Protocol).

Two-Way Intercom & Audio Mappings

For compatible hardware supporting ONVIF backchannels, OpticLink Pro establishes low-latency audio backchannel pipes. Audio captured by the local host's microphone is processed in the browser context via custom AudioWorklet processors before being packetized and sent to the core engine. This ensures the latency remains below 100ms for high-clarity local talkback.

Recording Persistent Storage Integration

OpticLink Pro writes video and audio directly to the host filesystem inside high-reliability containers. For external applications (such as a local Plex Server, customized surveillance indexes, or NAS scripts) looking to consume archived footage, the file structure is structured as follows:

3. Third-Party Application & Smart Home Mappings

Developers can leverage OpticLink Pro to extend local home automation platforms and customize physical operations.

Home Assistant (HASS) Integration

By combining Home Assistant shell commands with the ip-camera:// URI protocol, you can configure your dashboard to instantly open active streams on wall-mounted wall tablets or local monitoring PCs when events occur:

Home Assistant configuration.yaml Example:
# Define a service to launch a specific stream on a monitoring terminal
shell_command:
  launch_opticlink_gate_camera: >-
    explorer "ip-camera://connect?ip=192.168.1.120&port=80&username=admin&password=MyGateSecurePassword"

This service can be triggered by standard HASS Automations, such as when a door sensor is opened, a smart button is pressed, or security parameters change.

Custom Operations Dashboards

For enterprise operations centers, developers can design a lightweight HTML dashboard with visual maps. Clicking an area on the interactive map issues a call to window.location.href = "ip-camera://connect?ip=...". OpticLink Pro will instantly snap its interface focus to the camera feed corresponding to the map coordinates.

Next Steps for Integration

Ensure your cameras are ONVIF compliant, verify their network accessibility, and test the custom protocol scheme.

Back to Developer Hub