Readonly
colorsAPI to create, manage, and destroy colors.
Readonly
rpcThe RPC client for making remote procedure calls.
Readonly
sectionThe section box API for controlling the section box.
Gets the current connection status of the viewer.
The current ClientStatus.
The input API for handling user input events.
Event that is triggered when the viewer's connection status changes.
An event that emits the current ClientStatus.
Gets the current URL to which the viewer is connected.
The URL as a string, or undefined if not connected.
Connects to a VIM Ultra server.
Optional
settings: ConnectionSettingsA promise that resolves when the connection is established.
Requests the server to load the given URL or file path.
A load request object that can be used to wait for the load to complete.
Static
createCreates a Viewer instance with a new canvas element appended to the given parent element.
The parent HTML element to which the canvas will be appended.
Optional
logger: ILoggerOptional logger for logging messages.
A new instance of the Viewer class.
The main Viewer class responsible for managing VIM files, handling connections, and coordinating various components like the camera, decoder, and inputs.