@webex/plugin-meetings 2.59.3-next.1 → 2.59.4-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 (420) 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.js +2 -2
  8. package/dist/common/browser-detection.js.map +1 -1
  9. package/dist/common/collection.js +45 -45
  10. package/dist/common/collection.js.map +1 -1
  11. package/dist/common/config.js.map +1 -1
  12. package/dist/common/errors/captcha-error.js +7 -7
  13. package/dist/common/errors/captcha-error.js.map +1 -1
  14. package/dist/common/errors/intent-to-join.js +7 -7
  15. package/dist/common/errors/intent-to-join.js.map +1 -1
  16. package/dist/common/errors/join-meeting.js +8 -8
  17. package/dist/common/errors/join-meeting.js.map +1 -1
  18. package/dist/common/errors/media.js +7 -7
  19. package/dist/common/errors/media.js.map +1 -1
  20. package/dist/common/errors/parameter.js +7 -7
  21. package/dist/common/errors/parameter.js.map +1 -1
  22. package/dist/common/errors/password-error.js +7 -7
  23. package/dist/common/errors/password-error.js.map +1 -1
  24. package/dist/common/errors/permission.js +6 -6
  25. package/dist/common/errors/permission.js.map +1 -1
  26. package/dist/common/errors/reconnection-in-progress.js +6 -6
  27. package/dist/common/errors/reconnection-in-progress.js.map +1 -1
  28. package/dist/common/errors/reconnection.js +7 -7
  29. package/dist/common/errors/reconnection.js.map +1 -1
  30. package/dist/common/errors/stats.js +7 -7
  31. package/dist/common/errors/stats.js.map +1 -1
  32. package/dist/common/errors/webex-errors.js +42 -42
  33. package/dist/common/errors/webex-errors.js.map +1 -1
  34. package/dist/common/errors/webex-meetings-error.js +12 -12
  35. package/dist/common/errors/webex-meetings-error.js.map +1 -1
  36. package/dist/common/events/events-scope.js +10 -10
  37. package/dist/common/events/events-scope.js.map +1 -1
  38. package/dist/common/events/events.js +4 -4
  39. package/dist/common/events/events.js.map +1 -1
  40. package/dist/common/events/trigger-proxy.js.map +1 -1
  41. package/dist/common/events/util.js.map +1 -1
  42. package/dist/common/logs/logger-config.js.map +1 -1
  43. package/dist/common/logs/logger-proxy.js.map +1 -1
  44. package/dist/common/logs/request.js +18 -18
  45. package/dist/common/logs/request.js.map +1 -1
  46. package/dist/common/queue.js +18 -18
  47. package/dist/common/queue.js.map +1 -1
  48. package/dist/config.js.map +1 -1
  49. package/dist/constants.js +9 -9
  50. package/dist/constants.js.map +1 -1
  51. package/dist/controls-options-manager/constants.js.map +1 -1
  52. package/dist/controls-options-manager/enums.js.map +1 -1
  53. package/dist/controls-options-manager/index.js +83 -83
  54. package/dist/controls-options-manager/index.js.map +1 -1
  55. package/dist/controls-options-manager/util.js.map +1 -1
  56. package/dist/index.js.map +1 -1
  57. package/dist/locus-info/controlsUtils.js +27 -27
  58. package/dist/locus-info/controlsUtils.js.map +1 -1
  59. package/dist/locus-info/embeddedAppsUtils.js +14 -14
  60. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  61. package/dist/locus-info/fullState.js.map +1 -1
  62. package/dist/locus-info/hostUtils.js +19 -19
  63. package/dist/locus-info/hostUtils.js.map +1 -1
  64. package/dist/locus-info/index.js +198 -198
  65. package/dist/locus-info/index.js.map +1 -1
  66. package/dist/locus-info/infoUtils.js.map +1 -1
  67. package/dist/locus-info/mediaSharesUtils.js +50 -50
  68. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  69. package/dist/locus-info/parser.js +138 -138
  70. package/dist/locus-info/parser.js.map +1 -1
  71. package/dist/locus-info/selfUtils.js +52 -52
  72. package/dist/locus-info/selfUtils.js.map +1 -1
  73. package/dist/media/index.js +145 -145
  74. package/dist/media/index.js.map +1 -1
  75. package/dist/media/properties.js +49 -49
  76. package/dist/media/properties.js.map +1 -1
  77. package/dist/media/util.js.map +1 -1
  78. package/dist/mediaQualityMetrics/config.js.map +1 -1
  79. package/dist/meeting/effectsState.js +24 -24
  80. package/dist/meeting/effectsState.js.map +1 -1
  81. package/dist/meeting/in-meeting-actions.js +11 -11
  82. package/dist/meeting/in-meeting-actions.js.map +1 -1
  83. package/dist/meeting/index.js +1505 -1508
  84. package/dist/meeting/index.js.map +1 -1
  85. package/dist/meeting/muteState.js +85 -85
  86. package/dist/meeting/muteState.js.map +1 -1
  87. package/dist/meeting/request.js +143 -143
  88. package/dist/meeting/request.js.map +1 -1
  89. package/dist/meeting/state.js +30 -30
  90. package/dist/meeting/state.js.map +1 -1
  91. package/dist/meeting/util.js +4 -4
  92. package/dist/meeting/util.js.map +1 -1
  93. package/dist/meeting-info/collection.js +13 -13
  94. package/dist/meeting-info/collection.js.map +1 -1
  95. package/dist/meeting-info/index.js +50 -50
  96. package/dist/meeting-info/index.js.map +1 -1
  97. package/dist/meeting-info/meeting-info-v2.js +52 -52
  98. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  99. package/dist/meeting-info/request.js +14 -14
  100. package/dist/meeting-info/request.js.map +1 -1
  101. package/dist/meeting-info/util.js +9 -9
  102. package/dist/meeting-info/util.js.map +1 -1
  103. package/dist/meeting-info/utilv2.js +20 -20
  104. package/dist/meeting-info/utilv2.js.map +1 -1
  105. package/dist/meetings/collection.js +16 -16
  106. package/dist/meetings/collection.js.map +1 -1
  107. package/dist/meetings/index.js +259 -259
  108. package/dist/meetings/index.js.map +1 -1
  109. package/dist/meetings/request.js +15 -15
  110. package/dist/meetings/request.js.map +1 -1
  111. package/dist/meetings/util.js +29 -29
  112. package/dist/meetings/util.js.map +1 -1
  113. package/dist/member/index.js +214 -214
  114. package/dist/member/index.js.map +1 -1
  115. package/dist/member/member.types.js.map +1 -1
  116. package/dist/member/util.js +60 -60
  117. package/dist/member/util.js.map +1 -1
  118. package/dist/members/collection.js +11 -11
  119. package/dist/members/collection.js.map +1 -1
  120. package/dist/members/index.js +277 -277
  121. package/dist/members/index.js.map +1 -1
  122. package/dist/members/request.js +27 -27
  123. package/dist/members/request.js.map +1 -1
  124. package/dist/members/util.js +21 -21
  125. package/dist/members/util.js.map +1 -1
  126. package/dist/metrics/config.js.map +1 -1
  127. package/dist/metrics/constants.js.map +1 -1
  128. package/dist/metrics/index.js +92 -92
  129. package/dist/metrics/index.js.map +1 -1
  130. package/dist/networkQualityMonitor/index.js +65 -65
  131. package/dist/networkQualityMonitor/index.js.map +1 -1
  132. package/dist/peer-connection-manager/index.js +87 -87
  133. package/dist/peer-connection-manager/index.js.map +1 -1
  134. package/dist/peer-connection-manager/util.js +9 -9
  135. package/dist/peer-connection-manager/util.js.map +1 -1
  136. package/dist/personal-meeting-room/index.js +67 -67
  137. package/dist/personal-meeting-room/index.js.map +1 -1
  138. package/dist/personal-meeting-room/request.js +7 -7
  139. package/dist/personal-meeting-room/request.js.map +1 -1
  140. package/dist/personal-meeting-room/util.js.map +1 -1
  141. package/dist/reachability/index.js +119 -112
  142. package/dist/reachability/index.js.map +1 -1
  143. package/dist/reachability/request.js +15 -15
  144. package/dist/reachability/request.js.map +1 -1
  145. package/dist/reactions/reactions.js.map +1 -1
  146. package/dist/reactions/reactions.type.js.map +1 -1
  147. package/dist/reconnection-manager/index.js +112 -112
  148. package/dist/reconnection-manager/index.js.map +1 -1
  149. package/dist/recording-controller/enums.js.map +1 -1
  150. package/dist/recording-controller/index.js +127 -127
  151. package/dist/recording-controller/index.js.map +1 -1
  152. package/dist/recording-controller/util.js.map +1 -1
  153. package/dist/roap/collection.js.map +1 -1
  154. package/dist/roap/handler.js +27 -27
  155. package/dist/roap/handler.js.map +1 -1
  156. package/dist/roap/index.js +111 -111
  157. package/dist/roap/index.js.map +1 -1
  158. package/dist/roap/request.js +17 -17
  159. package/dist/roap/request.js.map +1 -1
  160. package/dist/roap/state.js +14 -14
  161. package/dist/roap/state.js.map +1 -1
  162. package/dist/roap/turnDiscovery.js +46 -46
  163. package/dist/roap/turnDiscovery.js.map +1 -1
  164. package/dist/roap/util.js.map +1 -1
  165. package/dist/statsAnalyzer/global.js.map +1 -1
  166. package/dist/statsAnalyzer/index.js +130 -130
  167. package/dist/statsAnalyzer/index.js.map +1 -1
  168. package/dist/statsAnalyzer/mqaUtil.js +15 -15
  169. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  170. package/dist/transcription/index.js +42 -42
  171. package/dist/transcription/index.js.map +1 -1
  172. package/internal-README.md +172 -172
  173. package/jest.config.js +3 -3
  174. package/package.json +15 -15
  175. package/process +1 -1
  176. package/src/common/browser-detection.ts +39 -39
  177. package/src/common/collection.ts +94 -94
  178. package/src/common/config.ts +9 -9
  179. package/src/common/errors/captcha-error.ts +25 -25
  180. package/src/common/errors/intent-to-join.ts +27 -27
  181. package/src/common/errors/join-meeting.ts +32 -32
  182. package/src/common/errors/media.ts +25 -25
  183. package/src/common/errors/parameter.ts +33 -33
  184. package/src/common/errors/password-error.ts +25 -25
  185. package/src/common/errors/permission.ts +24 -24
  186. package/src/common/errors/reconnection-in-progress.ts +8 -8
  187. package/src/common/errors/reconnection.ts +25 -25
  188. package/src/common/errors/stats.ts +25 -25
  189. package/src/common/errors/webex-errors.ts +140 -140
  190. package/src/common/errors/webex-meetings-error.ts +35 -35
  191. package/src/common/events/events-scope.ts +30 -30
  192. package/src/common/events/events.ts +25 -25
  193. package/src/common/events/trigger-proxy.ts +25 -25
  194. package/src/common/events/util.ts +39 -39
  195. package/src/common/logs/logger-config.ts +8 -8
  196. package/src/common/logs/logger-proxy.ts +44 -44
  197. package/src/common/logs/request.ts +65 -65
  198. package/src/common/queue.ts +50 -50
  199. package/src/config.ts +96 -96
  200. package/src/constants.ts +1121 -1121
  201. package/src/controls-options-manager/constants.ts +5 -5
  202. package/src/controls-options-manager/enums.ts +6 -6
  203. package/src/controls-options-manager/index.ts +183 -183
  204. package/src/controls-options-manager/util.ts +20 -20
  205. package/src/index.js +15 -15
  206. package/src/locus-info/controlsUtils.ts +112 -112
  207. package/src/locus-info/embeddedAppsUtils.ts +57 -57
  208. package/src/locus-info/fullState.ts +69 -69
  209. package/src/locus-info/hostUtils.ts +60 -60
  210. package/src/locus-info/index.ts +1303 -1303
  211. package/src/locus-info/infoUtils.ts +101 -101
  212. package/src/locus-info/mediaSharesUtils.ts +173 -173
  213. package/src/locus-info/parser.ts +680 -680
  214. package/src/locus-info/selfUtils.ts +428 -428
  215. package/src/media/index.ts +675 -675
  216. package/src/media/properties.ts +313 -313
  217. package/src/media/util.ts +37 -37
  218. package/src/mediaQualityMetrics/config.ts +382 -382
  219. package/src/meeting/effectsState.ts +209 -209
  220. package/src/meeting/in-meeting-actions.ts +153 -153
  221. package/src/meeting/index.ts +6537 -6537
  222. package/src/meeting/muteState.ts +365 -365
  223. package/src/meeting/request.ts +810 -810
  224. package/src/meeting/state.ts +194 -194
  225. package/src/meeting/util.ts +530 -530
  226. package/src/meeting-info/collection.ts +41 -41
  227. package/src/meeting-info/index.ts +137 -137
  228. package/src/meeting-info/meeting-info-v2.ts +273 -273
  229. package/src/meeting-info/request.ts +46 -46
  230. package/src/meeting-info/util.ts +314 -314
  231. package/src/meeting-info/utilv2.ts +324 -324
  232. package/src/meetings/collection.ts +43 -43
  233. package/src/meetings/index.ts +1128 -1128
  234. package/src/meetings/request.ts +81 -81
  235. package/src/meetings/util.ts +181 -181
  236. package/src/member/index.ts +446 -446
  237. package/src/member/member.types.ts +13 -13
  238. package/src/member/util.ts +286 -286
  239. package/src/members/collection.ts +40 -40
  240. package/src/members/index.ts +900 -900
  241. package/src/members/request.ts +175 -175
  242. package/src/members/util.ts +260 -260
  243. package/src/metrics/config.ts +485 -485
  244. package/src/metrics/constants.ts +61 -61
  245. package/src/metrics/index.ts +543 -543
  246. package/src/networkQualityMonitor/index.ts +211 -211
  247. package/src/peer-connection-manager/index.ts +847 -847
  248. package/src/peer-connection-manager/util.ts +119 -119
  249. package/src/personal-meeting-room/index.ts +157 -157
  250. package/src/personal-meeting-room/request.ts +48 -48
  251. package/src/personal-meeting-room/util.ts +49 -49
  252. package/src/reachability/index.ts +478 -478
  253. package/src/reachability/request.ts +81 -81
  254. package/src/reactions/reactions.ts +104 -104
  255. package/src/reactions/reactions.type.ts +36 -36
  256. package/src/reconnection-manager/index.ts +622 -622
  257. package/src/recording-controller/enums.ts +8 -8
  258. package/src/recording-controller/index.ts +315 -315
  259. package/src/recording-controller/util.ts +58 -58
  260. package/src/roap/collection.ts +62 -62
  261. package/src/roap/handler.ts +294 -294
  262. package/src/roap/index.ts +413 -413
  263. package/src/roap/request.ts +229 -229
  264. package/src/roap/state.ts +156 -156
  265. package/src/roap/turnDiscovery.ts +283 -283
  266. package/src/roap/util.ts +100 -100
  267. package/src/statsAnalyzer/global.ts +128 -128
  268. package/src/statsAnalyzer/index.ts +1266 -1266
  269. package/src/statsAnalyzer/mqaUtil.ts +290 -290
  270. package/src/transcription/index.ts +154 -154
  271. package/test/integration/spec/journey.js +941 -941
  272. package/test/integration/spec/space-meeting.js +457 -457
  273. package/test/integration/spec/transcription.js +55 -55
  274. package/test/unit/spec/common/browser-detection.js +119 -119
  275. package/test/unit/spec/common/queue.js +69 -69
  276. package/test/unit/spec/controls-options-manager/index.js +123 -123
  277. package/test/unit/spec/controls-options-manager/util.js +65 -65
  278. package/test/unit/spec/fixture/locus.js +406 -406
  279. package/test/unit/spec/locus-info/controlsUtils.js +82 -82
  280. package/test/unit/spec/locus-info/embeddedAppsUtils.js +104 -104
  281. package/test/unit/spec/locus-info/index.js +1272 -1272
  282. package/test/unit/spec/locus-info/infoUtils.js +138 -138
  283. package/test/unit/spec/locus-info/lib/BasicSeqCmp.json +975 -975
  284. package/test/unit/spec/locus-info/lib/SeqCmp.json +522 -522
  285. package/test/unit/spec/locus-info/lib/selfConstant.js +286 -286
  286. package/test/unit/spec/locus-info/parser.js +298 -298
  287. package/test/unit/spec/locus-info/selfUtils.js +185 -185
  288. package/test/unit/spec/media/properties.ts +305 -305
  289. package/test/unit/spec/meeting/effectsState.js +281 -281
  290. package/test/unit/spec/meeting/in-meeting-actions.ts +90 -90
  291. package/test/unit/spec/meeting/index.js +5227 -5227
  292. package/test/unit/spec/meeting/muteState.js +430 -430
  293. package/test/unit/spec/meeting/request.js +317 -317
  294. package/test/unit/spec/meeting/utils.js +319 -319
  295. package/test/unit/spec/meeting-info/meetinginfov2.js +376 -376
  296. package/test/unit/spec/meeting-info/request.js +64 -64
  297. package/test/unit/spec/meeting-info/util.js +37 -37
  298. package/test/unit/spec/meeting-info/utilv2.js +330 -330
  299. package/test/unit/spec/meetings/collection.js +52 -52
  300. package/test/unit/spec/meetings/index.js +1375 -1375
  301. package/test/unit/spec/meetings/utils.js +66 -66
  302. package/test/unit/spec/member/index.js +47 -47
  303. package/test/unit/spec/member/util.js +80 -80
  304. package/test/unit/spec/members/index.js +364 -364
  305. package/test/unit/spec/members/request.js +200 -200
  306. package/test/unit/spec/members/utils.js +42 -42
  307. package/test/unit/spec/metrics/index.js +111 -111
  308. package/test/unit/spec/networkQualityMonitor/index.js +99 -99
  309. package/test/unit/spec/peerconnection-manager/index.js +218 -218
  310. package/test/unit/spec/peerconnection-manager/utils.js +49 -49
  311. package/test/unit/spec/peerconnection-manager/utils.test-fixtures.ts +388 -388
  312. package/test/unit/spec/personal-meeting-room/personal-meeting-room.js +29 -29
  313. package/test/unit/spec/reachability/index.ts +50 -50
  314. package/test/unit/spec/reconnection-manager/index.js +206 -206
  315. package/test/unit/spec/recording-controller/index.js +230 -230
  316. package/test/unit/spec/recording-controller/util.js +101 -101
  317. package/test/unit/spec/roap/index.ts +128 -128
  318. package/test/unit/spec/roap/turnDiscovery.ts +372 -372
  319. package/test/unit/spec/roap/util.js +30 -30
  320. package/test/unit/spec/stats-analyzer/index.js +287 -287
  321. package/test/utils/cmr.js +104 -104
  322. package/test/utils/testUtils.js +287 -287
  323. package/test/utils/webex-config.js +77 -77
  324. package/test/utils/webex-test-users.js +82 -82
  325. package/tsconfig.json +5 -5
  326. package/dist/common/browser-detection.d.ts +0 -9
  327. package/dist/common/collection.d.ts +0 -48
  328. package/dist/common/config.d.ts +0 -2
  329. package/dist/common/errors/captcha-error.d.ts +0 -15
  330. package/dist/common/errors/intent-to-join.d.ts +0 -16
  331. package/dist/common/errors/join-meeting.d.ts +0 -17
  332. package/dist/common/errors/media.d.ts +0 -15
  333. package/dist/common/errors/parameter.d.ts +0 -15
  334. package/dist/common/errors/password-error.d.ts +0 -15
  335. package/dist/common/errors/permission.d.ts +0 -14
  336. package/dist/common/errors/reconnection-in-progress.d.ts +0 -9
  337. package/dist/common/errors/reconnection.d.ts +0 -15
  338. package/dist/common/errors/stats.d.ts +0 -15
  339. package/dist/common/errors/webex-errors.d.ts +0 -81
  340. package/dist/common/errors/webex-meetings-error.d.ts +0 -20
  341. package/dist/common/events/events-scope.d.ts +0 -17
  342. package/dist/common/events/events.d.ts +0 -12
  343. package/dist/common/events/trigger-proxy.d.ts +0 -2
  344. package/dist/common/events/util.d.ts +0 -2
  345. package/dist/common/logs/logger-config.d.ts +0 -2
  346. package/dist/common/logs/logger-proxy.d.ts +0 -2
  347. package/dist/common/logs/request.d.ts +0 -34
  348. package/dist/common/queue.d.ts +0 -32
  349. package/dist/config.d.ts +0 -73
  350. package/dist/constants.d.ts +0 -924
  351. package/dist/controls-options-manager/constants.d.ts +0 -4
  352. package/dist/controls-options-manager/enums.d.ts +0 -5
  353. package/dist/controls-options-manager/index.d.ts +0 -120
  354. package/dist/controls-options-manager/util.d.ts +0 -7
  355. package/dist/index.d.ts +0 -4
  356. package/dist/locus-info/controlsUtils.d.ts +0 -2
  357. package/dist/locus-info/embeddedAppsUtils.d.ts +0 -2
  358. package/dist/locus-info/fullState.d.ts +0 -2
  359. package/dist/locus-info/hostUtils.d.ts +0 -2
  360. package/dist/locus-info/index.d.ts +0 -269
  361. package/dist/locus-info/infoUtils.d.ts +0 -2
  362. package/dist/locus-info/mediaSharesUtils.d.ts +0 -2
  363. package/dist/locus-info/parser.d.ts +0 -212
  364. package/dist/locus-info/selfUtils.d.ts +0 -2
  365. package/dist/media/index.d.ts +0 -32
  366. package/dist/media/properties.d.ts +0 -108
  367. package/dist/media/util.d.ts +0 -2
  368. package/dist/mediaQualityMetrics/config.d.ts +0 -233
  369. package/dist/meeting/effectsState.d.ts +0 -42
  370. package/dist/meeting/in-meeting-actions.d.ts +0 -79
  371. package/dist/meeting/index.d.ts +0 -1621
  372. package/dist/meeting/muteState.d.ts +0 -116
  373. package/dist/meeting/request.d.ts +0 -255
  374. package/dist/meeting/state.d.ts +0 -9
  375. package/dist/meeting/util.d.ts +0 -2
  376. package/dist/meeting-info/collection.d.ts +0 -20
  377. package/dist/meeting-info/index.d.ts +0 -57
  378. package/dist/meeting-info/meeting-info-v2.d.ts +0 -93
  379. package/dist/meeting-info/request.d.ts +0 -22
  380. package/dist/meeting-info/util.d.ts +0 -2
  381. package/dist/meeting-info/utilv2.d.ts +0 -2
  382. package/dist/meetings/collection.d.ts +0 -23
  383. package/dist/meetings/index.d.ts +0 -296
  384. package/dist/meetings/request.d.ts +0 -27
  385. package/dist/meetings/util.d.ts +0 -18
  386. package/dist/member/index.d.ts +0 -147
  387. package/dist/member/member.types.d.ts +0 -11
  388. package/dist/member/util.d.ts +0 -2
  389. package/dist/members/collection.d.ts +0 -24
  390. package/dist/members/index.d.ts +0 -298
  391. package/dist/members/request.d.ts +0 -50
  392. package/dist/members/util.d.ts +0 -2
  393. package/dist/metrics/config.d.ts +0 -169
  394. package/dist/metrics/constants.d.ts +0 -57
  395. package/dist/metrics/index.d.ts +0 -152
  396. package/dist/networkQualityMonitor/index.d.ts +0 -70
  397. package/dist/peer-connection-manager/index.d.ts +0 -6
  398. package/dist/peer-connection-manager/util.d.ts +0 -6
  399. package/dist/personal-meeting-room/index.d.ts +0 -47
  400. package/dist/personal-meeting-room/request.d.ts +0 -14
  401. package/dist/personal-meeting-room/util.d.ts +0 -2
  402. package/dist/reachability/index.d.ts +0 -139
  403. package/dist/reachability/request.d.ts +0 -35
  404. package/dist/reactions/reactions.d.ts +0 -4
  405. package/dist/reactions/reactions.type.d.ts +0 -32
  406. package/dist/reconnection-manager/index.d.ts +0 -112
  407. package/dist/recording-controller/enums.d.ts +0 -7
  408. package/dist/recording-controller/index.d.ts +0 -193
  409. package/dist/recording-controller/util.d.ts +0 -13
  410. package/dist/roap/collection.d.ts +0 -10
  411. package/dist/roap/handler.d.ts +0 -47
  412. package/dist/roap/index.d.ts +0 -116
  413. package/dist/roap/request.d.ts +0 -35
  414. package/dist/roap/state.d.ts +0 -9
  415. package/dist/roap/turnDiscovery.d.ts +0 -67
  416. package/dist/roap/util.d.ts +0 -2
  417. package/dist/statsAnalyzer/global.d.ts +0 -126
  418. package/dist/statsAnalyzer/index.d.ts +0 -190
  419. package/dist/statsAnalyzer/mqaUtil.d.ts +0 -22
  420. package/dist/transcription/index.d.ts +0 -64
@@ -1,1266 +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 '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
- }
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
+ }