@webex/plugin-meetings 2.59.2 → 2.59.3-next.1

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 (418) hide show
  1. package/.eslintrc.js +6 -6
  2. package/LICENSE +1 -1
  3. package/README.md +1204 -1204
  4. package/UPGRADING.md +287 -287
  5. package/babel.config.js +3 -3
  6. package/browsers.js +108 -108
  7. package/dist/common/browser-detection.d.ts +9 -9
  8. package/dist/common/browser-detection.js.map +1 -1
  9. package/dist/common/collection.d.ts +48 -48
  10. package/dist/common/collection.js +43 -43
  11. package/dist/common/collection.js.map +1 -1
  12. package/dist/common/config.d.ts +2 -2
  13. package/dist/common/config.js.map +1 -1
  14. package/dist/common/errors/captcha-error.d.ts +15 -15
  15. package/dist/common/errors/captcha-error.js +7 -7
  16. package/dist/common/errors/captcha-error.js.map +1 -1
  17. package/dist/common/errors/intent-to-join.d.ts +16 -16
  18. package/dist/common/errors/intent-to-join.js +7 -7
  19. package/dist/common/errors/intent-to-join.js.map +1 -1
  20. package/dist/common/errors/join-meeting.d.ts +17 -17
  21. package/dist/common/errors/join-meeting.js +8 -8
  22. package/dist/common/errors/join-meeting.js.map +1 -1
  23. package/dist/common/errors/media.d.ts +15 -15
  24. package/dist/common/errors/media.js +7 -7
  25. package/dist/common/errors/media.js.map +1 -1
  26. package/dist/common/errors/parameter.d.ts +15 -15
  27. package/dist/common/errors/parameter.js +7 -7
  28. package/dist/common/errors/parameter.js.map +1 -1
  29. package/dist/common/errors/password-error.d.ts +15 -15
  30. package/dist/common/errors/password-error.js +7 -7
  31. package/dist/common/errors/password-error.js.map +1 -1
  32. package/dist/common/errors/permission.d.ts +14 -14
  33. package/dist/common/errors/permission.js +6 -6
  34. package/dist/common/errors/permission.js.map +1 -1
  35. package/dist/common/errors/reconnection-in-progress.d.ts +9 -9
  36. package/dist/common/errors/reconnection-in-progress.js +6 -6
  37. package/dist/common/errors/reconnection-in-progress.js.map +1 -1
  38. package/dist/common/errors/reconnection.d.ts +15 -15
  39. package/dist/common/errors/reconnection.js +7 -7
  40. package/dist/common/errors/reconnection.js.map +1 -1
  41. package/dist/common/errors/stats.d.ts +15 -15
  42. package/dist/common/errors/stats.js +7 -7
  43. package/dist/common/errors/stats.js.map +1 -1
  44. package/dist/common/errors/webex-errors.d.ts +81 -81
  45. package/dist/common/errors/webex-errors.js +42 -42
  46. package/dist/common/errors/webex-errors.js.map +1 -1
  47. package/dist/common/errors/webex-meetings-error.d.ts +20 -20
  48. package/dist/common/errors/webex-meetings-error.js +12 -12
  49. package/dist/common/errors/webex-meetings-error.js.map +1 -1
  50. package/dist/common/events/events-scope.d.ts +17 -17
  51. package/dist/common/events/events-scope.js +10 -10
  52. package/dist/common/events/events-scope.js.map +1 -1
  53. package/dist/common/events/events.d.ts +12 -12
  54. package/dist/common/events/events.js +4 -4
  55. package/dist/common/events/events.js.map +1 -1
  56. package/dist/common/events/trigger-proxy.d.ts +2 -2
  57. package/dist/common/events/trigger-proxy.js.map +1 -1
  58. package/dist/common/events/util.d.ts +2 -2
  59. package/dist/common/events/util.js.map +1 -1
  60. package/dist/common/logs/logger-config.d.ts +2 -2
  61. package/dist/common/logs/logger-config.js.map +1 -1
  62. package/dist/common/logs/logger-proxy.d.ts +2 -2
  63. package/dist/common/logs/logger-proxy.js.map +1 -1
  64. package/dist/common/logs/request.d.ts +34 -34
  65. package/dist/common/logs/request.js +18 -18
  66. package/dist/common/logs/request.js.map +1 -1
  67. package/dist/common/queue.d.ts +32 -32
  68. package/dist/common/queue.js +18 -18
  69. package/dist/common/queue.js.map +1 -1
  70. package/dist/config.d.ts +73 -73
  71. package/dist/config.js.map +1 -1
  72. package/dist/constants.d.ts +924 -924
  73. package/dist/constants.js +9 -9
  74. package/dist/constants.js.map +1 -1
  75. package/dist/controls-options-manager/constants.d.ts +4 -4
  76. package/dist/controls-options-manager/constants.js.map +1 -1
  77. package/dist/controls-options-manager/enums.d.ts +5 -5
  78. package/dist/controls-options-manager/enums.js.map +1 -1
  79. package/dist/controls-options-manager/index.d.ts +120 -120
  80. package/dist/controls-options-manager/index.js +81 -81
  81. package/dist/controls-options-manager/index.js.map +1 -1
  82. package/dist/controls-options-manager/util.d.ts +7 -7
  83. package/dist/controls-options-manager/util.js.map +1 -1
  84. package/dist/index.d.ts +4 -4
  85. package/dist/index.js.map +1 -1
  86. package/dist/locus-info/controlsUtils.d.ts +2 -2
  87. package/dist/locus-info/controlsUtils.js +21 -21
  88. package/dist/locus-info/controlsUtils.js.map +1 -1
  89. package/dist/locus-info/embeddedAppsUtils.d.ts +2 -2
  90. package/dist/locus-info/embeddedAppsUtils.js +14 -14
  91. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  92. package/dist/locus-info/fullState.d.ts +2 -2
  93. package/dist/locus-info/fullState.js.map +1 -1
  94. package/dist/locus-info/hostUtils.d.ts +2 -2
  95. package/dist/locus-info/hostUtils.js +19 -19
  96. package/dist/locus-info/hostUtils.js.map +1 -1
  97. package/dist/locus-info/index.d.ts +269 -269
  98. package/dist/locus-info/index.js +180 -180
  99. package/dist/locus-info/index.js.map +1 -1
  100. package/dist/locus-info/infoUtils.d.ts +2 -2
  101. package/dist/locus-info/infoUtils.js.map +1 -1
  102. package/dist/locus-info/mediaSharesUtils.d.ts +2 -2
  103. package/dist/locus-info/mediaSharesUtils.js +50 -50
  104. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  105. package/dist/locus-info/parser.d.ts +212 -212
  106. package/dist/locus-info/parser.js +136 -136
  107. package/dist/locus-info/parser.js.map +1 -1
  108. package/dist/locus-info/selfUtils.d.ts +2 -2
  109. package/dist/locus-info/selfUtils.js +52 -52
  110. package/dist/locus-info/selfUtils.js.map +1 -1
  111. package/dist/media/index.d.ts +32 -32
  112. package/dist/media/index.js +145 -145
  113. package/dist/media/index.js.map +1 -1
  114. package/dist/media/properties.d.ts +108 -108
  115. package/dist/media/properties.js +49 -49
  116. package/dist/media/properties.js.map +1 -1
  117. package/dist/media/util.d.ts +2 -2
  118. package/dist/media/util.js.map +1 -1
  119. package/dist/mediaQualityMetrics/config.d.ts +233 -233
  120. package/dist/mediaQualityMetrics/config.js.map +1 -1
  121. package/dist/meeting/effectsState.d.ts +42 -42
  122. package/dist/meeting/effectsState.js +24 -24
  123. package/dist/meeting/effectsState.js.map +1 -1
  124. package/dist/meeting/in-meeting-actions.d.ts +79 -79
  125. package/dist/meeting/in-meeting-actions.js +11 -11
  126. package/dist/meeting/in-meeting-actions.js.map +1 -1
  127. package/dist/meeting/index.d.ts +1621 -1621
  128. package/dist/meeting/index.js +1502 -1505
  129. package/dist/meeting/index.js.map +1 -1
  130. package/dist/meeting/muteState.d.ts +116 -116
  131. package/dist/meeting/muteState.js +85 -85
  132. package/dist/meeting/muteState.js.map +1 -1
  133. package/dist/meeting/request.d.ts +255 -255
  134. package/dist/meeting/request.js +141 -141
  135. package/dist/meeting/request.js.map +1 -1
  136. package/dist/meeting/state.d.ts +9 -9
  137. package/dist/meeting/state.js +30 -30
  138. package/dist/meeting/state.js.map +1 -1
  139. package/dist/meeting/util.d.ts +2 -2
  140. package/dist/meeting/util.js.map +1 -1
  141. package/dist/meeting-info/collection.d.ts +20 -20
  142. package/dist/meeting-info/collection.js +11 -11
  143. package/dist/meeting-info/collection.js.map +1 -1
  144. package/dist/meeting-info/index.d.ts +57 -57
  145. package/dist/meeting-info/index.js +50 -50
  146. package/dist/meeting-info/index.js.map +1 -1
  147. package/dist/meeting-info/meeting-info-v2.d.ts +93 -93
  148. package/dist/meeting-info/meeting-info-v2.js +52 -52
  149. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  150. package/dist/meeting-info/request.d.ts +22 -22
  151. package/dist/meeting-info/request.js +14 -14
  152. package/dist/meeting-info/request.js.map +1 -1
  153. package/dist/meeting-info/util.d.ts +2 -2
  154. package/dist/meeting-info/util.js +9 -9
  155. package/dist/meeting-info/util.js.map +1 -1
  156. package/dist/meeting-info/utilv2.d.ts +2 -2
  157. package/dist/meeting-info/utilv2.js +20 -20
  158. package/dist/meeting-info/utilv2.js.map +1 -1
  159. package/dist/meetings/collection.d.ts +23 -23
  160. package/dist/meetings/collection.js +14 -14
  161. package/dist/meetings/collection.js.map +1 -1
  162. package/dist/meetings/index.d.ts +296 -296
  163. package/dist/meetings/index.js +259 -259
  164. package/dist/meetings/index.js.map +1 -1
  165. package/dist/meetings/request.d.ts +27 -27
  166. package/dist/meetings/request.js +15 -15
  167. package/dist/meetings/request.js.map +1 -1
  168. package/dist/meetings/util.d.ts +18 -18
  169. package/dist/meetings/util.js +29 -29
  170. package/dist/meetings/util.js.map +1 -1
  171. package/dist/member/index.d.ts +147 -147
  172. package/dist/member/index.js +214 -214
  173. package/dist/member/index.js.map +1 -1
  174. package/dist/member/member.types.d.ts +11 -11
  175. package/dist/member/member.types.js.map +1 -1
  176. package/dist/member/util.d.ts +2 -2
  177. package/dist/member/util.js +60 -60
  178. package/dist/member/util.js.map +1 -1
  179. package/dist/members/collection.d.ts +24 -24
  180. package/dist/members/collection.js +11 -11
  181. package/dist/members/collection.js.map +1 -1
  182. package/dist/members/index.d.ts +298 -298
  183. package/dist/members/index.js +275 -275
  184. package/dist/members/index.js.map +1 -1
  185. package/dist/members/request.d.ts +50 -50
  186. package/dist/members/request.js +27 -27
  187. package/dist/members/request.js.map +1 -1
  188. package/dist/members/util.d.ts +2 -2
  189. package/dist/members/util.js +21 -21
  190. package/dist/members/util.js.map +1 -1
  191. package/dist/metrics/config.d.ts +169 -169
  192. package/dist/metrics/config.js.map +1 -1
  193. package/dist/metrics/constants.d.ts +57 -57
  194. package/dist/metrics/constants.js.map +1 -1
  195. package/dist/metrics/index.d.ts +152 -152
  196. package/dist/metrics/index.js +90 -90
  197. package/dist/metrics/index.js.map +1 -1
  198. package/dist/networkQualityMonitor/index.d.ts +70 -70
  199. package/dist/networkQualityMonitor/index.js +65 -65
  200. package/dist/networkQualityMonitor/index.js.map +1 -1
  201. package/dist/peer-connection-manager/index.d.ts +6 -6
  202. package/dist/peer-connection-manager/index.js +87 -87
  203. package/dist/peer-connection-manager/index.js.map +1 -1
  204. package/dist/peer-connection-manager/util.d.ts +6 -6
  205. package/dist/peer-connection-manager/util.js +9 -9
  206. package/dist/peer-connection-manager/util.js.map +1 -1
  207. package/dist/personal-meeting-room/index.d.ts +47 -47
  208. package/dist/personal-meeting-room/index.js +67 -67
  209. package/dist/personal-meeting-room/index.js.map +1 -1
  210. package/dist/personal-meeting-room/request.d.ts +14 -14
  211. package/dist/personal-meeting-room/request.js +7 -7
  212. package/dist/personal-meeting-room/request.js.map +1 -1
  213. package/dist/personal-meeting-room/util.d.ts +2 -2
  214. package/dist/personal-meeting-room/util.js.map +1 -1
  215. package/dist/reachability/index.d.ts +139 -139
  216. package/dist/reachability/index.js +110 -110
  217. package/dist/reachability/index.js.map +1 -1
  218. package/dist/reachability/request.d.ts +35 -35
  219. package/dist/reachability/request.js +15 -15
  220. package/dist/reachability/request.js.map +1 -1
  221. package/dist/reactions/reactions.d.ts +4 -4
  222. package/dist/reactions/reactions.js.map +1 -1
  223. package/dist/reactions/reactions.type.d.ts +32 -32
  224. package/dist/reactions/reactions.type.js.map +1 -1
  225. package/dist/reconnection-manager/index.d.ts +112 -112
  226. package/dist/reconnection-manager/index.js +112 -112
  227. package/dist/reconnection-manager/index.js.map +1 -1
  228. package/dist/recording-controller/enums.d.ts +7 -7
  229. package/dist/recording-controller/enums.js.map +1 -1
  230. package/dist/recording-controller/index.d.ts +193 -193
  231. package/dist/recording-controller/index.js +127 -127
  232. package/dist/recording-controller/index.js.map +1 -1
  233. package/dist/recording-controller/util.d.ts +13 -13
  234. package/dist/recording-controller/util.js.map +1 -1
  235. package/dist/roap/collection.d.ts +10 -10
  236. package/dist/roap/collection.js.map +1 -1
  237. package/dist/roap/handler.d.ts +47 -47
  238. package/dist/roap/handler.js +27 -27
  239. package/dist/roap/handler.js.map +1 -1
  240. package/dist/roap/index.d.ts +116 -116
  241. package/dist/roap/index.js +111 -111
  242. package/dist/roap/index.js.map +1 -1
  243. package/dist/roap/request.d.ts +35 -35
  244. package/dist/roap/request.js +17 -17
  245. package/dist/roap/request.js.map +1 -1
  246. package/dist/roap/state.d.ts +9 -9
  247. package/dist/roap/state.js +14 -14
  248. package/dist/roap/state.js.map +1 -1
  249. package/dist/roap/turnDiscovery.d.ts +67 -67
  250. package/dist/roap/turnDiscovery.js +46 -46
  251. package/dist/roap/turnDiscovery.js.map +1 -1
  252. package/dist/roap/util.d.ts +2 -2
  253. package/dist/roap/util.js.map +1 -1
  254. package/dist/statsAnalyzer/global.d.ts +126 -116
  255. package/dist/statsAnalyzer/global.js +10 -0
  256. package/dist/statsAnalyzer/global.js.map +1 -1
  257. package/dist/statsAnalyzer/index.d.ts +190 -191
  258. package/dist/statsAnalyzer/index.js +137 -139
  259. package/dist/statsAnalyzer/index.js.map +1 -1
  260. package/dist/statsAnalyzer/mqaUtil.d.ts +22 -22
  261. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  262. package/dist/transcription/index.d.ts +64 -64
  263. package/dist/transcription/index.js +42 -42
  264. package/dist/transcription/index.js.map +1 -1
  265. package/internal-README.md +172 -172
  266. package/jest.config.js +3 -3
  267. package/package.json +22 -21
  268. package/process +1 -1
  269. package/src/common/browser-detection.ts +39 -39
  270. package/src/common/collection.ts +94 -94
  271. package/src/common/config.ts +9 -9
  272. package/src/common/errors/captcha-error.ts +25 -25
  273. package/src/common/errors/intent-to-join.ts +27 -27
  274. package/src/common/errors/join-meeting.ts +32 -32
  275. package/src/common/errors/media.ts +25 -25
  276. package/src/common/errors/parameter.ts +33 -33
  277. package/src/common/errors/password-error.ts +25 -25
  278. package/src/common/errors/permission.ts +24 -24
  279. package/src/common/errors/reconnection-in-progress.ts +8 -8
  280. package/src/common/errors/reconnection.ts +25 -25
  281. package/src/common/errors/stats.ts +25 -25
  282. package/src/common/errors/webex-errors.ts +140 -140
  283. package/src/common/errors/webex-meetings-error.ts +35 -35
  284. package/src/common/events/events-scope.ts +30 -30
  285. package/src/common/events/events.ts +25 -25
  286. package/src/common/events/trigger-proxy.ts +25 -25
  287. package/src/common/events/util.ts +39 -39
  288. package/src/common/logs/logger-config.ts +8 -8
  289. package/src/common/logs/logger-proxy.ts +44 -44
  290. package/src/common/logs/request.ts +65 -65
  291. package/src/common/queue.ts +50 -50
  292. package/src/config.ts +96 -96
  293. package/src/constants.ts +1121 -1121
  294. package/src/controls-options-manager/constants.ts +5 -5
  295. package/src/controls-options-manager/enums.ts +6 -6
  296. package/src/controls-options-manager/index.ts +183 -183
  297. package/src/controls-options-manager/util.ts +20 -20
  298. package/src/index.js +15 -15
  299. package/src/locus-info/controlsUtils.ts +112 -112
  300. package/src/locus-info/embeddedAppsUtils.ts +57 -57
  301. package/src/locus-info/fullState.ts +69 -69
  302. package/src/locus-info/hostUtils.ts +60 -60
  303. package/src/locus-info/index.ts +1303 -1303
  304. package/src/locus-info/infoUtils.ts +101 -101
  305. package/src/locus-info/mediaSharesUtils.ts +173 -173
  306. package/src/locus-info/parser.ts +680 -680
  307. package/src/locus-info/selfUtils.ts +428 -428
  308. package/src/media/index.ts +675 -675
  309. package/src/media/properties.ts +313 -313
  310. package/src/media/util.ts +37 -37
  311. package/src/mediaQualityMetrics/config.ts +382 -382
  312. package/src/meeting/effectsState.ts +209 -209
  313. package/src/meeting/in-meeting-actions.ts +153 -153
  314. package/src/meeting/index.ts +6537 -6543
  315. package/src/meeting/muteState.ts +365 -365
  316. package/src/meeting/request.ts +810 -810
  317. package/src/meeting/state.ts +194 -194
  318. package/src/meeting/util.ts +530 -530
  319. package/src/meeting-info/collection.ts +41 -41
  320. package/src/meeting-info/index.ts +137 -137
  321. package/src/meeting-info/meeting-info-v2.ts +273 -273
  322. package/src/meeting-info/request.ts +46 -46
  323. package/src/meeting-info/util.ts +314 -314
  324. package/src/meeting-info/utilv2.ts +324 -324
  325. package/src/meetings/collection.ts +43 -43
  326. package/src/meetings/index.ts +1128 -1128
  327. package/src/meetings/request.ts +81 -81
  328. package/src/meetings/util.ts +181 -181
  329. package/src/member/index.ts +446 -446
  330. package/src/member/member.types.ts +13 -13
  331. package/src/member/util.ts +286 -286
  332. package/src/members/collection.ts +40 -40
  333. package/src/members/index.ts +900 -900
  334. package/src/members/request.ts +175 -175
  335. package/src/members/util.ts +260 -260
  336. package/src/metrics/config.ts +485 -485
  337. package/src/metrics/constants.ts +61 -61
  338. package/src/metrics/index.ts +543 -543
  339. package/src/networkQualityMonitor/index.ts +211 -211
  340. package/src/peer-connection-manager/index.ts +847 -847
  341. package/src/peer-connection-manager/util.ts +119 -119
  342. package/src/personal-meeting-room/index.ts +157 -157
  343. package/src/personal-meeting-room/request.ts +48 -48
  344. package/src/personal-meeting-room/util.ts +49 -49
  345. package/src/reachability/index.ts +478 -478
  346. package/src/reachability/request.ts +81 -81
  347. package/src/reactions/reactions.ts +104 -104
  348. package/src/reactions/reactions.type.ts +36 -36
  349. package/src/reconnection-manager/index.ts +622 -622
  350. package/src/recording-controller/enums.ts +8 -8
  351. package/src/recording-controller/index.ts +315 -315
  352. package/src/recording-controller/util.ts +58 -58
  353. package/src/roap/collection.ts +62 -62
  354. package/src/roap/handler.ts +294 -294
  355. package/src/roap/index.ts +413 -413
  356. package/src/roap/request.ts +229 -229
  357. package/src/roap/state.ts +156 -156
  358. package/src/roap/turnDiscovery.ts +283 -283
  359. package/src/roap/util.ts +100 -100
  360. package/src/statsAnalyzer/global.ts +128 -118
  361. package/src/statsAnalyzer/index.ts +1266 -1265
  362. package/src/statsAnalyzer/mqaUtil.ts +290 -290
  363. package/src/transcription/index.ts +154 -154
  364. package/test/integration/spec/journey.js +941 -941
  365. package/test/integration/spec/space-meeting.js +457 -457
  366. package/test/integration/spec/transcription.js +55 -55
  367. package/test/unit/spec/common/browser-detection.js +119 -119
  368. package/test/unit/spec/common/queue.js +69 -69
  369. package/test/unit/spec/controls-options-manager/index.js +123 -123
  370. package/test/unit/spec/controls-options-manager/util.js +65 -65
  371. package/test/unit/spec/fixture/locus.js +406 -406
  372. package/test/unit/spec/locus-info/controlsUtils.js +82 -82
  373. package/test/unit/spec/locus-info/embeddedAppsUtils.js +104 -104
  374. package/test/unit/spec/locus-info/index.js +1272 -1272
  375. package/test/unit/spec/locus-info/infoUtils.js +138 -138
  376. package/test/unit/spec/locus-info/lib/BasicSeqCmp.json +975 -975
  377. package/test/unit/spec/locus-info/lib/SeqCmp.json +522 -522
  378. package/test/unit/spec/locus-info/lib/selfConstant.js +286 -286
  379. package/test/unit/spec/locus-info/parser.js +298 -298
  380. package/test/unit/spec/locus-info/selfUtils.js +185 -185
  381. package/test/unit/spec/media/properties.ts +305 -305
  382. package/test/unit/spec/meeting/effectsState.js +281 -281
  383. package/test/unit/spec/meeting/in-meeting-actions.ts +90 -90
  384. package/test/unit/spec/meeting/index.js +5227 -5227
  385. package/test/unit/spec/meeting/muteState.js +430 -430
  386. package/test/unit/spec/meeting/request.js +317 -317
  387. package/test/unit/spec/meeting/utils.js +319 -319
  388. package/test/unit/spec/meeting-info/meetinginfov2.js +376 -376
  389. package/test/unit/spec/meeting-info/request.js +64 -64
  390. package/test/unit/spec/meeting-info/util.js +37 -37
  391. package/test/unit/spec/meeting-info/utilv2.js +330 -330
  392. package/test/unit/spec/meetings/collection.js +52 -52
  393. package/test/unit/spec/meetings/index.js +1375 -1375
  394. package/test/unit/spec/meetings/utils.js +66 -66
  395. package/test/unit/spec/member/index.js +47 -47
  396. package/test/unit/spec/member/util.js +80 -80
  397. package/test/unit/spec/members/index.js +364 -364
  398. package/test/unit/spec/members/request.js +200 -200
  399. package/test/unit/spec/members/utils.js +42 -42
  400. package/test/unit/spec/metrics/index.js +111 -111
  401. package/test/unit/spec/networkQualityMonitor/index.js +99 -99
  402. package/test/unit/spec/peerconnection-manager/index.js +218 -218
  403. package/test/unit/spec/peerconnection-manager/utils.js +49 -49
  404. package/test/unit/spec/peerconnection-manager/utils.test-fixtures.ts +388 -388
  405. package/test/unit/spec/personal-meeting-room/personal-meeting-room.js +29 -29
  406. package/test/unit/spec/reachability/index.ts +50 -50
  407. package/test/unit/spec/reconnection-manager/index.js +206 -206
  408. package/test/unit/spec/recording-controller/index.js +230 -230
  409. package/test/unit/spec/recording-controller/util.js +101 -101
  410. package/test/unit/spec/roap/index.ts +128 -128
  411. package/test/unit/spec/roap/turnDiscovery.ts +372 -372
  412. package/test/unit/spec/roap/util.js +30 -30
  413. package/test/unit/spec/stats-analyzer/index.js +287 -355
  414. package/test/utils/cmr.js +104 -104
  415. package/test/utils/testUtils.js +287 -287
  416. package/test/utils/webex-config.js +77 -77
  417. package/test/utils/webex-test-users.js +82 -82
  418. package/tsconfig.json +5 -5
