@observertc/observer-js 1.0.0-beta.2 → 1.0.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (223) hide show
  1. package/README.md +773 -388
  2. package/dist/index.d.mts +2793 -0
  3. package/dist/index.mjs +3719 -0
  4. package/dist/index.mjs.map +1 -0
  5. package/package.json +21 -14
  6. package/.eslintrc.json +0 -143
  7. package/.prettierignore +0 -5
  8. package/.prettierrc +0 -7
  9. package/jest.config.js +0 -9
  10. package/lib/ObservedCall.d.ts +0 -86
  11. package/lib/ObservedCall.d.ts.map +0 -1
  12. package/lib/ObservedCall.js +0 -225
  13. package/lib/ObservedCallEventMonitor.d.ts +0 -104
  14. package/lib/ObservedCallEventMonitor.d.ts.map +0 -1
  15. package/lib/ObservedCallEventMonitor.js +0 -314
  16. package/lib/ObservedCallSummary.d.ts +0 -18
  17. package/lib/ObservedCallSummary.d.ts.map +0 -1
  18. package/lib/ObservedCallSummary.js +0 -2
  19. package/lib/ObservedCertificate.d.ts +0 -19
  20. package/lib/ObservedCertificate.d.ts.map +0 -1
  21. package/lib/ObservedCertificate.js +0 -38
  22. package/lib/ObservedClient.d.ts +0 -130
  23. package/lib/ObservedClient.d.ts.map +0 -1
  24. package/lib/ObservedClient.js +0 -650
  25. package/lib/ObservedClientEventMonitor.d.ts +0 -91
  26. package/lib/ObservedClientEventMonitor.d.ts.map +0 -1
  27. package/lib/ObservedClientEventMonitor.js +0 -254
  28. package/lib/ObservedClientSummary.d.ts +0 -23
  29. package/lib/ObservedClientSummary.d.ts.map +0 -1
  30. package/lib/ObservedClientSummary.js +0 -2
  31. package/lib/ObservedCodec.d.ts +0 -22
  32. package/lib/ObservedCodec.d.ts.map +0 -1
  33. package/lib/ObservedCodec.js +0 -45
  34. package/lib/ObservedDataChannel.d.ts +0 -30
  35. package/lib/ObservedDataChannel.d.ts.map +0 -1
  36. package/lib/ObservedDataChannel.js +0 -75
  37. package/lib/ObservedIceCandidate.d.ts +0 -29
  38. package/lib/ObservedIceCandidate.d.ts.map +0 -1
  39. package/lib/ObservedIceCandidate.js +0 -59
  40. package/lib/ObservedIceCandidatePair.d.ts +0 -45
  41. package/lib/ObservedIceCandidatePair.d.ts.map +0 -1
  42. package/lib/ObservedIceCandidatePair.js +0 -127
  43. package/lib/ObservedIceTransport.d.ts +0 -36
  44. package/lib/ObservedIceTransport.d.ts.map +0 -1
  45. package/lib/ObservedIceTransport.js +0 -93
  46. package/lib/ObservedInboundRtp.d.ts +0 -92
  47. package/lib/ObservedInboundRtp.d.ts.map +0 -1
  48. package/lib/ObservedInboundRtp.js +0 -193
  49. package/lib/ObservedInboundTrack.d.ts +0 -32
  50. package/lib/ObservedInboundTrack.d.ts.map +0 -1
  51. package/lib/ObservedInboundTrack.js +0 -60
  52. package/lib/ObservedMediaPlayout.d.ts +0 -22
  53. package/lib/ObservedMediaPlayout.d.ts.map +0 -1
  54. package/lib/ObservedMediaPlayout.js +0 -42
  55. package/lib/ObservedMediaSource.d.ts +0 -28
  56. package/lib/ObservedMediaSource.d.ts.map +0 -1
  57. package/lib/ObservedMediaSource.js +0 -55
  58. package/lib/ObservedOutboundRtp.d.ts +0 -62
  59. package/lib/ObservedOutboundRtp.d.ts.map +0 -1
  60. package/lib/ObservedOutboundRtp.js +0 -144
  61. package/lib/ObservedOutboundTrack.d.ts +0 -32
  62. package/lib/ObservedOutboundTrack.d.ts.map +0 -1
  63. package/lib/ObservedOutboundTrack.js +0 -60
  64. package/lib/ObservedPeerConnection.d.ts +0 -207
  65. package/lib/ObservedPeerConnection.d.ts.map +0 -1
  66. package/lib/ObservedPeerConnection.js +0 -773
  67. package/lib/ObservedPeerConnectionTransport.d.ts +0 -17
  68. package/lib/ObservedPeerConnectionTransport.d.ts.map +0 -1
  69. package/lib/ObservedPeerConnectionTransport.js +0 -34
  70. package/lib/ObservedRemoteInboundRtp.d.ts +0 -30
  71. package/lib/ObservedRemoteInboundRtp.d.ts.map +0 -1
  72. package/lib/ObservedRemoteInboundRtp.js +0 -60
  73. package/lib/ObservedRemoteOutboundRtp.d.ts +0 -30
  74. package/lib/ObservedRemoteOutboundRtp.d.ts.map +0 -1
  75. package/lib/ObservedRemoteOutboundRtp.js +0 -60
  76. package/lib/ObservedTURN.d.ts +0 -31
  77. package/lib/ObservedTURN.d.ts.map +0 -1
  78. package/lib/ObservedTURN.js +0 -58
  79. package/lib/ObservedTurnServer.d.ts +0 -25
  80. package/lib/ObservedTurnServer.d.ts.map +0 -1
  81. package/lib/ObservedTurnServer.js +0 -59
  82. package/lib/Observer.d.ts +0 -65
  83. package/lib/Observer.d.ts.map +0 -1
  84. package/lib/Observer.js +0 -166
  85. package/lib/ObserverEventMonitor.d.ts +0 -138
  86. package/lib/ObserverEventMonitor.d.ts.map +0 -1
  87. package/lib/ObserverEventMonitor.js +0 -433
  88. package/lib/ObserverSummary.d.ts +0 -13
  89. package/lib/ObserverSummary.d.ts.map +0 -1
  90. package/lib/ObserverSummary.js +0 -2
  91. package/lib/common/Middleware.d.ts +0 -17
  92. package/lib/common/Middleware.d.ts.map +0 -1
  93. package/lib/common/Middleware.js +0 -60
  94. package/lib/common/SingleExecutor.d.ts +0 -3
  95. package/lib/common/SingleExecutor.d.ts.map +0 -1
  96. package/lib/common/SingleExecutor.js +0 -31
  97. package/lib/common/logger.d.ts +0 -17
  98. package/lib/common/logger.d.ts.map +0 -1
  99. package/lib/common/logger.js +0 -50
  100. package/lib/common/types.d.ts +0 -3
  101. package/lib/common/types.d.ts.map +0 -1
  102. package/lib/common/types.js +0 -3
  103. package/lib/common/utils.d.ts +0 -11
  104. package/lib/common/utils.d.ts.map +0 -1
  105. package/lib/common/utils.js +0 -63
  106. package/lib/detectors/Detector.d.ts +0 -5
  107. package/lib/detectors/Detector.d.ts.map +0 -1
  108. package/lib/detectors/Detector.js +0 -3
  109. package/lib/detectors/Detectors.d.ts +0 -11
  110. package/lib/detectors/Detectors.d.ts.map +0 -1
  111. package/lib/detectors/Detectors.js +0 -34
  112. package/lib/index.d.ts +0 -28
  113. package/lib/index.d.ts.map +0 -1
  114. package/lib/index.js +0 -49
  115. package/lib/mediasoup/ObservedMediaRouter.d.ts +0 -10
  116. package/lib/mediasoup/ObservedMediaRouter.d.ts.map +0 -1
  117. package/lib/mediasoup/ObservedMediaRouter.js +0 -6
  118. package/lib/monitors/TurnUsageMonitor.d.ts +0 -1
  119. package/lib/monitors/TurnUsageMonitor.d.ts.map +0 -1
  120. package/lib/monitors/TurnUsageMonitor.js +0 -146
  121. package/lib/schema/ClientEventTypes.d.ts +0 -228
  122. package/lib/schema/ClientEventTypes.d.ts.map +0 -1
  123. package/lib/schema/ClientEventTypes.js +0 -41
  124. package/lib/schema/ClientMetaTypes.d.ts +0 -34
  125. package/lib/schema/ClientMetaTypes.d.ts.map +0 -1
  126. package/lib/schema/ClientMetaTypes.js +0 -16
  127. package/lib/schema/ClientSample.d.ts +0 -1333
  128. package/lib/schema/ClientSample.d.ts.map +0 -1
  129. package/lib/schema/ClientSample.js +0 -4
  130. package/lib/scores/CalculatedScore.d.ts +0 -6
  131. package/lib/scores/CalculatedScore.d.ts.map +0 -1
  132. package/lib/scores/CalculatedScore.js +0 -2
  133. package/lib/scores/DefaultCallScoreCalculator.d.ts +0 -7
  134. package/lib/scores/DefaultCallScoreCalculator.d.ts.map +0 -1
  135. package/lib/scores/DefaultCallScoreCalculator.js +0 -21
  136. package/lib/scores/ScoreCalculator.d.ts +0 -4
  137. package/lib/scores/ScoreCalculator.d.ts.map +0 -1
  138. package/lib/scores/ScoreCalculator.js +0 -2
  139. package/lib/updaters/CallUpdater.d.ts +0 -5
  140. package/lib/updaters/CallUpdater.d.ts.map +0 -1
  141. package/lib/updaters/CallUpdater.js +0 -2
  142. package/lib/updaters/ObserverUpdater.d.ts +0 -5
  143. package/lib/updaters/ObserverUpdater.d.ts.map +0 -1
  144. package/lib/updaters/ObserverUpdater.js +0 -2
  145. package/lib/updaters/OnAllCallObserverUpdater.d.ts +0 -15
  146. package/lib/updaters/OnAllCallObserverUpdater.d.ts.map +0 -1
  147. package/lib/updaters/OnAllCallObserverUpdater.js +0 -50
  148. package/lib/updaters/OnAllClientCallUpdater.d.ts +0 -15
  149. package/lib/updaters/OnAllClientCallUpdater.d.ts.map +0 -1
  150. package/lib/updaters/OnAllClientCallUpdater.js +0 -53
  151. package/lib/updaters/OnAnyCallObserverUpdater.d.ts +0 -12
  152. package/lib/updaters/OnAnyCallObserverUpdater.d.ts.map +0 -1
  153. package/lib/updaters/OnAnyCallObserverUpdater.js +0 -37
  154. package/lib/updaters/OnAnyClientCallUpdater.d.ts +0 -12
  155. package/lib/updaters/OnAnyClientCallUpdater.d.ts.map +0 -1
  156. package/lib/updaters/OnAnyClientCallUpdater.js +0 -36
  157. package/lib/updaters/OnIntervalUpdater.d.ts +0 -10
  158. package/lib/updaters/OnIntervalUpdater.d.ts.map +0 -1
  159. package/lib/updaters/OnIntervalUpdater.js +0 -17
  160. package/lib/updaters/Updater.d.ts +0 -6
  161. package/lib/updaters/Updater.d.ts.map +0 -1
  162. package/lib/updaters/Updater.js +0 -2
  163. package/lib/utils/MediasoupRemoteTrackResolver.d.ts +0 -25
  164. package/lib/utils/MediasoupRemoteTrackResolver.d.ts.map +0 -1
  165. package/lib/utils/MediasoupRemoteTrackResolver.js +0 -110
  166. package/lib/utils/RemoteTrackResolver.d.ts +0 -7
  167. package/lib/utils/RemoteTrackResolver.d.ts.map +0 -1
  168. package/lib/utils/RemoteTrackResolver.js +0 -2
  169. package/src/ObservedCall.ts +0 -342
  170. package/src/ObservedCallEventMonitor.ts +0 -392
  171. package/src/ObservedCallSummary.ts +0 -22
  172. package/src/ObservedCertificate.ts +0 -43
  173. package/src/ObservedClient.ts +0 -807
  174. package/src/ObservedClientEventMonitor.ts +0 -309
  175. package/src/ObservedClientSummary.ts +0 -24
  176. package/src/ObservedCodec.ts +0 -49
  177. package/src/ObservedDataChannel.ts +0 -85
  178. package/src/ObservedIceCandidate.ts +0 -64
  179. package/src/ObservedIceCandidatePair.ts +0 -134
  180. package/src/ObservedIceTransport.ts +0 -99
  181. package/src/ObservedInboundRtp.ts +0 -205
  182. package/src/ObservedInboundTrack.ts +0 -75
  183. package/src/ObservedMediaPlayout.ts +0 -49
  184. package/src/ObservedMediaSource.ts +0 -60
  185. package/src/ObservedOutboundRtp.ts +0 -156
  186. package/src/ObservedOutboundTrack.ts +0 -74
  187. package/src/ObservedPeerConnection.ts +0 -1088
  188. package/src/ObservedPeerConnectionTransport.ts +0 -38
  189. package/src/ObservedRemoteInboundRtp.ts +0 -64
  190. package/src/ObservedRemoteOutboundRtp.ts +0 -65
  191. package/src/ObservedTURN.ts +0 -86
  192. package/src/ObservedTurnServer.ts +0 -72
  193. package/src/Observer.ts +0 -251
  194. package/src/ObserverEventMonitor.ts +0 -551
  195. package/src/ObserverSummary.ts +0 -15
  196. package/src/common/Middleware.ts +0 -84
  197. package/src/common/SingleExecutor.ts +0 -36
  198. package/src/common/logger.ts +0 -82
  199. package/src/common/types.ts +0 -4
  200. package/src/common/utils.ts +0 -69
  201. package/src/detectors/Detector.ts +0 -6
  202. package/src/detectors/Detectors.ts +0 -38
  203. package/src/index.ts +0 -28
  204. package/src/mediasoup/ObservedMediaRouter.ts +0 -10
  205. package/src/monitors/TurnUsageMonitor.ts +0 -187
  206. package/src/schema/ClientEventTypes.ts +0 -280
  207. package/src/schema/ClientMetaTypes.ts +0 -41
  208. package/src/schema/ClientSample.ts +0 -1682
  209. package/src/scores/CalculatedScore.ts +0 -6
  210. package/src/scores/DefaultCallScoreCalculator.ts +0 -23
  211. package/src/scores/ScoreCalculator.ts +0 -3
  212. package/src/updaters/CallUpdater.ts +0 -5
  213. package/src/updaters/ObserverUpdater.ts +0 -5
  214. package/src/updaters/OnAllCallObserverUpdater.ts +0 -59
  215. package/src/updaters/OnAllClientCallUpdater.ts +0 -61
  216. package/src/updaters/OnAnyCallObserverUpdater.ts +0 -41
  217. package/src/updaters/OnAnyClientCallUpdater.ts +0 -39
  218. package/src/updaters/OnIntervalUpdater.ts +0 -19
  219. package/src/updaters/Updater.ts +0 -5
  220. package/src/utils/MediasoupRemoteTrackResolver.ts +0 -155
  221. package/src/utils/RemoteTrackResolver.ts +0 -12
  222. package/tsconfig.json +0 -19
  223. package/tslint.json +0 -6
