im-rtc-call-engine 1.0.0

package/dist/signaling/frames.room.d.ts

@@ -0,0 +1,566 @@
+/**
+ * room 域：房间与媒体。见 RTC_PROTOCOL.md §3。
+ * Room 层是媒体的全部——1v1、群通话、会议都用同一套帧。
+ */
+/** PARTICIPANT_FIELDS：房间成员快照。 */
+export declare const PARTICIPANT_FIELDS: {
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly deviceId: {
+        readonly kind: "string";
+        readonly wire: "device_id";
+    };
+    readonly joinedAtMs: {
+        readonly kind: "int";
+        readonly wire: "joined_at_ms";
+    };
+};
+/** TRACK_FIELDS：一条已发布 Track 的快照。 */
+export declare const TRACK_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly kind: {
+        readonly kind: "enum";
+        readonly wire: "kind";
+        readonly values: readonly ["audio", "video"];
+        readonly fallback: "audio";
+    };
+    readonly source: {
+        readonly kind: "enum";
+        readonly wire: "source";
+        readonly values: readonly ["microphone", "camera", "screen", "screen_audio"];
+        readonly fallback: "microphone";
+    };
+    readonly codec: {
+        readonly kind: "string";
+        readonly wire: "codec";
+    };
+    /** 空数组 = 单层。**不能是 null**。 */
+    readonly simulcastLayers: {
+        readonly kind: "enumArray";
+        readonly wire: "simulcast_layers";
+        readonly values: readonly ["none", "l", "m", "h"];
+        readonly fallback: "l";
+    };
+    readonly muted: {
+        readonly kind: "bool";
+        readonly wire: "muted";
+    };
+};
+/**
+ * JOIN_FIELDS：进房请求。
+ *
+ * **注意 auto_subscribe / publish_audio 默认是 true**：直接用零值对象发这一帧，
+ * 线路上会变成 false，人进了房却收不到任何流。发送侧一律用 newJoinData()。
+ */
+export declare const JOIN_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly roomToken: {
+        readonly kind: "string";
+        readonly wire: "room_token";
+    };
+    readonly autoSubscribe: {
+        readonly kind: "bool";
+        readonly wire: "auto_subscribe";
+        readonly default: true;
+    };
+    readonly publishAudio: {
+        readonly kind: "bool";
+        readonly wire: "publish_audio";
+        readonly default: true;
+    };
+    readonly publishVideo: {
+        readonly kind: "bool";
+        readonly wire: "publish_video";
+        readonly default: false;
+    };
+};
+/** JOIN_OK_FIELDS：带回整个房间的快照，客户端据此一次性把九宫格搭起来。 */
+export declare const JOIN_OK_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly roomKind: {
+        readonly kind: "enum";
+        readonly wire: "room_kind";
+        readonly values: readonly ["call_1v1", "call_group", "meeting"];
+        readonly fallback: "call_group";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly maxParticipants: {
+        readonly kind: "int";
+        readonly wire: "max_participants";
+    };
+    readonly joinedAtMs: {
+        readonly kind: "int";
+        readonly wire: "joined_at_ms";
+    };
+    readonly participants: {
+        readonly kind: "objectArray";
+        readonly wire: "participants";
+        readonly fields: {
+            readonly participantId: {
+                readonly kind: "string";
+                readonly wire: "participant_id";
+            };
+            readonly uid: {
+                readonly kind: "string";
+                readonly wire: "uid";
+            };
+            readonly deviceId: {
+                readonly kind: "string";
+                readonly wire: "device_id";
+            };
+            readonly joinedAtMs: {
+                readonly kind: "int";
+                readonly wire: "joined_at_ms";
+            };
+        };
+    };
+    readonly tracks: {
+        readonly kind: "objectArray";
+        readonly wire: "tracks";
+        readonly fields: {
+            readonly trackId: {
+                readonly kind: "string";
+                readonly wire: "track_id";
+            };
+            readonly participantId: {
+                readonly kind: "string";
+                readonly wire: "participant_id";
+            };
+            readonly uid: {
+                readonly kind: "string";
+                readonly wire: "uid";
+            };
+            readonly kind: {
+                readonly kind: "enum";
+                readonly wire: "kind";
+                readonly values: readonly ["audio", "video"];
+                readonly fallback: "audio";
+            };
+            readonly source: {
+                readonly kind: "enum";
+                readonly wire: "source";
+                readonly values: readonly ["microphone", "camera", "screen", "screen_audio"];
+                readonly fallback: "microphone";
+            };
+            readonly codec: {
+                readonly kind: "string";
+                readonly wire: "codec";
+            };
+            /** 空数组 = 单层。**不能是 null**。 */
+            readonly simulcastLayers: {
+                readonly kind: "enumArray";
+                readonly wire: "simulcast_layers";
+                readonly values: readonly ["none", "l", "m", "h"];
+                readonly fallback: "l";
+            };
+            readonly muted: {
+                readonly kind: "bool";
+                readonly wire: "muted";
+            };
+        };
+    };
+};
+/** LEAVE_FIELDS：离房请求。 */
+export declare const LEAVE_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+};
+/**
+ * PUBLISH_FIELDS：发布请求。
+ *
+ * cid 是**客户端**生成的本地 track 标识，必须出现在随后 pub offer 的 msid 里；
+ * 服务端靠它把 SDP 的 m-line 认回 track_id。
+ */
+export declare const PUBLISH_FIELDS: {
+    readonly cid: {
+        readonly kind: "string";
+        readonly wire: "cid";
+    };
+    readonly kind: {
+        readonly kind: "enum";
+        readonly wire: "kind";
+        readonly values: readonly ["audio", "video"];
+        readonly fallback: "audio";
+    };
+    readonly source: {
+        readonly kind: "enum";
+        readonly wire: "source";
+        readonly values: readonly ["microphone", "camera", "screen", "screen_audio"];
+        readonly fallback: "microphone";
+    };
+    readonly simulcast: {
+        readonly kind: "bool";
+        readonly wire: "simulcast";
+    };
+    readonly width: {
+        readonly kind: "int";
+        readonly wire: "width";
+    };
+    readonly height: {
+        readonly kind: "int";
+        readonly wire: "height";
+    };
+    readonly maxBitrateKbps: {
+        readonly kind: "int";
+        readonly wire: "max_bitrate_kbps";
+    };
+};
+/** PUBLISH_OK_FIELDS：回带 track_id 与原样回显的 cid 供配对。 */
+export declare const PUBLISH_OK_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly cid: {
+        readonly kind: "string";
+        readonly wire: "cid";
+    };
+};
+/** TRACK_ID_FIELDS：只带 track_id 的帧（unpublish / unsubscribe）。 */
+export declare const TRACK_ID_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+};
+/** MUTE_FIELDS：开关麦克风/摄像头。**这不是 unpublish**，Track 与协商都保留。 */
+export declare const MUTE_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly muted: {
+        readonly kind: "bool";
+        readonly wire: "muted";
+    };
+};
+/** LAYER_FIELDS：订阅与换层。max_layer 是**上界不是命令**。 */
+export declare const LAYER_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly maxLayer: {
+        readonly kind: "enum";
+        readonly wire: "max_layer";
+        readonly values: readonly ["none", "l", "m", "h"];
+        readonly fallback: "l";
+        readonly default: "m";
+    };
+};
+/** SDP_FIELDS：room.offer 与 room.answer 共用。 */
+export declare const SDP_FIELDS: {
+    readonly pc: {
+        readonly kind: "enum";
+        readonly wire: "pc";
+        readonly values: readonly ["pub", "sub"];
+        readonly fallback: "pub";
+    };
+    readonly sdp: {
+        readonly kind: "string";
+        readonly wire: "sdp";
+    };
+};
+/** ICE_FIELDS：trickle ICE 候选。candidate 为 '' 表示收集结束，接收方必须容忍。 */
+export declare const ICE_FIELDS: {
+    readonly pc: {
+        readonly kind: "enum";
+        readonly wire: "pc";
+        readonly values: readonly ["pub", "sub"];
+        readonly fallback: "pub";
+    };
+    readonly candidate: {
+        readonly kind: "string";
+        readonly wire: "candidate";
+    };
+    readonly sdpMid: {
+        readonly kind: "string";
+        readonly wire: "sdp_mid";
+    };
+    readonly sdpMLineIndex: {
+        readonly kind: "int";
+        readonly wire: "sdp_mline_index";
+    };
+};
+/** PARTICIPANT_JOINED_FIELDS：有人进房。 */
+export declare const PARTICIPANT_JOINED_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly deviceId: {
+        readonly kind: "string";
+        readonly wire: "device_id";
+    };
+    readonly joinedAtMs: {
+        readonly kind: "int";
+        readonly wire: "joined_at_ms";
+    };
+};
+/** PARTICIPANT_LEFT_FIELDS：有人离房。reason 取 §6 的子集。 */
+export declare const PARTICIPANT_LEFT_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly deviceId: {
+        readonly kind: "string";
+        readonly wire: "device_id";
+    };
+    readonly reason: {
+        readonly kind: "enum";
+        readonly wire: "reason";
+        readonly values: readonly ["hangup", "cancel", "reject", "no_answer", "busy", "offline", "answered_elsewhere", "rejected_elsewhere", "kicked", "room_closed", "network", "error"];
+        readonly fallback: "error";
+    };
+    readonly durationSec: {
+        readonly kind: "int";
+        readonly wire: "duration_sec";
+    };
+};
+/** TRACK_PUBLISHED_FIELDS：有人发布了 Track。 */
+export declare const TRACK_PUBLISHED_FIELDS: {
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly kind: {
+        readonly kind: "enum";
+        readonly wire: "kind";
+        readonly values: readonly ["audio", "video"];
+        readonly fallback: "audio";
+    };
+    readonly source: {
+        readonly kind: "enum";
+        readonly wire: "source";
+        readonly values: readonly ["microphone", "camera", "screen", "screen_audio"];
+        readonly fallback: "microphone";
+    };
+    readonly codec: {
+        readonly kind: "string";
+        readonly wire: "codec";
+    };
+    /** 空数组 = 单层。**不能是 null**。 */
+    readonly simulcastLayers: {
+        readonly kind: "enumArray";
+        readonly wire: "simulcast_layers";
+        readonly values: readonly ["none", "l", "m", "h"];
+        readonly fallback: "l";
+    };
+    readonly muted: {
+        readonly kind: "bool";
+        readonly wire: "muted";
+    };
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+};
+/** TRACK_UNPUBLISHED_FIELDS：有人销毁了 Track。 */
+export declare const TRACK_UNPUBLISHED_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+};
+/** TRACK_MUTED_FIELDS：对应 onUserAudioAvailable / onUserVideoAvailable。 */
+export declare const TRACK_MUTED_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly trackId: {
+        readonly kind: "string";
+        readonly wire: "track_id";
+    };
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly kind: {
+        readonly kind: "enum";
+        readonly wire: "kind";
+        readonly values: readonly ["audio", "video"];
+        readonly fallback: "audio";
+    };
+    readonly muted: {
+        readonly kind: "bool";
+        readonly wire: "muted";
+    };
+};
+/** SPEAKER_FIELDS：一个正在说话的人。volume 0~100，**整数**。 */
+export declare const SPEAKER_FIELDS: {
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly volume: {
+        readonly kind: "int";
+        readonly wire: "volume";
+        readonly min: 0;
+        readonly max: 100;
+    };
+};
+/** ACTIVE_SPEAKERS_FIELDS：服务端节流 300ms，客户端**不得**依赖更高频率。 */
+export declare const ACTIVE_SPEAKERS_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly speakers: {
+        readonly kind: "objectArray";
+        readonly wire: "speakers";
+        readonly fields: {
+            readonly participantId: {
+                readonly kind: "string";
+                readonly wire: "participant_id";
+            };
+            readonly uid: {
+                readonly kind: "string";
+                readonly wire: "uid";
+            };
+            readonly volume: {
+                readonly kind: "int";
+                readonly wire: "volume";
+                readonly min: 0;
+                readonly max: 100;
+            };
+        };
+    };
+};
+/** QUALITY_ENTRY_FIELDS：一个人的网络质量，level 0~6。 */
+export declare const QUALITY_ENTRY_FIELDS: {
+    readonly participantId: {
+        readonly kind: "string";
+        readonly wire: "participant_id";
+    };
+    readonly uid: {
+        readonly kind: "string";
+        readonly wire: "uid";
+    };
+    readonly level: {
+        readonly kind: "int";
+        readonly wire: "level";
+        readonly min: 0;
+        readonly max: 6;
+        readonly outOfRange: 0;
+    };
+};
+/** QUALITY_FIELDS：服务端节流 2s。 */
+export declare const QUALITY_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly entries: {
+        readonly kind: "objectArray";
+        readonly wire: "entries";
+        readonly fields: {
+            readonly participantId: {
+                readonly kind: "string";
+                readonly wire: "participant_id";
+            };
+            readonly uid: {
+                readonly kind: "string";
+                readonly wire: "uid";
+            };
+            readonly level: {
+                readonly kind: "int";
+                readonly wire: "level";
+                readonly min: 0;
+                readonly max: 6;
+                readonly outOfRange: 0;
+            };
+        };
+    };
+};
+/** ROOM_CLOSED_FIELDS：房间结束。 */
+export declare const ROOM_CLOSED_FIELDS: {
+    readonly roomId: {
+        readonly kind: "string";
+        readonly wire: "room_id";
+    };
+    readonly reason: {
+        readonly kind: "enum";
+        readonly wire: "reason";
+        readonly values: readonly ["hangup", "cancel", "reject", "no_answer", "busy", "offline", "answered_elsewhere", "rejected_elsewhere", "kicked", "room_closed", "network", "error"];
+        readonly fallback: "error";
+    };
+    readonly durationSec: {
+        readonly kind: "int";
+        readonly wire: "duration_sec";
+    };
+};
+//# sourceMappingURL=frames.room.d.ts.map

