camstreamerlib 4.0.32 → 4.0.33

package/README.md

@@ -39,6 +39,15 @@ npm install camstreamerlib
 
 </br>
 
+# Examples
+
+| Example                                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                           | Open in browser                                                                        |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| [CamSwitcherEvents](examples/camswitcher-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/camswitcher-events.html))    | Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs [CamSwitcherAPI](doc/CamSwitcherAPI.md) to obtain the websocket authorization token, `DeviceConnectWsClient` (websocket) backs [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md), which validates and dispatches the events. Connection state is taken from the `authorization` event.                                                                | [open](https://camstreamer.github.io/CamStreamerLib/examples/camswitcher-events.html)  |
+| [PlaneTrackerEvents](examples/planetracker-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/planetracker-events.html)) | Logs every PlaneTracker event. PlaneTracker needs no authorization token — [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) announces the connecting user (`userId` / `userName` / `userPriority`, editable in the form) as the init message instead, so only the websocket client is needed. The continuous `CAMERA_POSITION` and `FLIGHT_LIST` events only update the summary line unless the checkbox is ticked. | [open](https://camstreamer.github.io/CamStreamerLib/examples/planetracker-events.html) |
+
+</br>
+
 # Breaking Changes
 
 <details open>

package/cjs/browser.index.d.ts

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/cjs/browser.index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index"), exports);
+__exportStar(require("./web/index"), exports);

package/esm/browser.index.js

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/examples/README.md

@@ -0,0 +1,43 @@
+# Examples
+
+Standalone browser examples that use CamStreamerLib directly from a `<script type="module">`,
+without a bundler or a framework.
+
+## Build the browser bundle
+
+```bash
+npm install
+npm run build:browser
+```
+
+## Run
+
+Modules can't be loaded over `file://`, so serve the folder over HTTP:
+
+```bash
+npx serve examples
+```
+
+Both pages connect to a camera through the Device Connect proxy. Fill in the device host
+(`<MAC_ADDRESS>.device-connect.net`) and the device access token in the form, or hardcode them in the
+`DEVICE_HOST` / `DEVICE_ACCESS_TOKEN` constants at the top of the page's script to have the form
+prefilled. See [doc/Client.md](../doc/Client.md).
+
+## camswitcher-events.html
+
+Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs `CamSwitcherAPI` to obtain the
+websocket authorization token; `DeviceConnectWsClient` (websocket) backs `CamSwitcherEvents`, which
+validates and dispatches the events. Connection state is taken from the `authorization` event.
+
+See [doc/ws/CamSwitcherEvents.md](../doc/ws/CamSwitcherEvents.md).
+
+## planetracker-events.html
+
+Logs every PlaneTracker event. PlaneTracker needs no authorization token — `PlaneTrackerEvents`
+announces the connecting user (`userId` / `userName` / `userPriority`, editable in the form) as the
+init message instead, so only the websocket client is needed.
+
+`CAMERA_POSITION` and `FLIGHT_LIST` arrive continuously, so by default they only update the summary
+line above the log; tick the checkbox to log them as well.
+
+See [doc/ws/PlaneTrackerEvents.md](../doc/ws/PlaneTrackerEvents.md).