@@ -0,0 +1,2793 @@
1
+ import { EventEmitter } from 'events';
2
+
3
+ /**
4
+ * The WebRTC app provided custom stats payload
5
+ */
6
+ type ExtensionStat = {
7
+ /**
8
+ * The type of the extension stats the custom app provides
9
+ */
10
+ type: string;
11
+ /**
12
+ * The payload of the extension stats the custom app provides
13
+ */
14
+ payload?: string;
15
+ };
16
+ /**
17
+ * A list of additional client events.
18
+ */
19
+ type ClientMetaData = {
20
+ /**
21
+ * The name of the event used as an identifier (e.g., MEDIA_TRACK_MUTED, USER_REJOINED, etc.).
22
+ */
23
+ type: string;
24
+ /**
25
+ * The value associated with the event, if applicable.
26
+ */
27
+ payload?: string;
28
+ /**
29
+ * The unique identifier of the peer connection for which the event was generated.
30
+ */
31
+ peerConnectionId?: string;
32
+ /**
33
+ * The identifier of the media track related to the event, if applicable.
34
+ */
35
+ trackId?: string;
36
+ /**
37
+ * The SSRC (Synchronization Source) identifier associated with the event, if applicable.
38
+ */
39
+ ssrc?: number;
40
+ /**
41
+ * The timestamp in epoch format when the event was generated.
42
+ */
43
+ timestamp?: number;
44
+ };
45
+ /**
46
+ * A list of client issues.
47
+ */
48
+ type ClientIssue = {
49
+ /**
50
+ * The name of the issue
51
+ */
52
+ type: string;
53
+ /**
54
+ * The value associated with the event, if applicable.
55
+ */
56
+ payload?: string;
57
+ /**
58
+ * The timestamp in epoch format when the event was generated.
59
+ */
60
+ timestamp?: number;
61
+ };
62
+ /**
63
+ * A list of client events.
64
+ */
65
+ type ClientEvent = {
66
+ /**
67
+ * The name of the event used as an identifier (e.g., MEDIA_TRACK_MUTED, USER_REJOINED, etc.).
68
+ */
69
+ type: string;
70
+ /**
71
+ * The value associated with the event, if applicable.
72
+ */
73
+ payload?: string;
74
+ /**
75
+ * The timestamp in epoch format when the event was generated.
76
+ */
77
+ timestamp?: number;
78
+ };
79
+ /**
80
+ * Certificates
81
+ */
82
+ type CertificateStats = {
83
+ /**
84
+ * The timestamp of the stat.
85
+ */
86
+ timestamp: number;
87
+ /**
88
+ * A unique identifier for the stat.
89
+ */
90
+ id: string;
91
+ /**
92
+ * The fingerprint of the certificate.
93
+ */
94
+ fingerprint?: string;
95
+ /**
96
+ * The algorithm used for the fingerprint (e.g., 'SHA-256').
97
+ */
98
+ fingerprintAlgorithm?: string;
99
+ /**
100
+ * The certificate encoded in base64 format.
101
+ */
102
+ base64Certificate?: string;
103
+ /**
104
+ * The certificate ID of the issuer (nullable).
105
+ */
106
+ issuerCertificateId?: string;
107
+ /**
108
+ * Additional information attached to this stats
109
+ */
110
+ attachments?: Record<string, unknown>;
111
+ };
112
+ /**
113
+ * ICE Candidate Pair Stats
114
+ */
115
+ type IceCandidatePairStats = {
116
+ /**
117
+ * The unique identifier for this RTCStats object.
118
+ */
119
+ id: string;
120
+ /**
121
+ * The timestamp of when the stats were recorded, in seconds.
122
+ */
123
+ timestamp: number;
124
+ /**
125
+ * The transport id of the connection this candidate pair belongs to.
126
+ */
127
+ transportId?: string;
128
+ /**
129
+ * The ID of the local ICE candidate in this pair.
130
+ */
131
+ localCandidateId?: string;
132
+ /**
133
+ * The ID of the remote ICE candidate in this pair.
134
+ */
135
+ remoteCandidateId?: string;
136
+ state?: 'new' | 'in-progress' | 'waiting' | 'failed' | 'succeeded' | 'cancelled' | 'inprogress';
137
+ /**
138
+ * Whether this candidate pair has been nominated.
139
+ */
140
+ nominated?: boolean;
141
+ /**
142
+ * The number of packets sent using this candidate pair.
143
+ */
144
+ packetsSent?: number;
145
+ /**
146
+ * The number of packets received using this candidate pair.
147
+ */
148
+ packetsReceived?: number;
149
+ /**
150
+ * The total number of bytes sent using this candidate pair.
151
+ */
152
+ bytesSent?: number;
153
+ /**
154
+ * The total number of bytes received using this candidate pair.
155
+ */
156
+ bytesReceived?: number;
157
+ /**
158
+ * The timestamp of the last packet sent using this candidate pair.
159
+ */
160
+ lastPacketSentTimestamp?: number;
161
+ /**
162
+ * The timestamp of the last packet received using this candidate pair.
163
+ */
164
+ lastPacketReceivedTimestamp?: number;
165
+ /**
166
+ * The total round trip time (RTT) for this candidate pair in seconds.
167
+ */
168
+ totalRoundTripTime?: number;
169
+ /**
170
+ * The current round trip time (RTT) for this candidate pair in seconds.
171
+ */
172
+ currentRoundTripTime?: number;
173
+ /**
174
+ * The available outgoing bitrate (in bits per second) for this candidate pair.
175
+ */
176
+ availableOutgoingBitrate?: number;
177
+ /**
178
+ * The available incoming bitrate (in bits per second) for this candidate pair.
179
+ */
180
+ availableIncomingBitrate?: number;
181
+ /**
182
+ * The number of ICE connection requests received by this candidate pair.
183
+ */
184
+ requestsReceived?: number;
185
+ /**
186
+ * The number of ICE connection requests sent by this candidate pair.
187
+ */
188
+ requestsSent?: number;
189
+ /**
190
+ * The number of ICE connection responses received by this candidate pair.
191
+ */
192
+ responsesReceived?: number;
193
+ /**
194
+ * The number of ICE connection responses sent by this candidate pair.
195
+ */
196
+ responsesSent?: number;
197
+ /**
198
+ * The number of ICE connection consent requests sent by this candidate pair.
199
+ */
200
+ consentRequestsSent?: number;
201
+ /**
202
+ * The number of packets discarded while attempting to send via this candidate pair.
203
+ */
204
+ packetsDiscardedOnSend?: number;
205
+ /**
206
+ * The total number of bytes discarded while attempting to send via this candidate pair.
207
+ */
208
+ bytesDiscardedOnSend?: number;
209
+ /**
210
+ * Additional information attached to this stats
211
+ */
212
+ attachments?: Record<string, unknown>;
213
+ };
214
+ /**
215
+ * ICE Candidate Stats
216
+ */
217
+ type IceCandidateStats = {
218
+ /**
219
+ * The timestamp of the stat.
220
+ */
221
+ timestamp: number;
222
+ /**
223
+ * A unique identifier for the stat.
224
+ */
225
+ id: string;
226
+ /**
227
+ * The transport ID associated with the ICE candidate.
228
+ */
229
+ transportId?: string;
230
+ /**
231
+ * The IP address of the ICE candidate (nullable).
232
+ */
233
+ address?: string;
234
+ /**
235
+ * The port number of the ICE candidate.
236
+ */
237
+ port?: number;
238
+ /**
239
+ * The transport protocol used by the candidate (e.g., 'udp', 'tcp').
240
+ */
241
+ protocol?: string;
242
+ /**
243
+ * The type of the ICE candidate (e.g., 'host', 'srflx', 'relay').
244
+ */
245
+ candidateType?: string;
246
+ /**
247
+ * The priority of the ICE candidate.
248
+ */
249
+ priority?: number;
250
+ /**
251
+ * The URL of the ICE candidate.
252
+ */
253
+ url?: string;
254
+ /**
255
+ * The protocol used for the relay (e.g., 'tcp', 'udp').
256
+ */
257
+ relayProtocol?: string;
258
+ /**
259
+ * A string representing the foundation for the ICE candidate.
260
+ */
261
+ foundation?: string;
262
+ /**
263
+ * The related address for the ICE candidate (if any).
264
+ */
265
+ relatedAddress?: string;
266
+ /**
267
+ * The related port for the ICE candidate (if any).
268
+ */
269
+ relatedPort?: number;
270
+ /**
271
+ * The username fragment for the ICE candidate.
272
+ */
273
+ usernameFragment?: string;
274
+ /**
275
+ * The TCP type of the ICE candidate (e.g., 'active', 'passive').
276
+ */
277
+ tcpType?: string;
278
+ /**
279
+ * Additional information attached to this stats
280
+ */
281
+ attachments?: Record<string, unknown>;
282
+ };
283
+ /**
284
+ * ICE Transport Stats
285
+ */
286
+ type IceTransportStats = {
287
+ /**
288
+ * The timestamp of the stat.
289
+ */
290
+ timestamp: number;
291
+ /**
292
+ * A unique identifier for the stat.
293
+ */
294
+ id: string;
295
+ /**
296
+ * The number of packets sent.
297
+ */
298
+ packetsSent?: number;
299
+ /**
300
+ * The number of packets received.
301
+ */
302
+ packetsReceived?: number;
303
+ /**
304
+ * The number of bytes sent.
305
+ */
306
+ bytesSent?: number;
307
+ /**
308
+ * The number of bytes received.
309
+ */
310
+ bytesReceived?: number;
311
+ /**
312
+ * The ICE role (e.g., 'controlling', 'controlled').
313
+ */
314
+ iceRole?: string;
315
+ /**
316
+ * The local username fragment for ICE.
317
+ */
318
+ iceLocalUsernameFragment?: string;
319
+ /**
320
+ * The DTLS transport state (e.g., 'new', 'connecting', 'connected').
321
+ */
322
+ dtlsState?: string;
323
+ /**
324
+ * The ICE transport state (e.g., 'new', 'checking', 'connected').
325
+ */
326
+ iceState?: string;
327
+ /**
328
+ * The ID of the selected ICE candidate pair.
329
+ */
330
+ selectedCandidatePairId?: string;
331
+ /**
332
+ * The ID of the local certificate.
333
+ */
334
+ localCertificateId?: string;
335
+ /**
336
+ * The ID of the remote certificate.
337
+ */
338
+ remoteCertificateId?: string;
339
+ /**
340
+ * The TLS version used for encryption.
341
+ */
342
+ tlsVersion?: string;
343
+ /**
344
+ * The DTLS cipher suite used.
345
+ */
346
+ dtlsCipher?: string;
347
+ /**
348
+ * The role in the DTLS handshake (e.g., 'client', 'server').
349
+ */
350
+ dtlsRole?: string;
351
+ /**
352
+ * The SRTP cipher used for encryption.
353
+ */
354
+ srtpCipher?: string;
355
+ /**
356
+ * The number of changes to the selected ICE candidate pair.
357
+ */
358
+ selectedCandidatePairChanges?: number;
359
+ /**
360
+ * Additional information attached to this stats
361
+ */
362
+ attachments?: Record<string, unknown>;
363
+ };
364
+ /**
365
+ * Data Channels Stats
366
+ */
367
+ type DataChannelStats = {
368
+ /**
369
+ * The timestamp of the stat.
370
+ */
371
+ timestamp: number;
372
+ /**
373
+ * A unique identifier for the stat.
374
+ */
375
+ id: string;
376
+ /**
377
+ * The label of the data channel.
378
+ */
379
+ label?: string;
380
+ /**
381
+ * The protocol of the data channel.
382
+ */
383
+ protocol?: string;
384
+ /**
385
+ * The identifier for the data channel.
386
+ */
387
+ dataChannelIdentifier?: number;
388
+ /**
389
+ * The state of the data channel (e.g., 'open', 'closed').
390
+ */
391
+ state?: string;
392
+ /**
393
+ * The number of messages sent on the data channel.
394
+ */
395
+ messagesSent?: number;
396
+ /**
397
+ * The number of bytes sent on the data channel.
398
+ */
399
+ bytesSent?: number;
400
+ /**
401
+ * The number of messages received on the data channel.
402
+ */
403
+ messagesReceived?: number;
404
+ /**
405
+ * The number of bytes received on the data channel.
406
+ */
407
+ bytesReceived?: number;
408
+ /**
409
+ * Additional information attached to this stats
410
+ */
411
+ attachments?: Record<string, unknown>;
412
+ };
413
+ /**
414
+ * PeerConnection Transport Stats
415
+ */
416
+ type PeerConnectionTransportStats = {
417
+ /**
418
+ * The timestamp of the stat.
419
+ */
420
+ timestamp: number;
421
+ /**
422
+ * A unique identifier for the stat.
423
+ */
424
+ id: string;
425
+ /**
426
+ * The number of data channels opened.
427
+ */
428
+ dataChannelsOpened?: number;
429
+ /**
430
+ * The number of data channels closed.
431
+ */
432
+ dataChannelsClosed?: number;
433
+ /**
434
+ * Additional information attached to this stats
435
+ */
436
+ attachments?: Record<string, unknown>;
437
+ };
438
+ /**
439
+ * Media Playout Stats
440
+ */
441
+ type MediaPlayoutStats = {
442
+ /**
443
+ * The timestamp of the stat.
444
+ */
445
+ timestamp: number;
446
+ /**
447
+ * A unique identifier for the stat.
448
+ */
449
+ id: string;
450
+ /**
451
+ * The kind of media (audio/video).
452
+ */
453
+ kind: string;
454
+ /**
455
+ * The duration of synthesized audio samples.
456
+ */
457
+ synthesizedSamplesDuration?: number;
458
+ /**
459
+ * The number of synthesized audio samples events.
460
+ */
461
+ synthesizedSamplesEvents?: number;
462
+ /**
463
+ * The total duration of all audio samples.
464
+ */
465
+ totalSamplesDuration?: number;
466
+ /**
467
+ * The total delay experienced during audio playout.
468
+ */
469
+ totalPlayoutDelay?: number;
470
+ /**
471
+ * The total count of audio samples.
472
+ */
473
+ totalSamplesCount?: number;
474
+ /**
475
+ * Additional information attached to this stats
476
+ */
477
+ attachments?: Record<string, unknown>;
478
+ };
479
+ /**
480
+ * Audio Source Stats
481
+ */
482
+ type MediaSourceStats = {
483
+ /**
484
+ * The timestamp of the stat.
485
+ */
486
+ timestamp: number;
487
+ /**
488
+ * A unique identifier for the stat.
489
+ */
490
+ id: string;
491
+ /**
492
+ * The type of media ('audio' or 'video').
493
+ */
494
+ kind: string;
495
+ /**
496
+ * The identifier of the media track.
497
+ */
498
+ trackIdentifier?: string;
499
+ /**
500
+ * The current audio level.
501
+ */
502
+ audioLevel?: number;
503
+ /**
504
+ * The total audio energy.
505
+ */
506
+ totalAudioEnergy?: number;
507
+ /**
508
+ * The total duration of audio samples.
509
+ */
510
+ totalSamplesDuration?: number;
511
+ /**
512
+ * The echo return loss.
513
+ */
514
+ echoReturnLoss?: number;
515
+ /**
516
+ * The enhancement of echo return loss.
517
+ */
518
+ echoReturnLossEnhancement?: number;
519
+ /**
520
+ * The width of the video.
521
+ */
522
+ width?: number;
523
+ /**
524
+ * The height of the video.
525
+ */
526
+ height?: number;
527
+ /**
528
+ * The total number of frames.
529
+ */
530
+ frames?: number;
531
+ /**
532
+ * The frames per second of the video.
533
+ */
534
+ framesPerSecond?: number;
535
+ /**
536
+ * Additional information attached to this stats
537
+ */
538
+ attachments?: Record<string, unknown>;
539
+ };
540
+ /**
541
+ * Remote Outbound RTPs
542
+ */
543
+ type RemoteOutboundRtpStats = {
544
+ /**
545
+ * The timestamp for this stats object in DOMHighResTimeStamp format.
546
+ */
547
+ timestamp: number;
548
+ /**
549
+ * The unique identifier for this stats object.
550
+ */
551
+ id: string;
552
+ /**
553
+ * The SSRC identifier of the RTP stream.
554
+ */
555
+ ssrc: number;
556
+ /**
557
+ * The type of media ('audio' or 'video').
558
+ */
559
+ kind: string;
560
+ /**
561
+ * The ID of the transport used for this stream.
562
+ */
563
+ transportId?: string;
564
+ /**
565
+ * The ID of the codec used for this stream.
566
+ */
567
+ codecId?: string;
568
+ /**
569
+ * The total number of packets sent on this stream.
570
+ */
571
+ packetsSent?: number;
572
+ /**
573
+ * The total number of bytes sent on this stream.
574
+ */
575
+ bytesSent?: number;
576
+ /**
577
+ * The ID of the local object corresponding to this stream.
578
+ */
579
+ localId?: string;
580
+ /**
581
+ * The remote timestamp for this stats object in DOMHighResTimeStamp format.
582
+ */
583
+ remoteTimestamp?: number;
584
+ /**
585
+ * The total number of reports sent on this stream.
586
+ */
587
+ reportsSent?: number;
588
+ /**
589
+ * The current estimated round-trip time for this stream in seconds.
590
+ */
591
+ roundTripTime?: number;
592
+ /**
593
+ * The total round-trip time for this stream in seconds.
594
+ */
595
+ totalRoundTripTime?: number;
596
+ /**
597
+ * The total number of round-trip time measurements for this stream.
598
+ */
599
+ roundTripTimeMeasurements?: number;
600
+ /**
601
+ * Additional information attached to this stats
602
+ */
603
+ attachments?: Record<string, unknown>;
604
+ };
605
+ /**
606
+ * The duration of quality limitation reasons categorized by type.
607
+ */
608
+ type QualityLimitationDurations = {
609
+ /**
610
+ * Duration of no quality limitation in seconds.
611
+ */
612
+ none: number;
613
+ /**
614
+ * Duration of CPU-based quality limitation in seconds.
615
+ */
616
+ cpu: number;
617
+ /**
618
+ * Duration of bandwidth-based quality limitation in seconds.
619
+ */
620
+ bandwidth: number;
621
+ /**
622
+ * Duration of other quality limitation reasons in seconds.
623
+ */
624
+ other: number;
625
+ };
626
+ /**
627
+ * Outbound RTPs
628
+ */
629
+ type OutboundRtpStats = {
630
+ /**
631
+ * The timestamp for this stats object in DOMHighResTimeStamp format.
632
+ */
633
+ timestamp: number;
634
+ /**
635
+ * The unique identifier for this stats object.
636
+ */
637
+ id: string;
638
+ /**
639
+ * The SSRC identifier of the RTP stream.
640
+ */
641
+ ssrc: number;
642
+ /**
643
+ * The type of media ('audio' or 'video').
644
+ */
645
+ kind: string;
646
+ /**
647
+ * The ID of the transport used for this stream.
648
+ */
649
+ transportId?: string;
650
+ /**
651
+ * The ID of the codec used for this stream.
652
+ */
653
+ codecId?: string;
654
+ /**
655
+ * The total number of packets sent on this stream.
656
+ */
657
+ packetsSent?: number;
658
+ /**
659
+ * The total number of bytes sent on this stream.
660
+ */
661
+ bytesSent?: number;
662
+ /**
663
+ * The media ID associated with this RTP stream.
664
+ */
665
+ mid?: string;
666
+ /**
667
+ * The ID of the media source associated with this stream.
668
+ */
669
+ mediaSourceId?: string;
670
+ /**
671
+ * The ID of the remote object corresponding to this stream.
672
+ */
673
+ remoteId?: string;
674
+ /**
675
+ * The RID value of the RTP stream.
676
+ */
677
+ rid?: string;
678
+ /**
679
+ * The total number of header bytes sent on this stream.
680
+ */
681
+ headerBytesSent?: number;
682
+ /**
683
+ * The number of retransmitted packets sent on this stream.
684
+ */
685
+ retransmittedPacketsSent?: number;
686
+ /**
687
+ * The number of retransmitted bytes sent on this stream.
688
+ */
689
+ retransmittedBytesSent?: number;
690
+ /**
691
+ * The SSRC for the RTX stream, if applicable.
692
+ */
693
+ rtxSsrc?: number;
694
+ /**
695
+ * The target bitrate for this RTP stream in bits per second.
696
+ */
697
+ targetBitrate?: number;
698
+ /**
699
+ * The total target encoded bytes for this stream.
700
+ */
701
+ totalEncodedBytesTarget?: number;
702
+ /**
703
+ * The width of the frames sent in pixels.
704
+ */
705
+ frameWidth?: number;
706
+ /**
707
+ * The height of the frames sent in pixels.
708
+ */
709
+ frameHeight?: number;
710
+ /**
711
+ * The number of frames sent per second.
712
+ */
713
+ framesPerSecond?: number;
714
+ /**
715
+ * The total number of frames sent on this stream.
716
+ */
717
+ framesSent?: number;
718
+ /**
719
+ * The total number of huge frames sent on this stream.
720
+ */
721
+ hugeFramesSent?: number;
722
+ /**
723
+ * The total number of frames encoded on this stream.
724
+ */
725
+ framesEncoded?: number;
726
+ /**
727
+ * The total number of key frames encoded on this stream.
728
+ */
729
+ keyFramesEncoded?: number;
730
+ /**
731
+ * The sum of QP values for all frames encoded on this stream.
732
+ */
733
+ qpSum?: number;
734
+ /**
735
+ * The total time spent encoding frames on this stream in seconds.
736
+ */
737
+ totalEncodeTime?: number;
738
+ /**
739
+ * The total delay for packets sent on this stream in seconds.
740
+ */
741
+ totalPacketSendDelay?: number;
742
+ /**
743
+ * The reason for any quality limitation on this stream.
744
+ */
745
+ qualityLimitationReason?: string;
746
+ /**
747
+ * The number of resolution changes due to quality limitations.
748
+ */
749
+ qualityLimitationResolutionChanges?: number;
750
+ /**
751
+ * The total number of NACK packets sent on this stream.
752
+ */
753
+ nackCount?: number;
754
+ /**
755
+ * The total number of FIR packets sent on this stream.
756
+ */
757
+ firCount?: number;
758
+ /**
759
+ * The total number of PLI packets sent on this stream.
760
+ */
761
+ pliCount?: number;
762
+ /**
763
+ * The implementation of the encoder used for this stream.
764
+ */
765
+ encoderImplementation?: string;
766
+ /**
767
+ * Indicates whether the encoder is power efficient.
768
+ */
769
+ powerEfficientEncoder?: boolean;
770
+ /**
771
+ * Indicates whether this stream is actively sending data.
772
+ */
773
+ active?: boolean;
774
+ /**
775
+ * The scalability mode of the encoder used for this stream.
776
+ */
777
+ scalabilityMode?: string;
778
+ /**
779
+ * The duration of quality limitation reasons categorized by type.
780
+ */
781
+ qualityLimitationDurations?: QualityLimitationDurations;
782
+ /**
783
+ * Additional information attached to this stats.
784
+ */
785
+ attachments?: Record<string, unknown>;
786
+ };
787
+ /**
788
+ * Remote Inbound RTPs
789
+ */
790
+ type RemoteInboundRtpStats = {
791
+ /**
792
+ * The timestamp for this stats object in DOMHighResTimeStamp format.
793
+ */
794
+ timestamp: number;
795
+ /**
796
+ * The unique identifier for this stats object.
797
+ */
798
+ id: string;
799
+ /**
800
+ * The SSRC identifier of the RTP stream.
801
+ */
802
+ ssrc: number;
803
+ /**
804
+ * The type of media ('audio' or 'video').
805
+ */
806
+ kind: string;
807
+ /**
808
+ * The ID of the transport used for this stream.
809
+ */
810
+ transportId?: string;
811
+ /**
812
+ * The ID of the codec used for this stream.
813
+ */
814
+ codecId?: string;
815
+ /**
816
+ * The total number of packets received on this stream.
817
+ */
818
+ packetsReceived?: number;
819
+ /**
820
+ * The total number of packets lost on this stream.
821
+ */
822
+ packetsLost?: number;
823
+ /**
824
+ * The jitter value for this stream in seconds.
825
+ */
826
+ jitter?: number;
827
+ /**
828
+ * The ID of the local object corresponding to this remote stream.
829
+ */
830
+ localId?: string;
831
+ /**
832
+ * The most recent RTT measurement for this stream in seconds.
833
+ */
834
+ roundTripTime?: number;
835
+ /**
836
+ * The cumulative RTT for all packets on this stream in seconds.
837
+ */
838
+ totalRoundTripTime?: number;
839
+ /**
840
+ * The fraction of packets lost on this stream, calculated over a time interval.
841
+ */
842
+ fractionLost?: number;
843
+ /**
844
+ * The total number of RTT measurements for this stream.
845
+ */
846
+ roundTripTimeMeasurements?: number;
847
+ /**
848
+ * Additional information attached to this stats
849
+ */
850
+ attachments?: Record<string, unknown>;
851
+ };
852
+ /**
853
+ * Inbound RTPs
854
+ */
855
+ type InboundRtpStats = {
856
+ /**
857
+ * The time the stats were collected, in high-resolution time.
858
+ */
859
+ timestamp: number;
860
+ /**
861
+ * Unique identifier of the stats object.
862
+ */
863
+ id: string;
864
+ /**
865
+ * Synchronization source identifier of the RTP stream.
866
+ */
867
+ ssrc: number;
868
+ /**
869
+ * Kind of the media (e.g., 'audio' or 'video').
870
+ */
871
+ kind: string;
872
+ /**
873
+ * Identifier for the media track associated with the RTP stream.
874
+ */
875
+ trackIdentifier: string;
876
+ /**
877
+ * ID of the transport associated with the RTP stream.
878
+ */
879
+ transportId?: string;
880
+ /**
881
+ * ID of the codec used for the RTP stream.
882
+ */
883
+ codecId?: string;
884
+ /**
885
+ * Number of packets received on the RTP stream.
886
+ */
887
+ packetsReceived?: number;
888
+ /**
889
+ * Number of packets lost on the RTP stream.
890
+ */
891
+ packetsLost?: number;
892
+ /**
893
+ * Jitter of the RTP stream in seconds.
894
+ */
895
+ jitter?: number;
896
+ /**
897
+ * The MediaStream ID of the RTP stream.
898
+ */
899
+ mid?: string;
900
+ /**
901
+ * Remote stats object ID associated with the RTP stream.
902
+ */
903
+ remoteId?: string;
904
+ /**
905
+ * Number of frames decoded.
906
+ */
907
+ framesDecoded?: number;
908
+ /**
909
+ * Number of keyframes decoded.
910
+ */
911
+ keyFramesDecoded?: number;
912
+ /**
913
+ * Number of frames rendered.
914
+ */
915
+ framesRendered?: number;
916
+ /**
917
+ * Number of frames dropped.
918
+ */
919
+ framesDropped?: number;
920
+ /**
921
+ * Width of the decoded video frames.
922
+ */
923
+ frameWidth?: number;
924
+ /**
925
+ * Height of the decoded video frames.
926
+ */
927
+ frameHeight?: number;
928
+ /**
929
+ * Frame rate in frames per second.
930
+ */
931
+ framesPerSecond?: number;
932
+ /**
933
+ * Sum of the Quantization Parameter values for decoded frames.
934
+ */
935
+ qpSum?: number;
936
+ /**
937
+ * Total time spent decoding in seconds.
938
+ */
939
+ totalDecodeTime?: number;
940
+ /**
941
+ * Sum of inter-frame delays in seconds.
942
+ */
943
+ totalInterFrameDelay?: number;
944
+ /**
945
+ * Sum of squared inter-frame delays in seconds.
946
+ */
947
+ totalSquaredInterFrameDelay?: number;
948
+ /**
949
+ * Number of times playback was paused.
950
+ */
951
+ pauseCount?: number;
952
+ /**
953
+ * Total duration of pauses in seconds.
954
+ */
955
+ totalPausesDuration?: number;
956
+ /**
957
+ * Number of times playback was frozen.
958
+ */
959
+ freezeCount?: number;
960
+ /**
961
+ * Total duration of freezes in seconds.
962
+ */
963
+ totalFreezesDuration?: number;
964
+ /**
965
+ * Timestamp of the last packet received.
966
+ */
967
+ lastPacketReceivedTimestamp?: number;
968
+ /**
969
+ * Total header bytes received.
970
+ */
971
+ headerBytesReceived?: number;
972
+ /**
973
+ * Total packets discarded.
974
+ */
975
+ packetsDiscarded?: number;
976
+ /**
977
+ * Total bytes received from FEC.
978
+ */
979
+ fecBytesReceived?: number;
980
+ /**
981
+ * Total packets received from FEC.
982
+ */
983
+ fecPacketsReceived?: number;
984
+ /**
985
+ * Total FEC packets discarded.
986
+ */
987
+ fecPacketsDiscarded?: number;
988
+ /**
989
+ * Total bytes received on the RTP stream.
990
+ */
991
+ bytesReceived?: number;
992
+ /**
993
+ * Number of NACKs sent.
994
+ */
995
+ nackCount?: number;
996
+ /**
997
+ * Number of Full Intra Requests sent.
998
+ */
999
+ firCount?: number;
1000
+ /**
1001
+ * Number of Picture Loss Indications sent.
1002
+ */
1003
+ pliCount?: number;
1004
+ /**
1005
+ * Total processing delay in seconds.
1006
+ */
1007
+ totalProcessingDelay?: number;
1008
+ /**
1009
+ * Estimated timestamp of playout.
1010
+ */
1011
+ estimatedPlayoutTimestamp?: number;
1012
+ /**
1013
+ * Total jitter buffer delay in seconds.
1014
+ */
1015
+ jitterBufferDelay?: number;
1016
+ /**
1017
+ * Target delay for the jitter buffer in seconds.
1018
+ */
1019
+ jitterBufferTargetDelay?: number;
1020
+ /**
1021
+ * Number of packets emitted from the jitter buffer.
1022
+ */
1023
+ jitterBufferEmittedCount?: number;
1024
+ /**
1025
+ * Minimum delay of the jitter buffer in seconds.
1026
+ */
1027
+ jitterBufferMinimumDelay?: number;
1028
+ /**
1029
+ * Total audio samples received.
1030
+ */
1031
+ totalSamplesReceived?: number;
1032
+ /**
1033
+ * Number of concealed audio samples.
1034
+ */
1035
+ concealedSamples?: number;
1036
+ /**
1037
+ * Number of silent audio samples concealed.
1038
+ */
1039
+ silentConcealedSamples?: number;
1040
+ /**
1041
+ * Number of audio concealment events.
1042
+ */
1043
+ concealmentEvents?: number;
1044
+ /**
1045
+ * Number of audio samples inserted for deceleration.
1046
+ */
1047
+ insertedSamplesForDeceleration?: number;
1048
+ /**
1049
+ * Number of audio samples removed for acceleration.
1050
+ */
1051
+ removedSamplesForAcceleration?: number;
1052
+ /**
1053
+ * Audio level in the range [0.0, 1.0].
1054
+ */
1055
+ audioLevel?: number;
1056
+ /**
1057
+ * Total audio energy in the stream.
1058
+ */
1059
+ totalAudioEnergy?: number;
1060
+ /**
1061
+ * Total duration of all received audio samples in seconds.
1062
+ */
1063
+ totalSamplesDuration?: number;
1064
+ /**
1065
+ * Total number of frames received.
1066
+ */
1067
+ framesReceived?: number;
1068
+ /**
1069
+ * Decoder implementation used for decoding frames.
1070
+ */
1071
+ decoderImplementation?: string;
1072
+ /**
1073
+ * Playout identifier for the RTP stream.
1074
+ */
1075
+ playoutId?: string;
1076
+ /**
1077
+ * Indicates if the decoder is power-efficient.
1078
+ */
1079
+ powerEfficientDecoder?: boolean;
1080
+ /**
1081
+ * Number of frames assembled from multiple packets.
1082
+ */
1083
+ framesAssembledFromMultiplePackets?: number;
1084
+ /**
1085
+ * Total assembly time for frames in seconds.
1086
+ */
1087
+ totalAssemblyTime?: number;
1088
+ /**
1089
+ * Number of retransmitted packets received.
1090
+ */
1091
+ retransmittedPacketsReceived?: number;
1092
+ /**
1093
+ * Number of retransmitted bytes received.
1094
+ */
1095
+ retransmittedBytesReceived?: number;
1096
+ /**
1097
+ * SSRC of the retransmission stream.
1098
+ */
1099
+ rtxSsrc?: number;
1100
+ /**
1101
+ * SSRC of the FEC stream.
1102
+ */
1103
+ fecSsrc?: number;
1104
+ /**
1105
+ * Total corruption probability of packets.
1106
+ */
1107
+ totalCorruptionProbability?: number;
1108
+ /**
1109
+ * Total squared corruption probability of packets.
1110
+ */
1111
+ totalSquaredCorruptionProbability?: number;
1112
+ /**
1113
+ * Number of corruption measurements.
1114
+ */
1115
+ corruptionMeasurements?: number;
1116
+ /**
1117
+ * Additional information attached to this stats
1118
+ */
1119
+ attachments?: Record<string, unknown>;
1120
+ };
1121
+ /**
1122
+ * Codec items
1123
+ */
1124
+ type CodecStats = {
1125
+ /**
1126
+ * The timestamp when the stats were generated.
1127
+ */
1128
+ timestamp: number;
1129
+ /**
1130
+ * The unique identifier for the stats object.
1131
+ */
1132
+ id: string;
1133
+ /**
1134
+ * The MIME type of the codec.
1135
+ */
1136
+ mimeType: string;
1137
+ /**
1138
+ * The payload type of the codec.
1139
+ */
1140
+ payloadType?: number;
1141
+ /**
1142
+ * The identifier of the transport associated with the codec.
1143
+ */
1144
+ transportId?: string;
1145
+ /**
1146
+ * The clock rate of the codec in Hz.
1147
+ */
1148
+ clockRate?: number;
1149
+ /**
1150
+ * The number of audio channels for the codec, if applicable.
1151
+ */
1152
+ channels?: number;
1153
+ /**
1154
+ * The SDP format-specific parameters line for the codec.
1155
+ */
1156
+ sdpFmtpLine?: string;
1157
+ /**
1158
+ * Additional information attached to this stats
1159
+ */
1160
+ attachments?: Record<string, unknown>;
1161
+ };
1162
+ /**
1163
+ * Outbound Track Stats items
1164
+ */
1165
+ type OutboundTrackSample = {
1166
+ /**
1167
+ * The timestamp when the stats were generated.
1168
+ */
1169
+ timestamp: number;
1170
+ /**
1171
+ * The unique identifier for the stats object.
1172
+ */
1173
+ id: string;
1174
+ /**
1175
+ * Kind of the media (e.g., 'audio' or 'video').
1176
+ */
1177
+ kind: string;
1178
+ /**
1179
+ * Calculated score for track (details should be added to attachments)
1180
+ */
1181
+ score?: number;
1182
+ /**
1183
+ * Additional information attached to this stats
1184
+ */
1185
+ attachments?: Record<string, unknown>;
1186
+ };
1187
+ /**
1188
+ * Inbound Track Stats items
1189
+ */
1190
+ type InboundTrackSample = {
1191
+ /**
1192
+ * The timestamp when the stats were generated.
1193
+ */
1194
+ timestamp: number;
1195
+ /**
1196
+ * The unique identifier for the stats object.
1197
+ */
1198
+ id: string;
1199
+ /**
1200
+ * Kind of the media (e.g., 'audio' or 'video').
1201
+ */
1202
+ kind: string;
1203
+ /**
1204
+ * Calculated score for track (details should be added to attachments)
1205
+ */
1206
+ score?: number;
1207
+ /**
1208
+ * Additional information attached to this stats
1209
+ */
1210
+ attachments?: Record<string, unknown>;
1211
+ };
1212
+ /**
1213
+ * docs
1214
+ */
1215
+ type PeerConnectionSample = {
1216
+ /**
1217
+ * Unique identifier of the stats object.
1218
+ */
1219
+ peerConnectionId: string;
1220
+ /**
1221
+ * Additional information attached to this sample
1222
+ */
1223
+ attachments?: Record<string, unknown>;
1224
+ /**
1225
+ * Calculated score for peer connection (details should be added to attachments)
1226
+ */
1227
+ score?: number;
1228
+ /**
1229
+ * Inbound Track Stats items
1230
+ */
1231
+ inboundTracks?: InboundTrackSample[];
1232
+ /**
1233
+ * Outbound Track Stats items
1234
+ */
1235
+ outboundTracks?: OutboundTrackSample[];
1236
+ /**
1237
+ * Codec items
1238
+ */
1239
+ codecs?: CodecStats[];
1240
+ /**
1241
+ * Inbound RTPs
1242
+ */
1243
+ inboundRtps?: InboundRtpStats[];
1244
+ /**
1245
+ * Remote Inbound RTPs
1246
+ */
1247
+ remoteInboundRtps?: RemoteInboundRtpStats[];
1248
+ /**
1249
+ * Outbound RTPs
1250
+ */
1251
+ outboundRtps?: OutboundRtpStats[];
1252
+ /**
1253
+ * Remote Outbound RTPs
1254
+ */
1255
+ remoteOutboundRtps?: RemoteOutboundRtpStats[];
1256
+ /**
1257
+ * Audio Source Stats
1258
+ */
1259
+ mediaSources?: MediaSourceStats[];
1260
+ /**
1261
+ * Media Playout Stats
1262
+ */
1263
+ mediaPlayouts?: MediaPlayoutStats[];
1264
+ /**
1265
+ * PeerConnection Transport Stats
1266
+ */
1267
+ peerConnectionTransports?: PeerConnectionTransportStats[];
1268
+ /**
1269
+ * Data Channels Stats
1270
+ */
1271
+ dataChannels?: DataChannelStats[];
1272
+ /**
1273
+ * ICE Transport Stats
1274
+ */
1275
+ iceTransports?: IceTransportStats[];
1276
+ /**
1277
+ * ICE Candidate Stats
1278
+ */
1279
+ iceCandidates?: IceCandidateStats[];
1280
+ /**
1281
+ * ICE Candidate Pair Stats
1282
+ */
1283
+ iceCandidatePairs?: IceCandidatePairStats[];
1284
+ /**
1285
+ * Certificates
1286
+ */
1287
+ certificates?: CertificateStats[];
1288
+ };
1289
+ /**
1290
+ * docs
1291
+ */
1292
+ type ClientSample = {
1293
+ /**
1294
+ * The timestamp the sample is created in GMT
1295
+ */
1296
+ timestamp: number;
1297
+ /**
1298
+ * the unique identifier of the call or session
1299
+ */
1300
+ callId?: string;
1301
+ /**
1302
+ * Unique id of the client providing samples.
1303
+ */
1304
+ clientId?: string;
1305
+ /**
1306
+ * Additional information attached to this sample (e.g.: roomId, userId, displayName, etc...)
1307
+ */
1308
+ attachments?: Record<string, unknown>;
1309
+ /**
1310
+ * Calculated score for client (details should be added to attachments)
1311
+ */
1312
+ score?: number;
1313
+ /**
1314
+ * Samples taken PeerConnections
1315
+ */
1316
+ peerConnections?: PeerConnectionSample[];
1317
+ /**
1318
+ * A list of client events.
1319
+ */
1320
+ clientEvents?: ClientEvent[];
1321
+ /**
1322
+ * A list of client issues.
1323
+ */
1324
+ clientIssues?: ClientIssue[];
1325
+ /**
1326
+ * A list of additional client events.
1327
+ */
1328
+ clientMetaItems?: ClientMetaData[];
1329
+ /**
1330
+ * The WebRTC app provided custom stats payload
1331
+ */
1332
+ extensionStats?: ExtensionStat[];
1333
+ };
1334
+
1335
+ type CalculatedScore = {
1336
+ weight: number;
1337
+ value?: number;
1338
+ appData?: Record<string, unknown>;
1339
+ };
1340
+
1341
+ type MediaKind = 'audio' | 'video';
1342
+
1343
+ declare class ObservedMediaSource implements MediaSourceStats {
1344
+ timestamp: number;
1345
+ id: string;
1346
+ kind: MediaKind;
1347
+ private readonly _peerConnection;
1348
+ private _visited;
1349
+ appData?: Record<string, unknown>;
1350
+ trackIdentifier?: string | undefined;
1351
+ audioLevel?: number | undefined;
1352
+ totalAudioEnergy?: number | undefined;
1353
+ totalSamplesDuration?: number | undefined;
1354
+ echoReturnLoss?: number | undefined;
1355
+ echoReturnLossEnhancement?: number | undefined;
1356
+ width?: number | undefined;
1357
+ height?: number | undefined;
1358
+ frames?: number | undefined;
1359
+ framesPerSecond?: number | undefined;
1360
+ attachments?: Record<string, unknown> | undefined;
1361
+ constructor(timestamp: number, id: string, kind: MediaKind, _peerConnection: ObservedPeerConnection);
1362
+ get visited(): boolean;
1363
+ getPeerConnection(): ObservedPeerConnection;
1364
+ getTrack(): ObservedOutboundTrack | undefined;
1365
+ update(stats: MediaSourceStats): void;
1366
+ }
1367
+
1368
+ declare class ObservedIceCandidate implements IceCandidateStats {
1369
+ timestamp: number;
1370
+ id: string;
1371
+ private readonly _peerConnection;
1372
+ private _visited;
1373
+ appData?: Record<string, unknown>;
1374
+ transportId?: string | undefined;
1375
+ address?: string | undefined;
1376
+ port?: number | undefined;
1377
+ protocol?: string | undefined;
1378
+ candidateType?: string | undefined;
1379
+ priority?: number | undefined;
1380
+ url?: string | undefined;
1381
+ relayProtocol?: string | undefined;
1382
+ foundation?: string | undefined;
1383
+ relatedAddress?: string | undefined;
1384
+ relatedPort?: number | undefined;
1385
+ usernameFragment?: string | undefined;
1386
+ tcpType?: string | undefined;
1387
+ attachments?: Record<string, unknown> | undefined;
1388
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1389
+ get visited(): boolean;
1390
+ getPeerConnection(): ObservedPeerConnection;
1391
+ getIceTransport(): ObservedIceTransport | undefined;
1392
+ update(stats: IceCandidateStats): void;
1393
+ }
1394
+
1395
+ declare class ObservedIceCandidatePair implements IceCandidatePairStats {
1396
+ timestamp: number;
1397
+ id: string;
1398
+ private readonly _peerConnection;
1399
+ private _visited;
1400
+ appData?: Record<string, unknown>;
1401
+ transportId?: string | undefined;
1402
+ localCandidateId?: string | undefined;
1403
+ remoteCandidateId?: string | undefined;
1404
+ state?: 'new' | 'in-progress' | 'waiting' | 'failed' | 'succeeded' | undefined;
1405
+ nominated?: boolean | undefined;
1406
+ packetsSent?: number | undefined;
1407
+ packetsReceived?: number | undefined;
1408
+ bytesSent?: number | undefined;
1409
+ bytesReceived?: number | undefined;
1410
+ lastPacketSentTimestamp?: number | undefined;
1411
+ lastPacketReceivedTimestamp?: number | undefined;
1412
+ totalRoundTripTime?: number | undefined;
1413
+ currentRoundTripTime?: number | undefined;
1414
+ availableOutgoingBitrate?: number | undefined;
1415
+ availableIncomingBitrate?: number | undefined;
1416
+ requestsReceived?: number | undefined;
1417
+ requestsSent?: number | undefined;
1418
+ responsesReceived?: number | undefined;
1419
+ responsesSent?: number | undefined;
1420
+ consentRequestsSent?: number | undefined;
1421
+ packetsDiscardedOnSend?: number | undefined;
1422
+ bytesDiscardedOnSend?: number | undefined;
1423
+ attachments?: Record<string, unknown> | undefined;
1424
+ deltaBytesSent: number;
1425
+ deltaBytesReceived: number;
1426
+ deltaPacketsSent: number;
1427
+ deltaPacketsReceived: number;
1428
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1429
+ get visited(): boolean;
1430
+ getPeerConnection(): ObservedPeerConnection;
1431
+ getIceTransport(): ObservedIceTransport | undefined;
1432
+ getLocalCandidate(): ObservedIceCandidate | undefined;
1433
+ getRemoteCandidate(): ObservedIceCandidate | undefined;
1434
+ update(stats: IceCandidatePairStats): void;
1435
+ private _convertState;
1436
+ }
1437
+
1438
+ declare class ObservedIceTransport implements IceTransportStats {
1439
+ timestamp: number;
1440
+ id: string;
1441
+ private readonly _peerConnection;
1442
+ private _visited;
1443
+ appData?: Record<string, unknown>;
1444
+ packetsSent?: number | undefined;
1445
+ packetsReceived?: number | undefined;
1446
+ bytesSent?: number | undefined;
1447
+ bytesReceived?: number | undefined;
1448
+ iceRole?: string | undefined;
1449
+ iceLocalUsernameFragment?: string | undefined;
1450
+ dtlsState?: string | undefined;
1451
+ iceState?: string | undefined;
1452
+ selectedCandidatePairId?: string | undefined;
1453
+ localCertificateId?: string | undefined;
1454
+ remoteCertificateId?: string | undefined;
1455
+ tlsVersion?: string | undefined;
1456
+ dtlsCipher?: string | undefined;
1457
+ dtlsRole?: string | undefined;
1458
+ srtpCipher?: string | undefined;
1459
+ selectedCandidatePairChanges?: number | undefined;
1460
+ attachments?: Record<string, unknown> | undefined;
1461
+ deltaPacketsReceived: number;
1462
+ deltaPacketsSent: number;
1463
+ deltaBytesReceived: number;
1464
+ deltaBytesSent: number;
1465
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1466
+ get visited(): boolean;
1467
+ getPeerConnection(): ObservedPeerConnection;
1468
+ getSelectedCandidatePair(): ObservedIceCandidatePair | undefined;
1469
+ update(stats: IceTransportStats): void;
1470
+ }
1471
+
1472
+ declare class ObservedCodec implements CodecStats {
1473
+ timestamp: number;
1474
+ id: string;
1475
+ mimeType: string;
1476
+ private readonly _peerConnection;
1477
+ private _visited;
1478
+ appData?: Record<string, unknown>;
1479
+ payloadType?: number | undefined;
1480
+ transportId?: string | undefined;
1481
+ clockRate?: number | undefined;
1482
+ channels?: number | undefined;
1483
+ sdpFmtpLine?: string | undefined;
1484
+ attachments?: Record<string, unknown> | undefined;
1485
+ constructor(timestamp: number, id: string, mimeType: string, _peerConnection: ObservedPeerConnection);
1486
+ get visited(): boolean;
1487
+ getPeerConnection(): ObservedPeerConnection;
1488
+ getIceTransport(): ObservedIceTransport | undefined;
1489
+ update(stats: CodecStats): void;
1490
+ }
1491
+
1492
+ declare class ObservedRemoteInboundRtp implements RemoteInboundRtpStats {
1493
+ timestamp: number;
1494
+ id: string;
1495
+ ssrc: number;
1496
+ kind: MediaKind;
1497
+ private readonly _peerConnection;
1498
+ private _visited;
1499
+ appData?: Record<string, unknown>;
1500
+ transportId?: string | undefined;
1501
+ codecId?: string | undefined;
1502
+ packetsReceived?: number | undefined;
1503
+ packetsLost?: number | undefined;
1504
+ jitter?: number | undefined;
1505
+ localId?: string | undefined;
1506
+ roundTripTime?: number | undefined;
1507
+ totalRoundTripTime?: number | undefined;
1508
+ fractionLost?: number | undefined;
1509
+ roundTripTimeMeasurements?: number | undefined;
1510
+ attachments?: Record<string, unknown> | undefined;
1511
+ constructor(timestamp: number, id: string, ssrc: number, kind: MediaKind, _peerConnection: ObservedPeerConnection);
1512
+ get visited(): boolean;
1513
+ getPeerConnection(): ObservedPeerConnection;
1514
+ getOutboundRtp(): ObservedOutboundRtp | undefined;
1515
+ getCodec(): ObservedCodec | undefined;
1516
+ update(stats: RemoteInboundRtpStats): void;
1517
+ }
1518
+
1519
+ declare class ObservedOutboundRtp implements OutboundRtpStats {
1520
+ timestamp: number;
1521
+ id: string;
1522
+ ssrc: number;
1523
+ kind: MediaKind;
1524
+ private readonly _peerConnection;
1525
+ private _visited;
1526
+ appData?: Record<string, unknown>;
1527
+ transportId?: string | undefined;
1528
+ codecId?: string | undefined;
1529
+ packetsSent?: number | undefined;
1530
+ bytesSent?: number | undefined;
1531
+ mid?: string | undefined;
1532
+ mediaSourceId?: string | undefined;
1533
+ remoteId?: string | undefined;
1534
+ rid?: string | undefined;
1535
+ headerBytesSent?: number | undefined;
1536
+ retransmittedPacketsSent?: number | undefined;
1537
+ retransmittedBytesSent?: number | undefined;
1538
+ rtxSsrc?: number | undefined;
1539
+ targetBitrate?: number | undefined;
1540
+ totalEncodedBytesTarget?: number | undefined;
1541
+ frameWidth?: number | undefined;
1542
+ frameHeight?: number | undefined;
1543
+ framesPerSecond?: number | undefined;
1544
+ framesSent?: number | undefined;
1545
+ hugeFramesSent?: number | undefined;
1546
+ framesEncoded?: number | undefined;
1547
+ keyFramesEncoded?: number | undefined;
1548
+ qpSum?: number | undefined;
1549
+ totalEncodeTime?: number | undefined;
1550
+ totalPacketSendDelay?: number | undefined;
1551
+ qualityLimitationReason?: string | undefined;
1552
+ qualityLimitationResolutionChanges?: number | undefined;
1553
+ nackCount?: number | undefined;
1554
+ firCount?: number | undefined;
1555
+ pliCount?: number | undefined;
1556
+ encoderImplementation?: string | undefined;
1557
+ powerEfficientEncoder?: boolean | undefined;
1558
+ active?: boolean | undefined;
1559
+ scalabilityMode?: string | undefined;
1560
+ qualityLimitationDurations?: QualityLimitationDurations | undefined;
1561
+ attachments?: Record<string, unknown> | undefined;
1562
+ bitrate: number;
1563
+ payloadBitrate: number;
1564
+ packetRate: number;
1565
+ bitPerPixel: number;
1566
+ deltaPacketsSent: number;
1567
+ deltaBytesSent: number;
1568
+ remoteRttInMs?: number;
1569
+ remoteFractionLost?: number;
1570
+ remoteJitter?: number;
1571
+ remotePacketsLost?: number;
1572
+ constructor(timestamp: number, id: string, ssrc: number, kind: MediaKind, _peerConnection: ObservedPeerConnection);
1573
+ get visited(): boolean;
1574
+ getPeerConnection(): ObservedPeerConnection;
1575
+ getRemoteInboundRtp(): ObservedRemoteInboundRtp | undefined;
1576
+ getCodec(): ObservedCodec | undefined;
1577
+ getMediaSource(): ObservedMediaSource | undefined;
1578
+ getTrack(): ObservedOutboundTrack | undefined;
1579
+ update(stats: OutboundRtpStats): void;
1580
+ }
1581
+
1582
+ type InboundAudioTrackReport = {
1583
+ trackId: string;
1584
+ fractionLostDistribution: {
1585
+ lt001: number;
1586
+ lt005: number;
1587
+ lt010: number;
1588
+ lt020: number;
1589
+ lt050: number;
1590
+ gtOrEq050: number;
1591
+ count: number;
1592
+ sum: number;
1593
+ };
1594
+ };
1595
+ type InboundVideoTrackReport = {
1596
+ trackId: string;
1597
+ fractionLostDistribution: {
1598
+ lt001: number;
1599
+ lt005: number;
1600
+ lt010: number;
1601
+ lt020: number;
1602
+ lt050: number;
1603
+ gtOrEq050: number;
1604
+ count: number;
1605
+ sum: number;
1606
+ };
1607
+ };
1608
+ type OutboundAudioTrackReport = {
1609
+ trackId: string;
1610
+ };
1611
+ type OutboundVideoTrackReport = {
1612
+ trackId: string;
1613
+ };
1614
+ type InboundTrackReport = ({
1615
+ kind: 'audio';
1616
+ } & InboundAudioTrackReport) | ({
1617
+ kind: 'video';
1618
+ } & InboundVideoTrackReport);
1619
+ type OutboundTrackReport = ({
1620
+ kind: 'audio';
1621
+ } & OutboundAudioTrackReport) | ({
1622
+ kind: 'video';
1623
+ } & OutboundVideoTrackReport);
1624
+ type TrackReport = ({
1625
+ direction: 'inbound';
1626
+ } & InboundTrackReport) | ({
1627
+ direction: 'outbound';
1628
+ } & OutboundTrackReport);
1629
+ type ClientReport = {
1630
+ callId: string;
1631
+ clientId: string;
1632
+ totalDataChannelBytesReceived: number;
1633
+ totalDataChannelBytesSent: number;
1634
+ totalDataChannelMessagesReceived: number;
1635
+ totalDataChannelMessagesSent: number;
1636
+ totalInboundRtpPacketsReceived: number;
1637
+ totalInboundRtpPacketsLost: number;
1638
+ totalInboundRtpBytesReceived: number;
1639
+ totalOutboundRtpPacketsSent: number;
1640
+ totalOutboundRtpBytesSent: number;
1641
+ totalAudioBytesReceived: number;
1642
+ totalVideoBytesReceived: number;
1643
+ totalAudioBytesSent: number;
1644
+ totalVideoBytesSent: number;
1645
+ totalNumberOfIssues: number;
1646
+ issues: Record<string, number>;
1647
+ rttDistribution: {
1648
+ lt50ms: number;
1649
+ lt150ms: number;
1650
+ lt300ms: number;
1651
+ gtOrEq300ms: number;
1652
+ count: number;
1653
+ sum: number;
1654
+ };
1655
+ scoreDistribution: {
1656
+ '0': number;
1657
+ '1': number;
1658
+ '2': number;
1659
+ '3': number;
1660
+ '4': number;
1661
+ '5': number;
1662
+ count: number;
1663
+ sum: number;
1664
+ };
1665
+ };
1666
+
1667
+ declare class ObservedOutboundTrack implements OutboundTrackSample {
1668
+ timestamp: number;
1669
+ readonly id: string;
1670
+ readonly kind: MediaKind;
1671
+ private readonly _peerConnection;
1672
+ private readonly _outboundRtps?;
1673
+ private readonly _mediaSource?;
1674
+ private _visited;
1675
+ appData?: Record<string, unknown>;
1676
+ readonly report: OutboundTrackReport;
1677
+ readonly calculatedScore: CalculatedScore;
1678
+ addedAt?: number | undefined;
1679
+ removedAt?: number | undefined;
1680
+ muted?: boolean;
1681
+ attachments?: Record<string, unknown> | undefined;
1682
+ constructor(timestamp: number, id: string, kind: MediaKind, _peerConnection: ObservedPeerConnection, _outboundRtps?: ObservedOutboundRtp[] | undefined, _mediaSource?: ObservedMediaSource | undefined);
1683
+ get score(): number | undefined;
1684
+ get visited(): boolean;
1685
+ getPeerConnection(): ObservedPeerConnection;
1686
+ getOutboundRtps(): ObservedOutboundRtp[] | undefined;
1687
+ getMediaSource(): ObservedMediaSource | undefined;
1688
+ getRemoteInboundTracks(): ObservedInboundTrack[] | undefined;
1689
+ update(stats: OutboundTrackSample): void;
1690
+ }
1691
+
1692
+ declare class ObservedMediaPlayout implements MediaPlayoutStats {
1693
+ timestamp: number;
1694
+ id: string;
1695
+ kind: MediaKind;
1696
+ private readonly _peerConnection;
1697
+ private _visited;
1698
+ appData?: Record<string, unknown>;
1699
+ synthesizedSamplesDuration?: number | undefined;
1700
+ synthesizedSamplesEvents?: number | undefined;
1701
+ totalSamplesDuration?: number | undefined;
1702
+ totalPlayoutDelay?: number | undefined;
1703
+ totalSamplesCount?: number | undefined;
1704
+ attachments?: Record<string, unknown> | undefined;
1705
+ constructor(timestamp: number, id: string, kind: MediaKind, _peerConnection: ObservedPeerConnection);
1706
+ get visited(): boolean;
1707
+ getPeerConnection(): ObservedPeerConnection;
1708
+ update(stats: MediaPlayoutStats): void;
1709
+ }
1710
+
1711
+ declare class ObservedInboundTrack implements InboundTrackSample {
1712
+ timestamp: number;
1713
+ readonly id: string;
1714
+ readonly kind: MediaKind;
1715
+ private readonly _peerConnection;
1716
+ private readonly _inboundRtp?;
1717
+ private readonly _mediaPlayout?;
1718
+ readonly calculatedScore: CalculatedScore;
1719
+ appData?: Record<string, unknown>;
1720
+ report: InboundTrackReport;
1721
+ private _visited;
1722
+ addedAt?: number | undefined;
1723
+ removedAt?: number | undefined;
1724
+ muted?: boolean;
1725
+ attachments?: Record<string, unknown> | undefined;
1726
+ constructor(timestamp: number, id: string, kind: MediaKind, _peerConnection: ObservedPeerConnection, _inboundRtp?: ObservedInboundRtp | undefined, _mediaPlayout?: ObservedMediaPlayout | undefined);
1727
+ get score(): number | undefined;
1728
+ get visited(): boolean;
1729
+ getPeerConnection(): ObservedPeerConnection;
1730
+ getInboundRtp(): ObservedInboundRtp | undefined;
1731
+ getMediaPlayout(): ObservedMediaPlayout | undefined;
1732
+ getRemoteOutboundTrack(): ObservedOutboundTrack | undefined;
1733
+ update(stats: InboundTrackSample): void;
1734
+ }
1735
+
1736
+ declare class ObservedRemoteOutboundRtp implements RemoteOutboundRtpStats {
1737
+ timestamp: number;
1738
+ id: string;
1739
+ ssrc: number;
1740
+ kind: MediaKind;
1741
+ private readonly _peerConnection;
1742
+ private _visited;
1743
+ appData?: Record<string, unknown>;
1744
+ transportId?: string | undefined;
1745
+ codecId?: string | undefined;
1746
+ packetsSent?: number | undefined;
1747
+ bytesSent?: number | undefined;
1748
+ localId?: string | undefined;
1749
+ remoteTimestamp?: number | undefined;
1750
+ reportsSent?: number | undefined;
1751
+ roundTripTime?: number | undefined;
1752
+ totalRoundTripTime?: number | undefined;
1753
+ roundTripTimeMeasurements?: number | undefined;
1754
+ attachments?: Record<string, unknown> | undefined;
1755
+ constructor(timestamp: number, id: string, ssrc: number, kind: MediaKind, _peerConnection: ObservedPeerConnection);
1756
+ get visited(): boolean;
1757
+ getPeerConnection(): ObservedPeerConnection;
1758
+ getInboundRtp(): ObservedInboundRtp | undefined;
1759
+ getCodec(): ObservedCodec | undefined;
1760
+ update(stats: RemoteOutboundRtpStats): void;
1761
+ }
1762
+
1763
+ declare class ObservedInboundRtp implements InboundRtpStats {
1764
+ timestamp: number;
1765
+ id: string;
1766
+ ssrc: number;
1767
+ kind: MediaKind;
1768
+ trackIdentifier: string;
1769
+ private readonly _peerConnection;
1770
+ appData?: Record<string, unknown>;
1771
+ private _visited;
1772
+ transportId?: string | undefined;
1773
+ codecId?: string | undefined;
1774
+ packetsReceived?: number | undefined;
1775
+ packetsLost?: number | undefined;
1776
+ mid?: string | undefined;
1777
+ remoteId?: string | undefined;
1778
+ framesDecoded?: number | undefined;
1779
+ keyFramesDecoded?: number | undefined;
1780
+ framesRendered?: number | undefined;
1781
+ framesDropped?: number | undefined;
1782
+ frameWidth?: number | undefined;
1783
+ frameHeight?: number | undefined;
1784
+ framesPerSecond?: number | undefined;
1785
+ qpSum?: number | undefined;
1786
+ totalDecodeTime?: number | undefined;
1787
+ totalInterFrameDelay?: number | undefined;
1788
+ totalSquaredInterFrameDelay?: number | undefined;
1789
+ pauseCount?: number | undefined;
1790
+ totalPausesDuration?: number | undefined;
1791
+ freezeCount?: number | undefined;
1792
+ totalFreezesDuration?: number | undefined;
1793
+ lastPacketReceivedTimestamp?: number | undefined;
1794
+ headerBytesReceived?: number | undefined;
1795
+ packetsDiscarded?: number | undefined;
1796
+ fecBytesReceived?: number | undefined;
1797
+ fecPacketsReceived?: number | undefined;
1798
+ fecPacketsDiscarded?: number | undefined;
1799
+ bytesReceived?: number | undefined;
1800
+ nackCount?: number | undefined;
1801
+ firCount?: number | undefined;
1802
+ pliCount?: number | undefined;
1803
+ totalProcessingDelay?: number | undefined;
1804
+ estimatedPlayoutTimestamp?: number | undefined;
1805
+ jitterBufferDelay?: number | undefined;
1806
+ jitterBufferTargetDelay?: number | undefined;
1807
+ jitterBufferEmittedCount?: number | undefined;
1808
+ jitterBufferMinimumDelay?: number | undefined;
1809
+ totalSamplesReceived?: number | undefined;
1810
+ concealedSamples?: number | undefined;
1811
+ silentConcealedSamples?: number | undefined;
1812
+ concealmentEvents?: number | undefined;
1813
+ insertedSamplesForDeceleration?: number | undefined;
1814
+ removedSamplesForAcceleration?: number | undefined;
1815
+ audioLevel?: number | undefined;
1816
+ totalAudioEnergy?: number | undefined;
1817
+ totalSamplesDuration?: number | undefined;
1818
+ framesReceived?: number | undefined;
1819
+ decoderImplementation?: string | undefined;
1820
+ playoutId?: string | undefined;
1821
+ powerEfficientDecoder?: boolean | undefined;
1822
+ framesAssembledFromMultiplePackets?: number | undefined;
1823
+ totalAssemblyTime?: number | undefined;
1824
+ retransmittedPacketsReceived?: number | undefined;
1825
+ retransmittedBytesReceived?: number | undefined;
1826
+ rtxSsrc?: number | undefined;
1827
+ fecSsrc?: number | undefined;
1828
+ totalCorruptionProbability?: number | undefined;
1829
+ totalSquaredCorruptionProbability?: number | undefined;
1830
+ corruptionMeasurements?: number | undefined;
1831
+ attachments?: Record<string, unknown> | undefined;
1832
+ jitter?: number | undefined;
1833
+ bitrate: number;
1834
+ fractionLost?: number;
1835
+ bitPerPixel: number;
1836
+ deltaLostPackets: number;
1837
+ deltaReceivedPackets: number;
1838
+ deltaBytesReceived: number;
1839
+ deltaReceivedSamples: number;
1840
+ deltaSilentConcealedSamples: number;
1841
+ remoteRttInMs?: number;
1842
+ remoteBytesSent?: number;
1843
+ remotePacketsSent?: number;
1844
+ remoteTimestamp?: number;
1845
+ constructor(timestamp: number, id: string, ssrc: number, kind: MediaKind, trackIdentifier: string, _peerConnection: ObservedPeerConnection);
1846
+ get visited(): boolean;
1847
+ getPeerConnection(): ObservedPeerConnection;
1848
+ getRemoteOutboundRtp(): ObservedRemoteOutboundRtp | undefined;
1849
+ getIceTransport(): ObservedIceTransport | undefined;
1850
+ getCodec(): ObservedCodec | undefined;
1851
+ getMediaPlayout(): ObservedMediaPlayout | undefined;
1852
+ getTrack(): ObservedInboundTrack | undefined;
1853
+ update(stats: InboundRtpStats): void;
1854
+ }
1855
+
1856
+ declare class ObservedCertificate implements CertificateStats {
1857
+ timestamp: number;
1858
+ id: string;
1859
+ private readonly _peerConnection;
1860
+ appData?: Record<string, unknown>;
1861
+ private _visited;
1862
+ fingerprint?: string;
1863
+ fingerprintAlgorithm?: string;
1864
+ base64Certificate?: string;
1865
+ issuerCertificateId?: string;
1866
+ attachments?: Record<string, unknown>;
1867
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1868
+ get visited(): boolean;
1869
+ getPeerConnection(): ObservedPeerConnection;
1870
+ update(stats: CertificateStats): void;
1871
+ }
1872
+
1873
+ declare class ObservedDataChannel implements DataChannelStats {
1874
+ timestamp: number;
1875
+ id: string;
1876
+ private readonly _peerConnection;
1877
+ private _visited;
1878
+ label?: string | undefined;
1879
+ protocol?: string | undefined;
1880
+ dataChannelIdentifier?: number | undefined;
1881
+ state?: string | undefined;
1882
+ messagesSent?: number | undefined;
1883
+ bytesSent?: number | undefined;
1884
+ messagesReceived?: number | undefined;
1885
+ bytesReceived?: number | undefined;
1886
+ attachments?: Record<string, unknown> | undefined;
1887
+ addedAt?: number | undefined;
1888
+ removedAt?: number | undefined;
1889
+ deltaBytesSent: number;
1890
+ deltaBytesReceived: number;
1891
+ deltaMessagesSent: number;
1892
+ deltaMessagesReceived: number;
1893
+ appData?: Record<string, unknown>;
1894
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1895
+ get visited(): boolean;
1896
+ getPeerConnection(): ObservedPeerConnection;
1897
+ update(stats: DataChannelStats): void;
1898
+ }
1899
+
1900
+ declare class ObservedPeerConnectionTransport implements PeerConnectionTransportStats {
1901
+ timestamp: number;
1902
+ id: string;
1903
+ private readonly _peerConnection;
1904
+ private _visited;
1905
+ appData?: Record<string, unknown>;
1906
+ dataChannelsOpened?: number | undefined;
1907
+ dataChannelsClosed?: number | undefined;
1908
+ attachments?: Record<string, unknown> | undefined;
1909
+ constructor(timestamp: number, id: string, _peerConnection: ObservedPeerConnection);
1910
+ get visited(): boolean;
1911
+ getPeerConnection(): ObservedPeerConnection;
1912
+ update(stats: PeerConnectionTransportStats): void;
1913
+ }
1914
+
1915
+ type ObservedTURNEventMap = {
1916
+ 'update': [ObservedTURN];
1917
+ 'close': [];
1918
+ };
1919
+ declare interface ObservedTURN {
1920
+ on<U extends keyof ObservedTURNEventMap>(event: U, listener: (...args: ObservedTURNEventMap[U]) => void): this;
1921
+ off<U extends keyof ObservedTURNEventMap>(event: U, listener: (...args: ObservedTURNEventMap[U]) => void): this;
1922
+ once<U extends keyof ObservedTURNEventMap>(event: U, listener: (...args: ObservedTURNEventMap[U]) => void): this;
1923
+ emit<U extends keyof ObservedTURNEventMap>(event: U, ...args: ObservedTURNEventMap[U]): boolean;
1924
+ }
1925
+ declare class ObservedTURN extends EventEmitter {
1926
+ totalBytesSent: number;
1927
+ totalBytesReceived: number;
1928
+ totalPacketsSent: number;
1929
+ totalPacketsReceived: number;
1930
+ packetsSentPerSecond: number;
1931
+ packetsReceivedPerSecond: number;
1932
+ outboundBitrate: number;
1933
+ inboundBitrate: number;
1934
+ numberOfClients: number;
1935
+ readonly servers: Map<string, ObservedTurnServer>;
1936
+ constructor();
1937
+ update(): void;
1938
+ addPeerConnection(peerConnection: ObservedPeerConnection): ObservedTurnServer | undefined;
1939
+ removePeerConnection(peerConnection: ObservedPeerConnection): void;
1940
+ }
1941
+
1942
+ declare class ObservedTurnServer {
1943
+ readonly url: string;
1944
+ readonly observedTURN: ObservedTURN;
1945
+ totalBytesSent: number;
1946
+ totalBytesReceived: number;
1947
+ totalPacketsSent: number;
1948
+ totalPacketsReceived: number;
1949
+ packetsSentPerSecond: number;
1950
+ packetsReceivedPerSecond: number;
1951
+ outboundBitrate: number;
1952
+ inboundBitrate: number;
1953
+ deltaBytesSent: number;
1954
+ deltaBytesReceived: number;
1955
+ deltaPacketsSent: number;
1956
+ deltaPacketsReceived: number;
1957
+ readonly observedPeerConnections: Map<string, ObservedPeerConnection>;
1958
+ updated: number;
1959
+ constructor(url: string, observedTURN: ObservedTURN);
1960
+ updateTurnUsage(...selectedcandidatepairs: ObservedIceCandidatePair[]): void;
1961
+ update(): void;
1962
+ }
1963
+
1964
+ type ObservedPeerConnectionEvents = {
1965
+ 'removed-inbound-track': [ObservedInboundTrack];
1966
+ 'removed-outbound-track': [ObservedOutboundTrack];
1967
+ close: [];
1968
+ };
1969
+ declare interface ObservedPeerConnection {
1970
+ on<U extends keyof ObservedPeerConnectionEvents>(event: U, listener: (...args: ObservedPeerConnectionEvents[U]) => void): this;
1971
+ off<U extends keyof ObservedPeerConnectionEvents>(event: U, listener: (...args: ObservedPeerConnectionEvents[U]) => void): this;
1972
+ once<U extends keyof ObservedPeerConnectionEvents>(event: U, listener: (...args: ObservedPeerConnectionEvents[U]) => void): this;
1973
+ emit<U extends keyof ObservedPeerConnectionEvents>(event: U, ...args: ObservedPeerConnectionEvents[U]): boolean;
1974
+ }
1975
+ declare class ObservedPeerConnection extends EventEmitter {
1976
+ readonly peerConnectionId: string;
1977
+ readonly client: ObservedClient;
1978
+ private _visited;
1979
+ appData?: Record<string, unknown>;
1980
+ readonly calculatedScore: CalculatedScore;
1981
+ closed: boolean;
1982
+ openedAt?: number;
1983
+ closedAt?: number;
1984
+ updated: number;
1985
+ connectionState?: 'new' | 'connecting' | 'connected' | 'disconnected' | 'failed' | 'closed';
1986
+ iceConnectionState?: 'new' | 'checking' | 'connected' | 'completed' | 'failed' | 'disconnected' | 'closed';
1987
+ iceGatheringState?: 'new' | 'gathering' | 'complete';
1988
+ availableIncomingBitrate: number;
1989
+ availableOutgoingBitrate: number;
1990
+ totalInboundPacketsLost: number;
1991
+ totalInboundPacketsReceived: number;
1992
+ totalOutboundPacketsSent: number;
1993
+ totalDataChannelBytesSent: number;
1994
+ totalDataChannelBytesReceived: number;
1995
+ totalDataChannelMessagesSent: number;
1996
+ totalDataChannelMessagesReceived: number;
1997
+ totalSentAudioBytes: number;
1998
+ totalSentVideoBytes: number;
1999
+ totalSentAudioPackets: number;
2000
+ totalSentVideoPackets: number;
2001
+ totalReceivedAudioPacktes: number;
2002
+ totalReceivedVideoPackets: number;
2003
+ totalReceivedAudioBytes: number;
2004
+ totalReceivedVideoBytes: number;
2005
+ deltaInboundPacketsLost: number;
2006
+ deltaInboundPacketsReceived: number;
2007
+ deltaOutboundPacketsSent: number;
2008
+ deltaDataChannelBytesSent: number;
2009
+ deltaDataChannelBytesReceived: number;
2010
+ deltaDataChannelMessagesSent: number;
2011
+ deltaDataChannelMessagesReceived: number;
2012
+ deltaInboundReceivedBytes: number;
2013
+ deltaOutboundSentBytes: number;
2014
+ deltaReceivedAudioBytes: number;
2015
+ deltaReceivedVideoBytes: number;
2016
+ deltaReceivedAudioPackets: number;
2017
+ deltaReceivedVideoPackets: number;
2018
+ deltaSentAudioBytes: number;
2019
+ deltaSentVideoBytes: number;
2020
+ deltaSentAudioPackets: number;
2021
+ deltaSentVideoPackets: number;
2022
+ deltaTransportSentBytes: number;
2023
+ deltaTransportReceivedBytes: number;
2024
+ receivingPacketsPerSecond: number;
2025
+ sendingPacketsPerSecond: number;
2026
+ sendingAudioBitrate: number;
2027
+ sendingVideoBitrate: number;
2028
+ receivingAudioBitrate: number;
2029
+ receivingVideoBitrate: number;
2030
+ currentRttInMs?: number;
2031
+ currentJitter?: number;
2032
+ usingTCP: boolean;
2033
+ usingTURN: boolean;
2034
+ observedTurnServer?: ObservedTurnServer;
2035
+ readonly observedCertificates: Map<string, ObservedCertificate>;
2036
+ readonly observedCodecs: Map<string, ObservedCodec>;
2037
+ readonly observedDataChannels: Map<string, ObservedDataChannel>;
2038
+ readonly observedIceCandidates: Map<string, ObservedIceCandidate>;
2039
+ readonly observedIceCandidatesPair: Map<string, ObservedIceCandidatePair>;
2040
+ readonly observedIceTransports: Map<string, ObservedIceTransport>;
2041
+ readonly observedInboundRtps: Map<number, ObservedInboundRtp>;
2042
+ readonly observedInboundTracks: Map<string, ObservedInboundTrack>;
2043
+ readonly observedMediaPlayouts: Map<string, ObservedMediaPlayout>;
2044
+ readonly observedMediaSources: Map<string, ObservedMediaSource>;
2045
+ readonly observedOutboundRtps: Map<number, ObservedOutboundRtp>;
2046
+ readonly observedOutboundTracks: Map<string, ObservedOutboundTrack>;
2047
+ readonly observedPeerConnectionTransports: Map<string, ObservedPeerConnectionTransport>;
2048
+ readonly observedRemoteInboundRtps: Map<number, ObservedRemoteInboundRtp>;
2049
+ readonly observedRemoteOutboundRtps: Map<number, ObservedRemoteOutboundRtp>;
2050
+ private readonly eventScope;
2051
+ constructor(peerConnectionId: string, client: ObservedClient);
2052
+ get score(): number | undefined;
2053
+ get visited(): boolean;
2054
+ get codecs(): ObservedCodec[];
2055
+ get inboundRtps(): ObservedInboundRtp[];
2056
+ get remoteOutboundRtps(): ObservedRemoteOutboundRtp[];
2057
+ get outboundRtps(): ObservedOutboundRtp[];
2058
+ get remoteInboundRtps(): ObservedRemoteInboundRtp[];
2059
+ get mediaSources(): ObservedMediaSource[];
2060
+ get mediaPlayouts(): ObservedMediaPlayout[];
2061
+ get dataChannels(): ObservedDataChannel[];
2062
+ get peerConnectionTransports(): ObservedPeerConnectionTransport[];
2063
+ get iceTransports(): ObservedIceTransport[];
2064
+ get iceCandidates(): ObservedIceCandidate[];
2065
+ get iceCandidatePairs(): ObservedIceCandidatePair[];
2066
+ get certificates(): ObservedCertificate[];
2067
+ get selectedIceCandidatePairs(): ObservedIceCandidatePair[];
2068
+ get selectedIceCandiadtePairForTurn(): ObservedIceCandidatePair[];
2069
+ close(): void;
2070
+ accept(sample: PeerConnectionSample, context?: AcceptContext): void;
2071
+ private _checkVisited;
2072
+ private _updateCertificateStats;
2073
+ private _updateCodecStats;
2074
+ private _updateDataChannelStats;
2075
+ private _updateIceCandidateStats;
2076
+ private _updateIceCandidatePairStats;
2077
+ private _updateIceTransportStats;
2078
+ private _updateInboundRtpStats;
2079
+ private _updateInboundTrackSample;
2080
+ private _updateMediaPlayoutStats;
2081
+ private _updateMediaSourceStats;
2082
+ private _updateOutboundRtpStats;
2083
+ private _updateOutboundTrackSample;
2084
+ private _updatePeerConnectionTransportStats;
2085
+ private _updateRemoteInboundRtpStats;
2086
+ private _updateRemoteOutboundRtpStats;
2087
+ /** Emit an Observer-bus event scoped to this peer connection. */
2088
+ private _notify;
2089
+ }
2090
+
2091
+ declare enum ClientMetaTypes {
2092
+ MEDIA_CONSTRAINT = "MEDIA_CONSTRAINT",
2093
+ MEDIA_DEVICE = "MEDIA_DEVICE",
2094
+ MEDIA_DEVICES_SUPPORTED_CONSTRAINTS = "MEDIA_DEVICES_SUPPORTED_CONSTRAINTS",
2095
+ USER_MEDIA_ERROR = "USER_MEDIA_ERROR",
2096
+ LOCAL_SDP = "LOCAL_SDP",
2097
+ OPERATION_SYSTEM = "OPERATION_SYSTEM",
2098
+ ENGINE = "ENGINE",
2099
+ PLATFORM = "PLATFORM",
2100
+ BROWSER = "BROWSER"
2101
+ }
2102
+ type MediaDeviceInfo = {
2103
+ deviceId: string;
2104
+ label: string;
2105
+ kind: string;
2106
+ groupId: string;
2107
+ };
2108
+ type Browser = {
2109
+ name: string;
2110
+ version: string;
2111
+ };
2112
+ type Platform = {
2113
+ name: string;
2114
+ version: string;
2115
+ };
2116
+ type Engine = {
2117
+ name: string;
2118
+ version: string;
2119
+ };
2120
+ type OperationSystem = {
2121
+ name: string;
2122
+ version: string;
2123
+ };
2124
+
2125
+ /** The lifecycle events a sink may emit (a subset of Node's writable-stream events). */
2126
+ type ClientSampleSinkEvents = {
2127
+ /** The destination is fully written and closed (e.g. a file flushed and its fd closed). */
2128
+ close: [];
2129
+ /** The destination failed. */
2130
+ error: [Error];
2131
+ /** `end()` was processed and all queued data was flushed (before `close`). */
2132
+ finish: [];
2133
+ /** The buffer drained after backpressure; safe to write more. */
2134
+ drain: [];
2135
+ };
2136
+ declare interface ClientSampleSink {
2137
+ on<E extends keyof ClientSampleSinkEvents>(event: E, listener: (...args: ClientSampleSinkEvents[E]) => void): this;
2138
+ once<E extends keyof ClientSampleSinkEvents>(event: E, listener: (...args: ClientSampleSinkEvents[E]) => void): this;
2139
+ off<E extends keyof ClientSampleSinkEvents>(event: E, listener: (...args: ClientSampleSinkEvents[E]) => void): this;
2140
+ emit<E extends keyof ClientSampleSinkEvents>(event: E, ...args: ClientSampleSinkEvents[E]): boolean;
2141
+ }
2142
+ /**
2143
+ * A per-client destination for accepted samples — a typed `EventEmitter` base class. One sink is
2144
+ * created per `ObservedClient` (via `ObserverConfig.createClientSink`). It is **object-mode**:
2145
+ * `write` receives the `ClientSample` itself, so each sink decides how to serialize it (JSON
2146
+ * line, protobuf, msgpack, a remote payload, …).
2147
+ *
2148
+ * The library calls `write(sample)` synchronously per accepted sample (not awaited), `end()`s the
2149
+ * sink when the client closes, and attaches an `error` listener so a failing sink can't crash the
2150
+ * process. The application — which created the sink — listens for `close` (destination ready,
2151
+ * e.g. a file flushed and its fd closed) and `error`.
2152
+ *
2153
+ * Subclass this and implement `write`/`end` (and `emit` your lifecycle events). Built-in sinks
2154
+ * (`JsonlFileSink`, `InMemorySink`) and their factories are exported from the package root.
2155
+ */
2156
+ declare abstract class ClientSampleSink extends EventEmitter {
2157
+ /** Accept one sample; the sink serializes it however it likes. `false` signals backpressure. */
2158
+ abstract write(sample: ClientSample): boolean;
2159
+ /** Finish writing; the sink flushes and (if applicable) emits `close`. */
2160
+ abstract end(): void;
2161
+ }
2162
+ /**
2163
+ * Produces a sink for a newly-created client, or `undefined` for no sink. Receives the
2164
+ * client id and its (already-created) parent call, so the destination can be derived
2165
+ * from `callId` / `clientId`.
2166
+ */
2167
+ type ClientSampleSinkFactory = (params: {
2168
+ clientId: string;
2169
+ observedCall: ObservedCall;
2170
+ }) => ClientSampleSink | undefined;
2171
+
2172
+ /**
2173
+ * The Observer is the single event bus for the whole hierarchy. Every event
2174
+ * worth subscribing to is emitted on the Observer with a payload object that
2175
+ * carries the ancestry of the entity it originates from, down to the subject,
2176
+ * plus the optional `context` passed through `accept(sample, context?)`.
2177
+ *
2178
+ * Lifecycle/coordination events (close, update, joined, left, newclient, ...)
2179
+ * remain as local EventEmitter events on each Observed* component so that
2180
+ * parent/child teardown and the updaters can wire to them directly.
2181
+ */
2182
+ /** Base fields present on every Observer event payload. */
2183
+ type ObserverEventBase = {
2184
+ observer: Observer;
2185
+ context?: AcceptContext;
2186
+ };
2187
+ /** Scope reaching a call. */
2188
+ type ObservedCallScope = ObserverEventBase & {
2189
+ observedCall: ObservedCall;
2190
+ };
2191
+ /** Scope reaching a client (carries its call). */
2192
+ type ObservedClientScope = ObservedCallScope & {
2193
+ observedClient: ObservedClient;
2194
+ };
2195
+ /** Scope reaching a peer connection (carries its call and client). */
2196
+ type ObservedPeerConnectionScope = ObservedClientScope & {
2197
+ observedPeerConnection: ObservedPeerConnection;
2198
+ };
2199
+ type ObserverEvents = {
2200
+ 'observer-updated': [ObserverEventBase];
2201
+ 'observer-closed': [ObserverEventBase];
2202
+ 'sample-rejected': [ObserverEventBase & {
2203
+ reason: SampleRejectedReason;
2204
+ sample: ClientSample;
2205
+ }];
2206
+ 'call-added': [ObservedCallScope];
2207
+ 'call-updated': [ObservedCallScope];
2208
+ 'call-closed': [ObservedCallScope];
2209
+ 'call-empty': [ObservedCallScope];
2210
+ 'call-not-empty': [ObservedCallScope];
2211
+ 'call-issue': [ObservedCallScope & {
2212
+ issue: ClientIssue;
2213
+ }];
2214
+ 'client-added': [ObservedClientScope];
2215
+ 'client-sink-created': [ObservedClientScope & {
2216
+ sink: ClientSampleSink;
2217
+ }];
2218
+ 'client-updated': [ObservedClientScope & {
2219
+ sample: ClientSample;
2220
+ elapsedTimeInMs: number;
2221
+ }];
2222
+ 'client-closed': [ObservedClientScope];
2223
+ 'client-joined': [ObservedClientScope];
2224
+ 'client-left': [ObservedClientScope];
2225
+ 'client-rejoined': [ObservedClientScope & {
2226
+ timestamp: number;
2227
+ }];
2228
+ 'client-issue': [ObservedClientScope & {
2229
+ issue: ClientIssue;
2230
+ }];
2231
+ 'client-metadata': [ObservedClientScope & {
2232
+ metaData: ClientMetaData;
2233
+ }];
2234
+ 'client-extension-stats': [ObservedClientScope & {
2235
+ extensionStats: ExtensionStat;
2236
+ }];
2237
+ 'client-event': [ObservedClientScope & {
2238
+ event: ClientEvent;
2239
+ }];
2240
+ 'client-track-report': [ObservedClientScope & {
2241
+ report: TrackReport;
2242
+ }];
2243
+ 'peer-connection-added': [ObservedPeerConnectionScope];
2244
+ 'peer-connection-updated': [ObservedPeerConnectionScope];
2245
+ 'peer-connection-closed': [ObservedPeerConnectionScope];
2246
+ 'ice-connection-state-changed': [ObservedPeerConnectionScope & {
2247
+ state: string;
2248
+ }];
2249
+ 'ice-gathering-state-changed': [ObservedPeerConnectionScope & {
2250
+ state: string;
2251
+ }];
2252
+ 'connection-state-changed': [ObservedPeerConnectionScope & {
2253
+ state: string;
2254
+ }];
2255
+ 'selected-candidate-pair-changed': [ObservedPeerConnectionScope];
2256
+ 'certificate-added': [ObservedPeerConnectionScope & {
2257
+ observedCertificate: ObservedCertificate;
2258
+ }];
2259
+ 'certificate-updated': [ObservedPeerConnectionScope & {
2260
+ observedCertificate: ObservedCertificate;
2261
+ }];
2262
+ 'certificate-removed': [ObservedPeerConnectionScope & {
2263
+ observedCertificate: ObservedCertificate;
2264
+ }];
2265
+ 'codec-added': [ObservedPeerConnectionScope & {
2266
+ observedCodec: ObservedCodec;
2267
+ }];
2268
+ 'codec-updated': [ObservedPeerConnectionScope & {
2269
+ observedCodec: ObservedCodec;
2270
+ }];
2271
+ 'codec-removed': [ObservedPeerConnectionScope & {
2272
+ observedCodec: ObservedCodec;
2273
+ }];
2274
+ 'inbound-rtp-added': [ObservedPeerConnectionScope & {
2275
+ observedInboundRtp: ObservedInboundRtp;
2276
+ }];
2277
+ 'inbound-rtp-updated': [ObservedPeerConnectionScope & {
2278
+ observedInboundRtp: ObservedInboundRtp;
2279
+ }];
2280
+ 'inbound-rtp-removed': [ObservedPeerConnectionScope & {
2281
+ observedInboundRtp: ObservedInboundRtp;
2282
+ }];
2283
+ 'outbound-rtp-added': [ObservedPeerConnectionScope & {
2284
+ observedOutboundRtp: ObservedOutboundRtp;
2285
+ }];
2286
+ 'outbound-rtp-updated': [ObservedPeerConnectionScope & {
2287
+ observedOutboundRtp: ObservedOutboundRtp;
2288
+ }];
2289
+ 'outbound-rtp-removed': [ObservedPeerConnectionScope & {
2290
+ observedOutboundRtp: ObservedOutboundRtp;
2291
+ }];
2292
+ 'remote-inbound-rtp-added': [ObservedPeerConnectionScope & {
2293
+ observedRemoteInboundRtp: ObservedRemoteInboundRtp;
2294
+ }];
2295
+ 'remote-inbound-rtp-updated': [ObservedPeerConnectionScope & {
2296
+ observedRemoteInboundRtp: ObservedRemoteInboundRtp;
2297
+ }];
2298
+ 'remote-inbound-rtp-removed': [ObservedPeerConnectionScope & {
2299
+ observedRemoteInboundRtp: ObservedRemoteInboundRtp;
2300
+ }];
2301
+ 'remote-outbound-rtp-added': [ObservedPeerConnectionScope & {
2302
+ observedRemoteOutboundRtp: ObservedRemoteOutboundRtp;
2303
+ }];
2304
+ 'remote-outbound-rtp-updated': [ObservedPeerConnectionScope & {
2305
+ observedRemoteOutboundRtp: ObservedRemoteOutboundRtp;
2306
+ }];
2307
+ 'remote-outbound-rtp-removed': [ObservedPeerConnectionScope & {
2308
+ observedRemoteOutboundRtp: ObservedRemoteOutboundRtp;
2309
+ }];
2310
+ 'data-channel-added': [ObservedPeerConnectionScope & {
2311
+ observedDataChannel: ObservedDataChannel;
2312
+ }];
2313
+ 'data-channel-updated': [ObservedPeerConnectionScope & {
2314
+ observedDataChannel: ObservedDataChannel;
2315
+ }];
2316
+ 'data-channel-removed': [ObservedPeerConnectionScope & {
2317
+ observedDataChannel: ObservedDataChannel;
2318
+ }];
2319
+ 'ice-candidate-added': [ObservedPeerConnectionScope & {
2320
+ observedIceCandidate: ObservedIceCandidate;
2321
+ }];
2322
+ 'ice-candidate-updated': [ObservedPeerConnectionScope & {
2323
+ observedIceCandidate: ObservedIceCandidate;
2324
+ }];
2325
+ 'ice-candidate-removed': [ObservedPeerConnectionScope & {
2326
+ observedIceCandidate: ObservedIceCandidate;
2327
+ }];
2328
+ 'ice-candidate-pair-added': [ObservedPeerConnectionScope & {
2329
+ observedIceCandidatePair: ObservedIceCandidatePair;
2330
+ }];
2331
+ 'ice-candidate-pair-updated': [ObservedPeerConnectionScope & {
2332
+ observedIceCandidatePair: ObservedIceCandidatePair;
2333
+ }];
2334
+ 'ice-candidate-pair-removed': [ObservedPeerConnectionScope & {
2335
+ observedIceCandidatePair: ObservedIceCandidatePair;
2336
+ }];
2337
+ 'ice-transport-added': [ObservedPeerConnectionScope & {
2338
+ observedIceTransport: ObservedIceTransport;
2339
+ }];
2340
+ 'ice-transport-updated': [ObservedPeerConnectionScope & {
2341
+ observedIceTransport: ObservedIceTransport;
2342
+ }];
2343
+ 'ice-transport-removed': [ObservedPeerConnectionScope & {
2344
+ observedIceTransport: ObservedIceTransport;
2345
+ }];
2346
+ 'media-source-added': [ObservedPeerConnectionScope & {
2347
+ observedMediaSource: ObservedMediaSource;
2348
+ }];
2349
+ 'media-source-updated': [ObservedPeerConnectionScope & {
2350
+ observedMediaSource: ObservedMediaSource;
2351
+ }];
2352
+ 'media-source-removed': [ObservedPeerConnectionScope & {
2353
+ observedMediaSource: ObservedMediaSource;
2354
+ }];
2355
+ 'media-playout-added': [ObservedPeerConnectionScope & {
2356
+ observedMediaPlayout: ObservedMediaPlayout;
2357
+ }];
2358
+ 'media-playout-updated': [ObservedPeerConnectionScope & {
2359
+ observedMediaPlayout: ObservedMediaPlayout;
2360
+ }];
2361
+ 'media-playout-removed': [ObservedPeerConnectionScope & {
2362
+ observedMediaPlayout: ObservedMediaPlayout;
2363
+ }];
2364
+ 'peer-connection-transport-added': [ObservedPeerConnectionScope & {
2365
+ observedPeerConnectionTransport: ObservedPeerConnectionTransport;
2366
+ }];
2367
+ 'peer-connection-transport-updated': [ObservedPeerConnectionScope & {
2368
+ observedPeerConnectionTransport: ObservedPeerConnectionTransport;
2369
+ }];
2370
+ 'peer-connection-transport-removed': [ObservedPeerConnectionScope & {
2371
+ observedPeerConnectionTransport: ObservedPeerConnectionTransport;
2372
+ }];
2373
+ 'inbound-track-added': [ObservedPeerConnectionScope & {
2374
+ observedInboundTrack: ObservedInboundTrack;
2375
+ }];
2376
+ 'inbound-track-updated': [ObservedPeerConnectionScope & {
2377
+ observedInboundTrack: ObservedInboundTrack;
2378
+ }];
2379
+ 'inbound-track-removed': [ObservedPeerConnectionScope & {
2380
+ observedInboundTrack: ObservedInboundTrack;
2381
+ }];
2382
+ 'inbound-track-muted': [ObservedPeerConnectionScope & {
2383
+ observedInboundTrack: ObservedInboundTrack;
2384
+ }];
2385
+ 'inbound-track-unmuted': [ObservedPeerConnectionScope & {
2386
+ observedInboundTrack: ObservedInboundTrack;
2387
+ }];
2388
+ 'outbound-track-added': [ObservedPeerConnectionScope & {
2389
+ observedOutboundTrack: ObservedOutboundTrack;
2390
+ }];
2391
+ 'outbound-track-updated': [ObservedPeerConnectionScope & {
2392
+ observedOutboundTrack: ObservedOutboundTrack;
2393
+ }];
2394
+ 'outbound-track-removed': [ObservedPeerConnectionScope & {
2395
+ observedOutboundTrack: ObservedOutboundTrack;
2396
+ }];
2397
+ 'outbound-track-muted': [ObservedPeerConnectionScope & {
2398
+ observedOutboundTrack: ObservedOutboundTrack;
2399
+ }];
2400
+ 'outbound-track-unmuted': [ObservedPeerConnectionScope & {
2401
+ observedOutboundTrack: ObservedOutboundTrack;
2402
+ }];
2403
+ };
2404
+
2405
+ type ObservedClientSettings<AppData extends Record<string, unknown> = Record<string, unknown>> = {
2406
+ clientId: string;
2407
+ appData?: AppData;
2408
+ closeClientIfIdleForMs?: number;
2409
+ };
2410
+ type ObservedClientEvents = {
2411
+ update: [sample: ClientSample, elapsedTimeInMs: number, context?: AcceptContext];
2412
+ close: [];
2413
+ joined: [];
2414
+ left: [];
2415
+ };
2416
+ declare interface ObservedClient {
2417
+ on<U extends keyof ObservedClientEvents>(event: U, listener: (...args: ObservedClientEvents[U]) => void): this;
2418
+ off<U extends keyof ObservedClientEvents>(event: U, listener: (...args: ObservedClientEvents[U]) => void): this;
2419
+ once<U extends keyof ObservedClientEvents>(event: U, listener: (...args: ObservedClientEvents[U]) => void): this;
2420
+ emit<U extends keyof ObservedClientEvents>(event: U, ...args: ObservedClientEvents[U]): boolean;
2421
+ }
2422
+ declare class ObservedClient<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
2423
+ readonly call: ObservedCall;
2424
+ readonly clientId: string;
2425
+ readonly observedPeerConnections: Map<string, ObservedPeerConnection>;
2426
+ /** Per-client sink (from `ObserverConfig.createClientSink`), if any. */
2427
+ readonly sink?: ClientSampleSink;
2428
+ /** Ancestry base shared by all Observer-bus events originating at this client. */
2429
+ readonly eventScope: ObservedClientScope;
2430
+ readonly calculatedScore: CalculatedScore;
2431
+ readonly settings: Pick<ObservedClientSettings, 'closeClientIfIdleForMs'>;
2432
+ appData: AppData;
2433
+ attachments?: Record<string, unknown>;
2434
+ updated: number;
2435
+ acceptedSamples: number;
2436
+ closed: boolean;
2437
+ joinedAt?: number;
2438
+ leftAt?: number;
2439
+ closedAt?: number;
2440
+ lastSampleTimestamp?: number;
2441
+ operationSystem?: OperationSystem;
2442
+ engine?: Engine;
2443
+ platform?: Platform;
2444
+ browser?: Browser;
2445
+ mediaConstraints: string[];
2446
+ usingTURN: boolean;
2447
+ usingTCP: boolean;
2448
+ availableOutgoingBitrate: number;
2449
+ availableIncomingBitrate: number;
2450
+ deltaReceivedAudioBytes: number;
2451
+ deltaReceivedVideoBytes: number;
2452
+ deltaSentAudioBytes: number;
2453
+ deltaSentVideoBytes: number;
2454
+ deltaDataChannelBytesSent: number;
2455
+ deltaDataChannelBytesReceived: number;
2456
+ deltaDataChannelMessagesSent: number;
2457
+ deltaDataChannelMessagesReceived: number;
2458
+ deltaInboundPacketsLost: number;
2459
+ deltaInboundPacketsReceived: number;
2460
+ deltaOutboundPacketsSent: number;
2461
+ deltaTransportSentBytes: number;
2462
+ deltaTransportReceivedBytes: number;
2463
+ deltaRttLt50Measurements: number;
2464
+ deltaRttLt150Measurements: number;
2465
+ deltaRttLt300Measurements: number;
2466
+ deltaRttGtOrEq300Measurements: number;
2467
+ currentMaxRttInMs?: number;
2468
+ currentMinRttInMs?: number;
2469
+ currentAvgRttInMs?: number;
2470
+ sendingAudioBitrate: number;
2471
+ sendingVideoBitrate: number;
2472
+ receivingAudioBitrate: number;
2473
+ receivingVideoBitrate: number;
2474
+ numberOfInboundRtpStreams: number;
2475
+ numberOfInbundTracks: number;
2476
+ numberOfOutboundRtpStreams: number;
2477
+ numberOfOutboundTracks: number;
2478
+ numberOfDataChannels: number;
2479
+ deltaNumberOfIssues: number;
2480
+ totalScoreSum: number;
2481
+ numberOfScoreMeasurements: number;
2482
+ readonly report: ClientReport;
2483
+ readonly mediaDevices: MediaDeviceInfo[];
2484
+ issues: ClientIssue[];
2485
+ private _injections;
2486
+ private closeTimer?;
2487
+ constructor(settings: ObservedClientSettings<AppData>, call: ObservedCall);
2488
+ get numberOfPeerConnections(): number;
2489
+ get score(): number | undefined;
2490
+ close(): void;
2491
+ accept(sample: ClientSample, context?: AcceptContext): void;
2492
+ injectMetaData(metaData: ClientMetaData): void;
2493
+ injectEvent(event: ClientEvent): void;
2494
+ injectIssue(issue: ClientIssue): void;
2495
+ injectExtensionStat(stat: ExtensionStat): void;
2496
+ injectAttachment(key: string, value: unknown): void;
2497
+ addMetadata(metadata: ClientMetaData): void;
2498
+ addIssue(issue: ClientIssue): void;
2499
+ addExtensionStats(stats: ExtensionStat): void;
2500
+ private _processClientEvent;
2501
+ private _updatePeerConnection;
2502
+ private _mergeInjections;
2503
+ /** Emit an Observer-bus event scoped to this client (or a peer connection under it). */
2504
+ private _notify;
2505
+ }
2506
+
2507
+ interface ScoreCalculator {
2508
+ update(): void;
2509
+ }
2510
+
2511
+ interface RemoteTrackResolver {
2512
+ resolveRemoteOutboundTrack(inboundTrack: ObservedInboundTrack): ObservedOutboundTrack | undefined;
2513
+ resolveRemoteInboundTracks(outboundTrack: ObservedOutboundTrack): ObservedInboundTrack[] | undefined;
2514
+ }
2515
+
2516
+ interface Updater {
2517
+ readonly name: string;
2518
+ readonly description?: string;
2519
+ close(): void;
2520
+ }
2521
+
2522
+ interface Detector {
2523
+ readonly name: string;
2524
+ /** Called on every entity update; may raise issues via the entity it observes. */
2525
+ update(): void;
2526
+ }
2527
+
2528
+ declare class Detectors {
2529
+ private _detectors;
2530
+ constructor(...detectors: Detector[]);
2531
+ get listOfNames(): string[];
2532
+ add(detector: Detector): void;
2533
+ remove(detector: Detector): void;
2534
+ update(): void;
2535
+ clear(): void;
2536
+ }
2537
+
2538
+ type ObservedCallUpdateConfig = {
2539
+ updatePolicy: 'update-on-interval';
2540
+ updateIntervalInMs: number;
2541
+ } | {
2542
+ updatePolicy?: 'update-on-any-client-updated' | 'update-when-all-client-updated';
2543
+ updateIntervalInMs?: number;
2544
+ };
2545
+ type ObservedCallSettings<AppData extends Record<string, unknown> = Record<string, unknown>> = ObservedCallUpdateConfig & {
2546
+ callId: string;
2547
+ appData?: AppData;
2548
+ remoteTrackResolvePolicy?: 'p2p' | 'mediasoup-sfu' | 'none';
2549
+ closeCallIfEmptyForMs?: number;
2550
+ };
2551
+ type ObservedCallEvents = {
2552
+ update: [];
2553
+ newclient: [ObservedClient];
2554
+ empty: [];
2555
+ 'not-empty': [];
2556
+ close: [];
2557
+ };
2558
+ declare interface ObservedCall {
2559
+ on<U extends keyof ObservedCallEvents>(event: U, listener: (...args: ObservedCallEvents[U]) => void): this;
2560
+ off<U extends keyof ObservedCallEvents>(event: U, listener: (...args: ObservedCallEvents[U]) => void): this;
2561
+ once<U extends keyof ObservedCallEvents>(event: U, listener: (...args: ObservedCallEvents[U]) => void): this;
2562
+ emit<U extends keyof ObservedCallEvents>(event: U, ...args: ObservedCallEvents[U]): boolean;
2563
+ }
2564
+ declare class ObservedCall<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
2565
+ readonly observer: Observer;
2566
+ updater?: Updater;
2567
+ scoreCalculator: ScoreCalculator;
2568
+ readonly detectors: Detectors;
2569
+ readonly callId: string;
2570
+ readonly observedClients: Map<string, ObservedClient<Record<string, unknown>>>;
2571
+ readonly clientsUsedTurn: Set<string>;
2572
+ readonly calculatedScore: CalculatedScore;
2573
+ remoteTrackResolver?: RemoteTrackResolver;
2574
+ totalAddedClients: number;
2575
+ totalRemovedClients: number;
2576
+ numberOfIssues: number;
2577
+ numberOfPeerConnections: number;
2578
+ numberOfInboundRtpStreams: number;
2579
+ numberOfOutboundRtpStreams: number;
2580
+ numberOfDataChannels: number;
2581
+ maxNumberOfClients: number;
2582
+ deltaNumberOfIssues: number;
2583
+ appData: AppData;
2584
+ closed: boolean;
2585
+ startedAt?: number;
2586
+ endedAt?: number;
2587
+ closedAt?: number;
2588
+ readonly settings: Pick<ObservedCallSettings, 'closeCallIfEmptyForMs'>;
2589
+ /** Ancestry base shared by all Observer-bus events originating at this call. */
2590
+ readonly eventScope: ObservedCallScope;
2591
+ private closeTimer?;
2592
+ constructor(settings: ObservedCallSettings<AppData>, observer: Observer);
2593
+ get numberOfClients(): number;
2594
+ get score(): number | undefined;
2595
+ /** Raise a call-level (server-side) issue; surfaced on the Observer bus as `call-issue`. */
2596
+ addIssue(issue: ClientIssue): void;
2597
+ close(): void;
2598
+ getObservedClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(clientId: string): ObservedClient<ClientAppData> | undefined;
2599
+ createObservedClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedClientSettings<ClientAppData>): ObservedClient<ClientAppData> | undefined;
2600
+ getOrCreateObservedClient<ClientAppData extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedClientSettings<ClientAppData>): ObservedClient<ClientAppData> | undefined;
2601
+ update(context?: AcceptContext): void;
2602
+ private _onClientUpdate;
2603
+ private _clientJoined;
2604
+ private _clientLeft;
2605
+ /** Emit an Observer-bus event scoped to this call. */
2606
+ private _notify;
2607
+ }
2608
+
2609
+ type SampleRejectedReason = 'observer-closed' | 'missing-callId' | 'missing-clientId';
2610
+
2611
+ /**
2612
+ * Optional, free-form context supplied to `accept()`. A single context object is
2613
+ * threaded down the accept chain (Observer -> Client -> PeerConnection) and is
2614
+ * merged into the `appData` of entities created during the accept pass.
2615
+ */
2616
+ type AcceptContext = Record<string, unknown>;
2617
+ type ObserverUpdateConfig = {
2618
+ updatePolicy: 'update-on-interval';
2619
+ updateIntervalInMs: number;
2620
+ } | {
2621
+ updatePolicy?: 'update-on-any-call-updated' | 'update-when-all-call-updated';
2622
+ updateIntervalInMs?: number;
2623
+ };
2624
+ /** Produces the initial `appData` for a call created without an explicit `appData`. */
2625
+ type CallAppDataFactory = (params: {
2626
+ callId: string;
2627
+ observer: Observer;
2628
+ }) => Record<string, unknown>;
2629
+ /** Produces the initial `appData` for a client created without an explicit `appData`. */
2630
+ type ClientAppDataFactory = (params: {
2631
+ clientId: string;
2632
+ observedCall: ObservedCall;
2633
+ }) => Record<string, unknown>;
2634
+ type ObserverConfig<AppData extends Record<string, unknown> = Record<string, unknown>> = ObserverUpdateConfig & {
2635
+ defaultCallUpdatePolicy?: ObservedCallSettings['updatePolicy'];
2636
+ defaultCallUpdateIntervalInMs?: number;
2637
+ appData?: AppData;
2638
+ closeClientIfIdleForMs?: number;
2639
+ closeCallIfEmptyForMs?: number;
2640
+ /**
2641
+ * Optional factory invoked when a call is created without an explicit `appData`
2642
+ * (e.g. lazily by `accept()`), so apps can enrich appData without pre-creating the
2643
+ * entity. `appData` is application-owned; it is never modified by the `accept()` context.
2644
+ */
2645
+ createCallAppData?: CallAppDataFactory;
2646
+ /** Same as `createCallAppData`, for clients. Receives the (already-created) parent call. */
2647
+ createClientAppData?: ClientAppDataFactory;
2648
+ /**
2649
+ * Optional factory invoked when a client is created, producing a per-client sink that
2650
+ * receives every sample the client accepts (or `undefined` for no sink). The destination
2651
+ * can be derived from `callId` / `clientId`.
2652
+ */
2653
+ createClientSink?: ClientSampleSinkFactory;
2654
+ };
2655
+ declare interface Observer {
2656
+ on<U extends keyof ObserverEvents>(event: U, listener: (...args: ObserverEvents[U]) => void): this;
2657
+ off<U extends keyof ObserverEvents>(event: U, listener: (...args: ObserverEvents[U]) => void): this;
2658
+ once<U extends keyof ObserverEvents>(event: U, listener: (...args: ObserverEvents[U]) => void): this;
2659
+ emit<U extends keyof ObserverEvents>(event: U, ...args: ObserverEvents[U]): boolean;
2660
+ }
2661
+ declare class Observer<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
2662
+ readonly config: ObserverConfig<AppData>;
2663
+ readonly observedTURN: ObservedTURN;
2664
+ readonly observedCalls: Map<string, ObservedCall<Record<string, unknown>>>;
2665
+ updater?: Updater;
2666
+ /** Ancestry base shared by all Observer-bus events originating at the observer. */
2667
+ readonly eventScope: ObserverEventBase;
2668
+ closed: boolean;
2669
+ totalAddedCall: number;
2670
+ totalRemovedCall: number;
2671
+ numberOfClientsUsingTurn: number;
2672
+ numberOfClients: number;
2673
+ numberOfInboundRtpStreams: number;
2674
+ numberOfOutboundRtpStreams: number;
2675
+ numberOfDataChannels: number;
2676
+ numberOfPeerConnections: number;
2677
+ private _timer?;
2678
+ constructor(config?: ObserverConfig<AppData>);
2679
+ get numberOfCalls(): number;
2680
+ get appData(): AppData | undefined;
2681
+ getObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(callId: string): ObservedCall<T> | undefined;
2682
+ createObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedCallSettings<T>): ObservedCall<T> | undefined;
2683
+ getOrCreateObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedCallSettings<T>): ObservedCall<T> | undefined;
2684
+ close(): void;
2685
+ accept(sample: ClientSample, context?: AcceptContext): void;
2686
+ update(): void;
2687
+ /** Emit an Observer-bus event. */
2688
+ private _notify;
2689
+ }
2690
+
2691
+ declare enum ClientEventTypes {
2692
+ CLIENT_JOINED = "CLIENT_JOINED",
2693
+ CLIENT_LEFT = "CLIENT_LEFT",
2694
+ PEER_CONNECTION_OPENED = "PEER_CONNECTION_OPENED",
2695
+ PEER_CONNECTION_CLOSED = "PEER_CONNECTION_CLOSED",
2696
+ MEDIA_TRACK_ADDED = "MEDIA_TRACK_ADDED",
2697
+ MEDIA_TRACK_REMOVED = "MEDIA_TRACK_REMOVED",
2698
+ MEDIA_TRACK_RESUMED = "MEDIA_TRACK_RESUMED",
2699
+ MEDIA_TRACK_MUTED = "MEDIA_TRACK_MUTED",
2700
+ MEDIA_TRACK_UNMUTED = "MEDIA_TRACK_UNMUTED",
2701
+ ICE_GATHERING_STATE_CHANGED = "ICE_GATHERING_STATE_CHANGED",
2702
+ PEER_CONNECTION_STATE_CHANGED = "PEER_CONNECTION_STATE_CHANGED",
2703
+ ICE_CONNECTION_STATE_CHANGED = "ICE_CONNECTION_STATE_CHANGED",
2704
+ DATA_CHANNEL_OPEN = "DATA_CHANNEL_OPEN",
2705
+ DATA_CHANNEL_CLOSED = "DATA_CHANNEL_CLOSED",
2706
+ DATA_CHANNEL_ERROR = "DATA_CHANNEL_ERROR",
2707
+ NEGOTIATION_NEEDED = "NEGOTIATION_NEEDED",
2708
+ SIGNALING_STATE_CHANGE = "SIGNALING_STATE_CHANGE",
2709
+ ICE_CANDIDATE = "ICE_CANDIDATE",
2710
+ ICE_CANDIDATE_ERROR = "ICE_CANDIDATE_ERROR",
2711
+ PRODUCER_ADDED = "PRODUCER_ADDED",
2712
+ PRODUCER_REMOVED = "PRODUCER_REMOVED",
2713
+ PRODUCER_PAUSED = "PRODUCER_PAUSED",
2714
+ PRODUCER_RESUMED = "PRODUCER_RESUMED",
2715
+ CONSUMER_ADDED = "CONSUMER_ADDED",
2716
+ CONSUMER_REMOVED = "CONSUMER_REMOVED",
2717
+ CONSUMER_PAUSED = "CONSUMER_PAUSED",
2718
+ CONSUMER_RESUMED = "CONSUMER_RESUMED",
2719
+ DATA_PRODUCER_CREATED = "DATA_PRODUCER_CREATED",
2720
+ DATA_PRODUCER_CLOSED = "DATA_PRODUCER_CLOSED",
2721
+ DATA_CONSUMER_CREATED = "DATA_CONSUMER_CREATED",
2722
+ DATA_CONSUMER_CLOSED = "DATA_CONSUMER_CLOSED"
2723
+ }
2724
+
2725
+ interface Logger {
2726
+ trace(...args: any[]): void;
2727
+ debug(...args: any[]): void;
2728
+ info(...args: any[]): void;
2729
+ warn(...args: any[]): void;
2730
+ error(...args: any[]): void;
2731
+ }
2732
+ interface ObserverLogger {
2733
+ trace(module: string, ...args: any[]): void;
2734
+ debug(module: string, ...args: any[]): void;
2735
+ info(module: string, ...args: any[]): void;
2736
+ warn(module: string, ...args: any[]): void;
2737
+ error(module: string, ...args: any[]): void;
2738
+ }
2739
+ declare function createLogger(moduleName: string): Logger;
2740
+ declare function setObserverLogger(logger: ObserverLogger): void;
2741
+
2742
+ type JsonlFileSinkOptions = {
2743
+ /** Absolute or relative file path to append JSONL lines to. */
2744
+ path: string;
2745
+ /** Optional custom serializer; defaults to `JSON.stringify`. */
2746
+ serializeSample?: (sample: ClientSample) => string;
2747
+ };
2748
+ /**
2749
+ * A sink that serializes each sample to a JSON line and appends it to a file. It wraps an
2750
+ * `fs.WriteStream` and re-emits its lifecycle events, so `close` fires once the file is flushed
2751
+ * and its descriptor is closed (file ready) and `error` surfaces file errors.
2752
+ */
2753
+ declare class JsonlFileSink extends ClientSampleSink {
2754
+ private readonly _stream;
2755
+ private readonly _serializeSample;
2756
+ constructor(options: JsonlFileSinkOptions);
2757
+ write(sample: ClientSample): boolean;
2758
+ end(): void;
2759
+ }
2760
+ /** Build a JSONL file sink for a single path. */
2761
+ declare function createJsonlFileSink(options: JsonlFileSinkOptions): ClientSampleSink;
2762
+ type JsonlFileSinkFactoryOptions = {
2763
+ /** Directory the per-client files are written into (must exists). */
2764
+ directory: string;
2765
+ /** Builds the file name from the call/client ids. Defaults to `${callId}__${clientId}.jsonl`. */
2766
+ getFileName?: (params: {
2767
+ callId: string;
2768
+ clientId: string;
2769
+ }) => string;
2770
+ /** Optional custom serializer; defaults to `JSON.stringify`. */
2771
+ serializeSample?: (sample: ClientSample) => string;
2772
+ };
2773
+ /**
2774
+ * Convenience factory that writes one JSONL file per client, with the path derived from
2775
+ * `callId` / `clientId`. Plug into `ObserverConfig.createClientSink`.
2776
+ */
2777
+ declare function createJsonlFileSinkFactory(options: JsonlFileSinkFactoryOptions): ClientSampleSinkFactory;
2778
+
2779
+ /**
2780
+ * A `ClientSampleSink` that collects the accepted sample objects into an array. Useful for
2781
+ * tests and offline replay. Emits `close` on `end()`.
2782
+ */
2783
+ declare class InMemorySink extends ClientSampleSink {
2784
+ readonly samples: ClientSample[];
2785
+ constructor(samples?: ClientSample[]);
2786
+ write(sample: ClientSample): boolean;
2787
+ end(): void;
2788
+ }
2789
+ declare function createInMemorySink(samples?: ClientSample[]): InMemorySink;
2790
+
2791
+ type Middleware<T> = (input: T, next: (nextInput: T) => void) => void;
2792
+
2793
+ export { type AcceptContext, type CallAppDataFactory, type ClientAppDataFactory, type ClientEvent, ClientEventTypes, type ClientIssue, type ClientMetaData, ClientMetaTypes, type ClientReport, type ClientSample, ClientSampleSink, type ClientSampleSinkEvents, type ClientSampleSinkFactory, type Detector, Detectors, InMemorySink, JsonlFileSink, type JsonlFileSinkFactoryOptions, type JsonlFileSinkOptions, type Logger, type Middleware, ObservedCall, type ObservedCallScope, ObservedCertificate, ObservedClient, type ObservedClientScope, ObservedCodec, ObservedDataChannel, ObservedIceCandidate, ObservedIceCandidatePair, ObservedIceTransport, ObservedInboundRtp, ObservedInboundTrack, ObservedMediaPlayout, ObservedMediaSource, ObservedOutboundRtp, ObservedOutboundTrack, ObservedPeerConnection, type ObservedPeerConnectionScope, ObservedPeerConnectionTransport, ObservedRemoteInboundRtp, ObservedRemoteOutboundRtp, Observer, type ObserverEventBase, type ObserverEvents, type ObserverLogger, type SampleRejectedReason, type ScoreCalculator, type TrackReport, createInMemorySink, createJsonlFileSink, createJsonlFileSinkFactory, createLogger, setObserverLogger };