@@ -1,1265 +1,1266 @@
1
- /* eslint-disable prefer-destructuring */
2
-
3
- import {cloneDeep} from 'lodash';
4
-
5
- import EventsScope from '../common/events/events-scope';
6
- import {
7
- DEFAULT_GET_STATS_FILTER,
8
- CONNECTION_STATE,
9
- STATS,
10
- MQA_INTEVAL,
11
- NETWORK_TYPE,
12
- MEDIA_DEVICES,
13
- _UNKNOWN_,
14
- } from '../constants';
15
- import mqaData from '../mediaQualityMetrics/config';
16
- import LoggerProxy from '../common/logs/logger-proxy';
17
-
18
- import defaultStats from './global';
19
- import {
20
- getAudioSenderMqa,
21
- getAudioReceiverMqa,
22
- getVideoSenderMqa,
23
- getVideoReceiverMqa,
24
- } from './mqaUtil';
25
-
26
- export const EVENTS = {
27
- MEDIA_QUALITY: 'MEDIA_QUALITY',
28
- LOCAL_MEDIA_STARTED: 'LOCAL_MEDIA_STARTED',
29
- LOCAL_MEDIA_STOPPED: 'LOCAL_MEDIA_STOPPED',
30
- REMOTE_MEDIA_STARTED: 'REMOTE_MEDIA_STARTED',
31
- REMOTE_MEDIA_STOPPED: 'REMOTE_MEDIA_STOPPED',
32
- };
33
-
34
- /**
35
- * Stats Analyzer class that will emit events based on detected quality
36
- *
37
- * @export
38
- * @class StatsAnalyzer
39
- * @extends {EventsScope}
40
- */
41
- export class StatsAnalyzer extends EventsScope {
42
- config: any;
43
- correlationId: any;
44
- lastEmittedStartStopEvent: any;
45
- lastMqaDataSent: any;
46
- lastStatsResults: any;
47
- localMQEStats: any;
48
- meetingMediaStatus: any;
49
- mqaInterval: NodeJS.Timeout;
50
- mqaSentCount: any;
51
- networkQualityMonitor: any;
52
- peerConnection: any;
53
- statsInterval: NodeJS.Timeout;
54
- statsResults: any;
55
- statsStarted: any;
56
-
57
- /**
58
- * Creates a new instance of StatsAnalyzer
59
- * @constructor
60
- * @public
61
- * @param {Object} config SDK Configuration Object
62
- * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
63
- * @param {Object} statsResults Default properties for stats
64
- */
65
- constructor(
66
- config: any,
67
- networkQualityMonitor: object = {},
68
- statsResults: object = defaultStats
69
- ) {
70
- super();
71
- this.statsStarted = false;
72
- this.statsResults = statsResults;
73
- this.lastStatsResults = null;
74
- this.config = config;
75
- this.networkQualityMonitor = networkQualityMonitor;
76
- this.correlationId = config.correlationId;
77
- this.mqaSentCount = -1;
78
- this.lastMqaDataSent = {
79
- resolutions: {
80
- video: {send: {}, recv: {}},
81
- audio: {send: {}, recv: {}},
82
- share: {send: {}, recv: {}},
83
- },
84
- video: {send: {}, recv: {}},
85
- audio: {send: {}, recv: {}},
86
- share: {send: {}, recv: {}},
87
- };
88
- this.localMQEStats = {
89
- audio: {
90
- RX: {
91
- packetsLost: [],
92
- jitter: [],
93
- latency: [],
94
- bitRate: [],
95
- },
96
- TX: {
97
- packetsLost: [],
98
- jitter: [],
99
- latency: [],
100
- bitRate: [],
101
- },
102
- },
103
- video: {
104
- RX: {
105
- packetsLost: [],
106
- jitter: [],
107
- latency: [],
108
- bitRate: [],
109
- frameRate: [],
110
- resolutionWidth: [],
111
- resolutionHeight: [],
112
- requestedKeyFrame: [],
113
- receivedKeyFrame: [],
114
- },
115
- TX: {
116
- packetsLost: [],
117
- jitter: [],
118
- latency: [],
119
- bitRate: [],
120
- frameRate: [],
121
- resolutionWidth: [],
122
- resolutionHeight: [],
123
- requestedKeyFrame: [],
124
- receivedKeyFrame: [],
125
- },
126
- },
127
- };
128
- this.lastEmittedStartStopEvent = {
129
- audio: {
130
- local: undefined,
131
- remote: undefined,
132
- },
133
- video: {
134
- local: undefined,
135
- remote: undefined,
136
- },
137
- share: {
138
- local: undefined,
139
- remote: undefined,
140
- },
141
- };
142
- }
143
-
144
- populateResults(lastMqa) {
145
- // Audio
146
-
147
- this.localMQEStats.audio.RX.packetsLost.push(lastMqa.audioReceive[0].common.mediaHopByHopLost);
148
- this.localMQEStats.audio.RX.jitter.push(lastMqa.audioReceive[0].streams[0].common.rtpJitter);
149
- this.localMQEStats.audio.RX.latency.push(lastMqa.audioReceive[0].common.roundTripTime);
150
- this.localMQEStats.audio.RX.bitRate.push(
151
- lastMqa.audioReceive[0].streams[0].common.receivedBitrate
152
- );
153
-
154
- this.localMQEStats.audio.TX.packetsLost.push(lastMqa.audioTransmit[0].common.remoteLossRate);
155
- this.localMQEStats.audio.TX.jitter.push(lastMqa.audioTransmit[0].common.remoteJitter);
156
- this.localMQEStats.audio.TX.latency.push(lastMqa.audioTransmit[0].common.roundTripTime);
157
- this.localMQEStats.audio.TX.bitRate.push(
158
- lastMqa.audioTransmit[0].streams[0].common.transmittedBitrate
159
- );
160
-
161
- // Video
162
-
163
- this.localMQEStats.video.RX.packetsLost.push(lastMqa.videoReceive[0].common.mediaHopByHopLost);
164
- this.localMQEStats.video.RX.jitter.push(lastMqa.videoReceive[0].streams[0].common.rtpJitter);
165
- this.localMQEStats.video.RX.latency.push(
166
- lastMqa.videoReceive[0].streams[0].common.roundTripTime
167
- );
168
- this.localMQEStats.video.RX.bitRate.push(
169
- lastMqa.videoReceive[0].streams[0].common.receivedBitrate
170
- );
171
- this.localMQEStats.video.RX.frameRate.push(
172
- lastMqa.videoReceive[0].streams[0].common.receivedFrameRate
173
- );
174
- this.localMQEStats.video.RX.resolutionWidth.push(
175
- lastMqa.videoReceive[0].streams[0].receivedWidth
176
- );
177
- this.localMQEStats.video.RX.resolutionHeight.push(
178
- lastMqa.videoReceive[0].streams[0].receivedHeight
179
- );
180
- this.localMQEStats.video.RX.requestedKeyFrame.push();
181
- this.localMQEStats.video.RX.receivedKeyFrame.push();
182
-
183
- this.localMQEStats.video.TX.packetsLost.push(lastMqa.videoTransmit[0].common.remoteLossRate);
184
- this.localMQEStats.video.TX.jitter.push(lastMqa.videoTransmit[0].common.remoteJitter);
185
- this.localMQEStats.video.TX.latency.push(lastMqa.videoTransmit[0].common.roundTripTime);
186
- this.localMQEStats.video.TX.bitRate.push(
187
- lastMqa.videoTransmit[0].streams[0].common.transmittedBitrate
188
- );
189
- this.localMQEStats.video.TX.frameRate.push(
190
- lastMqa.videoTransmit[0].streams[0].common.transmittedFrameRate
191
- );
192
- this.localMQEStats.video.TX.resolutionWidth.push(
193
- lastMqa.videoTransmit[0].streams[0].transmittedWidth
194
- );
195
- this.localMQEStats.video.TX.resolutionHeight.push(
196
- lastMqa.videoTransmit[0].streams[0].transmittedHeight
197
- );
198
- this.localMQEStats.video.TX.requestedKeyFrame.push(
199
- lastMqa.videoTransmit[0].streams[0].requestedKeyFrames
200
- );
201
- this.localMQEStats.video.TX.receivedKeyFrame.push();
202
- }
203
-
204
- resetStatsResults() {
205
- this.statsResults.audio.send.meanRemoteJitter = [];
206
- this.statsResults.video.send.meanRemoteJitter = [];
207
- this.statsResults.share.send.meanRemoteJitter = [];
208
-
209
- this.statsResults.audio.recv.meanRtpJitter = [];
210
-
211
- // TODO: currently no values are present
212
- this.statsResults.video.recv.meanRtpJitter = [];
213
- this.statsResults.share.recv.meanRtpJitter = [];
214
-
215
- // Reset the roundTripTime
216
- this.statsResults.audio.send.meanRoundTripTime = [];
217
- this.statsResults.video.send.meanRoundTripTime = [];
218
- this.statsResults.share.send.meanRoundTripTime = [];
219
- }
220
-
221
- /**
222
- * sets mediaStatus status for analyzing metrics
223
- *
224
- * @public
225
- * @param {Object} status for the audio and video
226
- * @memberof StatsAnalyzer
227
- * @returns {void}
228
- */
229
- public updateMediaStatus(status: object) {
230
- this.meetingMediaStatus = status;
231
- }
232
-
233
- /**
234
- * captures MQA data from peerconnection
235
- *
236
- * @public
237
- * @memberof StatsAnalyzer
238
- * @returns {void}
239
- */
240
- public sendMqaData() {
241
- const audioReceiver = mqaData.intervals[0].audioReceive[0];
242
- const audioSender = mqaData.intervals[0].audioTransmit[0];
243
- const videoReceiver = mqaData.intervals[0].videoReceive[0];
244
- const videoSender = mqaData.intervals[0].videoTransmit[0];
245
- const shareSender = mqaData.intervals[0].videoTransmit[1];
246
- const shareReceiver = mqaData.intervals[0].videoReceive[1];
247
-
248
- getAudioSenderMqa({
249
- audioSender,
250
- statsResults: this.statsResults,
251
- lastMqaDataSent: this.lastMqaDataSent,
252
- });
253
- getAudioReceiverMqa({
254
- audioReceiver,
255
- statsResults: this.statsResults,
256
- lastMqaDataSent: this.lastMqaDataSent,
257
- });
258
-
259
- getVideoReceiverMqa({
260
- videoReceiver,
261
- statsResults: this.statsResults,
262
- lastMqaDataSent: this.lastMqaDataSent,
263
- });
264
- getVideoSenderMqa({
265
- videoSender,
266
- statsResults: this.statsResults,
267
- lastMqaDataSent: this.lastMqaDataSent,
268
- });
269
-
270
- // Capture mqa for share scenario
271
-
272
- getVideoSenderMqa({
273
- videoSender: shareSender,
274
- statsResults: this.statsResults,
275
- lastMqaDataSent: this.lastMqaDataSent,
276
- isShareStream: true,
277
- });
278
-
279
- getVideoReceiverMqa({
280
- videoReceiver: shareReceiver,
281
- statsResults: this.statsResults,
282
- lastMqaDataSent: this.lastMqaDataSent,
283
- isShareStream: true,
284
- });
285
- mqaData.intervals[0].intervalMetadata.peerReflexiveIP =
286
- this.statsResults.connectionType.local.ipAddress[0];
287
-
288
- // Adding peripheral information
289
- mqaData.intervals[0].intervalMetadata.peripherals = [];
290
- mqaData.intervals[0].intervalMetadata.peripherals.push({
291
- information: _UNKNOWN_,
292
- name: MEDIA_DEVICES.SPEAKER,
293
- });
294
- mqaData.intervals[0].intervalMetadata.peripherals.push({
295
- information: this.peerConnection?.audioTransceiver?.sender?.track?.label || _UNKNOWN_,
296
- name: MEDIA_DEVICES.MICROPHONE,
297
- });
298
- mqaData.intervals[0].intervalMetadata.peripherals.push({
299
- information: this.peerConnection?.videoTransceiver?.sender?.track?.label || _UNKNOWN_,
300
- name: MEDIA_DEVICES.CAMERA,
301
- });
302
-
303
- // @ts-ignore
304
- mqaData.networkType = this.statsResults.connectionType.local.networkType;
305
-
306
- this.mqaSentCount += 1;
307
-
308
- mqaData.intervals[0].intervalNumber = this.mqaSentCount;
309
-
310
- // DO Deep copy, for some reason it takes the reference all the time rather then old value set
311
- this.lastMqaDataSent = cloneDeep(this.statsResults);
312
-
313
- this.populateResults(mqaData.intervals[0]);
314
-
315
- this.resetStatsResults();
316
-
317
- this.emit(
318
- {
319
- file: 'statsAnalyzer',
320
- function: 'sendMqaData',
321
- },
322
- EVENTS.MEDIA_QUALITY,
323
- {
324
- data: mqaData.intervals[0],
325
- // @ts-ignore
326
- networkType: mqaData.networkType,
327
- }
328
- );
329
- }
330
-
331
- /**
332
- * updated the peerconnection when changed
333
- *
334
- * @private
335
- * @memberof updatePeerconnection
336
- * @param {PeerConnection} peerConnection
337
- * @returns {void}
338
- */
339
- updatePeerconnection(peerConnection: any) {
340
- this.peerConnection = peerConnection;
341
- }
342
-
343
- /**
344
- * Starts the stats analyzer on interval
345
- *
346
- * @public
347
- * @memberof StatsAnalyzer
348
- * @param {PeerConnection} peerConnection
349
- * @returns {Promise}
350
- */
351
- public startAnalyzer(peerConnection: any) {
352
- if (!this.statsStarted) {
353
- this.statsStarted = true;
354
- this.peerConnection = peerConnection;
355
-
356
- return this.getStatsAndParse().then(() => {
357
- this.statsInterval = setInterval(() => {
358
- this.getStatsAndParse();
359
- }, this.config.analyzerInterval);
360
- // Trigger initial fetch
361
- this.sendMqaData();
362
- this.mqaInterval = setInterval(() => {
363
- this.sendMqaData();
364
- }, MQA_INTEVAL);
365
- });
366
- }
367
-
368
- return Promise.resolve();
369
- }
370
-
371
- /**
372
- * Cleans up the analyzer when done
373
- *
374
- * @public
375
- * @memberof StatsAnalyzer
376
- * @returns {void}
377
- */
378
- public stopAnalyzer() {
379
- const sendOneLastMqa = this.mqaInterval && this.statsInterval;
380
-
381
- if (this.statsInterval) {
382
- clearInterval(this.statsInterval);
383
- this.statsInterval = undefined;
384
- }
385
-
386
- if (this.mqaInterval) {
387
- clearInterval(this.mqaInterval);
388
- this.mqaInterval = undefined;
389
- }
390
-
391
- if (sendOneLastMqa) {
392
- return this.getStatsAndParse().then(() => {
393
- this.sendMqaData();
394
- this.peerConnection = null;
395
- });
396
- }
397
-
398
- return Promise.resolve();
399
- }
400
-
401
- /**
402
- * Parse a single result of get stats
403
- *
404
- * @private
405
- * @param {*} getStatsResult
406
- * @param {String} type
407
- * @param {boolean} isSender
408
- * @returns {void}
409
- * @memberof StatsAnalyzer
410
- */
411
- private parseGetStatsResult(getStatsResult: any, type: string, isSender: boolean) {
412
- if (!getStatsResult) {
413
- return;
414
- }
415
-
416
- switch (getStatsResult.type) {
417
- case 'outbound-rtp':
418
- this.processOutboundRTPResult(getStatsResult, type);
419
- break;
420
- case 'inbound-rtp':
421
- this.processInboundRTPResult(getStatsResult, type);
422
- break;
423
- case 'remote-inbound-rtp':
424
- case 'remote-outbound-rtp':
425
- // @ts-ignore
426
- this.compareSentAndReceived(getStatsResult, type, isSender);
427
- break;
428
- case 'remotecandidate':
429
- case 'remote-candidate':
430
- this.parseCandidate(getStatsResult, type, isSender, true);
431
- break;
432
- case 'local-candidate':
433
- this.parseCandidate(getStatsResult, type, isSender, false);
434
- break;
435
- case 'media-source':
436
- // @ts-ignore
437
- this.parseAudioSource(getStatsResult, type);
438
- break;
439
- default:
440
- break;
441
- }
442
- }
443
-
444
- /**
445
- * Filters the get stats results for types
446
- * @private
447
- * @param {Array} getStatsResults
448
- * @param {String} type
449
- * @param {boolean} isSender
450
- * @returns {void}
451
- */
452
- private filterAndParseGetStatsResults(
453
- getStatsResults: Array<any>,
454
- type: string,
455
- isSender: boolean
456
- ) {
457
- const {types} = DEFAULT_GET_STATS_FILTER;
458
-
459
- getStatsResults.forEach((result) => {
460
- if (types.includes(result.type)) {
461
- this.parseGetStatsResult(result, type, isSender);
462
- }
463
- });
464
- }
465
-
466
- /**
467
- * parse the audio
468
- * @param {String} result
469
- * @param {boolean} type
470
- * @returns {void}
471
- */
472
- parseAudioSource(result: any, type: any) {
473
- if (!result) {
474
- return;
475
- }
476
-
477
- if (type === STATS.AUDIO_CORRELATE) {
478
- this.statsResults[type].send.audioLevel = result.audioLevel;
479
- this.statsResults[type].send.totalAudioEnergy = result.totalAudioEnergy;
480
- }
481
- }
482
-
483
- /**
484
- * emits started/stopped events for local/remote media by checking
485
- * if given values are increasing or not. The previousValue, currentValue
486
- * params can be any numerical value like number of receive packets or
487
- * decoded frames, etc.
488
- *
489
- * @private
490
- * @param {string} mediaType
491
- * @param {number} previousValue - value to compare
492
- * @param {number} currentValue - value to compare (must be same type of value as previousValue)
493
- * @param {boolean} isLocal - true if stats are for local media being sent out, false for remote media being received
494
- * @memberof StatsAnalyzer
495
- * @returns {void}
496
- */
497
- emitStartStopEvents = (
498
- mediaType: string,
499
- previousValue: number,
500
- currentValue: number,
501
- isLocal: boolean
502
- ) => {
503
- if (mediaType !== 'audio' && mediaType !== 'video' && mediaType !== 'share') {
504
- throw new Error(`Unsupported mediaType: ${mediaType}`);
505
- }
506
-
507
- // eslint-disable-next-line no-param-reassign
508
- if (previousValue === undefined) previousValue = 0;
509
- // eslint-disable-next-line no-param-reassign
510
- if (currentValue === undefined) currentValue = 0;
511
-
512
- const lastEmittedEvent = isLocal
513
- ? this.lastEmittedStartStopEvent[mediaType].local
514
- : this.lastEmittedStartStopEvent[mediaType].remote;
515
-
516
- let newEvent;
517
-
518
- if (currentValue - previousValue > 0) {
519
- newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STARTED : EVENTS.REMOTE_MEDIA_STARTED;
520
- } else if (currentValue === previousValue && currentValue > 0) {
521
- newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STOPPED : EVENTS.REMOTE_MEDIA_STOPPED;
522
- }
523
-
524
- if (newEvent && lastEmittedEvent !== newEvent) {
525
- if (isLocal) {
526
- this.lastEmittedStartStopEvent[mediaType].local = newEvent;
527
- } else {
528
- this.lastEmittedStartStopEvent[mediaType].remote = newEvent;
529
- }
530
- this.emit(
531
- {
532
- file: 'statsAnalyzer/index',
533
- function: 'compareLastStatsResult',
534
- },
535
- newEvent,
536
- {
537
- type: mediaType,
538
- }
539
- );
540
- }
541
- };
542
-
543
- /**
544
- * compares current and previous stats to check if packets are not sent
545
- *
546
- * @private
547
- * @memberof StatsAnalyzer
548
- * @returns {void}
549
- */
550
- private compareLastStatsResult() {
551
- if (this.lastStatsResults !== null && this.meetingMediaStatus) {
552
- // compare audio stats sent
553
- let mediaType = STATS.AUDIO_CORRELATE;
554
- let currentStats = null;
555
- let previousStats = null;
556
-
557
- if (this.meetingMediaStatus.expected.sendAudio) {
558
- currentStats = this.statsResults[mediaType].send;
559
- previousStats = this.lastStatsResults[mediaType].send;
560
-
561
- if (
562
- currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
563
- currentStats.totalPacketsSent === 0
564
- ) {
565
- LoggerProxy.logger.info(
566
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
567
- );
568
- } else {
569
- if (
570
- currentStats.totalAudioEnergy === previousStats.totalAudioEnergy ||
571
- currentStats.totalAudioEnergy === 0
572
- ) {
573
- LoggerProxy.logger.info(
574
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Energy present`
575
- );
576
- }
577
-
578
- if (currentStats.audioLevel === 0) {
579
- LoggerProxy.logger.info(
580
- `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} level is 0 for the user`
581
- );
582
- }
583
- }
584
-
585
- this.emitStartStopEvents(
586
- mediaType,
587
- previousStats.totalPacketsSent,
588
- currentStats.totalPacketsSent,
589
- true
590
- );
591
- }
592
-
593
- if (this.meetingMediaStatus.expected.receiveAudio) {
594
- // compare audio stats received
595
- currentStats = this.statsResults[mediaType].recv;
596
- previousStats = this.lastStatsResults[mediaType].recv;
597
-
598
- if (
599
- currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
600
- currentStats.totalPacketsReceived === 0
601
- ) {
602
- LoggerProxy.logger.info(
603
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
604
- );
605
- } else if (
606
- currentStats.totalSamplesReceived === previousStats.totalSamplesReceived ||
607
- currentStats.totalSamplesReceived === 0
608
- ) {
609
- LoggerProxy.logger.info(
610
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} samples received`
611
- );
612
- }
613
-
614
- this.emitStartStopEvents(
615
- mediaType,
616
- previousStats.totalPacketsReceived,
617
- currentStats.totalPacketsReceived,
618
- false
619
- );
620
- }
621
-
622
- mediaType = STATS.VIDEO_CORRELATE;
623
- if (this.meetingMediaStatus.expected.sendVideo) {
624
- // compare video stats sent
625
- currentStats = this.statsResults[mediaType].send;
626
- previousStats = this.lastStatsResults[mediaType].send;
627
-
628
- if (
629
- currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
630
- currentStats.totalPacketsSent === 0
631
- ) {
632
- LoggerProxy.logger.info(
633
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
634
- );
635
- } else {
636
- if (
637
- currentStats.framesEncoded === previousStats.framesEncoded ||
638
- currentStats.framesEncoded === 0
639
- ) {
640
- LoggerProxy.logger.info(
641
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Frames Encoded`
642
- );
643
- }
644
-
645
- if (
646
- this.statsResults.resolutions[mediaType].send.framesSent ===
647
- this.lastStatsResults.resolutions[mediaType].send.framesSent ||
648
- this.statsResults.resolutions[mediaType].send.framesSent === 0
649
- ) {
650
- LoggerProxy.logger.info(
651
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Frames sent`
652
- );
653
- }
654
- }
655
-
656
- this.emitStartStopEvents(
657
- mediaType,
658
- previousStats.framesSent,
659
- currentStats.framesSent,
660
- true
661
- );
662
- }
663
-
664
- if (this.meetingMediaStatus.expected.receiveVideo) {
665
- // compare video stats reveived
666
-
667
- currentStats = this.statsResults[mediaType].recv;
668
- previousStats = this.lastStatsResults[mediaType].recv;
669
-
670
- if (
671
- currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
672
- currentStats.totalPacketsReceived === 0
673
- ) {
674
- LoggerProxy.logger.info(
675
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
676
- );
677
- } else {
678
- if (
679
- this.statsResults.resolutions[mediaType].recv.framesReceived ===
680
- this.lastStatsResults.resolutions[mediaType].recv.framesReceived ||
681
- this.statsResults.resolutions[mediaType].recv.framesReceived === 0
682
- ) {
683
- LoggerProxy.logger.info(
684
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames received`
685
- );
686
- }
687
-
688
- if (
689
- this.statsResults[mediaType].recv.framesDecoded ===
690
- this.lastStatsResults[mediaType].recv.framesDecoded ||
691
- this.statsResults.resolutions[mediaType].send.framesDecoded === 0
692
- ) {
693
- LoggerProxy.logger.info(
694
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames decoded`
695
- );
696
- }
697
-
698
- if (
699
- this.statsResults.resolutions[mediaType].recv.framesDropped -
700
- this.lastStatsResults.resolutions[mediaType].recv.framesDropped >
701
- 10
702
- ) {
703
- LoggerProxy.logger.info(
704
- `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} frames are getting dropped`
705
- );
706
- }
707
- }
708
-
709
- this.emitStartStopEvents(
710
- mediaType,
711
- previousStats.framesDecoded,
712
- currentStats.framesDecoded,
713
- false
714
- );
715
- }
716
-
717
- mediaType = STATS.SHARE_CORRELATE;
718
- if (this.meetingMediaStatus.expected.sendShare) {
719
- // compare share stats sent
720
-
721
- currentStats = this.statsResults[mediaType].send;
722
- previousStats = this.lastStatsResults[mediaType].send;
723
-
724
- if (
725
- currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
726
- currentStats.totalPacketsSent === 0
727
- ) {
728
- LoggerProxy.logger.info(
729
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
730
- );
731
- } else {
732
- if (
733
- currentStats.framesEncoded === previousStats.framesEncoded ||
734
- currentStats.framesEncoded === 0
735
- ) {
736
- LoggerProxy.logger.info(
737
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames getting encoded`
738
- );
739
- }
740
-
741
- if (
742
- this.statsResults.resolutions[mediaType].send.framesSent ===
743
- this.lastStatsResults.resolutions[mediaType].send.framesSent ||
744
- this.statsResults.resolutions[mediaType].send.framesSent === 0
745
- ) {
746
- LoggerProxy.logger.info(
747
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames sent`
748
- );
749
- }
750
- }
751
-
752
- // TODO:need to check receive share value
753
- // compare share stats reveived
754
- currentStats = this.statsResults[mediaType].recv;
755
- previousStats = this.lastStatsResults[mediaType].recv;
756
-
757
- if (
758
- currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
759
- currentStats.totalPacketsSent === 0
760
- ) {
761
- LoggerProxy.logger.info(
762
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
763
- );
764
- } else {
765
- if (
766
- this.statsResults.resolutions[mediaType].recv.framesReceived ===
767
- this.lastStatsResults.resolutions[mediaType].recv.framesReceived ||
768
- this.statsResults.resolutions[mediaType].recv.framesReceived === 0
769
- ) {
770
- LoggerProxy.logger.info(
771
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames received`
772
- );
773
- }
774
-
775
- if (
776
- this.statsResults[mediaType].recv.framesDecoded ===
777
- this.lastStatsResults[mediaType].recv.framesDecoded ||
778
- this.statsResults.resolutions[mediaType].send.framesDecoded === 0
779
- ) {
780
- LoggerProxy.logger.info(
781
- `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames decoded`
782
- );
783
- }
784
-
785
- if (
786
- this.statsResults.resolutions[mediaType].recv.framesDropped -
787
- this.lastStatsResults.resolutions[mediaType].recv.framesDropped >
788
- 10
789
- ) {
790
- LoggerProxy.logger.info(
791
- `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} frames are getting dropped`
792
- );
793
- }
794
- }
795
-
796
- // we are not calling emitStartStopEvents() for sending or receiving share because sharing is often started and stopped
797
- // in meetings and this.meetingMediaStatus.expected values can be out of sync with the actual packet flow
798
- // so we would send "sharing stopped" events incorrectly
799
- }
800
- }
801
- }
802
-
803
- /**
804
- * Does a `getStats` on all the transceivers and parses the results
805
- *
806
- * @private
807
- * @memberof StatsAnalyzer
808
- * @returns {Promise}
809
- */
810
- private getStatsAndParse() {
811
- if (!this.peerConnection) {
812
- return Promise.resolve();
813
- }
814
-
815
- if (this.peerConnection && this.peerConnection.connectionState === CONNECTION_STATE.FAILED) {
816
- LoggerProxy.logger.trace(
817
- 'StatsAnalyzer:index#getStatsAndParse --> PeerConnection is in failed state'
818
- );
819
-
820
- return Promise.resolve();
821
- }
822
-
823
- LoggerProxy.logger.trace('StatsAnalyzer:index#getStatsAndParse --> Collecting Stats');
824
-
825
- return Promise.all([
826
- this.peerConnection.videoTransceiver.sender.getStats().then((res) => {
827
- this.filterAndParseGetStatsResults(res, STATS.VIDEO_CORRELATE, true);
828
- }),
829
-
830
- this.peerConnection.videoTransceiver.receiver.getStats().then((res) => {
831
- this.filterAndParseGetStatsResults(res, STATS.VIDEO_CORRELATE, false);
832
- }),
833
-
834
- this.peerConnection.audioTransceiver.sender.getStats().then((res) => {
835
- this.filterAndParseGetStatsResults(res, STATS.AUDIO_CORRELATE, true);
836
- }),
837
-
838
- this.peerConnection.audioTransceiver.receiver.getStats().then((res) => {
839
- this.filterAndParseGetStatsResults(res, STATS.AUDIO_CORRELATE, false);
840
- }),
841
-
842
- // TODO: add checks for screen share
843
- this.peerConnection.shareTransceiver.sender.getStats().then((res) => {
844
- this.filterAndParseGetStatsResults(res, STATS.SHARE_CORRELATE, true);
845
- }),
846
-
847
- this.peerConnection.shareTransceiver.receiver.getStats().then((res) => {
848
- this.filterAndParseGetStatsResults(res, STATS.SHARE_CORRELATE, false);
849
- }),
850
- ]).then(() => {
851
- this.statsResults[STATS.AUDIO_CORRELATE].direction =
852
- this.peerConnection.audioTransceiver.currentDirection;
853
- this.statsResults[STATS.VIDEO_CORRELATE].direction =
854
- this.peerConnection.videoTransceiver.currentDirection;
855
- this.statsResults[STATS.SHARE_CORRELATE].direction =
856
- this.peerConnection.shareTransceiver.currentDirection;
857
-
858
- // Process Stats results every 5 seconds
859
- this.compareLastStatsResult();
860
-
861
- // Save the last results to compare with the current
862
- this.lastStatsResults = JSON.parse(JSON.stringify(this.statsResults));
863
-
864
- LoggerProxy.logger.trace(
865
- 'StatsAnalyzer:index#getStatsAndParse --> Finished Collecting Stats'
866
- );
867
- });
868
- }
869
-
870
- /**
871
- * Processes OutboundRTP stats result and stores
872
- * @private
873
- * @param {*} result
874
- * @param {*} type
875
- * @returns {void}
876
- */
877
- private processOutboundRTPResult(result: any, type: any) {
878
- const mediaType = type || STATS.AUDIO_CORRELATE;
879
- const sendrecvType = STATS.SEND_DIRECTION;
880
-
881
- this.processTrackResult(result, type, sendrecvType);
882
- if (result.bytesSent) {
883
- let kilobytes = 0;
884
-
885
- if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesSent) {
886
- this.statsResults.internal[mediaType][sendrecvType].prevBytesSent = result.bytesSent;
887
- }
888
- if (!this.statsResults.internal[mediaType][sendrecvType].framesEncoded) {
889
- this.statsResults.internal[mediaType][sendrecvType].framesEncoded = result.framesEncoded;
890
- }
891
- if (!this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded) {
892
- this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded =
893
- result.keyFramesEncoded;
894
- }
895
-
896
- const bytes =
897
- result.bytesSent - this.statsResults.internal[mediaType][sendrecvType].prevBytesSent;
898
-
899
- this.statsResults.internal[mediaType][sendrecvType].prevBytesSent = result.bytesSent;
900
-
901
- kilobytes = bytes / 1024;
902
-
903
- this.statsResults[mediaType][sendrecvType].availableBandwidth = kilobytes.toFixed(1);
904
- this.statsResults[mediaType].bytesSent = kilobytes;
905
-
906
- this.statsResults[mediaType][sendrecvType].framesEncoded =
907
- result.framesEncoded - this.statsResults.internal[mediaType][sendrecvType].framesEncoded;
908
- this.statsResults[mediaType][sendrecvType].keyFramesEncoded =
909
- result.keyFramesEncoded -
910
- this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded;
911
- this.statsResults.internal[mediaType].outboundRtpId = result.id;
912
-
913
- if (!this.statsResults.internal[mediaType][sendrecvType].packetsSent) {
914
- this.statsResults.internal[mediaType][sendrecvType].packetsSent = result.packetsSent;
915
- }
916
-
917
- this.statsResults[mediaType][sendrecvType].packetsSent =
918
- result.packetsSent - this.statsResults.internal[mediaType][sendrecvType].packetsSent;
919
- this.statsResults.internal[mediaType][sendrecvType].packetsSent = result.packetsSent;
920
-
921
- // Data saved to send MQA metrics
922
-
923
- this.statsResults[mediaType][sendrecvType].totalKeyFramesEncoded = result.keyFramesEncoded;
924
- this.statsResults[mediaType][sendrecvType].totalNackCount = result.nackCount;
925
- this.statsResults[mediaType][sendrecvType].totalPliCount = result.pliCount;
926
- this.statsResults[mediaType][sendrecvType].totalPacketsSent = result.packetsSent;
927
- this.statsResults[mediaType][sendrecvType].totalFirCount = result.firCount;
928
- this.statsResults[mediaType][sendrecvType].framesSent = result.framesSent;
929
- this.statsResults[mediaType][sendrecvType].framesEncoded = result.framesEncoded;
930
- this.statsResults[mediaType][sendrecvType].encoderImplementation =
931
- result.encoderImplementation;
932
- this.statsResults[mediaType][sendrecvType].qualityLimitationReason =
933
- result.qualityLimitationReason;
934
- this.statsResults[mediaType][sendrecvType].qualityLimitationResolutionChanges =
935
- result.qualityLimitationResolutionChanges;
936
- this.statsResults[mediaType][sendrecvType].retransmittedPacketsSent =
937
- result.retransmittedPacketsSent;
938
- this.statsResults[mediaType][sendrecvType].totalBytesSent = result.bytesSent;
939
- this.statsResults[mediaType][sendrecvType].headerBytesSent = result.headerBytesSent;
940
- this.statsResults[mediaType][sendrecvType].retransmittedBytesSent =
941
- result.retransmittedBytesSent;
942
- }
943
- }
944
-
945
- /**
946
- * Processes InboundRTP stats result and stores
947
- * @private
948
- * @param {*} result
949
- * @param {*} type
950
- * @returns {void}
951
- */
952
- private processInboundRTPResult(result: any, type: any) {
953
- const mediaType = type || STATS.AUDIO_CORRELATE;
954
- const sendrecvType = STATS.RECEIVE_DIRECTION;
955
-
956
- this.processTrackResult(result, type, sendrecvType);
957
- if (result.bytesReceived) {
958
- let kilobytes = 0;
959
-
960
- if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived) {
961
- this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived =
962
- result.bytesReceived;
963
- }
964
-
965
- if (!this.statsResults.internal[mediaType][sendrecvType].pliCount) {
966
- this.statsResults.internal[mediaType][sendrecvType].pliCount = result.pliCount;
967
- }
968
-
969
- if (!this.statsResults.internal[mediaType][sendrecvType].packetsLost) {
970
- this.statsResults.internal[mediaType][sendrecvType].packetsLost = result.packetsLost;
971
- }
972
-
973
- if (!this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived) {
974
- this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived =
975
- result.packetsReceived;
976
- }
977
-
978
- if (!this.statsResults.internal[mediaType][sendrecvType].lastPacketReceivedTimestamp) {
979
- this.statsResults.internal[mediaType][sendrecvType].lastPacketReceivedTimestamp =
980
- result.lastPacketReceivedTimestamp;
981
- }
982
-
983
- const bytes =
984
- result.bytesReceived -
985
- this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived;
986
-
987
- this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived = result.bytesReceived;
988
-
989
- kilobytes = bytes / 1024;
990
- this.statsResults[mediaType][sendrecvType].availableBandwidth = kilobytes.toFixed(1);
991
- this.statsResults[mediaType].bytesReceived = kilobytes.toFixed(1);
992
-
993
- this.statsResults[mediaType][sendrecvType].pliCount =
994
- result.pliCount - this.statsResults.internal[mediaType][sendrecvType].pliCount;
995
- this.statsResults[mediaType][sendrecvType].currentPacketsLost =
996
- result.packetsLost - this.statsResults.internal[mediaType][sendrecvType].packetsLost;
997
- if (this.statsResults[mediaType][sendrecvType].currentPacketsLost < 0) {
998
- this.statsResults[mediaType][sendrecvType].currentPacketsLost = 0;
999
- }
1000
-
1001
- this.statsResults[mediaType][sendrecvType].packetsReceived =
1002
- result.packetsReceived -
1003
- this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived;
1004
- this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived =
1005
- result.packetsReceived;
1006
-
1007
- if (this.statsResults[mediaType][sendrecvType].packetsReceived === 0) {
1008
- LoggerProxy.logger.info(
1009
- `StatsAnalyzer:index#processInboundRTPResult --> No packets received for ${mediaType} `,
1010
- this.statsResults[mediaType][sendrecvType].packetsReceived
1011
- );
1012
- }
1013
-
1014
- // Check the over all packet Lost ratio
1015
- this.statsResults[mediaType][sendrecvType].currentPacketLossRatio =
1016
- this.statsResults[mediaType][sendrecvType].currentPacketsLost > 0
1017
- ? this.statsResults[mediaType][sendrecvType].currentPacketsLost /
1018
- (this.statsResults[mediaType][sendrecvType].packetsReceived +
1019
- this.statsResults[mediaType][sendrecvType].currentPacketsLost)
1020
- : 0;
1021
- if (this.statsResults[mediaType][sendrecvType].currentPacketLossRatio > 3) {
1022
- LoggerProxy.logger.info(
1023
- 'StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver ',
1024
- this.statsResults[mediaType][sendrecvType].currentPacketLossRatio
1025
- );
1026
- }
1027
-
1028
- // TODO: check the packet loss value is negative values here
1029
-
1030
- if (result.packetsLost) {
1031
- this.statsResults[mediaType][sendrecvType].totalPacketsLost =
1032
- result.packetsLost > 0 ? result.packetsLost : -result.packetsLost;
1033
- } else {
1034
- this.statsResults[mediaType][sendrecvType].totalPacketsLost = 0;
1035
- }
1036
-
1037
- this.statsResults[mediaType][sendrecvType].lastPacketReceivedTimestamp =
1038
- result.lastPacketReceivedTimestamp;
1039
-
1040
- // From Thin
1041
- this.statsResults[mediaType][sendrecvType].totalNackCount = result.nackCount;
1042
- this.statsResults[mediaType][sendrecvType].totalPliCount = result.pliCount;
1043
- this.statsResults[mediaType][sendrecvType].framesDecoded = result.framesDecoded;
1044
- this.statsResults[mediaType][sendrecvType].keyFramesDecoded = result.keyFramesDecoded;
1045
-
1046
- this.statsResults[mediaType][sendrecvType].decoderImplementation =
1047
- result.decoderImplementation;
1048
- this.statsResults[mediaType][sendrecvType].totalPacketsReceived = result.packetsReceived;
1049
-
1050
- this.statsResults[mediaType][sendrecvType].fecPacketsDiscarded = result.fecPacketsDiscarded;
1051
- this.statsResults[mediaType][sendrecvType].fecPacketsReceived = result.fecPacketsReceived;
1052
- this.statsResults[mediaType][sendrecvType].totalBytesReceived = result.bytesReceived;
1053
- this.statsResults[mediaType][sendrecvType].headerBytesReceived = result.headerBytesReceived;
1054
-
1055
- this.statsResults[mediaType][sendrecvType].meanRtpJitter.push(result.jitter);
1056
-
1057
- // Audio stats
1058
-
1059
- this.statsResults[mediaType][sendrecvType].audioLevel = result.audioLevel;
1060
- this.statsResults[mediaType][sendrecvType].totalAudioEnergy = result.totalAudioEnergy;
1061
- this.statsResults[mediaType][sendrecvType].totalSamplesReceived =
1062
- result.totalSamplesReceived || 0;
1063
- this.statsResults[mediaType][sendrecvType].totalSamplesDecoded =
1064
- result.totalSamplesDecoded || 0;
1065
- this.statsResults[mediaType][sendrecvType].concealedSamples = result.concealedSamples || 0;
1066
- }
1067
- }
1068
-
1069
- /**
1070
- * Processes remote and local candidate result and stores
1071
- * @private
1072
- * @param {*} result
1073
- * @param {*} type
1074
- * @param {boolean} isSender
1075
- * @param {boolean} isRemote
1076
- *
1077
- * @returns {void}
1078
- */
1079
- parseCandidate = (result: any, type: any, isSender: boolean, isRemote: boolean) => {
1080
- if (!result || !result.id) {
1081
- return;
1082
- }
1083
- const RemoteCandidateType = {};
1084
- const RemoteTransport = {};
1085
- const RemoteIpAddress = {};
1086
- const RemoteNetworkType = {};
1087
-
1088
- if (!result.id) return;
1089
-
1090
- const sendRecvType = isSender ? STATS.SEND_DIRECTION : STATS.RECEIVE_DIRECTION;
1091
- const ipType = isRemote ? STATS.REMOTE : STATS.LOCAL;
1092
-
1093
- if (!RemoteCandidateType[result.id]) {
1094
- RemoteCandidateType[result.id] = [];
1095
- }
1096
-
1097
- if (!RemoteTransport[result.id]) {
1098
- RemoteTransport[result.id] = [];
1099
- }
1100
-
1101
- if (!RemoteIpAddress[result.id]) {
1102
- RemoteIpAddress[result.id] = [];
1103
- }
1104
- if (!RemoteNetworkType[result.id]) {
1105
- RemoteNetworkType[result.id] = [];
1106
- }
1107
-
1108
- if (
1109
- result.candidateType &&
1110
- RemoteCandidateType[result.id].indexOf(result.candidateType) === -1
1111
- ) {
1112
- RemoteCandidateType[result.id].push(result.candidateType);
1113
- }
1114
-
1115
- if (result.protocol && RemoteTransport[result.id].indexOf(result.protocol) === -1) {
1116
- RemoteTransport[result.id].push(result.protocol.toUpperCase());
1117
- }
1118
-
1119
- if (
1120
- result.ip &&
1121
- RemoteIpAddress[result.id].indexOf(`${result.ip}:${result.portNumber}`) === -1
1122
- ) {
1123
- RemoteIpAddress[result.id].push(`${result.ip}`); // TODO: Add ports
1124
- }
1125
-
1126
- if (result.networkType && RemoteNetworkType[result.id].indexOf(result.networkType) === -1) {
1127
- RemoteNetworkType[result.id].push(result.networkType);
1128
- }
1129
-
1130
- this.statsResults.internal.candidates[result.id] = {
1131
- candidateType: RemoteCandidateType[result.id],
1132
- ipAddress: RemoteIpAddress[result.id],
1133
- portNumber: result.port,
1134
- networkType: RemoteNetworkType[result.id],
1135
- priority: result.priority,
1136
- transport: RemoteTransport[result.id],
1137
- timestamp: result.time,
1138
- id: result.id,
1139
- type: result.type,
1140
- };
1141
-
1142
- this.statsResults.connectionType[ipType].candidateType = RemoteCandidateType[result.id];
1143
- this.statsResults.connectionType[ipType].ipAddress = RemoteIpAddress[result.id];
1144
-
1145
- this.statsResults.connectionType[ipType].networkType =
1146
- RemoteNetworkType[result.id][0] === NETWORK_TYPE.VPN
1147
- ? NETWORK_TYPE.UNKNOWN
1148
- : RemoteNetworkType[result.id][0];
1149
- this.statsResults.connectionType[ipType].transport = RemoteTransport[result.id];
1150
-
1151
- this.statsResults[type][sendRecvType].totalRoundTripTime = result.totalRoundTripTime;
1152
- };
1153
-
1154
- /**
1155
- * Process Track results
1156
- *
1157
- * @private
1158
- * @param {*} result
1159
- * @param {*} mediaType
1160
- * @param {*} sendrecvType
1161
- * @returns {void}
1162
- * @memberof StatsAnalyzer
1163
- */
1164
- private processTrackResult(result: any, mediaType: any, sendrecvType: any) {
1165
- if (!result || mediaType === STATS.AUDIO_CORRELATE) {
1166
- return;
1167
- }
1168
- if (result.type !== 'inbound-rtp' && result.type !== 'outbound-rtp') {
1169
- return;
1170
- }
1171
- if (result.frameWidth && result.frameHeight) {
1172
- this.statsResults.resolutions[mediaType][sendrecvType].width = result.frameWidth;
1173
- this.statsResults.resolutions[mediaType][sendrecvType].height = result.frameHeight;
1174
- }
1175
-
1176
- if (sendrecvType === STATS.RECEIVE_DIRECTION) {
1177
- this.statsResults.resolutions[mediaType][sendrecvType].framesReceived = result.framesReceived;
1178
- this.statsResults.resolutions[mediaType][sendrecvType].framesDecoded = result.framesDecoded;
1179
- this.statsResults.resolutions[mediaType][sendrecvType].framesDropped = result.framesDropped;
1180
- } else if (sendrecvType === STATS.SEND_DIRECTION) {
1181
- this.statsResults.resolutions[mediaType][sendrecvType].framesSent = result.framesSent;
1182
- this.statsResults.resolutions[mediaType][sendrecvType].hugeFramesSent = result.hugeFramesSent;
1183
- }
1184
-
1185
- if (result.trackIdentifier && mediaType !== STATS.AUDIO_CORRELATE) {
1186
- this.statsResults.resolutions[mediaType][sendrecvType].trackIdentifier =
1187
- result.trackIdentifier;
1188
-
1189
- const jitterBufferDelay = result && result.jitterBufferDelay;
1190
- const jitterBufferEmittedCount = result && result.jitterBufferEmittedCount;
1191
-
1192
- this.statsResults.resolutions[mediaType][sendrecvType].avgJitterDelay =
1193
- jitterBufferEmittedCount && +jitterBufferDelay / +jitterBufferEmittedCount;
1194
-
1195
- // Used to calculate the jitter
1196
- this.statsResults.resolutions[mediaType][sendrecvType].jitterBufferDelay =
1197
- result.jitterBufferDelay;
1198
- this.statsResults.resolutions[mediaType][sendrecvType].jitterBufferEmittedCount =
1199
- result.jitterBufferEmittedCount;
1200
- }
1201
- }
1202
-
1203
- /**
1204
- *
1205
- * @private
1206
- * @param {*} result
1207
- * @param {*} type
1208
- * @returns {void}
1209
- * @memberof StatsAnalyzer
1210
- */
1211
- private compareSentAndReceived(result: any, type: any) {
1212
- if (!type) {
1213
- return;
1214
- }
1215
-
1216
- const mediaType = type;
1217
-
1218
- if (!this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver) {
1219
- this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1220
- }
1221
-
1222
- const currentPacketLoss =
1223
- result.packetsLost - this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver;
1224
-
1225
- this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1226
- this.statsResults[mediaType].send.packetsLostOnReceiver = currentPacketLoss;
1227
- this.statsResults[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1228
-
1229
- this.statsResults[mediaType].send.meanRemoteJitter.push(result.jitter);
1230
- this.statsResults[mediaType].send.meanRoundTripTime.push(result.roundTripTime);
1231
-
1232
- this.statsResults[mediaType].send.timestamp = result.timestamp;
1233
- this.statsResults[mediaType].send.ssrc = result.ssrc;
1234
- this.statsResults[mediaType].send.reportsReceived = result.reportsReceived;
1235
-
1236
- // Total packloss ratio on this video section of the call
1237
- this.statsResults[mediaType].send.overAllPacketLossRatio =
1238
- this.statsResults[mediaType].send.totalPacketsLostOnReceiver > 0
1239
- ? this.statsResults[mediaType].send.totalPacketsLostOnReceiver /
1240
- this.statsResults[mediaType].send.totalPacketsSent
1241
- : 0;
1242
- this.statsResults[mediaType].send.currentPacketLossRatio =
1243
- this.statsResults[mediaType].send.packetsLostOnReceiver > 0
1244
- ? (this.statsResults[mediaType].send.packetsLostOnReceiver * 100) /
1245
- (this.statsResults[mediaType].send.packetsSent +
1246
- this.statsResults[mediaType].send.packetsLostOnReceiver)
1247
- : 0;
1248
-
1249
- if (
1250
- this.statsResults[mediaType].send.maxPacketLossRatio <
1251
- this.statsResults[mediaType].send.currentPacketLossRatio
1252
- ) {
1253
- this.statsResults[mediaType].send.maxPacketLossRatio =
1254
- this.statsResults[mediaType].send.currentPacketLossRatio;
1255
- }
1256
-
1257
- if (result.type === 'remote-inbound-rtp') {
1258
- this.networkQualityMonitor.determineUplinkNetworkQuality({
1259
- mediaType,
1260
- remoteRtpResults: result,
1261
- statsAnalyzerCurrentStats: this.statsResults,
1262
- });
1263
- }
1264
- }
1265
- }
1
+ /* eslint-disable prefer-destructuring */
2
+
3
+ import {cloneDeep} from 'lodash';
4
+
5
+ import EventsScope from '../common/events/events-scope';
6
+ import {
7
+ DEFAULT_GET_STATS_FILTER,
8
+ CONNECTION_STATE,
9
+ STATS,
10
+ MQA_INTEVAL,
11
+ NETWORK_TYPE,
12
+ MEDIA_DEVICES,
13
+ _UNKNOWN_,
14
+ } from '../constants';
15
+ import mqaData from '../mediaQualityMetrics/config';
16
+ import LoggerProxy from '../common/logs/logger-proxy';
17
+
18
+ import defaultStats from './global';
19
+ import {
20
+ getAudioSenderMqa,
21
+ getAudioReceiverMqa,
22
+ getVideoSenderMqa,
23
+ getVideoReceiverMqa,
24
+ } from './mqaUtil';
25
+
26
+ export const EVENTS = {
27
+ MEDIA_QUALITY: 'MEDIA_QUALITY',
28
+ LOCAL_MEDIA_STARTED: 'LOCAL_MEDIA_STARTED',
29
+ LOCAL_MEDIA_STOPPED: 'LOCAL_MEDIA_STOPPED',
30
+ REMOTE_MEDIA_STARTED: 'REMOTE_MEDIA_STARTED',
31
+ REMOTE_MEDIA_STOPPED: 'REMOTE_MEDIA_STOPPED',
32
+ };
33
+
34
+ /**
35
+ * Stats Analyzer class that will emit events based on detected quality
36
+ *
37
+ * @export
38
+ * @class StatsAnalyzer
39
+ * @extends {EventsScope}
40
+ */
41
+ export class StatsAnalyzer extends EventsScope {
42
+ config: any;
43
+ correlationId: any;
44
+ lastEmittedStartStopEvent: any;
45
+ lastMqaDataSent: any;
46
+ lastStatsResults: any;
47
+ localMQEStats: any;
48
+ meetingMediaStatus: any;
49
+ mqaInterval: NodeJS.Timeout;
50
+ mqaSentCount: any;
51
+ networkQualityMonitor: any;
52
+ peerConnection: any;
53
+ statsInterval: NodeJS.Timeout;
54
+ statsResults: any;
55
+ statsStarted: any;
56
+
57
+ /**
58
+ * Creates a new instance of StatsAnalyzer
59
+ * @constructor
60
+ * @public
61
+ * @param {Object} config SDK Configuration Object
62
+ * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
63
+ * @param {Object} statsResults Default properties for stats
64
+ */
65
+ constructor(
66
+ config: any,
67
+ networkQualityMonitor: object = {},
68
+ statsResults: object = defaultStats
69
+ ) {
70
+ super();
71
+ this.statsStarted = false;
72
+ this.statsResults = statsResults;
73
+ this.lastStatsResults = null;
74
+ this.config = config;
75
+ this.networkQualityMonitor = networkQualityMonitor;
76
+ this.correlationId = config.correlationId;
77
+ this.mqaSentCount = -1;
78
+ this.lastMqaDataSent = {
79
+ resolutions: {
80
+ video: {send: {}, recv: {}},
81
+ audio: {send: {}, recv: {}},
82
+ share: {send: {}, recv: {}},
83
+ },
84
+ video: {send: {}, recv: {}},
85
+ audio: {send: {}, recv: {}},
86
+ share: {send: {}, recv: {}},
87
+ };
88
+ this.localMQEStats = {
89
+ audio: {
90
+ RX: {
91
+ packetsLost: [],
92
+ jitter: [],
93
+ latency: [],
94
+ bitRate: [],
95
+ },
96
+ TX: {
97
+ packetsLost: [],
98
+ jitter: [],
99
+ latency: [],
100
+ bitRate: [],
101
+ },
102
+ },
103
+ video: {
104
+ RX: {
105
+ packetsLost: [],
106
+ jitter: [],
107
+ latency: [],
108
+ bitRate: [],
109
+ frameRate: [],
110
+ resolutionWidth: [],
111
+ resolutionHeight: [],
112
+ requestedKeyFrame: [],
113
+ receivedKeyFrame: [],
114
+ },
115
+ TX: {
116
+ packetsLost: [],
117
+ jitter: [],
118
+ latency: [],
119
+ bitRate: [],
120
+ frameRate: [],
121
+ resolutionWidth: [],
122
+ resolutionHeight: [],
123
+ requestedKeyFrame: [],
124
+ receivedKeyFrame: [],
125
+ },
126
+ },
127
+ };
128
+ this.lastEmittedStartStopEvent = {
129
+ audio: {
130
+ local: undefined,
131
+ remote: undefined,
132
+ },
133
+ video: {
134
+ local: undefined,
135
+ remote: undefined,
136
+ },
137
+ share: {
138
+ local: undefined,
139
+ remote: undefined,
140
+ },
141
+ };
142
+ }
143
+
144
+ populateResults(lastMqa) {
145
+ // Audio
146
+
147
+ this.localMQEStats.audio.RX.packetsLost.push(lastMqa.audioReceive[0].common.mediaHopByHopLost);
148
+ this.localMQEStats.audio.RX.jitter.push(lastMqa.audioReceive[0].streams[0].common.rtpJitter);
149
+ this.localMQEStats.audio.RX.latency.push(lastMqa.audioReceive[0].common.roundTripTime);
150
+ this.localMQEStats.audio.RX.bitRate.push(
151
+ lastMqa.audioReceive[0].streams[0].common.receivedBitrate
152
+ );
153
+
154
+ this.localMQEStats.audio.TX.packetsLost.push(lastMqa.audioTransmit[0].common.remoteLossRate);
155
+ this.localMQEStats.audio.TX.jitter.push(lastMqa.audioTransmit[0].common.remoteJitter);
156
+ this.localMQEStats.audio.TX.latency.push(lastMqa.audioTransmit[0].common.roundTripTime);
157
+ this.localMQEStats.audio.TX.bitRate.push(
158
+ lastMqa.audioTransmit[0].streams[0].common.transmittedBitrate
159
+ );
160
+
161
+ // Video
162
+
163
+ this.localMQEStats.video.RX.packetsLost.push(lastMqa.videoReceive[0].common.mediaHopByHopLost);
164
+ this.localMQEStats.video.RX.jitter.push(lastMqa.videoReceive[0].streams[0].common.rtpJitter);
165
+ this.localMQEStats.video.RX.latency.push(
166
+ lastMqa.videoReceive[0].streams[0].common.roundTripTime
167
+ );
168
+ this.localMQEStats.video.RX.bitRate.push(
169
+ lastMqa.videoReceive[0].streams[0].common.receivedBitrate
170
+ );
171
+ this.localMQEStats.video.RX.frameRate.push(
172
+ lastMqa.videoReceive[0].streams[0].common.receivedFrameRate
173
+ );
174
+ this.localMQEStats.video.RX.resolutionWidth.push(
175
+ lastMqa.videoReceive[0].streams[0].receivedWidth
176
+ );
177
+ this.localMQEStats.video.RX.resolutionHeight.push(
178
+ lastMqa.videoReceive[0].streams[0].receivedHeight
179
+ );
180
+ this.localMQEStats.video.RX.requestedKeyFrame.push();
181
+ this.localMQEStats.video.RX.receivedKeyFrame.push();
182
+
183
+ this.localMQEStats.video.TX.packetsLost.push(lastMqa.videoTransmit[0].common.remoteLossRate);
184
+ this.localMQEStats.video.TX.jitter.push(lastMqa.videoTransmit[0].common.remoteJitter);
185
+ this.localMQEStats.video.TX.latency.push(lastMqa.videoTransmit[0].common.roundTripTime);
186
+ this.localMQEStats.video.TX.bitRate.push(
187
+ lastMqa.videoTransmit[0].streams[0].common.transmittedBitrate
188
+ );
189
+ this.localMQEStats.video.TX.frameRate.push(
190
+ lastMqa.videoTransmit[0].streams[0].common.transmittedFrameRate
191
+ );
192
+ this.localMQEStats.video.TX.resolutionWidth.push(
193
+ lastMqa.videoTransmit[0].streams[0].transmittedWidth
194
+ );
195
+ this.localMQEStats.video.TX.resolutionHeight.push(
196
+ lastMqa.videoTransmit[0].streams[0].transmittedHeight
197
+ );
198
+ this.localMQEStats.video.TX.requestedKeyFrame.push(
199
+ lastMqa.videoTransmit[0].streams[0].requestedKeyFrames
200
+ );
201
+ this.localMQEStats.video.TX.receivedKeyFrame.push();
202
+ }
203
+
204
+ resetStatsResults() {
205
+ this.statsResults.audio.send.meanRemoteJitter = [];
206
+ this.statsResults.video.send.meanRemoteJitter = [];
207
+ this.statsResults.share.send.meanRemoteJitter = [];
208
+
209
+ this.statsResults.audio.recv.meanRtpJitter = [];
210
+
211
+ // TODO: currently no values are present
212
+ this.statsResults.video.recv.meanRtpJitter = [];
213
+ this.statsResults.share.recv.meanRtpJitter = [];
214
+
215
+ // Reset the roundTripTime
216
+ this.statsResults.audio.send.meanRoundTripTime = [];
217
+ this.statsResults.video.send.meanRoundTripTime = [];
218
+ this.statsResults.share.send.meanRoundTripTime = [];
219
+ }
220
+
221
+ /**
222
+ * sets mediaStatus status for analyzing metrics
223
+ *
224
+ * @public
225
+ * @param {Object} status for the audio and video
226
+ * @memberof StatsAnalyzer
227
+ * @returns {void}
228
+ */
229
+ public updateMediaStatus(status: object) {
230
+ this.meetingMediaStatus = status;
231
+ }
232
+
233
+ /**
234
+ * captures MQA data from peerconnection
235
+ *
236
+ * @public
237
+ * @memberof StatsAnalyzer
238
+ * @returns {void}
239
+ */
240
+ public sendMqaData() {
241
+ const audioReceiver = mqaData.intervals[0].audioReceive[0];
242
+ const audioSender = mqaData.intervals[0].audioTransmit[0];
243
+ const videoReceiver = mqaData.intervals[0].videoReceive[0];
244
+ const videoSender = mqaData.intervals[0].videoTransmit[0];
245
+ const shareSender = mqaData.intervals[0].videoTransmit[1];
246
+ const shareReceiver = mqaData.intervals[0].videoReceive[1];
247
+
248
+ getAudioSenderMqa({
249
+ audioSender,
250
+ statsResults: this.statsResults,
251
+ lastMqaDataSent: this.lastMqaDataSent,
252
+ });
253
+ getAudioReceiverMqa({
254
+ audioReceiver,
255
+ statsResults: this.statsResults,
256
+ lastMqaDataSent: this.lastMqaDataSent,
257
+ });
258
+
259
+ getVideoReceiverMqa({
260
+ videoReceiver,
261
+ statsResults: this.statsResults,
262
+ lastMqaDataSent: this.lastMqaDataSent,
263
+ });
264
+ getVideoSenderMqa({
265
+ videoSender,
266
+ statsResults: this.statsResults,
267
+ lastMqaDataSent: this.lastMqaDataSent,
268
+ });
269
+
270
+ // Capture mqa for share scenario
271
+
272
+ getVideoSenderMqa({
273
+ videoSender: shareSender,
274
+ statsResults: this.statsResults,
275
+ lastMqaDataSent: this.lastMqaDataSent,
276
+ isShareStream: true,
277
+ });
278
+
279
+ getVideoReceiverMqa({
280
+ videoReceiver: shareReceiver,
281
+ statsResults: this.statsResults,
282
+ lastMqaDataSent: this.lastMqaDataSent,
283
+ isShareStream: true,
284
+ });
285
+ mqaData.intervals[0].intervalMetadata.peerReflexiveIP =
286
+ this.statsResults.connectionType.local.ipAddress[0];
287
+
288
+ // Adding peripheral information
289
+ mqaData.intervals[0].intervalMetadata.peripherals = [];
290
+ mqaData.intervals[0].intervalMetadata.peripherals.push({
291
+ information: _UNKNOWN_,
292
+ name: MEDIA_DEVICES.SPEAKER,
293
+ });
294
+ mqaData.intervals[0].intervalMetadata.peripherals.push({
295
+ information: this.peerConnection?.audioTransceiver?.sender?.track?.label || _UNKNOWN_,
296
+ name: MEDIA_DEVICES.MICROPHONE,
297
+ });
298
+ mqaData.intervals[0].intervalMetadata.peripherals.push({
299
+ information: this.peerConnection?.videoTransceiver?.sender?.track?.label || _UNKNOWN_,
300
+ name: MEDIA_DEVICES.CAMERA,
301
+ });
302
+
303
+ // @ts-ignore
304
+ mqaData.networkType = this.statsResults.connectionType.local.networkType;
305
+
306
+ this.mqaSentCount += 1;
307
+
308
+ mqaData.intervals[0].intervalNumber = this.mqaSentCount;
309
+
310
+ // DO Deep copy, for some reason it takes the reference all the time rather then old value set
311
+ this.lastMqaDataSent = cloneDeep(this.statsResults);
312
+
313
+ this.populateResults(mqaData.intervals[0]);
314
+
315
+ this.resetStatsResults();
316
+
317
+ this.emit(
318
+ {
319
+ file: 'statsAnalyzer',
320
+ function: 'sendMqaData',
321
+ },
322
+ EVENTS.MEDIA_QUALITY,
323
+ {
324
+ data: mqaData.intervals[0],
325
+ // @ts-ignore
326
+ networkType: mqaData.networkType,
327
+ }
328
+ );
329
+ }
330
+
331
+ /**
332
+ * updated the peerconnection when changed
333
+ *
334
+ * @private
335
+ * @memberof updatePeerconnection
336
+ * @param {PeerConnection} peerConnection
337
+ * @returns {void}
338
+ */
339
+ updatePeerconnection(peerConnection: any) {
340
+ this.peerConnection = peerConnection;
341
+ }
342
+
343
+ /**
344
+ * Starts the stats analyzer on interval
345
+ *
346
+ * @public
347
+ * @memberof StatsAnalyzer
348
+ * @param {PeerConnection} peerConnection
349
+ * @returns {Promise}
350
+ */
351
+ public startAnalyzer(peerConnection: any) {
352
+ if (!this.statsStarted) {
353
+ this.statsStarted = true;
354
+ this.peerConnection = peerConnection;
355
+
356
+ return this.getStatsAndParse().then(() => {
357
+ this.statsInterval = setInterval(() => {
358
+ this.getStatsAndParse();
359
+ }, this.config.analyzerInterval);
360
+ // Trigger initial fetch
361
+ this.sendMqaData();
362
+ this.mqaInterval = setInterval(() => {
363
+ this.sendMqaData();
364
+ }, MQA_INTEVAL);
365
+ });
366
+ }
367
+
368
+ return Promise.resolve();
369
+ }
370
+
371
+ /**
372
+ * Cleans up the analyzer when done
373
+ *
374
+ * @public
375
+ * @memberof StatsAnalyzer
376
+ * @returns {void}
377
+ */
378
+ public stopAnalyzer() {
379
+ const sendOneLastMqa = this.mqaInterval && this.statsInterval;
380
+
381
+ if (this.statsInterval) {
382
+ clearInterval(this.statsInterval);
383
+ this.statsInterval = undefined;
384
+ }
385
+
386
+ if (this.mqaInterval) {
387
+ clearInterval(this.mqaInterval);
388
+ this.mqaInterval = undefined;
389
+ }
390
+
391
+ if (sendOneLastMqa) {
392
+ return this.getStatsAndParse().then(() => {
393
+ this.sendMqaData();
394
+ this.peerConnection = null;
395
+ });
396
+ }
397
+
398
+ return Promise.resolve();
399
+ }
400
+
401
+ /**
402
+ * Parse a single result of get stats
403
+ *
404
+ * @private
405
+ * @param {*} getStatsResult
406
+ * @param {String} type
407
+ * @param {boolean} isSender
408
+ * @returns {void}
409
+ * @memberof StatsAnalyzer
410
+ */
411
+ private parseGetStatsResult(getStatsResult: any, type: string, isSender: boolean) {
412
+ if (!getStatsResult) {
413
+ return;
414
+ }
415
+
416
+ switch (getStatsResult.type) {
417
+ case 'outbound-rtp':
418
+ this.processOutboundRTPResult(getStatsResult, type);
419
+ break;
420
+ case 'inbound-rtp':
421
+ this.processInboundRTPResult(getStatsResult, type);
422
+ break;
423
+ case 'track':
424
+ this.processTrackResult(getStatsResult, type);
425
+ break;
426
+ case 'remote-inbound-rtp':
427
+ case 'remote-outbound-rtp':
428
+ // @ts-ignore
429
+ this.compareSentAndReceived(getStatsResult, type, isSender);
430
+ break;
431
+ case 'remotecandidate':
432
+ case 'remote-candidate':
433
+ this.parseCandidate(getStatsResult, type, isSender, true);
434
+ break;
435
+ case 'local-candidate':
436
+ this.parseCandidate(getStatsResult, type, isSender, false);
437
+ break;
438
+ case 'media-source':
439
+ // @ts-ignore
440
+ this.parseAudioSource(getStatsResult, type);
441
+ break;
442
+ default:
443
+ break;
444
+ }
445
+ }
446
+
447
+ /**
448
+ * Filters the get stats results for types
449
+ * @private
450
+ * @param {Array} getStatsResults
451
+ * @param {String} type
452
+ * @param {boolean} isSender
453
+ * @returns {void}
454
+ */
455
+ private filterAndParseGetStatsResults(
456
+ getStatsResults: Array<any>,
457
+ type: string,
458
+ isSender: boolean
459
+ ) {
460
+ const {types} = DEFAULT_GET_STATS_FILTER;
461
+
462
+ getStatsResults.forEach((result) => {
463
+ if (types.includes(result.type)) {
464
+ this.parseGetStatsResult(result, type, isSender);
465
+ }
466
+ });
467
+ }
468
+
469
+ /**
470
+ * parse the audio
471
+ * @param {String} result
472
+ * @param {boolean} type
473
+ * @returns {void}
474
+ */
475
+ parseAudioSource(result: any, type: any) {
476
+ if (!result) {
477
+ return;
478
+ }
479
+
480
+ if (type === STATS.AUDIO_CORRELATE) {
481
+ this.statsResults[type].send.audioLevel = result.audioLevel;
482
+ this.statsResults[type].send.totalAudioEnergy = result.totalAudioEnergy;
483
+ }
484
+ }
485
+
486
+ /**
487
+ * emits started/stopped events for local/remote media by checking
488
+ * if given values are increasing or not. The previousValue, currentValue
489
+ * params can be any numerical value like number of receive packets or
490
+ * decoded frames, etc.
491
+ *
492
+ * @private
493
+ * @param {string} mediaType
494
+ * @param {number} previousValue - value to compare
495
+ * @param {number} currentValue - value to compare (must be same type of value as previousValue)
496
+ * @param {boolean} isLocal - true if stats are for local media being sent out, false for remote media being received
497
+ * @memberof StatsAnalyzer
498
+ * @returns {void}
499
+ */
500
+ emitStartStopEvents = (
501
+ mediaType: string,
502
+ previousValue: number,
503
+ currentValue: number,
504
+ isLocal: boolean
505
+ ) => {
506
+ if (mediaType !== 'audio' && mediaType !== 'video' && mediaType !== 'share') {
507
+ throw new Error(`Unsupported mediaType: ${mediaType}`);
508
+ }
509
+
510
+ // eslint-disable-next-line no-param-reassign
511
+ if (previousValue === undefined) previousValue = 0;
512
+ // eslint-disable-next-line no-param-reassign
513
+ if (currentValue === undefined) currentValue = 0;
514
+
515
+ const lastEmittedEvent = isLocal
516
+ ? this.lastEmittedStartStopEvent[mediaType].local
517
+ : this.lastEmittedStartStopEvent[mediaType].remote;
518
+
519
+ let newEvent;
520
+
521
+ if (currentValue - previousValue > 0) {
522
+ newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STARTED : EVENTS.REMOTE_MEDIA_STARTED;
523
+ } else if (currentValue === previousValue && currentValue > 0) {
524
+ newEvent = isLocal ? EVENTS.LOCAL_MEDIA_STOPPED : EVENTS.REMOTE_MEDIA_STOPPED;
525
+ }
526
+
527
+ if (newEvent && lastEmittedEvent !== newEvent) {
528
+ if (isLocal) {
529
+ this.lastEmittedStartStopEvent[mediaType].local = newEvent;
530
+ } else {
531
+ this.lastEmittedStartStopEvent[mediaType].remote = newEvent;
532
+ }
533
+ this.emit(
534
+ {
535
+ file: 'statsAnalyzer/index',
536
+ function: 'compareLastStatsResult',
537
+ },
538
+ newEvent,
539
+ {
540
+ type: mediaType,
541
+ }
542
+ );
543
+ }
544
+ };
545
+
546
+ /**
547
+ * compares current and previous stats to check if packets are not sent
548
+ *
549
+ * @private
550
+ * @memberof StatsAnalyzer
551
+ * @returns {void}
552
+ */
553
+ private compareLastStatsResult() {
554
+ if (this.lastStatsResults !== null && this.meetingMediaStatus) {
555
+ // compare audio stats sent
556
+ let mediaType = STATS.AUDIO_CORRELATE;
557
+ let currentStats = null;
558
+ let previousStats = null;
559
+
560
+ if (this.meetingMediaStatus.expected.sendAudio) {
561
+ currentStats = this.statsResults[mediaType].send;
562
+ previousStats = this.lastStatsResults[mediaType].send;
563
+
564
+ if (
565
+ currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
566
+ currentStats.totalPacketsSent === 0
567
+ ) {
568
+ LoggerProxy.logger.info(
569
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
570
+ );
571
+ } else {
572
+ if (
573
+ currentStats.totalAudioEnergy === previousStats.totalAudioEnergy ||
574
+ currentStats.totalAudioEnergy === 0
575
+ ) {
576
+ LoggerProxy.logger.info(
577
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Energy present`
578
+ );
579
+ }
580
+
581
+ if (currentStats.audioLevel === 0) {
582
+ LoggerProxy.logger.info(
583
+ `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} level is 0 for the user`
584
+ );
585
+ }
586
+ }
587
+
588
+ this.emitStartStopEvents(
589
+ mediaType,
590
+ previousStats.totalPacketsSent,
591
+ currentStats.totalPacketsSent,
592
+ true
593
+ );
594
+ }
595
+
596
+ if (this.meetingMediaStatus.expected.receiveAudio) {
597
+ // compare audio stats received
598
+ currentStats = this.statsResults[mediaType].recv;
599
+ previousStats = this.lastStatsResults[mediaType].recv;
600
+
601
+ if (
602
+ currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
603
+ currentStats.totalPacketsReceived === 0
604
+ ) {
605
+ LoggerProxy.logger.info(
606
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
607
+ );
608
+ } else if (
609
+ currentStats.totalSamplesReceived === previousStats.totalSamplesReceived ||
610
+ currentStats.totalSamplesReceived === 0
611
+ ) {
612
+ LoggerProxy.logger.info(
613
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} samples received`
614
+ );
615
+ }
616
+
617
+ this.emitStartStopEvents(
618
+ mediaType,
619
+ previousStats.totalPacketsReceived,
620
+ currentStats.totalPacketsReceived,
621
+ false
622
+ );
623
+ }
624
+
625
+ mediaType = STATS.VIDEO_CORRELATE;
626
+ if (this.meetingMediaStatus.expected.sendVideo) {
627
+ // compare video stats sent
628
+ currentStats = this.statsResults[mediaType].send;
629
+ previousStats = this.lastStatsResults[mediaType].send;
630
+
631
+ if (
632
+ currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
633
+ currentStats.totalPacketsSent === 0
634
+ ) {
635
+ LoggerProxy.logger.info(
636
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
637
+ );
638
+ } else {
639
+ if (
640
+ currentStats.framesEncoded === previousStats.framesEncoded ||
641
+ currentStats.framesEncoded === 0
642
+ ) {
643
+ LoggerProxy.logger.info(
644
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Frames Encoded`
645
+ );
646
+ }
647
+
648
+ if (
649
+ this.statsResults.resolutions[mediaType].send.framesSent ===
650
+ this.lastStatsResults.resolutions[mediaType].send.framesSent ||
651
+ this.statsResults.resolutions[mediaType].send.framesSent === 0
652
+ ) {
653
+ LoggerProxy.logger.info(
654
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} Frames sent`
655
+ );
656
+ }
657
+ }
658
+
659
+ this.emitStartStopEvents(
660
+ mediaType,
661
+ previousStats.framesSent,
662
+ currentStats.framesSent,
663
+ true
664
+ );
665
+ }
666
+
667
+ if (this.meetingMediaStatus.expected.receiveVideo) {
668
+ // compare video stats reveived
669
+
670
+ currentStats = this.statsResults[mediaType].recv;
671
+ previousStats = this.lastStatsResults[mediaType].recv;
672
+
673
+ if (
674
+ currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
675
+ currentStats.totalPacketsReceived === 0
676
+ ) {
677
+ LoggerProxy.logger.info(
678
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
679
+ );
680
+ } else {
681
+ if (
682
+ this.statsResults.resolutions[mediaType].recv.framesReceived ===
683
+ this.lastStatsResults.resolutions[mediaType].recv.framesReceived ||
684
+ this.statsResults.resolutions[mediaType].recv.framesReceived === 0
685
+ ) {
686
+ LoggerProxy.logger.info(
687
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames received`
688
+ );
689
+ }
690
+
691
+ if (
692
+ this.statsResults[mediaType].recv.framesDecoded ===
693
+ this.lastStatsResults[mediaType].recv.framesDecoded ||
694
+ this.statsResults.resolutions[mediaType].send.framesDecoded === 0
695
+ ) {
696
+ LoggerProxy.logger.info(
697
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames decoded`
698
+ );
699
+ }
700
+
701
+ if (
702
+ this.statsResults.resolutions[mediaType].recv.framesDropped -
703
+ this.lastStatsResults.resolutions[mediaType].recv.framesDropped >
704
+ 10
705
+ ) {
706
+ LoggerProxy.logger.info(
707
+ `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} frames are getting dropped`
708
+ );
709
+ }
710
+ }
711
+
712
+ this.emitStartStopEvents(
713
+ mediaType,
714
+ previousStats.framesDecoded,
715
+ currentStats.framesDecoded,
716
+ false
717
+ );
718
+ }
719
+
720
+ mediaType = STATS.SHARE_CORRELATE;
721
+ if (this.meetingMediaStatus.expected.sendShare) {
722
+ // compare share stats sent
723
+
724
+ currentStats = this.statsResults[mediaType].send;
725
+ previousStats = this.lastStatsResults[mediaType].send;
726
+
727
+ if (
728
+ currentStats.totalPacketsSent === previousStats.totalPacketsSent ||
729
+ currentStats.totalPacketsSent === 0
730
+ ) {
731
+ LoggerProxy.logger.info(
732
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets sent`
733
+ );
734
+ } else {
735
+ if (
736
+ currentStats.framesEncoded === previousStats.framesEncoded ||
737
+ currentStats.framesEncoded === 0
738
+ ) {
739
+ LoggerProxy.logger.info(
740
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames getting encoded`
741
+ );
742
+ }
743
+
744
+ if (
745
+ this.statsResults.resolutions[mediaType].send.framesSent ===
746
+ this.lastStatsResults.resolutions[mediaType].send.framesSent ||
747
+ this.statsResults.resolutions[mediaType].send.framesSent === 0
748
+ ) {
749
+ LoggerProxy.logger.info(
750
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames sent`
751
+ );
752
+ }
753
+ }
754
+
755
+ // TODO:need to check receive share value
756
+ // compare share stats reveived
757
+ currentStats = this.statsResults[mediaType].recv;
758
+ previousStats = this.lastStatsResults[mediaType].recv;
759
+
760
+ if (
761
+ currentStats.totalPacketsReceived === previousStats.totalPacketsReceived ||
762
+ currentStats.totalPacketsSent === 0
763
+ ) {
764
+ LoggerProxy.logger.info(
765
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} RTP packets received`
766
+ );
767
+ } else {
768
+ if (
769
+ this.statsResults.resolutions[mediaType].recv.framesReceived ===
770
+ this.lastStatsResults.resolutions[mediaType].recv.framesReceived ||
771
+ this.statsResults.resolutions[mediaType].recv.framesReceived === 0
772
+ ) {
773
+ LoggerProxy.logger.info(
774
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames received`
775
+ );
776
+ }
777
+
778
+ if (
779
+ this.statsResults[mediaType].recv.framesDecoded ===
780
+ this.lastStatsResults[mediaType].recv.framesDecoded ||
781
+ this.statsResults.resolutions[mediaType].send.framesDecoded === 0
782
+ ) {
783
+ LoggerProxy.logger.info(
784
+ `StatsAnalyzer:index#compareLastStatsResult --> No ${mediaType} frames decoded`
785
+ );
786
+ }
787
+
788
+ if (
789
+ this.statsResults.resolutions[mediaType].recv.framesDropped -
790
+ this.lastStatsResults.resolutions[mediaType].recv.framesDropped >
791
+ 10
792
+ ) {
793
+ LoggerProxy.logger.info(
794
+ `StatsAnalyzer:index#compareLastStatsResult --> ${mediaType} frames are getting dropped`
795
+ );
796
+ }
797
+ }
798
+
799
+ // we are not calling emitStartStopEvents() for sending or receiving share because sharing is often started and stopped
800
+ // in meetings and this.meetingMediaStatus.expected values can be out of sync with the actual packet flow
801
+ // so we would send "sharing stopped" events incorrectly
802
+ }
803
+ }
804
+ }
805
+
806
+ /**
807
+ * Does a `getStats` on all the transceivers and parses the results
808
+ *
809
+ * @private
810
+ * @memberof StatsAnalyzer
811
+ * @returns {Promise}
812
+ */
813
+ private getStatsAndParse() {
814
+ if (!this.peerConnection) {
815
+ return Promise.resolve();
816
+ }
817
+
818
+ if (this.peerConnection && this.peerConnection.connectionState === CONNECTION_STATE.FAILED) {
819
+ LoggerProxy.logger.trace(
820
+ 'StatsAnalyzer:index#getStatsAndParse --> PeerConnection is in failed state'
821
+ );
822
+
823
+ return Promise.resolve();
824
+ }
825
+
826
+ LoggerProxy.logger.trace('StatsAnalyzer:index#getStatsAndParse --> Collecting Stats');
827
+
828
+ return Promise.all([
829
+ this.peerConnection.videoTransceiver.sender.getStats().then((res) => {
830
+ this.filterAndParseGetStatsResults(res, STATS.VIDEO_CORRELATE, true);
831
+ }),
832
+
833
+ this.peerConnection.videoTransceiver.receiver.getStats().then((res) => {
834
+ this.filterAndParseGetStatsResults(res, STATS.VIDEO_CORRELATE, false);
835
+ }),
836
+
837
+ this.peerConnection.audioTransceiver.sender.getStats().then((res) => {
838
+ this.filterAndParseGetStatsResults(res, STATS.AUDIO_CORRELATE, true);
839
+ }),
840
+
841
+ this.peerConnection.audioTransceiver.receiver.getStats().then((res) => {
842
+ this.filterAndParseGetStatsResults(res, STATS.AUDIO_CORRELATE, false);
843
+ }),
844
+
845
+ // TODO: add checks for screen share
846
+ this.peerConnection.shareTransceiver.sender.getStats().then((res) => {
847
+ this.filterAndParseGetStatsResults(res, STATS.SHARE_CORRELATE, true);
848
+ }),
849
+
850
+ this.peerConnection.shareTransceiver.receiver.getStats().then((res) => {
851
+ this.filterAndParseGetStatsResults(res, STATS.SHARE_CORRELATE, false);
852
+ }),
853
+ ]).then(() => {
854
+ this.statsResults[STATS.AUDIO_CORRELATE].direction =
855
+ this.peerConnection.audioTransceiver.currentDirection;
856
+ this.statsResults[STATS.VIDEO_CORRELATE].direction =
857
+ this.peerConnection.videoTransceiver.currentDirection;
858
+ this.statsResults[STATS.SHARE_CORRELATE].direction =
859
+ this.peerConnection.shareTransceiver.currentDirection;
860
+
861
+ // Process Stats results every 5 seconds
862
+ this.compareLastStatsResult();
863
+
864
+ // Save the last results to compare with the current
865
+ this.lastStatsResults = JSON.parse(JSON.stringify(this.statsResults));
866
+
867
+ LoggerProxy.logger.trace(
868
+ 'StatsAnalyzer:index#getStatsAndParse --> Finished Collecting Stats'
869
+ );
870
+ });
871
+ }
872
+
873
+ /**
874
+ * Processes OutboundRTP stats result and stores
875
+ * @private
876
+ * @param {*} result
877
+ * @param {*} type
878
+ * @returns {void}
879
+ */
880
+ private processOutboundRTPResult(result: any, type: any) {
881
+ const mediaType = type || STATS.AUDIO_CORRELATE;
882
+ const sendrecvType = STATS.SEND_DIRECTION;
883
+
884
+ if (result.bytesSent) {
885
+ let kilobytes = 0;
886
+
887
+ if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesSent) {
888
+ this.statsResults.internal[mediaType][sendrecvType].prevBytesSent = result.bytesSent;
889
+ }
890
+ if (!this.statsResults.internal[mediaType][sendrecvType].framesEncoded) {
891
+ this.statsResults.internal[mediaType][sendrecvType].framesEncoded = result.framesEncoded;
892
+ }
893
+ if (!this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded) {
894
+ this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded =
895
+ result.keyFramesEncoded;
896
+ }
897
+
898
+ const bytes =
899
+ result.bytesSent - this.statsResults.internal[mediaType][sendrecvType].prevBytesSent;
900
+
901
+ this.statsResults.internal[mediaType][sendrecvType].prevBytesSent = result.bytesSent;
902
+
903
+ kilobytes = bytes / 1024;
904
+
905
+ this.statsResults[mediaType][sendrecvType].availableBandwidth = kilobytes.toFixed(1);
906
+ this.statsResults[mediaType].bytesSent = kilobytes;
907
+
908
+ this.statsResults[mediaType][sendrecvType].framesEncoded =
909
+ result.framesEncoded - this.statsResults.internal[mediaType][sendrecvType].framesEncoded;
910
+ this.statsResults[mediaType][sendrecvType].keyFramesEncoded =
911
+ result.keyFramesEncoded -
912
+ this.statsResults.internal[mediaType][sendrecvType].keyFramesEncoded;
913
+ this.statsResults.internal[mediaType].outboundRtpId = result.id;
914
+
915
+ if (!this.statsResults.internal[mediaType][sendrecvType].packetsSent) {
916
+ this.statsResults.internal[mediaType][sendrecvType].packetsSent = result.packetsSent;
917
+ }
918
+
919
+ this.statsResults[mediaType][sendrecvType].packetsSent =
920
+ result.packetsSent - this.statsResults.internal[mediaType][sendrecvType].packetsSent;
921
+ this.statsResults.internal[mediaType][sendrecvType].packetsSent = result.packetsSent;
922
+
923
+ // Data saved to send MQA metrics
924
+
925
+ this.statsResults[mediaType][sendrecvType].totalKeyFramesEncoded = result.keyFramesEncoded;
926
+ this.statsResults[mediaType][sendrecvType].totalNackCount = result.nackCount;
927
+ this.statsResults[mediaType][sendrecvType].totalPliCount = result.pliCount;
928
+ this.statsResults[mediaType][sendrecvType].totalPacketsSent = result.packetsSent;
929
+ this.statsResults[mediaType][sendrecvType].totalFirCount = result.firCount;
930
+ this.statsResults[mediaType][sendrecvType].framesSent = result.framesSent;
931
+ this.statsResults[mediaType][sendrecvType].framesEncoded = result.framesEncoded;
932
+ this.statsResults[mediaType][sendrecvType].encoderImplementation =
933
+ result.encoderImplementation;
934
+ this.statsResults[mediaType][sendrecvType].qualityLimitationReason =
935
+ result.qualityLimitationReason;
936
+ this.statsResults[mediaType][sendrecvType].qualityLimitationResolutionChanges =
937
+ result.qualityLimitationResolutionChanges;
938
+ this.statsResults[mediaType][sendrecvType].retransmittedPacketsSent =
939
+ result.retransmittedPacketsSent;
940
+ this.statsResults[mediaType][sendrecvType].totalBytesSent = result.bytesSent;
941
+ this.statsResults[mediaType][sendrecvType].headerBytesSent = result.headerBytesSent;
942
+ this.statsResults[mediaType][sendrecvType].retransmittedBytesSent =
943
+ result.retransmittedBytesSent;
944
+ }
945
+ }
946
+
947
+ /**
948
+ * Processes InboundRTP stats result and stores
949
+ * @private
950
+ * @param {*} result
951
+ * @param {*} type
952
+ * @returns {void}
953
+ */
954
+ private processInboundRTPResult(result: any, type: any) {
955
+ const mediaType = type || STATS.AUDIO_CORRELATE;
956
+ const sendrecvType = STATS.RECEIVE_DIRECTION;
957
+
958
+ if (result.bytesReceived) {
959
+ let kilobytes = 0;
960
+
961
+ if (!this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived) {
962
+ this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived =
963
+ result.bytesReceived;
964
+ }
965
+
966
+ if (!this.statsResults.internal[mediaType][sendrecvType].pliCount) {
967
+ this.statsResults.internal[mediaType][sendrecvType].pliCount = result.pliCount;
968
+ }
969
+
970
+ if (!this.statsResults.internal[mediaType][sendrecvType].packetsLost) {
971
+ this.statsResults.internal[mediaType][sendrecvType].packetsLost = result.packetsLost;
972
+ }
973
+
974
+ if (!this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived) {
975
+ this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived =
976
+ result.packetsReceived;
977
+ }
978
+
979
+ if (!this.statsResults.internal[mediaType][sendrecvType].lastPacketReceivedTimestamp) {
980
+ this.statsResults.internal[mediaType][sendrecvType].lastPacketReceivedTimestamp =
981
+ result.lastPacketReceivedTimestamp;
982
+ }
983
+
984
+ const bytes =
985
+ result.bytesReceived -
986
+ this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived;
987
+
988
+ this.statsResults.internal[mediaType][sendrecvType].prevBytesReceived = result.bytesReceived;
989
+
990
+ kilobytes = bytes / 1024;
991
+ this.statsResults[mediaType][sendrecvType].availableBandwidth = kilobytes.toFixed(1);
992
+ this.statsResults[mediaType].bytesReceived = kilobytes.toFixed(1);
993
+
994
+ this.statsResults[mediaType][sendrecvType].pliCount =
995
+ result.pliCount - this.statsResults.internal[mediaType][sendrecvType].pliCount;
996
+ this.statsResults[mediaType][sendrecvType].currentPacketsLost =
997
+ result.packetsLost - this.statsResults.internal[mediaType][sendrecvType].packetsLost;
998
+ if (this.statsResults[mediaType][sendrecvType].currentPacketsLost < 0) {
999
+ this.statsResults[mediaType][sendrecvType].currentPacketsLost = 0;
1000
+ }
1001
+
1002
+ this.statsResults[mediaType][sendrecvType].packetsReceived =
1003
+ result.packetsReceived -
1004
+ this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived;
1005
+ this.statsResults.internal[mediaType][sendrecvType].totalPacketsReceived =
1006
+ result.packetsReceived;
1007
+
1008
+ if (this.statsResults[mediaType][sendrecvType].packetsReceived === 0) {
1009
+ LoggerProxy.logger.info(
1010
+ `StatsAnalyzer:index#processInboundRTPResult --> No packets received for ${mediaType} `,
1011
+ this.statsResults[mediaType][sendrecvType].packetsReceived
1012
+ );
1013
+ }
1014
+
1015
+ // Check the over all packet Lost ratio
1016
+ this.statsResults[mediaType][sendrecvType].currentPacketLossRatio =
1017
+ this.statsResults[mediaType][sendrecvType].currentPacketsLost > 0
1018
+ ? this.statsResults[mediaType][sendrecvType].currentPacketsLost /
1019
+ (this.statsResults[mediaType][sendrecvType].packetsReceived +
1020
+ this.statsResults[mediaType][sendrecvType].currentPacketsLost)
1021
+ : 0;
1022
+ if (this.statsResults[mediaType][sendrecvType].currentPacketLossRatio > 3) {
1023
+ LoggerProxy.logger.info(
1024
+ 'StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver ',
1025
+ this.statsResults[mediaType][sendrecvType].currentPacketLossRatio
1026
+ );
1027
+ }
1028
+
1029
+ // TODO: check the packet loss value is negative values here
1030
+
1031
+ if (result.packetsLost) {
1032
+ this.statsResults[mediaType][sendrecvType].totalPacketsLost =
1033
+ result.packetsLost > 0 ? result.packetsLost : -result.packetsLost;
1034
+ } else {
1035
+ this.statsResults[mediaType][sendrecvType].totalPacketsLost = 0;
1036
+ }
1037
+
1038
+ this.statsResults[mediaType][sendrecvType].lastPacketReceivedTimestamp =
1039
+ result.lastPacketReceivedTimestamp;
1040
+
1041
+ // From Thin
1042
+ this.statsResults[mediaType][sendrecvType].totalNackCount = result.nackCount;
1043
+ this.statsResults[mediaType][sendrecvType].totalPliCount = result.pliCount;
1044
+ this.statsResults[mediaType][sendrecvType].framesDecoded = result.framesDecoded;
1045
+ this.statsResults[mediaType][sendrecvType].keyFramesDecoded = result.keyFramesDecoded;
1046
+
1047
+ this.statsResults[mediaType][sendrecvType].decoderImplementation =
1048
+ result.decoderImplementation;
1049
+ this.statsResults[mediaType][sendrecvType].totalPacketsReceived = result.packetsReceived;
1050
+
1051
+ this.statsResults[mediaType][sendrecvType].fecPacketsDiscarded = result.fecPacketsDiscarded;
1052
+ this.statsResults[mediaType][sendrecvType].fecPacketsReceived = result.fecPacketsReceived;
1053
+ this.statsResults[mediaType][sendrecvType].totalBytesReceived = result.bytesReceived;
1054
+ this.statsResults[mediaType][sendrecvType].headerBytesReceived = result.headerBytesReceived;
1055
+
1056
+ this.statsResults[mediaType][sendrecvType].meanRtpJitter.push(result.jitter);
1057
+
1058
+ // Audio stats
1059
+
1060
+ this.statsResults[mediaType][sendrecvType].audioLevel = result.audioLevel;
1061
+ this.statsResults[mediaType][sendrecvType].totalAudioEnergy = result.totalAudioEnergy;
1062
+ this.statsResults[mediaType][sendrecvType].totalSamplesReceived =
1063
+ result.totalSamplesReceived || 0;
1064
+ this.statsResults[mediaType][sendrecvType].totalSamplesDecoded =
1065
+ result.totalSamplesDecoded || 0;
1066
+ this.statsResults[mediaType][sendrecvType].concealedSamples = result.concealedSamples || 0;
1067
+ }
1068
+ }
1069
+
1070
+ /**
1071
+ * Processes remote and local candidate result and stores
1072
+ * @private
1073
+ * @param {*} result
1074
+ * @param {*} type
1075
+ * @param {boolean} isSender
1076
+ * @param {boolean} isRemote
1077
+ *
1078
+ * @returns {void}
1079
+ */
1080
+ parseCandidate = (result: any, type: any, isSender: boolean, isRemote: boolean) => {
1081
+ if (!result || !result.id) {
1082
+ return;
1083
+ }
1084
+ const RemoteCandidateType = {};
1085
+ const RemoteTransport = {};
1086
+ const RemoteIpAddress = {};
1087
+ const RemoteNetworkType = {};
1088
+
1089
+ if (!result.id) return;
1090
+
1091
+ const sendRecvType = isSender ? STATS.SEND_DIRECTION : STATS.RECEIVE_DIRECTION;
1092
+ const ipType = isRemote ? STATS.REMOTE : STATS.LOCAL;
1093
+
1094
+ if (!RemoteCandidateType[result.id]) {
1095
+ RemoteCandidateType[result.id] = [];
1096
+ }
1097
+
1098
+ if (!RemoteTransport[result.id]) {
1099
+ RemoteTransport[result.id] = [];
1100
+ }
1101
+
1102
+ if (!RemoteIpAddress[result.id]) {
1103
+ RemoteIpAddress[result.id] = [];
1104
+ }
1105
+ if (!RemoteNetworkType[result.id]) {
1106
+ RemoteNetworkType[result.id] = [];
1107
+ }
1108
+
1109
+ if (
1110
+ result.candidateType &&
1111
+ RemoteCandidateType[result.id].indexOf(result.candidateType) === -1
1112
+ ) {
1113
+ RemoteCandidateType[result.id].push(result.candidateType);
1114
+ }
1115
+
1116
+ if (result.protocol && RemoteTransport[result.id].indexOf(result.protocol) === -1) {
1117
+ RemoteTransport[result.id].push(result.protocol.toUpperCase());
1118
+ }
1119
+
1120
+ if (
1121
+ result.ip &&
1122
+ RemoteIpAddress[result.id].indexOf(`${result.ip}:${result.portNumber}`) === -1
1123
+ ) {
1124
+ RemoteIpAddress[result.id].push(`${result.ip}`); // TODO: Add ports
1125
+ }
1126
+
1127
+ if (result.networkType && RemoteNetworkType[result.id].indexOf(result.networkType) === -1) {
1128
+ RemoteNetworkType[result.id].push(result.networkType);
1129
+ }
1130
+
1131
+ this.statsResults.internal.candidates[result.id] = {
1132
+ candidateType: RemoteCandidateType[result.id],
1133
+ ipAddress: RemoteIpAddress[result.id],
1134
+ portNumber: result.port,
1135
+ networkType: RemoteNetworkType[result.id],
1136
+ priority: result.priority,
1137
+ transport: RemoteTransport[result.id],
1138
+ timestamp: result.time,
1139
+ id: result.id,
1140
+ type: result.type,
1141
+ };
1142
+
1143
+ this.statsResults.connectionType[ipType].candidateType = RemoteCandidateType[result.id];
1144
+ this.statsResults.connectionType[ipType].ipAddress = RemoteIpAddress[result.id];
1145
+
1146
+ this.statsResults.connectionType[ipType].networkType =
1147
+ RemoteNetworkType[result.id][0] === NETWORK_TYPE.VPN
1148
+ ? NETWORK_TYPE.UNKNOWN
1149
+ : RemoteNetworkType[result.id][0];
1150
+ this.statsResults.connectionType[ipType].transport = RemoteTransport[result.id];
1151
+
1152
+ this.statsResults[type][sendRecvType].totalRoundTripTime = result.totalRoundTripTime;
1153
+ };
1154
+
1155
+ /**
1156
+ * Process Track results
1157
+ *
1158
+ * @private
1159
+ * @param {*} result
1160
+ * @param {*} mediaType
1161
+ * @returns {void}
1162
+ * @memberof StatsAnalyzer
1163
+ */
1164
+ private processTrackResult(result: any, mediaType: any) {
1165
+ if (!result || result.type !== 'track') {
1166
+ return;
1167
+ }
1168
+ if (result.type !== 'track') return;
1169
+
1170
+ const sendrecvType =
1171
+ result.remoteSource === true ? STATS.RECEIVE_DIRECTION : STATS.SEND_DIRECTION;
1172
+
1173
+ if (result.frameWidth && result.frameHeight) {
1174
+ this.statsResults.resolutions[mediaType][sendrecvType].width = result.frameWidth;
1175
+ this.statsResults.resolutions[mediaType][sendrecvType].height = result.frameHeight;
1176
+ this.statsResults.resolutions[mediaType][sendrecvType].framesSent = result.framesSent;
1177
+ this.statsResults.resolutions[mediaType][sendrecvType].hugeFramesSent = result.hugeFramesSent;
1178
+ }
1179
+
1180
+ if (sendrecvType === STATS.RECEIVE_DIRECTION) {
1181
+ this.statsResults.resolutions[mediaType][sendrecvType].framesReceived = result.framesReceived;
1182
+ this.statsResults.resolutions[mediaType][sendrecvType].framesDecoded = result.framesDecoded;
1183
+ this.statsResults.resolutions[mediaType][sendrecvType].framesDropped = result.framesDropped;
1184
+ }
1185
+
1186
+ if (result.trackIdentifier && mediaType !== STATS.AUDIO_CORRELATE) {
1187
+ this.statsResults.resolutions[mediaType][sendrecvType].trackIdentifier =
1188
+ result.trackIdentifier;
1189
+
1190
+ const jitterBufferDelay = result && result.jitterBufferDelay;
1191
+ const jitterBufferEmittedCount = result && result.jitterBufferEmittedCount;
1192
+
1193
+ this.statsResults.resolutions[mediaType][sendrecvType].avgJitterDelay =
1194
+ jitterBufferEmittedCount && +jitterBufferDelay / +jitterBufferEmittedCount;
1195
+
1196
+ // Used to calculate the jitter
1197
+ this.statsResults.resolutions[mediaType][sendrecvType].jitterBufferDelay =
1198
+ result.jitterBufferDelay;
1199
+ this.statsResults.resolutions[mediaType][sendrecvType].jitterBufferEmittedCount =
1200
+ result.jitterBufferEmittedCount;
1201
+ }
1202
+ }
1203
+
1204
+ /**
1205
+ *
1206
+ * @private
1207
+ * @param {*} result
1208
+ * @param {*} type
1209
+ * @returns {void}
1210
+ * @memberof StatsAnalyzer
1211
+ */
1212
+ private compareSentAndReceived(result: any, type: any) {
1213
+ if (!type) {
1214
+ return;
1215
+ }
1216
+
1217
+ const mediaType = type;
1218
+
1219
+ if (!this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver) {
1220
+ this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1221
+ }
1222
+
1223
+ const currentPacketLoss =
1224
+ result.packetsLost - this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver;
1225
+
1226
+ this.statsResults.internal[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1227
+ this.statsResults[mediaType].send.packetsLostOnReceiver = currentPacketLoss;
1228
+ this.statsResults[mediaType].send.totalPacketsLostOnReceiver = result.packetsLost;
1229
+
1230
+ this.statsResults[mediaType].send.meanRemoteJitter.push(result.jitter);
1231
+ this.statsResults[mediaType].send.meanRoundTripTime.push(result.roundTripTime);
1232
+
1233
+ this.statsResults[mediaType].send.timestamp = result.timestamp;
1234
+ this.statsResults[mediaType].send.ssrc = result.ssrc;
1235
+ this.statsResults[mediaType].send.reportsReceived = result.reportsReceived;
1236
+
1237
+ // Total packloss ratio on this video section of the call
1238
+ this.statsResults[mediaType].send.overAllPacketLossRatio =
1239
+ this.statsResults[mediaType].send.totalPacketsLostOnReceiver > 0
1240
+ ? this.statsResults[mediaType].send.totalPacketsLostOnReceiver /
1241
+ this.statsResults[mediaType].send.totalPacketsSent
1242
+ : 0;
1243
+ this.statsResults[mediaType].send.currentPacketLossRatio =
1244
+ this.statsResults[mediaType].send.packetsLostOnReceiver > 0
1245
+ ? (this.statsResults[mediaType].send.packetsLostOnReceiver * 100) /
1246
+ (this.statsResults[mediaType].send.packetsSent +
1247
+ this.statsResults[mediaType].send.packetsLostOnReceiver)
1248
+ : 0;
1249
+
1250
+ if (
1251
+ this.statsResults[mediaType].send.maxPacketLossRatio <
1252
+ this.statsResults[mediaType].send.currentPacketLossRatio
1253
+ ) {
1254
+ this.statsResults[mediaType].send.maxPacketLossRatio =
1255
+ this.statsResults[mediaType].send.currentPacketLossRatio;
1256
+ }
1257
+
1258
+ if (result.type === 'remote-inbound-rtp') {
1259
+ this.networkQualityMonitor.determineUplinkNetworkQuality({
1260
+ mediaType,
1261
+ remoteRtpResults: result,
1262
+ statsAnalyzerCurrentStats: this.statsResults,
1263
+ });
1264
+ }
1265
+ }
1266
+ }