@webex/plugin-meetings 3.0.0-beta.15 → 3.0.0-beta.151

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 (480) hide show
  1. package/README.md +45 -1
  2. package/dist/annotation/annotation.types.js +7 -0
  3. package/dist/annotation/annotation.types.js.map +1 -0
  4. package/dist/annotation/constants.js +49 -0
  5. package/dist/annotation/constants.js.map +1 -0
  6. package/dist/annotation/index.js +359 -0
  7. package/dist/annotation/index.js.map +1 -0
  8. package/dist/breakouts/breakout.js +193 -0
  9. package/dist/breakouts/breakout.js.map +1 -0
  10. package/dist/breakouts/collection.js +23 -0
  11. package/dist/breakouts/collection.js.map +1 -0
  12. package/dist/breakouts/edit-lock-error.js +52 -0
  13. package/dist/breakouts/edit-lock-error.js.map +1 -0
  14. package/dist/breakouts/events.js +43 -0
  15. package/dist/breakouts/events.js.map +1 -0
  16. package/dist/breakouts/index.js +1046 -0
  17. package/dist/breakouts/index.js.map +1 -0
  18. package/dist/breakouts/request.js +78 -0
  19. package/dist/breakouts/request.js.map +1 -0
  20. package/dist/breakouts/utils.js +67 -0
  21. package/dist/breakouts/utils.js.map +1 -0
  22. package/dist/common/browser-detection.js +1 -21
  23. package/dist/common/browser-detection.js.map +1 -1
  24. package/dist/common/collection.js +5 -20
  25. package/dist/common/collection.js.map +1 -1
  26. package/dist/common/config.js +0 -7
  27. package/dist/common/config.js.map +1 -1
  28. package/dist/common/errors/captcha-error.js +0 -21
  29. package/dist/common/errors/captcha-error.js.map +1 -1
  30. package/dist/common/errors/intent-to-join.js +0 -21
  31. package/dist/common/errors/intent-to-join.js.map +1 -1
  32. package/dist/common/errors/join-meeting.js +0 -21
  33. package/dist/common/errors/join-meeting.js.map +1 -1
  34. package/dist/common/errors/media.js +0 -21
  35. package/dist/common/errors/media.js.map +1 -1
  36. package/dist/common/errors/parameter.js +0 -28
  37. package/dist/common/errors/parameter.js.map +1 -1
  38. package/dist/common/errors/password-error.js +0 -21
  39. package/dist/common/errors/password-error.js.map +1 -1
  40. package/dist/common/errors/permission.js +0 -21
  41. package/dist/common/errors/permission.js.map +1 -1
  42. package/dist/common/errors/reconnection-in-progress.js +0 -17
  43. package/dist/common/errors/reconnection-in-progress.js.map +1 -1
  44. package/dist/common/errors/reconnection.js +0 -21
  45. package/dist/common/errors/reconnection.js.map +1 -1
  46. package/dist/common/errors/stats.js +0 -21
  47. package/dist/common/errors/stats.js.map +1 -1
  48. package/dist/common/errors/webex-errors.js +9 -43
  49. package/dist/common/errors/webex-errors.js.map +1 -1
  50. package/dist/common/errors/webex-meetings-error.js +1 -24
  51. package/dist/common/errors/webex-meetings-error.js.map +1 -1
  52. package/dist/common/events/events-scope.js +0 -22
  53. package/dist/common/events/events-scope.js.map +1 -1
  54. package/dist/common/events/events.js +0 -23
  55. package/dist/common/events/events.js.map +1 -1
  56. package/dist/common/events/trigger-proxy.js +0 -12
  57. package/dist/common/events/trigger-proxy.js.map +1 -1
  58. package/dist/common/events/util.js +0 -15
  59. package/dist/common/events/util.js.map +1 -1
  60. package/dist/common/logs/logger-config.js +0 -4
  61. package/dist/common/logs/logger-config.js.map +1 -1
  62. package/dist/common/logs/logger-proxy.js +1 -8
  63. package/dist/common/logs/logger-proxy.js.map +1 -1
  64. package/dist/common/logs/request.js +35 -61
  65. package/dist/common/logs/request.js.map +1 -1
  66. package/dist/common/queue.js +4 -14
  67. package/dist/common/queue.js.map +1 -1
  68. package/dist/config.js +7 -13
  69. package/dist/config.js.map +1 -1
  70. package/dist/constants.js +208 -64
  71. package/dist/constants.js.map +1 -1
  72. package/dist/controls-options-manager/constants.js +14 -0
  73. package/dist/controls-options-manager/constants.js.map +1 -0
  74. package/dist/controls-options-manager/enums.js +27 -0
  75. package/dist/controls-options-manager/enums.js.map +1 -0
  76. package/dist/controls-options-manager/index.js +297 -0
  77. package/dist/controls-options-manager/index.js.map +1 -0
  78. package/dist/controls-options-manager/types.js +7 -0
  79. package/dist/controls-options-manager/types.js.map +1 -0
  80. package/dist/controls-options-manager/util.js +300 -0
  81. package/dist/controls-options-manager/util.js.map +1 -0
  82. package/dist/index.js +78 -17
  83. package/dist/index.js.map +1 -1
  84. package/dist/locus-info/controlsUtils.js +100 -29
  85. package/dist/locus-info/controlsUtils.js.map +1 -1
  86. package/dist/locus-info/embeddedAppsUtils.js +3 -26
  87. package/dist/locus-info/embeddedAppsUtils.js.map +1 -1
  88. package/dist/locus-info/fullState.js +0 -15
  89. package/dist/locus-info/fullState.js.map +1 -1
  90. package/dist/locus-info/hostUtils.js +4 -12
  91. package/dist/locus-info/hostUtils.js.map +1 -1
  92. package/dist/locus-info/index.js +387 -208
  93. package/dist/locus-info/index.js.map +1 -1
  94. package/dist/locus-info/infoUtils.js +0 -38
  95. package/dist/locus-info/infoUtils.js.map +1 -1
  96. package/dist/locus-info/mediaSharesUtils.js +54 -38
  97. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  98. package/dist/locus-info/parser.js +90 -126
  99. package/dist/locus-info/parser.js.map +1 -1
  100. package/dist/locus-info/selfUtils.js +93 -92
  101. package/dist/locus-info/selfUtils.js.map +1 -1
  102. package/dist/media/index.js +70 -219
  103. package/dist/media/index.js.map +1 -1
  104. package/dist/media/properties.js +74 -198
  105. package/dist/media/properties.js.map +1 -1
  106. package/dist/media/util.js +1 -8
  107. package/dist/media/util.js.map +1 -1
  108. package/dist/mediaQualityMetrics/config.js +505 -495
  109. package/dist/mediaQualityMetrics/config.js.map +1 -1
  110. package/dist/meeting/in-meeting-actions.js +79 -14
  111. package/dist/meeting/in-meeting-actions.js.map +1 -1
  112. package/dist/meeting/index.js +2685 -3324
  113. package/dist/meeting/index.js.map +1 -1
  114. package/dist/meeting/locusMediaRequest.js +291 -0
  115. package/dist/meeting/locusMediaRequest.js.map +1 -0
  116. package/dist/meeting/muteState.js +243 -185
  117. package/dist/meeting/muteState.js.map +1 -1
  118. package/dist/meeting/request.js +296 -342
  119. package/dist/meeting/request.js.map +1 -1
  120. package/dist/meeting/request.type.js +0 -1
  121. package/dist/meeting/request.type.js.map +1 -1
  122. package/dist/meeting/state.js +16 -26
  123. package/dist/meeting/state.js.map +1 -1
  124. package/dist/meeting/util.js +446 -585
  125. package/dist/meeting/util.js.map +1 -1
  126. package/dist/meeting-info/collection.js +3 -25
  127. package/dist/meeting-info/collection.js.map +1 -1
  128. package/dist/meeting-info/index.js +8 -31
  129. package/dist/meeting-info/index.js.map +1 -1
  130. package/dist/meeting-info/meeting-info-v2.js +261 -242
  131. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  132. package/dist/meeting-info/request.js +1 -16
  133. package/dist/meeting-info/request.js.map +1 -1
  134. package/dist/meeting-info/util.js +98 -183
  135. package/dist/meeting-info/util.js.map +1 -1
  136. package/dist/meeting-info/utilv2.js +156 -232
  137. package/dist/meeting-info/utilv2.js.map +1 -1
  138. package/dist/meetings/collection.js +24 -20
  139. package/dist/meetings/collection.js.map +1 -1
  140. package/dist/meetings/index.js +526 -372
  141. package/dist/meetings/index.js.map +1 -1
  142. package/dist/meetings/meetings.types.js +7 -0
  143. package/dist/meetings/meetings.types.js.map +1 -0
  144. package/dist/meetings/request.js +21 -40
  145. package/dist/meetings/request.js.map +1 -1
  146. package/dist/meetings/util.js +172 -141
  147. package/dist/meetings/util.js.map +1 -1
  148. package/dist/member/index.js +58 -57
  149. package/dist/member/index.js.map +1 -1
  150. package/dist/member/types.js +15 -0
  151. package/dist/member/types.js.map +1 -0
  152. package/dist/member/util.js +101 -69
  153. package/dist/member/util.js.map +1 -1
  154. package/dist/members/collection.js +12 -12
  155. package/dist/members/collection.js.map +1 -1
  156. package/dist/members/index.js +123 -162
  157. package/dist/members/index.js.map +1 -1
  158. package/dist/members/request.js +120 -85
  159. package/dist/members/request.js.map +1 -1
  160. package/dist/members/types.js +15 -0
  161. package/dist/members/types.js.map +1 -0
  162. package/dist/members/util.js +314 -260
  163. package/dist/members/util.js.map +1 -1
  164. package/dist/metrics/config.js +50 -16
  165. package/dist/metrics/config.js.map +1 -1
  166. package/dist/metrics/constants.js +4 -7
  167. package/dist/metrics/constants.js.map +1 -1
  168. package/dist/metrics/index.js +75 -147
  169. package/dist/metrics/index.js.map +1 -1
  170. package/dist/multistream/mediaRequestManager.js +170 -50
  171. package/dist/multistream/mediaRequestManager.js.map +1 -1
  172. package/dist/multistream/receiveSlot.js +58 -65
  173. package/dist/multistream/receiveSlot.js.map +1 -1
  174. package/dist/multistream/receiveSlotManager.js +73 -94
  175. package/dist/multistream/receiveSlotManager.js.map +1 -1
  176. package/dist/multistream/remoteMedia.js +55 -74
  177. package/dist/multistream/remoteMedia.js.map +1 -1
  178. package/dist/multistream/remoteMediaGroup.js +66 -43
  179. package/dist/multistream/remoteMediaGroup.js.map +1 -1
  180. package/dist/multistream/remoteMediaManager.js +502 -442
  181. package/dist/multistream/remoteMediaManager.js.map +1 -1
  182. package/dist/networkQualityMonitor/index.js +24 -51
  183. package/dist/networkQualityMonitor/index.js.map +1 -1
  184. package/dist/personal-meeting-room/index.js +3 -38
  185. package/dist/personal-meeting-room/index.js.map +1 -1
  186. package/dist/personal-meeting-room/request.js +2 -33
  187. package/dist/personal-meeting-room/request.js.map +1 -1
  188. package/dist/personal-meeting-room/util.js +0 -13
  189. package/dist/personal-meeting-room/util.js.map +1 -1
  190. package/dist/reachability/index.js +190 -199
  191. package/dist/reachability/index.js.map +1 -1
  192. package/dist/reachability/request.js +14 -23
  193. package/dist/reachability/request.js.map +1 -1
  194. package/dist/reactions/constants.js +13 -0
  195. package/dist/reactions/constants.js.map +1 -0
  196. package/dist/reactions/reactions.js +2 -4
  197. package/dist/reactions/reactions.js.map +1 -1
  198. package/dist/reactions/reactions.type.js +18 -24
  199. package/dist/reactions/reactions.type.js.map +1 -1
  200. package/dist/reconnection-manager/index.js +356 -476
  201. package/dist/reconnection-manager/index.js.map +1 -1
  202. package/dist/recording-controller/enums.js +17 -0
  203. package/dist/recording-controller/enums.js.map +1 -0
  204. package/dist/recording-controller/index.js +343 -0
  205. package/dist/recording-controller/index.js.map +1 -0
  206. package/dist/recording-controller/util.js +63 -0
  207. package/dist/recording-controller/util.js.map +1 -0
  208. package/dist/roap/index.js +32 -75
  209. package/dist/roap/index.js.map +1 -1
  210. package/dist/roap/request.js +129 -136
  211. package/dist/roap/request.js.map +1 -1
  212. package/dist/roap/turnDiscovery.js +143 -103
  213. package/dist/roap/turnDiscovery.js.map +1 -1
  214. package/dist/statsAnalyzer/global.js +1 -95
  215. package/dist/statsAnalyzer/global.js.map +1 -1
  216. package/dist/statsAnalyzer/index.js +369 -462
  217. package/dist/statsAnalyzer/index.js.map +1 -1
  218. package/dist/statsAnalyzer/mqaUtil.js +144 -94
  219. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  220. package/dist/transcription/index.js +9 -44
  221. package/dist/transcription/index.js.map +1 -1
  222. package/dist/types/annotation/annotation.types.d.ts +43 -0
  223. package/dist/types/annotation/constants.d.ts +31 -0
  224. package/dist/types/annotation/index.d.ts +124 -0
  225. package/dist/types/breakouts/breakout.d.ts +8 -0
  226. package/dist/types/breakouts/collection.d.ts +5 -0
  227. package/dist/types/breakouts/edit-lock-error.d.ts +15 -0
  228. package/dist/types/breakouts/events.d.ts +2 -0
  229. package/dist/types/breakouts/index.d.ts +5 -0
  230. package/dist/types/breakouts/request.d.ts +22 -0
  231. package/dist/types/breakouts/utils.d.ts +15 -0
  232. package/dist/types/common/browser-detection.d.ts +9 -0
  233. package/dist/types/common/collection.d.ts +48 -0
  234. package/dist/types/common/config.d.ts +2 -0
  235. package/dist/types/common/errors/captcha-error.d.ts +15 -0
  236. package/dist/types/common/errors/intent-to-join.d.ts +16 -0
  237. package/dist/types/common/errors/join-meeting.d.ts +17 -0
  238. package/dist/types/common/errors/media.d.ts +15 -0
  239. package/dist/types/common/errors/parameter.d.ts +15 -0
  240. package/dist/types/common/errors/password-error.d.ts +15 -0
  241. package/dist/types/common/errors/permission.d.ts +14 -0
  242. package/dist/types/common/errors/reconnection-in-progress.d.ts +9 -0
  243. package/dist/types/common/errors/reconnection.d.ts +15 -0
  244. package/dist/types/common/errors/stats.d.ts +15 -0
  245. package/dist/types/common/errors/webex-errors.d.ts +69 -0
  246. package/dist/types/common/errors/webex-meetings-error.d.ts +20 -0
  247. package/dist/types/common/events/events-scope.d.ts +17 -0
  248. package/dist/types/common/events/events.d.ts +12 -0
  249. package/dist/types/common/events/trigger-proxy.d.ts +2 -0
  250. package/dist/types/common/events/util.d.ts +2 -0
  251. package/dist/types/common/logs/logger-config.d.ts +2 -0
  252. package/dist/types/common/logs/logger-proxy.d.ts +2 -0
  253. package/dist/types/common/logs/request.d.ts +34 -0
  254. package/dist/types/common/queue.d.ts +32 -0
  255. package/dist/types/config.d.ts +72 -0
  256. package/dist/types/constants.d.ts +978 -0
  257. package/dist/types/controls-options-manager/constants.d.ts +4 -0
  258. package/dist/types/controls-options-manager/enums.d.ts +15 -0
  259. package/dist/types/controls-options-manager/index.d.ts +136 -0
  260. package/dist/types/controls-options-manager/types.d.ts +43 -0
  261. package/dist/types/controls-options-manager/util.d.ts +1 -0
  262. package/dist/types/index.d.ts +7 -0
  263. package/dist/types/locus-info/controlsUtils.d.ts +2 -0
  264. package/dist/types/locus-info/embeddedAppsUtils.d.ts +2 -0
  265. package/dist/types/locus-info/fullState.d.ts +2 -0
  266. package/dist/types/locus-info/hostUtils.d.ts +2 -0
  267. package/dist/types/locus-info/index.d.ts +315 -0
  268. package/dist/types/locus-info/infoUtils.d.ts +2 -0
  269. package/dist/types/locus-info/mediaSharesUtils.d.ts +2 -0
  270. package/dist/types/locus-info/parser.d.ts +212 -0
  271. package/dist/types/locus-info/selfUtils.d.ts +2 -0
  272. package/dist/types/media/index.d.ts +34 -0
  273. package/dist/types/media/properties.d.ts +86 -0
  274. package/dist/types/media/util.d.ts +2 -0
  275. package/dist/types/mediaQualityMetrics/config.d.ts +365 -0
  276. package/dist/types/meeting/in-meeting-actions.d.ts +149 -0
  277. package/dist/types/meeting/index.d.ts +1509 -0
  278. package/dist/types/meeting/locusMediaRequest.d.ts +70 -0
  279. package/dist/types/meeting/muteState.d.ts +184 -0
  280. package/dist/types/meeting/request.d.ts +270 -0
  281. package/dist/types/meeting/request.type.d.ts +11 -0
  282. package/dist/types/meeting/state.d.ts +9 -0
  283. package/dist/types/meeting/util.d.ts +75 -0
  284. package/dist/types/meeting-info/collection.d.ts +20 -0
  285. package/dist/types/meeting-info/index.d.ts +57 -0
  286. package/dist/types/meeting-info/meeting-info-v2.d.ts +122 -0
  287. package/dist/types/meeting-info/request.d.ts +22 -0
  288. package/dist/types/meeting-info/util.d.ts +2 -0
  289. package/dist/types/meeting-info/utilv2.d.ts +2 -0
  290. package/dist/types/meetings/collection.d.ts +31 -0
  291. package/dist/types/meetings/index.d.ts +364 -0
  292. package/dist/types/meetings/meetings.types.d.ts +4 -0
  293. package/dist/types/meetings/request.d.ts +27 -0
  294. package/dist/types/meetings/util.d.ts +18 -0
  295. package/dist/types/member/index.d.ts +157 -0
  296. package/dist/types/member/types.d.ts +21 -0
  297. package/dist/types/member/util.d.ts +2 -0
  298. package/dist/types/members/collection.d.ts +29 -0
  299. package/dist/types/members/index.d.ts +353 -0
  300. package/dist/types/members/request.d.ts +114 -0
  301. package/dist/types/members/types.d.ts +24 -0
  302. package/dist/types/members/util.d.ts +210 -0
  303. package/dist/types/metrics/config.d.ts +195 -0
  304. package/dist/types/metrics/constants.d.ts +55 -0
  305. package/dist/types/metrics/index.d.ts +169 -0
  306. package/dist/types/multistream/mediaRequestManager.d.ts +104 -0
  307. package/dist/types/multistream/receiveSlot.d.ts +68 -0
  308. package/dist/types/multistream/receiveSlotManager.d.ts +56 -0
  309. package/dist/types/multistream/remoteMedia.d.ts +72 -0
  310. package/dist/types/multistream/remoteMediaGroup.d.ts +47 -0
  311. package/dist/types/multistream/remoteMediaManager.d.ts +277 -0
  312. package/dist/types/networkQualityMonitor/index.d.ts +70 -0
  313. package/dist/types/personal-meeting-room/index.d.ts +47 -0
  314. package/dist/types/personal-meeting-room/request.d.ts +14 -0
  315. package/dist/types/personal-meeting-room/util.d.ts +2 -0
  316. package/dist/types/reachability/index.d.ts +152 -0
  317. package/dist/types/reachability/request.d.ts +37 -0
  318. package/dist/types/reactions/constants.d.ts +3 -0
  319. package/dist/types/reactions/reactions.d.ts +4 -0
  320. package/dist/types/reactions/reactions.type.d.ts +52 -0
  321. package/dist/types/reconnection-manager/index.d.ts +126 -0
  322. package/dist/types/recording-controller/enums.d.ts +7 -0
  323. package/dist/types/recording-controller/index.d.ts +193 -0
  324. package/dist/types/recording-controller/util.d.ts +13 -0
  325. package/dist/types/roap/index.d.ts +77 -0
  326. package/dist/types/roap/request.d.ts +36 -0
  327. package/dist/types/roap/turnDiscovery.d.ts +91 -0
  328. package/dist/types/statsAnalyzer/global.d.ts +36 -0
  329. package/dist/types/statsAnalyzer/index.d.ts +200 -0
  330. package/dist/types/statsAnalyzer/mqaUtil.d.ts +24 -0
  331. package/dist/types/transcription/index.d.ts +64 -0
  332. package/package.json +28 -21
  333. package/src/annotation/annotation.types.ts +52 -0
  334. package/src/annotation/constants.ts +36 -0
  335. package/src/annotation/index.ts +343 -0
  336. package/src/breakouts/README.md +220 -0
  337. package/src/breakouts/breakout.ts +163 -0
  338. package/src/breakouts/collection.ts +19 -0
  339. package/src/breakouts/edit-lock-error.ts +25 -0
  340. package/src/breakouts/events.ts +37 -0
  341. package/src/breakouts/index.ts +921 -0
  342. package/src/breakouts/request.ts +55 -0
  343. package/src/breakouts/utils.ts +57 -0
  344. package/src/common/errors/webex-errors.ts +6 -2
  345. package/src/common/logs/logger-proxy.ts +1 -1
  346. package/src/config.ts +5 -7
  347. package/src/constants.ts +155 -20
  348. package/src/controls-options-manager/constants.ts +5 -0
  349. package/src/controls-options-manager/enums.ts +18 -0
  350. package/src/controls-options-manager/index.ts +278 -0
  351. package/src/controls-options-manager/types.ts +59 -0
  352. package/src/controls-options-manager/util.ts +286 -0
  353. package/src/index.ts +34 -0
  354. package/src/locus-info/controlsUtils.ts +108 -0
  355. package/src/locus-info/index.ts +310 -21
  356. package/src/locus-info/mediaSharesUtils.ts +48 -0
  357. package/src/locus-info/parser.ts +2 -1
  358. package/src/locus-info/selfUtils.ts +71 -1
  359. package/src/media/index.ts +70 -142
  360. package/src/media/properties.ts +41 -104
  361. package/src/mediaQualityMetrics/config.ts +379 -377
  362. package/src/meeting/in-meeting-actions.ts +156 -0
  363. package/src/meeting/index.ts +1730 -1768
  364. package/src/meeting/locusMediaRequest.ts +309 -0
  365. package/src/meeting/muteState.ts +228 -132
  366. package/src/meeting/request.ts +100 -91
  367. package/src/meeting/request.type.ts +2 -0
  368. package/src/meeting/util.ts +421 -421
  369. package/src/meeting-info/meeting-info-v2.ts +134 -13
  370. package/src/meeting-info/utilv2.ts +13 -3
  371. package/src/meetings/collection.ts +20 -0
  372. package/src/meetings/index.ts +375 -83
  373. package/src/meetings/meetings.types.ts +9 -0
  374. package/src/meetings/request.ts +3 -1
  375. package/src/meetings/util.ts +103 -4
  376. package/src/member/index.ts +40 -0
  377. package/src/member/types.ts +24 -0
  378. package/src/member/util.ts +81 -1
  379. package/src/members/collection.ts +8 -0
  380. package/src/members/index.ts +108 -6
  381. package/src/members/request.ts +98 -17
  382. package/src/members/types.ts +28 -0
  383. package/src/members/util.ts +319 -240
  384. package/src/metrics/config.ts +49 -10
  385. package/src/metrics/constants.ts +2 -4
  386. package/src/metrics/index.ts +43 -27
  387. package/src/multistream/mediaRequestManager.ts +210 -45
  388. package/src/multistream/receiveSlot.ts +68 -26
  389. package/src/multistream/receiveSlotManager.ts +61 -38
  390. package/src/multistream/remoteMedia.ts +29 -3
  391. package/src/multistream/remoteMediaGroup.ts +61 -2
  392. package/src/multistream/remoteMediaManager.ts +260 -66
  393. package/src/networkQualityMonitor/index.ts +6 -6
  394. package/src/reachability/index.ts +75 -25
  395. package/src/reachability/request.ts +10 -5
  396. package/src/reactions/constants.ts +4 -0
  397. package/src/reactions/reactions.ts +4 -4
  398. package/src/reactions/reactions.type.ts +28 -3
  399. package/src/reconnection-manager/index.ts +53 -32
  400. package/src/recording-controller/enums.ts +8 -0
  401. package/src/recording-controller/index.ts +315 -0
  402. package/src/recording-controller/util.ts +58 -0
  403. package/src/roap/index.ts +21 -30
  404. package/src/roap/request.ts +51 -52
  405. package/src/roap/turnDiscovery.ts +51 -27
  406. package/src/statsAnalyzer/global.ts +1 -94
  407. package/src/statsAnalyzer/index.ts +380 -390
  408. package/src/statsAnalyzer/mqaUtil.ts +106 -99
  409. package/test/integration/spec/converged-space-meetings.js +233 -0
  410. package/test/integration/spec/journey.js +332 -255
  411. package/test/integration/spec/space-meeting.js +78 -5
  412. package/test/integration/spec/transcription.js +1 -1
  413. package/test/unit/spec/annotation/index.ts +436 -0
  414. package/test/unit/spec/breakouts/breakout.ts +203 -0
  415. package/test/unit/spec/breakouts/collection.ts +15 -0
  416. package/test/unit/spec/breakouts/edit-lock-error.ts +30 -0
  417. package/test/unit/spec/breakouts/events.ts +77 -0
  418. package/test/unit/spec/breakouts/index.ts +1790 -0
  419. package/test/unit/spec/breakouts/request.ts +104 -0
  420. package/test/unit/spec/breakouts/utils.js +72 -0
  421. package/test/unit/spec/controls-options-manager/index.js +287 -0
  422. package/test/unit/spec/controls-options-manager/util.js +518 -0
  423. package/test/unit/spec/fixture/locus.js +1 -0
  424. package/test/unit/spec/locus-info/controlsUtils.js +303 -30
  425. package/test/unit/spec/locus-info/index.js +615 -4
  426. package/test/unit/spec/locus-info/mediaSharesUtils.ts +22 -0
  427. package/test/unit/spec/locus-info/selfConstant.js +38 -0
  428. package/test/unit/spec/locus-info/selfUtils.js +200 -0
  429. package/test/unit/spec/media/index.ts +118 -22
  430. package/test/unit/spec/media/properties.ts +9 -9
  431. package/test/unit/spec/meeting/in-meeting-actions.ts +76 -0
  432. package/test/unit/spec/meeting/index.js +2394 -1381
  433. package/test/unit/spec/meeting/locusMediaRequest.ts +436 -0
  434. package/test/unit/spec/meeting/muteState.js +370 -208
  435. package/test/unit/spec/meeting/request.js +354 -42
  436. package/test/unit/spec/meeting/utils.js +268 -156
  437. package/test/unit/spec/meeting-info/meetinginfov2.js +383 -5
  438. package/test/unit/spec/meeting-info/utilv2.js +21 -0
  439. package/test/unit/spec/meetings/collection.js +14 -0
  440. package/test/unit/spec/meetings/index.js +842 -128
  441. package/test/unit/spec/meetings/utils.js +206 -2
  442. package/test/unit/spec/member/index.js +24 -0
  443. package/test/unit/spec/member/util.js +384 -32
  444. package/test/unit/spec/members/index.js +320 -1
  445. package/test/unit/spec/members/request.js +206 -27
  446. package/test/unit/spec/members/utils.js +184 -0
  447. package/test/unit/spec/metrics/index.js +98 -0
  448. package/test/unit/spec/multistream/mediaRequestManager.ts +676 -105
  449. package/test/unit/spec/multistream/receiveSlot.ts +77 -18
  450. package/test/unit/spec/multistream/receiveSlotManager.ts +69 -39
  451. package/test/unit/spec/multistream/remoteMedia.ts +32 -2
  452. package/test/unit/spec/multistream/remoteMediaGroup.ts +271 -5
  453. package/test/unit/spec/multistream/remoteMediaManager.ts +672 -65
  454. package/test/unit/spec/networkQualityMonitor/index.js +4 -4
  455. package/test/unit/spec/reachability/index.ts +176 -25
  456. package/test/unit/spec/reachability/request.js +66 -0
  457. package/test/unit/spec/reconnection-manager/index.js +46 -13
  458. package/test/unit/spec/recording-controller/index.js +231 -0
  459. package/test/unit/spec/recording-controller/util.js +102 -0
  460. package/test/unit/spec/roap/index.ts +21 -51
  461. package/test/unit/spec/roap/request.ts +187 -0
  462. package/test/unit/spec/roap/turnDiscovery.ts +73 -34
  463. package/test/unit/spec/stats-analyzer/index.js +94 -43
  464. package/test/utils/constants.js +9 -0
  465. package/test/utils/integrationTestUtils.js +46 -0
  466. package/test/utils/testUtils.js +0 -45
  467. package/test/utils/webex-config.js +4 -0
  468. package/test/utils/webex-test-users.js +7 -3
  469. package/tsconfig.json +6 -0
  470. package/dist/media/internal-media-core-wrapper.js +0 -22
  471. package/dist/media/internal-media-core-wrapper.js.map +0 -1
  472. package/dist/meeting/effectsState.js +0 -334
  473. package/dist/meeting/effectsState.js.map +0 -1
  474. package/dist/multistream/multistreamMedia.js +0 -117
  475. package/dist/multistream/multistreamMedia.js.map +0 -1
  476. package/src/index.js +0 -15
  477. package/src/media/internal-media-core-wrapper.ts +0 -9
  478. package/src/meeting/effectsState.ts +0 -211
  479. package/src/multistream/multistreamMedia.ts +0 -93
  480. package/test/unit/spec/meeting/effectsState.js +0 -281
