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

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