@ksp-gonogo/kerbcast 1.4.0

package/CHANGELOG.md

@@ -0,0 +1,186 @@
+# Changelog
+
+## 0.12.0 - 2026-06-07
+
+### Added
+
+- `BrowserKerbcastTransport` accepts an options object with `iceGatheringTimeoutMs`
+  (default 2000 ms). `waitForIceComplete` now resolves at the earlier of gathering
+  completing or the timeout, so connect does not stall the full STUN timeout on
+  LAN topologies where the STUN server is unreachable.
+- `KerbcastClientConfig.iceGatheringTimeoutMs` threads the timeout into the default
+  transport when no custom transport is provided.
+- `BrowserKerbcastTransportOptions` exported from the package root.
+- `KerbcastPeer.getStats?()` optional method; `BrowserKerbcastTransport` implements
+  it via `RTCPeerConnection.getStats(null)`. Third-party transports and existing
+  mocks keep compiling without changes.
+- `KerbcastClient.inboundVideoStats()` returns a `Map<number, InboundVideoStats>`
+  keyed by flightId. Resolves to an empty map when not connected or when the
+  transport does not implement `getStats`.
+- `InboundVideoStats` type exported from the package root.
+- `MockSidecar.setInboundStats(flightId, partialStats)` configures the stats the
+  fake `getStats()` returns, keyed by track id (legacy mode) or mid (dynamic mode).
+- `DiscoveredCamera` widened to match the full `GET /cameras` payload: added
+  `lifecycle`, `panYawMin`, `panYawMax`, `panPitchMin`, `panPitchMax`,
+  `encoderBitrateBps`, `targetBitrateBps`, `degradeLevel`. `maxWidth`/`maxHeight`
+  were already present. Additive -- existing consumers that destructure only
+  the previous fields continue working unchanged.
+- `PanZoomController` headless state machine for pan/zoom camera control.
+  Manages rate deduplication, analog deadzone, optimistic nudge accumulators,
+  FoV slider debounce, and echo-sync idle rules. `KerbcastCameraHandle`
+  satisfies `PanZoomCommandSink` structurally. Exported from the package root
+  along with `PanZoomCommandSink`, `PanZoomBounds`, and `PanZoomControllerOptions`.
+
+## 0.3.1 — 2026-05-21
+
+Export `KerbcastTransport`, `KerbcastPeer`, `KerbcastDataChannel` from
+the package root. 0.3.0 introduced these as a public extension
+point for tests and non-browser consumers but didn't re-export
+them, so the only way to reference the types was a deep import
+into `dist/client.d.ts`. Strictly additive — no behaviour change.
+
+
+## 0.3.0 — 2026-05-21
+
+High-level `KerbcastClient` class wraps the WebRTC peer, the
+`kerbcast-control` data channel, per-camera state cache, and
+per-track `MediaStream`s. Consumers no longer hand-roll
+`RTCPeerConnection`, build JSON wire messages, or thread SDP offers
+through `fetch`.
+
+```ts
+import { KerbcastClient, Layer } from "@jonpepler/kerbcast";
+
+const client = new KerbcastClient({ host: "192.168.1.74", port: 8088 });
+await client.connect();
+
+const cam = client.camera(2592004302);
+await cam.setLayers([Layer.Near, Layer.Scaled]);
+await cam.setFov(35);
+await cam.setDegrade(0.5);
+
+document.querySelector("video")!.srcObject = cam.mediaStream;
+
+cam.on("change", (state) => { /* per-camera state delta */ });
+client.on("adaptive-shed", (e) => { /* shed level + reason */ });
+```
+
+### Added
+
+- `KerbcastClient` owns the peer, control channel, and registry of
+  cameras. `connect(flightIds?)`, `disconnect()`, `camera(flightId)`,
+  `discover()`.
+- `KerbcastCameraHandle` exposes `setLayers`, `setRenderSize`,
+  `setFov`, `setPan`, `setDegrade`, `requestKeyframe`, plus a
+  `mediaStream` getter that yields the per-camera `MediaStream`
+  once the track arrives.
+- Typed event API on both `KerbcastClient`
+  (`state-change` / `cameras-change` / `adaptive-shed` / `error`)
+  and `KerbcastCameraHandle` (`change` / `stream`). Subscribing
+  returns an unsubscribe function.
+- `KerbcastTransport` interface — swappable transport for tests and
+  non-browser consumers. Default `BrowserKerbcastTransport` uses
+  `RTCPeerConnection`.
+- `client.discover()` fetches the sidecar's `/cameras` listing
+  without opening a peer connection, for picking a subset to
+  `connect()` with.
+
+### Restructured
+
+- Generated wire-format types moved from `src/index.ts` to
+  `src/__generated__/types.ts`. `src/index.ts` is now hand-written
+  and re-exports both the generated types and the new client.
+- Consumers that imported types from the package root keep working
+  (`import { ClientMessage } from "@jonpepler/kerbcast"` still
+  resolves to the same wire-format types).
+
+Version line is shared with the Rust sidecar (`sidecar/Cargo.toml`).
+CI verifies the two agree before any publish.
+
+## 0.2.0 — 2026-05-21
+
+New `set-degrade` client message and matching `degradeLevel` field
+on `CameraState`. Lets consumers request artificial signal
+degradation per camera (e.g. when in-game CommNet signal weakens);
+sidecar applies `max` across active subscribers and squeezes the
+encoder bitrate + skips a fraction of frames to produce the
+macroblocking + stuttering aesthetic of real signal loss. Also a
+real CPU optimisation: if every consumer wants degraded video, the
+encoder runs lighter.
+
+```ts
+const msg: ClientMessage = {
+  type: "set-degrade",
+  content: { flightId: 2592004302, level: 0.7 },
+};
+dc.send(JSON.stringify(msg));
+```
+
+### Wire-format additions
+
+- `ClientMessage::SetDegrade { flightId, level }` — level clamps to
+  `[0.0, 1.0]`; out-of-range values are clamped by the sidecar.
+- `CameraState.degradeLevel` — sidecar-pushed effective degrade
+  (max across subscribers).
+
+Additive: existing 0.1.0 consumers keep working — they just don't
+see the new field unless they read it.
+
+## 0.1.0 — 2026-05-21
+
+Initial release as `@jonpepler/kerbcast` on GitHub Packages.
+TypeScript bindings for the kerbcast sidecar's WebRTC data-channel
+protocol, generated from Rust types via
+[typeshare](https://github.com/1Password/typeshare).
+
+### Client → server messages
+
+- `hello` — handshake; server replies with `Hello` + `CameraSnapshot`.
+- `set-layers` — operator layer mask per camera (`NEAR` / `SCALED` /
+  `GALAXY`).
+- `set-render-size` — operator capture dimensions per camera (even
+  pixels, capped at the ring's allocated max).
+- `set-fov` — operator FoV in degrees (silently rejected for fixed-FoV
+  parts; clients should clamp to `fovMin`/`fovMax` from the camera's
+  `CameraState`).
+- `set-pan` — reserved for the future Hullcam VDS pan/tilt extension.
+  Rejected today on every shipping part (`supportsPan == false`).
+- `request-keyframe` — recover the H.264 stream after packet loss.
+
+### Server → client messages
+
+- `hello` — reply to client `hello` with sidecar version + encoder
+  backend name.
+- `camera-snapshot` — full state of every currently-attached camera.
+  Sent on handshake and after structural changes (vessel switch, ring
+  added / removed).
+- `camera-state-changed` — single-camera delta on operator request or
+  adaptive event.
+- `adaptive-shed` — KSP-FPS adaptive shedding level changed; carries a
+  human-readable `reason` so client UIs can show *why* quality
+  changed rather than just *that* it did.
+- `error` — malformed / invalid client message.
+
+### Per-camera capabilities
+
+`CameraState` exposes feature flags so clients can render controls
+only for what each part advertises:
+
+- `supportsZoom`, `fov`, `fovMin`, `fovMax` — true for parts whose
+  Hullcam module is `MuMechModuleHullCameraZoom` (19 of 21 stock
+  Hullcam VDS parts).
+- `supportsPan`, `panYawMin`/`Max`, `panPitchMin`/`Max`, `panYaw`,
+  `panPitch` — reserved; always false on shipping parts.
+- `encoderBitrateBps`, `targetBitrateBps` — current encoder bitrate
+  and REMB-driven target. Diverge briefly when receivers' bandwidth
+  estimates move; converge after the consume loop's next bitrate
+  threshold check.
+
+### Wire format
+
+JSON-per-message over an `RTCDataChannel` labelled `kerbcast-control`,
+opened by the browser after SDP exchange completes. Messages use
+adjacent tagging — `{ "type": "set-layers", "content": { ... } }` —
+because that's the discriminator shape typeshare can faithfully model
+across TypeScript / Kotlin / Swift / Scala / Go. Unit variants
+(`hello`) carry no `content`.

package/LICENSE

@@ -0,0 +1,369 @@
+kerbcast
+Copyright (c) 2026 Jon Pepler
+
+This work is licensed under the Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International License.
+Full legal text follows.
+
+
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
+Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International Public License
+("Public License"). To the extent this Public License may be
+interpreted as a contract, You are granted the Licensed Rights in
+consideration of Your acceptance of these terms and conditions, and the
+Licensor grants You such rights in consideration of benefits the
+Licensor receives from making the Licensed Material available under
+these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. BY-NC-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  e. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution, NonCommercial, and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  i. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  j. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  k. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  l. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  m. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  n. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-NC-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+

package/README.md

@@ -0,0 +1,112 @@
+# @ksp-gonogo/kerbcast
+
+TypeScript client for the kerbcast sidecar. Used by browsers and other
+clients that consume the sidecar's H.264 streams.
+
+`KerbcastClient` owns the WebRTC peer, the `kerbcast-control` data
+channel, and the per-camera state cache and `MediaStream`s.
+Consumers get a high-level RPC surface plus typed event
+subscriptions. The wire-format types are still exported for anyone
+rolling their own transport.
+
+The Rust crate and this package ship the same SemVer version,
+bumped together by `./scripts/bump-version.sh`.
+
+## Install
+
+Hosted on public npm. No registry route or auth needed:
+
+```sh
+npm add @ksp-gonogo/kerbcast
+```
+
+## Use
+
+```ts
+import { KerbcastClient, Layer } from "@ksp-gonogo/kerbcast";
+
+const client = new KerbcastClient({ host: "192.168.1.74", port: 8088 });
+await client.connect();
+
+const cam = client.camera(2592004302);
+await cam.setLayers([Layer.Near, Layer.Scaled]);
+await cam.setFov(35);
+await cam.setRenderSize(384, 384);
+await cam.setDegrade(0.5);
+
+const videoEl = document.querySelector("video")!;
+videoEl.srcObject = cam.mediaStream;
+
+cam.on("change", (state) => {
+  console.log("camera state", state);
+});
+client.on("adaptive-shed", (event) => {
+  console.log("shed level", event.level, "ksp fps", event.kspFps);
+});
+
+// Tear down when done.
+client.disconnect();
+```
+
+### Pre-handshake discovery
+
+```ts
+const cameras = await client.discover();
+// Pick the cameras you want, then connect with that subset.
+await client.connect(cameras.slice(0, 2).map((c) => c.flightId));
+```
+
+### Lower-level access
+
+The wire-format types are also exported for consumers that want to
+roll their own transport (a Node.js consumer outside a browser, a
+test harness, an alternative-language gateway, etc).
+
+```ts
+import type { ClientMessage } from "@ksp-gonogo/kerbcast";
+
+declare const controlChannel: RTCDataChannel;
+
+const setLayers: ClientMessage = {
+  type: "set-layers",
+  content: { flightId: 2592004302, layers: ["NEAR", "SCALED"] },
+};
+controlChannel.send(JSON.stringify(setLayers));
+```
+
+## Per-camera capabilities
+
+`CameraState` includes capability flags so consumers render only the
+controls each part actually supports.
+
+- `supportsZoom`, `fov`, `fovMin`, `fovMax`. 19 of 21 stock Hullcam
+  VDS parts support runtime FoV via `MuMechModuleHullCameraZoom`.
+- `supportsPan`, `panYawMin/Max`, `panPitchMin/Max`. Reserved for the
+  planned mod extension that adds steerable mounts. Always `false`
+  right now.
+- `encoderBitrateBps`, `targetBitrateBps`. Current encoder bitrate
+  and the REMB-driven target. They diverge briefly when receivers'
+  bandwidth estimates move.
+- `degradeLevel`. Effective signal-degradation level (max across
+  subscribers). Sidecar applies it via bitrate squeeze plus frame
+  skip, producing the macroblocking and stuttering aesthetic of
+  in-game CommNet signal loss. Also a real CPU optimisation when
+  every consumer wants degraded video.
+
+## Multi-language
+
+`typeshare` also generates Kotlin, Swift, Scala, and Go. Those
+land alongside `client-sdk/typescript/` as consumers appear. A C#
+binding is pending an upstream `typeshare` C# generator or a
+hand-written shim.
+
+## License
+
+[CC BY-NC-SA 4.0](https://github.com/ksp-gonogo/kerbcast/blob/main/LICENSE).
+
+## Versioning
+
+[SemVer](https://semver.org/) against the wire format and client
+API. See [CHANGELOG.md](https://github.com/ksp-gonogo/kerbcast/blob/main/client-sdk/typescript/CHANGELOG.md).
+While the protocol is at `0.x`, any minor bump may require consumer
+updates. Strict SemVer applies at `1.0.0`.