@rapidmx/meet-plugin 0.10.0 → 0.12.0

package/dist/apps/shared/webrtc/types.d.ts

@@ -21,21 +21,22 @@ export declare const REACTION_EMOJIS: readonly ["👍", "👏", "❤️", "🎉"
  * literal so a listener on the meeting's channel (which will also see other frame shapes if this server ever
  * grows other push consumers) can cheaply recognize and skip anything that isn't one of these.
  *
- * `hello`/`bye`/`presenter-claim`/`presenter-release`/`state`/`reaction` are broadcast (`to` left unset - every
- * participant is relevant); `offer`/`answer`/`ice-candidate`/`mute-request`/`kicked` are point-to-point (`to` is the
- * intended peer's uid) - a recipient that isn't `to` (when set) ignores the message, since a channel's pub/sub fans
- * every message out to every subscriber, sender included.
+ * `hello`/`bye`/`presenter-claim`/`presenter-release`/`state`/`reaction`/`talking-stick` are broadcast (`to` left
+ * unset - every participant is relevant); `offer`/`answer`/`ice-candidate`/`mute-request`/`kicked` are
+ * point-to-point (`to` is the intended peer's uid) - a recipient that isn't `to` (when set) ignores the message,
+ * since a channel's pub/sub fans every message out to every subscriber, sender included.
  *
- * `mute-request`/`kicked` are host moderation signals (see `MeshConnectionManager`'s doc comment) - purely
- * cooperative, like every other message here: the recipient's own client decides whether to honor one, and nothing
- * on the wire distinguishes a genuine host's message from any other participant's, since this client protocol has
- * no host identity of its own to check against server-side. `kicked` is paired with the sender also revoking the
- * recipient's server-side channel grant (`BaseVideoMeetingRoute.revokeChannelGrant()`), which is enforced and does
- * not depend on the recipient's client cooperating.
+ * `mute-request`/`kicked`/`talking-stick` are host moderation signals (see `MeshConnectionManager`'s doc comment) -
+ * purely cooperative, like every other message here: the recipient's own client decides whether to honor one, and
+ * nothing on the wire distinguishes a genuine host's message from any other participant's, since this client
+ * protocol has no host identity of its own to check against server-side. `kicked` is paired with the sender also
+ * revoking the recipient's server-side channel grant (`BaseVideoMeetingRoute.revokeChannelGrant()`), which is
+ * enforced and does not depend on the recipient's client cooperating; `talking-stick` has no server-side
+ * counterpart at all (see this module's doc comment on why it is purely an in-call runtime signal).
  */
 export interface SignalMessage {
     type: "video-meeting-signal";
-    kind: "hello" | "bye" | "offer" | "answer" | "ice-candidate" | "presenter-claim" | "presenter-release" | "state" | "reaction" | "relay-fallback" | "mute-request" | "kicked";
+    kind: "hello" | "bye" | "offer" | "answer" | "ice-candidate" | "presenter-claim" | "presenter-release" | "state" | "reaction" | "relay-fallback" | "mute-request" | "kicked" | "talking-stick";
     /** The sender's authenticated uid - the real caller's own uid when `join()` returned `authenticated: true`, else
      * the `guest:<random>` uid `BaseVideoMeetingRoute.join()` minted. The server refuses a published message whose
      * `from` isn't the authenticated caller's uid (it stops one participant speaking as another), so this must be
@@ -54,6 +55,11 @@ export interface SignalMessage {
     state?: ParticipantState;
     /** `reaction` only - one of `REACTION_EMOJIS`. */
     emoji?: string;
+    /** `talking-stick` only - whether talking-stick mode is currently on. */
+    active?: boolean;
+    /** `talking-stick` only - the peer id (`MeshParticipant.uid`/this tab's own id) currently holding the stick.
+     * Absent when `active` is `false`, or when nobody holds it yet. */
+    holder?: string;
     /** `offer`/`answer` only. */
     sdp?: RTCSessionDescriptionInit;
     /** `ice-candidate` only. */
@@ -209,4 +215,12 @@ export type MeshEvent = {
  * "removed by the host" state rather than the ordinary "you left" one. */
  | {
     type: "kicked";
+}
+/** Talking-stick mode turned on or off, or the stick changed hands - see this module's doc comment and
+ * `MeshConnectionManager.setTalkingStick()`. `holder` is the peer id now holding it; absent while `active` is
+ * `false`, or (transiently) if whoever held it has since left the call. */
+ | {
+    type: "talking-stick-changed";
+    active: boolean;
+    holder?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rapidmx/meet-plugin",
-    "version": "0.10.0",
+    "version": "0.12.0",
     "description": "RapidMX plugin that provides WebRTC video conferencing, joinable from a calendar invite or a shared link.",
     "repository": "https://github.com/rapidmx/meet-plugin.git",
     "author": "RapidREST <rapidrests@gmail.com>",