@phenixrts/sdk 2025.2.4-beta.663 → 2025.2.4-beta.664

package/README.md

@@ -180,3 +180,58 @@ Weigh these points, because the choice is yours to make and the SDK will not mak
 - The fetch sends every viewer's IP address, User-Agent and Referer to the CDN. Under GDPR you are the controller, so name the recipient in your privacy notice before you ship this.
 - The CDN becomes an availability dependency of playback. If it is unreachable, chunked playback fails.
 - A strict `script-src` policy, an offline deployment or an on-premise deployment will block the fetch. Bundle hls.js or mirror it on your own origin instead.
+
+## Replay
+
+Replay plays a bounded window of the recent past over a real-time channel, then returns to real-time. Every `Channel` exposes it as `channel.replay`.
+
+Three things must be in place:
+
+- The publisher publishes with the capabilities `on-demand` and `time-shift-manifest`.
+- The viewer token carries the capability `replay`.
+- A media player is available: an hls.js registered through `hlsJsLoader` (see "Providing hls.js"), or native HLS playback where the browser offers it.
+
+`channel.replay.isSupported` answers the last two before any playback is attempted. It is observable because the token can be rotated on a running channel.
+
+### Requesting a window
+
+Address the window by start time and duration:
+```
+    channel.replay.start({
+        startTime: Date.now() - 60000,
+        duration: 30000
+    }).then(function() {
+        console.log('Replaying', channel.replay.window.value);
+    }).catch(function(error) {
+        console.log('Refused:', error.reason);
+    });
+
+    channel.replay.returnToRealTime();
+```
+The platform serves a window from one recording that contains it in full, and caps a window at five minutes. The SDK does not shorten an over-long request; the platform refuses it and the reason is reported.
+
+Replay cannot end closer than 8 seconds to now, because the segments at the live edge have not been written yet. If the requested end falls inside that gap, the SDK pulls the end back to 8 seconds behind real-time and leaves the start unchanged. `channel.replay.window` reports both the window that plays and the window that was requested, with `wasAdjusted` set when the end was moved.
+
+### Observing a session
+
+| Member | Meaning |
+|---|---|
+| `state` | `phenix.ReplayState`: `Idle`, `Loading`, `Playing`, `Ended`, `ReturningToRealTime`, or the refusal or failure the last session ended in. |
+| `error` | Why the last session was refused or failed, or `null`. Set for every refusal, before the promise rejects. |
+| `isReplaying` | Whether a replay session currently presents over the application video element. |
+| `window` | The window that is playing, or `null`. |
+| `autoMuted` | Whether the browser required the replay element to be muted before it would play. |
+
+A rejection from `start()` carries the same reason on `error.reason`, and the internal status word on `error.status`. That word is the platform's own status, or the client's own refusal (for example `already-replaying` or `unsupported-feature`).
+
+### What happens to your video element
+
+Replay never takes the application video element. The real-time stream stays bound to it and keeps playing. The SDK creates a second video element for the session, marked `data-phenix-replay="true"`, positions it over the real-time picture, and removes it when the session ends. The application element is muted for the duration of the session and gets its previous muted state back afterwards; its volume is not touched.
+
+The replay element inherits `controls`, `muted` and `volume` from the application element. The whole window stays seekable on it for the life of the session. Give the application element a positioned parent (`position: relative` is enough) so the replay element can be laid over it.
+
+When the window ends, or `returnToRealTime()` is called, real-time presentation resumes at once; the peer connection was never released. If the publisher stopped in the meantime, `state` becomes `RealTimeUnavailable` and `error` becomes `real-time-unavailable`.
+
+Replay is available on a real-time `Channel` only. A chunked channel (a viewer token carrying `streaming` or `on-demand`), a `ProtectedChannel` and an `IsoBmffChannel` refuse with `unsupported-feature`.
+
+`examples/src/channel-viewer-replay-example.html` carries a working viewer with a scrub bar and a session panel.

package/channels/debug/channels.js

@@ -14330,7 +14330,7 @@ var VersionManager = /*#__PURE__*/function () {
     key: "sdkVersion",
     get: function get() {
       try {
-        return "2026-09-15T22:24:19.581Z (2025.2.4-beta.663)";
+        return "2026-09-15T22:26:58.419Z (2025.2.4-beta.664)";
       } catch (e) {
         return this._defaultVersion;
       }

package/channels/debug/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phenixrts/sdk/channels/debug",
-  "version": "2025.2.4-beta.663",
+  "version": "2025.2.4-beta.664",
   "files": [
     "*"
   ],

package/channels/debug.private/channels.js

@@ -14085,7 +14085,7 @@ var VersionManager = /*#__PURE__*/function () {
     key: "sdkVersion",
     get: function get() {
       try {
-        return "2026-09-15T22:24:19.581Z (2025.2.4-beta.663)";
+        return "2026-09-15T22:26:58.419Z (2025.2.4-beta.664)";
       } catch (e) {
         return this._defaultVersion;
       }

package/channels/debug.private/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phenixrts/sdk/channels/debug.private",
-  "version": "2025.2.4-beta.663",
+  "version": "2025.2.4-beta.664",
   "files": [
     "*"
   ],

package/channels/debug.provideGlobalScope/channels.js

@@ -13960,7 +13960,7 @@ var VersionManager = /*#__PURE__*/function () {
     key: "sdkVersion",
     get: function get() {
       try {
-        return "2026-09-15T22:24:19.581Z (2025.2.4-beta.663)";
+        return "2026-09-15T22:26:58.419Z (2025.2.4-beta.664)";
       } catch (e) {
         return this._defaultVersion;
       }

package/channels/debug.provideGlobalScope/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phenixrts/sdk/channels/debug.provideGlobalScope",
-  "version": "2025.2.4-beta.663",
+  "version": "2025.2.4-beta.664",
   "files": [
     "*"
   ],

package/channels/es5.debug.private/channels.js

@@ -13375,7 +13375,7 @@ var VersionManager = /*#__PURE__*/function () {
     key: "sdkVersion",
     get: function get() {
       try {
-        return "2026-09-15T22:24:19.581Z (2025.2.4-beta.663)";
+        return "2026-09-15T22:26:58.419Z (2025.2.4-beta.664)";
       } catch (e) {
         return this._defaultVersion;
       }

package/channels/es5.debug.private/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phenixrts/sdk/channels/es5.debug.private",
-  "version": "2025.2.4-beta.663",
+  "version": "2025.2.4-beta.664",
   "files": [
     "*"
   ],