@@ -0,0 +1,104 @@
1
+ import { StreamRequest } from '@webex/internal-media-core';
2
+ import { ReceiveSlot } from './receiveSlot';
3
+ export interface ActiveSpeakerPolicyInfo {
4
+ policy: 'active-speaker';
5
+ priority: number;
6
+ crossPriorityDuplication: boolean;
7
+ crossPolicyDuplication: boolean;
8
+ preferLiveVideo: boolean;
9
+ }
10
+ export interface ReceiverSelectedPolicyInfo {
11
+ policy: 'receiver-selected';
12
+ csi: number;
13
+ }
14
+ export type PolicyInfo = ActiveSpeakerPolicyInfo | ReceiverSelectedPolicyInfo;
15
+ export interface H264CodecInfo {
16
+ codec: 'h264';
17
+ maxFs?: number;
18
+ maxFps?: number;
19
+ maxMbps?: number;
20
+ maxWidth?: number;
21
+ maxHeight?: number;
22
+ }
23
+ export type CodecInfo = H264CodecInfo;
24
+ export interface MediaRequest {
25
+ policyInfo: PolicyInfo;
26
+ receiveSlots: Array<ReceiveSlot>;
27
+ codecInfo?: CodecInfo;
28
+ preferredMaxFs?: number;
29
+ handleMaxFs?: ({ maxFs }: {
30
+ maxFs: number;
31
+ }) => void;
32
+ }
33
+ export type MediaRequestId = string;
34
+ type DegradationPreferences = {
35
+ maxMacroblocksLimit: number;
36
+ };
37
+ type SendMediaRequestsCallback = (streamRequests: StreamRequest[]) => void;
38
+ type Kind = 'audio' | 'video';
39
+ type Options = {
40
+ degradationPreferences: DegradationPreferences;
41
+ kind: Kind;
42
+ };
43
+ export declare class MediaRequestManager {
44
+ private sendMediaRequestsCallback;
45
+ private kind;
46
+ private counter;
47
+ private clientRequests;
48
+ private degradationPreferences;
49
+ private sourceUpdateListener;
50
+ private debouncedSourceUpdateListener;
51
+ private previousStreamRequests;
52
+ constructor(sendMediaRequestsCallback: SendMediaRequestsCallback, options: Options);
53
+ setDegradationPreferences(degradationPreferences: DegradationPreferences): void;
54
+ private getDegradedClientRequests;
55
+ /**
56
+ * Returns true if two stream requests are the same, false otherwise.
57
+ *
58
+ * @param {StreamRequest} streamRequestA - Stream request A for comparison.
59
+ * @param {StreamRequest} streamRequestB - Stream request B for comparison.
60
+ * @returns {boolean} - Whether they are equal.
61
+ */
62
+ isEqual(streamRequestA: StreamRequest, streamRequestB: StreamRequest): boolean;
63
+ /**
64
+ * Compares new stream requests to previous ones and determines
65
+ * if they are the same.
66
+ *
67
+ * @param {StreamRequest[]} newRequests - Array with new requests.
68
+ * @returns {boolean} - True if they are equal, false otherwise.
69
+ */
70
+ private checkIsNewRequestsEqualToPrev;
71
+ /**
72
+ * Returns the maxPayloadBitsPerSecond per Stream
73
+ *
74
+ * If MediaRequestManager kind is "audio", a constant bitrate will be returned.
75
+ * If MediaRequestManager kind is "video", the bitrate will be calculated based
76
+ * on maxFs (default h264 maxFs as fallback if maxFs is not defined)
77
+ *
78
+ * @param {MediaRequest} mediaRequest - mediaRequest to take data from
79
+ * @returns {number} maxPayloadBitsPerSecond
80
+ */
81
+ private getMaxPayloadBitsPerSecond;
82
+ /**
83
+ * Returns the max Macro Blocks per second (maxMbps) per H264 Stream
84
+ *
85
+ * The maxMbps will be calculated based on maxFs and maxFps
86
+ * (default h264 maxFps as fallback if maxFps is not defined)
87
+ *
88
+ * @param {MediaRequest} mediaRequest - mediaRequest to take data from
89
+ * @returns {number} maxMbps
90
+ */
91
+ private getH264MaxMbps;
92
+ /**
93
+ * Clears the previous stream requests.
94
+ *
95
+ * @returns {void}
96
+ */
97
+ clearPreviousRequests(): void;
98
+ private sendRequests;
99
+ addRequest(mediaRequest: MediaRequest, commit?: boolean): MediaRequestId;
100
+ cancelRequest(requestId: MediaRequestId, commit?: boolean): void;
101
+ commit(): void;
102
+ reset(): void;
103
+ }
104
+ export {};
@@ -0,0 +1,68 @@
1
+ import { MediaType, ReceiveSlot as WcmeReceiveSlot, StreamState } from '@webex/internal-media-core';
2
+ import EventsScope from '../common/events/events-scope';
3
+ export declare const ReceiveSlotEvents: {
4
+ SourceUpdate: string;
5
+ MaxFsUpdate: string;
6
+ };
7
+ export type { StreamState } from '@webex/internal-media-core';
8
+ export type CSI = number;
9
+ export type MemberId = string;
10
+ export type ReceiveSlotId = string;
11
+ export type FindMemberIdCallback = (csi: CSI) => MemberId | undefined;
12
+ /**
13
+ * Class representing a receive slot. A single receive slot is able to receive a single track
14
+ * for example some participant's main video or audio
15
+ */
16
+ export declare class ReceiveSlot extends EventsScope {
17
+ #private;
18
+ private readonly mcReceiveSlot;
19
+ private readonly findMemberIdCallback;
20
+ readonly id: ReceiveSlotId;
21
+ readonly mediaType: MediaType;
22
+ /**
23
+ * constructor - don't use it directly, you should always use meeting.receiveSlotManager.allocateSlot()
24
+ * to create any receive slots
25
+ *
26
+ * @param {MediaType} mediaType
27
+ * @param {ReceiveSlot} mcReceiveSlot
28
+ * @param {FindMemberIdCallback} findMemberIdCallback callback for finding memberId for given CSI
29
+ */
30
+ constructor(mediaType: MediaType, mcReceiveSlot: WcmeReceiveSlot, findMemberIdCallback: FindMemberIdCallback);
31
+ /**
32
+ * Getter for memberId
33
+ */
34
+ get memberId(): string;
35
+ /**
36
+ * Getter for csi
37
+ */
38
+ get csi(): number;
39
+ /**
40
+ * Set the max frame size for this slot
41
+ * @param newFs frame size
42
+ */
43
+ setMaxFs(newFs: any): void;
44
+ /**
45
+ * Getter for sourceState
46
+ */
47
+ get sourceState(): StreamState;
48
+ /**
49
+ * registers event handlers with the underlying ReceiveSlot
50
+ */
51
+ private setupEventListeners;
52
+ /** Tries to find the member id for this receive slot if it hasn't got one */
53
+ findMemberId(): void;
54
+ /**
55
+ * @returns {string} a log message used to identify the receive slot
56
+ */
57
+ get logString(): string;
58
+ /**
59
+ * The MediaStream object associated with this slot.
60
+ *
61
+ * @returns {MediaStream} The MediaStreamTrack.
62
+ */
63
+ get stream(): MediaStream;
64
+ /**
65
+ * The underlying WCME receive slot
66
+ */
67
+ get wcmeReceiveSlot(): WcmeReceiveSlot;
68
+ }
@@ -0,0 +1,56 @@
1
+ import { MediaType, ReceiveSlot as WcmeReceiveSlot } from '@webex/internal-media-core';
2
+ import { FindMemberIdCallback, ReceiveSlot } from './receiveSlot';
3
+ export type CreateSlotCallback = (mediaType: MediaType) => Promise<WcmeReceiveSlot>;
4
+ export type { CSI, FindMemberIdCallback } from './receiveSlot';
5
+ /**
6
+ * Manages all receive slots used by a meeting. WMCE receive slots cannot be ever deleted,
7
+ * so this manager has a pool in order to re-use the slots that were released earlier.
8
+ */
9
+ export declare class ReceiveSlotManager {
10
+ private allocatedSlots;
11
+ private freeSlots;
12
+ private createSlotCallback;
13
+ private findMemberIdByCsiCallback;
14
+ /**
15
+ * Constructor
16
+ * @param {Meeting} meeting
17
+ */
18
+ constructor(createSlotCallback: CreateSlotCallback, findMemberIdByCsiCallback: FindMemberIdCallback);
19
+ /**
20
+ * Creates a new receive slot or returns one from the existing pool of free slots
21
+ *
22
+ * @param {MediaType} mediaType
23
+ * @returns {Promise<ReceiveSlot>}
24
+ */
25
+ allocateSlot(mediaType: MediaType): Promise<ReceiveSlot>;
26
+ /**
27
+ * Releases the slot back to the pool so it can be re-used by others in the future
28
+ * @param {ReceiveSlot} slot
29
+ */
30
+ releaseSlot(slot: ReceiveSlot): void;
31
+ /**
32
+ * Resets the slot manager - this method should be called when the media connection is torn down
33
+ */
34
+ reset(): void;
35
+ /**
36
+ * Returns statistics about the managed slots
37
+ *
38
+ * @returns {Object}
39
+ */
40
+ getStats(): {
41
+ numAllocatedSlots: {};
42
+ numFreeSlots: {};
43
+ };
44
+ /**
45
+ * Tries to find the member id on all allocated receive slots
46
+ * This function should be called when new members are added to the meeting.
47
+ */
48
+ updateMemberIds(): void;
49
+ /**
50
+ * Find a receive slot by a ssrc.
51
+ *
52
+ * @param ssrc - The ssrc of the receive slot to find.
53
+ * @returns - The receive slot with this ssrc, undefined if not found.
54
+ */
55
+ findReceiveSlotBySsrc(ssrc: number): ReceiveSlot | undefined;
56
+ }
@@ -0,0 +1,72 @@
1
+ import { MediaType, StreamState } from '@webex/internal-media-core';
2
+ import EventsScope from '../common/events/events-scope';
3
+ import { MediaRequestManager } from './mediaRequestManager';
4
+ import { ReceiveSlot } from './receiveSlot';
5
+ export declare const RemoteMediaEvents: {
6
+ SourceUpdate: string;
7
+ Stopped: string;
8
+ };
9
+ export type RemoteVideoResolution = 'thumbnail' | 'very small' | 'small' | 'medium' | 'large' | 'best';
10
+ /**
11
+ * Converts pane size into h264 maxFs
12
+ * @param {PaneSize} paneSize
13
+ * @returns {number}
14
+ */
15
+ export declare function getMaxFs(paneSize: RemoteVideoResolution): number;
16
+ type Options = {
17
+ resolution?: RemoteVideoResolution;
18
+ };
19
+ export type RemoteMediaId = string;
20
+ /**
21
+ * Class representing a remote audio/video stream.
22
+ *
23
+ * Internally it is associated with a specific receive slot
24
+ * and a media request for it.
25
+ */
26
+ export declare class RemoteMedia extends EventsScope {
27
+ private receiveSlot?;
28
+ private readonly mediaRequestManager;
29
+ private readonly options;
30
+ private mediaRequestId?;
31
+ readonly id: RemoteMediaId;
32
+ /**
33
+ * Constructs RemoteMedia instance
34
+ *
35
+ * @param receiveSlot
36
+ * @param mediaRequestManager
37
+ * @param options
38
+ */
39
+ constructor(receiveSlot: ReceiveSlot, mediaRequestManager: MediaRequestManager, options?: Options);
40
+ /**
41
+ * Supply the width and height of the video element
42
+ * to restrict the requested resolution to this size
43
+ * @param width width of the video element
44
+ * @param height height of the video element
45
+ */
46
+ setSizeHint(width: any, height: any): void;
47
+ /**
48
+ * registers event listeners on the receive slot and forwards all the events
49
+ */
50
+ private setupEventListeners;
51
+ /**
52
+ * Getter for mediaType
53
+ */
54
+ get mediaType(): MediaType;
55
+ /**
56
+ * Getter for memberId
57
+ */
58
+ get memberId(): string;
59
+ /**
60
+ * Getter for csi
61
+ */
62
+ get csi(): number;
63
+ /**
64
+ * Getter for source state
65
+ */
66
+ get sourceState(): StreamState;
67
+ /**
68
+ * Getter for remote media stream
69
+ */
70
+ get stream(): MediaStream;
71
+ }
72
+ export {};
@@ -0,0 +1,47 @@
1
+ import { RemoteMedia, RemoteVideoResolution } from './remoteMedia';
2
+ import { MediaRequestManager } from './mediaRequestManager';
3
+ import { CSI, ReceiveSlot } from './receiveSlot';
4
+ type Options = {
5
+ resolution?: RemoteVideoResolution;
6
+ preferLiveVideo?: boolean;
7
+ };
8
+ export declare class RemoteMediaGroup {
9
+ private mediaRequestManager;
10
+ private priority;
11
+ private options;
12
+ private unpinnedRemoteMedia;
13
+ private mediaRequestId?;
14
+ private pinnedRemoteMedia;
15
+ constructor(mediaRequestManager: MediaRequestManager, receiveSlots: ReceiveSlot[], priority: number, commitMediaRequest: boolean, options?: Options);
16
+ /**
17
+ * Gets the array of remote media elements from the group
18
+ *
19
+ * @param {string} filter - 'all' (default) returns both pinned and unpinned
20
+ * @returns {Array<RemoteMedia>}
21
+ */
22
+ getRemoteMedia(filter?: 'all' | 'pinned' | 'unpinned'): RemoteMedia[];
23
+ /**
24
+ * Pins a specific remote media instance to a specfic CSI, so the media will
25
+ * no longer come from active speaker, but from that CSI.
26
+ * If no CSI is given, the current CSI value is used.
27
+ *
28
+ */
29
+ pin(remoteMedia: RemoteMedia, csi?: CSI): void;
30
+ /**
31
+ * Unpins a remote media instance, so that it will again provide media from active speakers
32
+ *
33
+ */
34
+ unpin(remoteMedia: RemoteMedia): void;
35
+ isPinned(remoteMedia: RemoteMedia): boolean;
36
+ private sendActiveSpeakerMediaRequest;
37
+ private cancelActiveSpeakerMediaRequest;
38
+ /**
39
+ * Checks if a given RemoteMedia instance belongs to this group.
40
+ *
41
+ * @param remoteMedia RemoteMedia instance to check
42
+ * @param filter controls which remote media from the group to check
43
+ * @returns true if remote media is found
44
+ */
45
+ includes(remoteMedia: RemoteMedia, filter?: 'all' | 'pinned' | 'unpinned'): boolean;
46
+ }
47
+ export {};
@@ -0,0 +1,277 @@
1
+ import { EventMap } from 'typed-emitter';
2
+ import EventsScope from '../common/events/events-scope';
3
+ import { RemoteMedia, RemoteVideoResolution } from './remoteMedia';
4
+ import { CSI } from './receiveSlot';
5
+ import { ReceiveSlotManager } from './receiveSlotManager';
6
+ import { RemoteMediaGroup } from './remoteMediaGroup';
7
+ import { MediaRequestManager } from './mediaRequestManager';
8
+ export type PaneSize = RemoteVideoResolution;
9
+ export type LayoutId = string;
10
+ export type PaneId = string;
11
+ export type PaneGroupId = string;
12
+ export interface ActiveSpeakerVideoPaneGroup {
13
+ id: PaneGroupId;
14
+ numPanes: number;
15
+ size: PaneSize;
16
+ priority: number;
17
+ }
18
+ export interface MemberVideoPane {
19
+ id: PaneId;
20
+ size: PaneSize;
21
+ csi?: CSI;
22
+ }
23
+ export interface VideoLayout {
24
+ screenShareVideo?: {
25
+ size: PaneSize;
26
+ };
27
+ activeSpeakerVideoPaneGroups?: ActiveSpeakerVideoPaneGroup[];
28
+ memberVideoPanes?: MemberVideoPane[];
29
+ }
30
+ export interface Configuration {
31
+ audio: {
32
+ numOfActiveSpeakerStreams: number;
33
+ numOfScreenShareStreams: number;
34
+ };
35
+ video: {
36
+ preferLiveVideo: boolean;
37
+ initialLayoutId: LayoutId;
38
+ layouts: {
39
+ [key: LayoutId]: VideoLayout;
40
+ };
41
+ };
42
+ }
43
+ /**
44
+ * Default configuration:
45
+ * - uses 3 audio streams
46
+ * - prefers active speakers with live video (e.g. are not audio only or video muted) over active speakers without live video
47
+ * - has a few layouts defined, including 1 that contains remote screen share (ScreenShareView)
48
+ */
49
+ export declare const DefaultConfiguration: Configuration;
50
+ export declare enum Event {
51
+ AudioCreated = "AudioCreated",
52
+ ScreenShareAudioCreated = "ScreenShareAudioCreated",
53
+ VideoLayoutChanged = "VideoLayoutChanged"
54
+ }
55
+ export interface VideoLayoutChangedEventData {
56
+ layoutId: LayoutId;
57
+ activeSpeakerVideoPanes: {
58
+ [key: PaneGroupId]: RemoteMediaGroup;
59
+ };
60
+ memberVideoPanes: {
61
+ [key: PaneId]: RemoteMedia;
62
+ };
63
+ screenShareVideo?: RemoteMedia;
64
+ }
65
+ export interface Events extends EventMap {
66
+ [Event.AudioCreated]: (audio: RemoteMediaGroup) => void;
67
+ [Event.ScreenShareAudioCreated]: (screenShareAudio: RemoteMediaGroup) => void;
68
+ [Event.VideoLayoutChanged]: (data: VideoLayoutChangedEventData) => void;
69
+ }
70
+ /**
71
+ * A helper class that manages all remote audio/video streams in order to achieve a predefined set of layouts.
72
+ * It also creates a fixed number of audio streams and these don't change during the meeting.
73
+ *
74
+ * Things that RemoteMediaManager does:
75
+ * - owns the receive slots (creates them when needed, and re-uses them when switching layouts)
76
+ * - constructs appropriate RemoteMedia and RemoteMediaGroup objects and sends appropriate mediaRequests
77
+ */
78
+ export declare class RemoteMediaManager extends EventsScope {
79
+ private config;
80
+ private started;
81
+ private receiveSlotManager;
82
+ private mediaRequestManagers;
83
+ private currentLayout?;
84
+ private slots;
85
+ private media;
86
+ private receiveSlotAllocations;
87
+ private currentLayoutId?;
88
+ /**
89
+ * Constructor
90
+ *
91
+ * @param {ReceiveSlotManager} receiveSlotManager
92
+ * @param {{audio: MediaRequestManager, video: mediaRequestManagers}} mediaRequestManagers
93
+ * @param {Configuration} config Configuration describing what video layouts to use during the meeting
94
+ */
95
+ constructor(receiveSlotManager: ReceiveSlotManager, mediaRequestManagers: {
96
+ audio: MediaRequestManager;
97
+ video: MediaRequestManager;
98
+ screenShareAudio: MediaRequestManager;
99
+ screenShareVideo: MediaRequestManager;
100
+ }, config?: Configuration);
101
+ /**
102
+ * Checks if configuration is valid, throws an error if it's not
103
+ */
104
+ private checkConfigValidity;
105
+ /**
106
+ * Starts the RemoteMediaManager.
107
+ *
108
+ * @returns {Promise}
109
+ */
110
+ start(): Promise<void>;
111
+ /**
112
+ * Releases all the used resources (like allocated receive slots). This function needs
113
+ * to be called when we leave the meeting, etc.
114
+ */
115
+ stop(): void;
116
+ /**
117
+ * Returns the total number of main video panes required for a given layout
118
+ *
119
+ * @param {VideoLayout} layout
120
+ * @returns {number}
121
+ */
122
+ private getRequiredNumVideoSlotsForLayout;
123
+ /**
124
+ * Allocates the maximum number of panes that any of the configured layouts will require.
125
+ * We do this at the beginning, because it's more efficient (much faster) then allocating receive slots
126
+ * later, after the SDP exchange was done.
127
+ */
128
+ private preallocateVideoReceiveSlots;
129
+ /**
130
+ * Changes the layout (triggers Event.VideoLayoutChanged)
131
+ *
132
+ * @param {LayoutId} layoutId new layout id
133
+ * @returns {Promise}
134
+ */
135
+ setLayout(layoutId: LayoutId): Promise<void>;
136
+ /**
137
+ * Returns the currently selected layout id
138
+ *
139
+ * @returns {LayoutId}
140
+ */
141
+ getLayoutId(): LayoutId | undefined;
142
+ /**
143
+ * sets the preferLiveVideo
144
+ */
145
+ setPreferLiveVideo(preferLiveVideo: boolean): void;
146
+ /**
147
+ * Sets CSIs for multiple RemoteMedia instances belonging to RemoteMediaGroup.
148
+ * For each entry in the remoteMediaCsis array:
149
+ * - if csi is specified, the RemoteMedia instance is pinned to that CSI
150
+ * - if csi is undefined, the RemoteMedia instance is unpinned
151
+ */
152
+ setActiveSpeakerCsis(remoteMediaCsis: {
153
+ remoteMedia: RemoteMedia;
154
+ csi?: number;
155
+ }[]): void;
156
+ /**
157
+ * Creates the audio slots
158
+ */
159
+ private createAudioMedia;
160
+ /**
161
+ * Creates receive slots required for receiving screen share audio and video
162
+ */
163
+ private createScreenShareReceiveSlots;
164
+ /**
165
+ * Creates RemoteMedia objects for screen share
166
+ */
167
+ private createScreenShareAudioMedia;
168
+ /**
169
+ * Goes over all receiver-selected slots and keeps only the ones that are required by a given layout,
170
+ * the rest are all moved to the "unused" list
171
+ */
172
+ private trimReceiverSelectedSlots;
173
+ /**
174
+ * Releases all the "unused" video slots.
175
+ */
176
+ private releaseUnusedVideoSlots;
177
+ /**
178
+ * Allocates receive slots to all active speaker video panes
179
+ * in the current selected layout.
180
+ *
181
+ * Allocation tries to keep the same order of the slots between the previous
182
+ * layout and the new one. Sorting helps making sure that highest priority slots
183
+ * go in the same order in the new layout.
184
+ */
185
+ private allocateSlotsToActiveSpeakerPaneGroups;
186
+ /**
187
+ * Allocates receive slots to all receiver selected video panes
188
+ * in the current selected layout
189
+ */
190
+ private allocateSlotsToReceiverSelectedVideoPaneGroups;
191
+ /**
192
+ * Ensures that we have enough slots for the current layout.
193
+ */
194
+ private refillRequiredSlotsIfNeeded;
195
+ /**
196
+ * Move all active speaker slots to "unused"
197
+ */
198
+ private trimActiveSpeakerSlots;
199
+ /**
200
+ * Logs the state of the receive slots
201
+ */
202
+ private logReceieveSlots;
203
+ /**
204
+ * Makes sure we have the right number of receive slots created for the current layout
205
+ * and allocates them to the right video panes / pane groups
206
+ *
207
+ * @returns {Promise}
208
+ */
209
+ private updateVideoReceiveSlots;
210
+ /**
211
+ * Creates new RemoteMedia and RemoteMediaGroup objects for the current layout
212
+ * and sends the media requests for all of them.
213
+ */
214
+ private updateVideoRemoteMediaObjects;
215
+ /**
216
+ * Checks if current layout requires a screen share.
217
+ * If it does, it creates new RemoteMediaGroup object for screen share
218
+ * and sends the media requests for it.
219
+ * If it doesn't, it makes sure we clean up any RemoteMediaGroup objects
220
+ * created earlier for screen share (for previous layout).
221
+ */
222
+ private updateScreenShareVideoRemoteMediaObject;
223
+ /**
224
+ * Invalidates all remote media objects belonging to currently selected layout
225
+ */
226
+ private invalidateCurrentRemoteMedia;
227
+ /** emits Event.VideoLayoutChanged */
228
+ private emitVideoLayoutChangedEvent;
229
+ /**
230
+ * Sets a new CSI on a given remote media object
231
+ *
232
+ * @param {RemoteMedia} remoteMedia remote Media object to modify
233
+ * @param {CSI} csi new CSI value, can be null if we want to stop receiving media
234
+ */
235
+ setRemoteVideoCsi(remoteMedia: RemoteMedia, csi: CSI | null): void;
236
+ /**
237
+ * Adds a new member video pane to the currently selected layout.
238
+ *
239
+ * Changes to the layout are lost after a layout change.
240
+ *
241
+ * @param {MemberVideoPane} newPane
242
+ * @returns {Promise<RemoteMedia>}
243
+ */
244
+ addMemberVideoPane(newPane: MemberVideoPane): Promise<RemoteMedia>;
245
+ /**
246
+ * Removes a member video pane from the currently selected layout.
247
+ *
248
+ * Changes to the layout are lost after a layout change.
249
+ *
250
+ * @param {PaneId} paneId pane id of the pane to remove
251
+ * @returns {Promise<void>}
252
+ */
253
+ removeMemberVideoPane(paneId: PaneId): Promise<void>;
254
+ /**
255
+ * Pins an active speaker remote media object to the given CSI value. From that moment
256
+ * onwards the remote media will only play audio/video from that specific CSI until
257
+ * unpinActiveSpeakerVideoPane() is called or current layout is changed.
258
+ *
259
+ * @param {RemoteMedia} remoteMedia remote media object reference
260
+ * @param {CSI} csi CSI value to pin to, if undefined, then current CSI value is used
261
+ */
262
+ pinActiveSpeakerVideoPane(remoteMedia: RemoteMedia, csi?: CSI): void;
263
+ /**
264
+ * Unpins a remote media object from the fixed CSI value it was pinned to.
265
+ *
266
+ * @param {RemoteMedia} remoteMedia remote media object reference
267
+ */
268
+ unpinActiveSpeakerVideoPane(remoteMedia: RemoteMedia): void;
269
+ /**
270
+ * Returns true if a given remote media object belongs to an active speaker group and has been pinned.
271
+ * Throws an error if the remote media object doesn't belong to any active speaker remote media group.
272
+ *
273
+ * @param {RemoteMedia} remoteMedia remote media object
274
+ * @returns {boolean}
275
+ */
276
+ isPinned(remoteMedia: RemoteMedia): boolean;
277
+ }
@@ -0,0 +1,70 @@
1
+ import EventsScope from '../common/events/events-scope';
2
+ /**
3
+ * Meeting - network quality event
4
+ * Emitted on each interval of retrieving stats Analyzer data
5
+ * @event network:quality
6
+ * @type {Object}
7
+ * @property {string} mediaType {video|audio}
8
+ * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
9
+ * @memberof NetworkQualityMonitor
10
+ */
11
+ /**
12
+ * NetworkQualityMonitor class that will emit events based on detected quality
13
+ *
14
+ * @class NetworkQualityMonitor
15
+ * @extends {EventsScope}
16
+ */
17
+ export default class NetworkQualityMonitor extends EventsScope {
18
+ config: any;
19
+ frequencyTypes: any;
20
+ indicatorTypes: any;
21
+ mediaType: any;
22
+ networkQualityScore: any;
23
+ networkQualityStatus: any;
24
+ /**
25
+ * Creates a new instance of NetworkQualityMonitor
26
+ * @constructor
27
+ * @public
28
+ * @param {Object} config
29
+ * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
30
+ * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
31
+ * @property {number} networkQualityScore - 0|1 1 is acceptable 0 is bad/unknown
32
+ * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
33
+ * @property {string} mediaType - audio|video
34
+ */
35
+ constructor(config: any);
36
+ /**
37
+ * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
38
+ *
39
+ * @memberof NetworkQualityMonitor
40
+ * @returns {void}
41
+ */
42
+ emitNetworkQuality(): void;
43
+ /**
44
+ * invokes emitNetworkQuality method resets values back to default
45
+ * @returns {void}
46
+ * @memberof NetworkQualityMonitor
47
+ */
48
+ updateNetworkQualityStatus(): void;
49
+ /**
50
+ * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
51
+ * @param {Object} configObj
52
+ * @param {string} configObj.mediaType {audio|video}
53
+ * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
54
+ * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
55
+ * @returns {void}
56
+ * @public
57
+ * @memberof NetworkQualityMonitor
58
+ */
59
+ determineUplinkNetworkQuality({ mediaType, remoteRtpResults, statsAnalyzerCurrentStats, }: {
60
+ mediaType: string;
61
+ remoteRtpResults: any;
62
+ statsAnalyzerCurrentStats: object;
63
+ }): void;
64
+ /**
65
+ * Get the current status of network quaility object - networkQualityStatus
66
+ * @returns {Object}
67
+ * @public
68
+ */
69
+ get networkQualityStats(): any;
70
+ }