package/dist/signaling/frames.room.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frames.room.d.ts","sourceRoot":"","sources":["../../src/signaling/frames.room.ts"],"names":[],"mappings":"AAUA;;;GAGG;AAEH,iCAAiC;AACjC,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;CAKC,CAAC;AAEjC,oCAAoC;AACpC,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAOvB,6BAA6B;;;;;;;;;;;CAGC,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;CAMQ,CAAC;AAEjC,gDAAgD;AAChD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YApBzB,6BAA6B;;;;;;;;;;;;;CA4BC,CAAC;AAEjC,yBAAyB;AACzB,eAAO,MAAM,YAAY;;;;;CAEO,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQK,CAAC;AAEjC,oDAAoD;AACpD,eAAO,MAAM,iBAAiB;;;;;;;;;CAGE,CAAC;AAEjC,+DAA+D;AAC/D,eAAO,MAAM,eAAe;;;;;CAEI,CAAC;AAEjC,4DAA4D;AAC5D,eAAO,MAAM,WAAW;;;;;;;;;CAGQ,CAAC;AAEjC,gDAAgD;AAChD,eAAO,MAAM,YAAY;;;;;;;;;;;;CAGO,CAAC;AAEjC,8CAA8C;AAC9C,eAAO,MAAM,UAAU;;;;;;;;;;;CAGS,CAAC;AAEjC,+DAA+D;AAC/D,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;CAKS,CAAC;AAEjC,sCAAsC;AACtC,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;CAMN,CAAC;AAEjC,oDAAoD;AACpD,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOJ,CAAC;AAEjC,0CAA0C;AAC1C,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA5GjC,6BAA6B;;;;;;;;;;;;;;;CA+GC,CAAC;AAEjC,4CAA4C;AAC5C,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;CAKL,CAAC;AAEjC,yEAAyE;AACzE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOC,CAAC;AAEjC,mDAAmD;AACnD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;CAIK,CAAC;AAEjC,0DAA0D;AAC1D,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;CAGH,CAAC;AAEjC,+CAA+C;AAC/C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;CAKD,CAAC;AAEjC,+BAA+B;AAC/B,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;CAGK,CAAC;AAEjC,+BAA+B;AAC/B,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;CAIC,CAAC"}