@streaming-cdn/rtc-web 1.3.19 → 1.3.21

package/README.md

@@ -1,4 +1,4 @@
-# RTC Web SDK 1.3.19
+# RTC Web SDK 1.3.21
 
 The customer package contains compiled ESM/UMD JavaScript and TypeScript declarations. It intentionally excludes implementation source and source maps. Example source remains available under `examples/`.
 
@@ -84,7 +84,7 @@ const phone = createRtcIncomingClient({
     if (!response.ok) throw new Error("Unable to refresh RTC identity");
     return response.json();
   },
-  apiBaseUrl: "https://streaming-cdn.ewin888.com",
+  callActionsUrl: "https://streaming-cdn.ewin888.com",
   autoConnect: false,
   mount: document.querySelector("#incoming-call")
 });
@@ -99,6 +99,47 @@ yourPush.onMessage((payload) => phone.handleIncomingCall({
 
 Omit `mount` when your application also owns the incoming-call UI. Call `accept`, `reject`, `busy`, `end`, or `cancel` from your own controls.
 
+## Where call actions go: `callActionsUrl`
+
+Accept, reject, busy, end and cancel are not local actions: the call's state
+lives in a record on the platform, and pressing Accept must (1) update that
+record, (2) notify the caller, and (3) stop the ringing on the callee's other
+devices. The button therefore sends one authenticated HTTP request — and it
+cannot ride the signaling socket, because when a push notification wakes the
+app there is no socket yet. `callActionsUrl` is the origin those requests go
+to. It applies ONLY to the incoming-call client's call actions; no other SDK
+API reads it.
+
+```
+Caller                     Platform                          Callee device
+  |  create call (server API) |                                    |
+  |-------------------------->|  call record: "ringing"            |
+  |      ringback tone        |---- push / signaling notify ------>|  incoming-call UI shows
+  |                           |                                    |  (no connection exists yet)
+  |                           |                                    |  user taps Accept / Reject
+  |                           |<== POST {callActionsUrl}/v1/rtc/client/calls/:id/accept
+  |                           |    the server arbitrates: accepted,
+  |                           |    or "already cancelled" if the
+  |                           |    caller hung up first
+  |<-- "accepted" notify -----|--- stop ringing other devices ---->|
+  |                           |                                    |  connect signaling (signalingUrl)
+  |<================== media session establishes ================>|
+```
+
+Resolution order: `callActionsUrl` -> `signalingUrl`'s origin -> the page's own
+origin. In practice:
+
+| Scenario | Needed? |
+| --- | --- |
+| Web app served from the platform's own domain | No — the page origin is used |
+| Your own website (different domain) embedding the incoming-call UI | Yes — set it to the platform origin |
+| `signalingUrl` already provided | No — its origin is reused |
+| React Native / non-browser | Provide `signalingUrl` or `callActionsUrl` (there is no page origin to fall back to) |
+
+`apiBaseUrl` is the deprecated former name; it is still accepted as an alias
+so existing integrations keep working.
+
+
 For outgoing UI, show `contacting` while mobile push is being delivered, move to `ringing` on `call.delivery`, and show `connected` only after both `call.updated: accepted` and the media client's `connected` event. Do not call `join()` before acceptance. Cancel unanswered calls at the invitation `expiresAt` timestamp (45 seconds by default).
 
 ## Complete managed integration
@@ -315,3 +356,14 @@ Abnormal close, reconnect, and recovery duration are also sent as bounded
 operational diagnostics. Tokens, SDP, media, and chat content are never part of
 that report. Set `reportSignalingDiagnostics: false` only when replacing this
 with an application-owned diagnostics pipeline.
+
+## 1.3.21 notes
+
+- Per-peer quality: a `bandwidth` limitation reason counts against a link only
+  when the measured uplink does not comfortably clear the current tier
+  (`bandwidthHeadroomRatio`, default 1.25) — encoder ramp-up during the first
+  minute no longer forces a downgrade.
+- Quality samples carry direction-explicit resolutions:
+  `inboundFrameWidth/Height` (received; equals the historical
+  `frameWidth/Height`) and `outboundFrameWidth/Height` (what your encoder
+  sends).

package/dist/index.d.ts

@@ -101,8 +101,21 @@ export interface RtcQualitySample {
     outboundBitrateBps: number | null;
     availableOutgoingBitrateBps: number | null;
     framesPerSecond: number | null;
+    /**
+     * INBOUND (received) resolution — the remote side's picture, which moves
+     * with THEIR quality tier, not yours (N3: an integrator saw "low" record a
+     * larger frame than "medium" and reasonably read it as a bug). Kept under
+     * the historical names for compatibility; prefer the direction-explicit
+     * fields below.
+     */
     frameWidth: number | null;
     frameHeight: number | null;
+    /** Received (inbound) video resolution — same values as frameWidth/frameHeight. */
+    inboundFrameWidth: number | null;
+    inboundFrameHeight: number | null;
+    /** Sent (outbound) video resolution — what YOUR encoder is producing. */
+    outboundFrameWidth: number | null;
+    outboundFrameHeight: number | null;
     framesDropped: number | null;
     freezeCount: number | null;
     freezeDurationMs: number | null;
@@ -253,6 +266,15 @@ export interface RtcIncomingClientOptions {
     /** Refresh lead time. Defaults to five minutes and scales down for short-lived tokens. */
     tokenRefreshSkewMs?: number;
     signalingUrl?: string;
+    /**
+     * Origin for call-action requests (accept / reject / busy / end / cancel).
+     * These change the call record on the platform, so they are HTTP requests —
+     * a push-woken app has no signaling socket yet when the user answers. Only
+     * the incoming-call client reads this; no other SDK API needs it. Falls
+     * back to signalingUrl's origin, then to the page's own origin.
+     */
+    callActionsUrl?: string;
+    /** @deprecated Former name of callActionsUrl; still honored as an alias. */
     apiBaseUrl?: string;
     autoConnect?: boolean;
     mount?: HTMLElement | string | null;
@@ -355,4 +377,4 @@ export declare class RtcIncomingClient extends EventTarget {
     private emit;
 }
 export declare function createRtcIncomingClient(options: RtcIncomingClientOptions): RtcIncomingClient;
-export declare const version = "1.3.19";
+export declare const version = "1.3.21";

package/dist/peer-quality.d.ts

@@ -37,6 +37,8 @@ export interface PeerQualityThresholds {
     goodLossPct: number;
     goodRttMs: number;
     sustainRatio: number;
+    /** "bandwidth" counts only when the uplink estimate is below this multiple of the tier target. */
+    bandwidthHeadroomRatio: number;
 }
 export declare const defaultPeerQualityThresholds: PeerQualityThresholds;
 export interface PeerQualitySample {