agora-electron-sdk 4.2.0-dev.4 → 4.2.0-dev.8

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 (270) hide show
  1. package/js/AgoraSdk.js +4 -2
  2. package/js/Private/AgoraBase.js +1154 -6
  3. package/js/Private/AgoraMediaBase.js +308 -0
  4. package/js/Private/AgoraMediaPlayerTypes.js +112 -0
  5. package/js/Private/IAgoraLog.js +12 -0
  6. package/js/Private/IAgoraMediaStreamingSource.js +10 -0
  7. package/js/Private/IAgoraMusicContentCenter.js +104 -0
  8. package/js/Private/IAgoraRhythmPlayer.js +8 -0
  9. package/js/Private/IAgoraRtcEngine.js +843 -0
  10. package/js/Private/IAgoraRtcEngineEx.js +8 -0
  11. package/js/Private/IAgoraSpatialAudio.js +44 -0
  12. package/js/Private/impl/IAgoraMediaPlayerImpl.js +59 -59
  13. package/js/Private/impl/IAgoraRtcEngineImpl.js +55 -46
  14. package/js/Private/internal/IrisApiEngine.js +7 -12
  15. package/js/Private/internal/MediaEngineInternal.js +7 -11
  16. package/js/Private/internal/MediaPlayerInternal.js +22 -20
  17. package/js/Private/internal/MediaRecorderInternal.js +4 -4
  18. package/js/Private/internal/MusicContentCenterInternal.js +7 -9
  19. package/js/Private/internal/RtcEngineExInternal.js +52 -62
  20. package/js/Renderer/AgoraView.js +21 -24
  21. package/js/Renderer/IRenderer.js +6 -13
  22. package/js/Renderer/IRendererManager.js +9 -0
  23. package/js/Renderer/RendererManager.js +49 -33
  24. package/js/Renderer/{GlRenderer → WebGLRenderer}/index.js +39 -45
  25. package/js/Renderer/YUVCanvasRenderer/index.js +8 -7
  26. package/js/Renderer/index.js +18 -0
  27. package/js/Utils.js +6 -8
  28. package/package.json +5 -4
  29. package/scripts/buildJS.js +1 -2
  30. package/scripts/getConfig.js +0 -1
  31. package/ts/AgoraSdk.ts +5 -2
  32. package/ts/Private/IAgoraMediaPlayer.ts +45 -45
  33. package/ts/Private/IAgoraRtcEngine.ts +33 -25
  34. package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +84 -84
  35. package/ts/Private/impl/IAgoraRtcEngineImpl.ts +75 -65
  36. package/ts/Private/internal/IrisApiEngine.ts +0 -2
  37. package/ts/Private/internal/RtcEngineExInternal.ts +23 -12
  38. package/ts/Renderer/AgoraView.ts +1 -0
  39. package/ts/Renderer/IRenderer.ts +8 -14
  40. package/ts/Renderer/IRendererManager.ts +35 -0
  41. package/ts/Renderer/RendererManager.ts +9 -9
  42. package/ts/Renderer/{GlRenderer → WebGLRenderer}/index.ts +26 -45
  43. package/ts/Renderer/YUVCanvasRenderer/index.ts +8 -10
  44. package/ts/Renderer/index.ts +2 -0
  45. package/ts/Types.ts +15 -9
  46. package/ts/Utils.ts +4 -6
  47. package/types/AgoraSdk.d.ts +4 -2
  48. package/types/AgoraSdk.d.ts.map +1 -0
  49. package/types/Private/AgoraBase.d.ts +1 -0
  50. package/types/Private/AgoraBase.d.ts.map +1 -0
  51. package/types/Private/AgoraMediaBase.d.ts +1 -0
  52. package/types/Private/AgoraMediaBase.d.ts.map +1 -0
  53. package/types/Private/AgoraMediaPlayerTypes.d.ts +1 -0
  54. package/types/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
  55. package/types/Private/IAgoraLog.d.ts +1 -0
  56. package/types/Private/IAgoraLog.d.ts.map +1 -0
  57. package/types/Private/IAgoraMediaEngine.d.ts +1 -0
  58. package/types/Private/IAgoraMediaEngine.d.ts.map +1 -0
  59. package/types/Private/IAgoraMediaPlayer.d.ts +35 -34
  60. package/types/Private/IAgoraMediaPlayer.d.ts.map +1 -0
  61. package/types/Private/IAgoraMediaPlayerSource.d.ts +1 -0
  62. package/types/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
  63. package/types/Private/IAgoraMediaRecorder.d.ts +1 -0
  64. package/types/Private/IAgoraMediaRecorder.d.ts.map +1 -0
  65. package/types/Private/IAgoraMediaStreamingSource.d.ts +1 -0
  66. package/types/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
  67. package/types/Private/IAgoraMusicContentCenter.d.ts +1 -0
  68. package/types/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
  69. package/types/Private/IAgoraRhythmPlayer.d.ts +1 -0
  70. package/types/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
  71. package/types/Private/IAgoraRtcEngine.d.ts +27 -19
  72. package/types/Private/IAgoraRtcEngine.d.ts.map +1 -0
  73. package/types/Private/IAgoraRtcEngineEx.d.ts +1 -0
  74. package/types/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
  75. package/types/Private/IAgoraSpatialAudio.d.ts +1 -0
  76. package/types/Private/IAgoraSpatialAudio.d.ts.map +1 -0
  77. package/types/Private/IAudioDeviceManager.d.ts +1 -0
  78. package/types/Private/IAudioDeviceManager.d.ts.map +1 -0
  79. package/types/Private/extension/AgoraBaseExtension.d.ts +1 -0
  80. package/types/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
  81. package/types/Private/extension/AgoraMediaBaseExtension.d.ts +1 -0
  82. package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
  83. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +1 -0
  84. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
  85. package/types/Private/extension/IAgoraLogExtension.d.ts +1 -0
  86. package/types/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
  87. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts +1 -0
  88. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
  89. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts +1 -0
  90. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
  91. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +1 -0
  92. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
  93. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts +1 -0
  94. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
  95. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts +1 -0
  96. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
  97. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts +1 -0
  98. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
  99. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts +1 -0
  100. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
  101. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts +1 -0
  102. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
  103. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts +1 -0
  104. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
  105. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts +1 -0
  106. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
  107. package/types/Private/impl/AgoraBaseImpl.d.ts +1 -0
  108. package/types/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
  109. package/types/Private/impl/AgoraMediaBaseImpl.d.ts +1 -0
  110. package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
  111. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts +1 -0
  112. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
  113. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts +9 -8
  114. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
  115. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +1 -0
  116. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
  117. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts +1 -0
  118. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
  119. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts +1 -0
  120. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
  121. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts +1 -0
  122. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
  123. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts +13 -10
  124. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
  125. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts +1 -0
  126. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
  127. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts +1 -0
  128. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
  129. package/types/Private/internal/AudioDeviceManagerInternal.d.ts +1 -0
  130. package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
  131. package/types/Private/internal/IrisApiEngine.d.ts +8 -7
  132. package/types/Private/internal/IrisApiEngine.d.ts.map +1 -0
  133. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts +1 -0
  134. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
  135. package/types/Private/internal/MediaEngineInternal.d.ts +1 -0
  136. package/types/Private/internal/MediaEngineInternal.d.ts.map +1 -0
  137. package/types/Private/internal/MediaPlayerInternal.d.ts +1 -0
  138. package/types/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
  139. package/types/Private/internal/MediaRecorderInternal.d.ts +1 -0
  140. package/types/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
  141. package/types/Private/internal/MusicContentCenterInternal.d.ts +1 -0
  142. package/types/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
  143. package/types/Private/internal/RtcEngineExInternal.d.ts +3 -2
  144. package/types/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
  145. package/{js → types}/Private/internal/emitter/EventEmitter.d.ts +1 -0
  146. package/types/Private/internal/emitter/EventEmitter.d.ts.map +1 -0
  147. package/types/Private/ti/AgoraBase-ti.d.ts +1 -0
  148. package/types/Private/ti/AgoraBase-ti.d.ts.map +1 -0
  149. package/types/Private/ti/AgoraMediaBase-ti.d.ts +1 -0
  150. package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
  151. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts +1 -0
  152. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
  153. package/types/Private/ti/IAgoraLog-ti.d.ts +1 -0
  154. package/types/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
  155. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts +1 -0
  156. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
  157. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts +1 -0
  158. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
  159. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +1 -0
  160. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
  161. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts +1 -0
  162. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
  163. package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts +1 -0
  164. package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
  165. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts +1 -0
  166. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
  167. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts +1 -0
  168. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
  169. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts +1 -0
  170. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
  171. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts +1 -0
  172. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
  173. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts +1 -0
  174. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
  175. package/types/Private/ti/IAudioDeviceManager-ti.d.ts +1 -0
  176. package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
  177. package/types/Renderer/AgoraView.d.ts +1 -0
  178. package/types/Renderer/AgoraView.d.ts.map +1 -0
  179. package/types/Renderer/IRenderer.d.ts +6 -5
  180. package/types/Renderer/IRenderer.d.ts.map +1 -0
  181. package/types/Renderer/IRendererManager.d.ts +18 -0
  182. package/types/Renderer/IRendererManager.d.ts.map +1 -0
  183. package/types/Renderer/RendererManager.d.ts +5 -3
  184. package/types/Renderer/RendererManager.d.ts.map +1 -0
  185. package/types/Renderer/{GlRenderer → WebGLRenderer}/index.d.ts +9 -19
  186. package/types/Renderer/WebGLRenderer/index.d.ts.map +1 -0
  187. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts +1 -0
  188. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
  189. package/types/Renderer/YUVCanvasRenderer/index.d.ts +4 -4
  190. package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
  191. package/types/Renderer/index.d.ts +3 -0
  192. package/types/Renderer/index.d.ts.map +1 -0
  193. package/types/Types.d.ts +15 -9
  194. package/types/Types.d.ts.map +1 -0
  195. package/types/Utils.d.ts +1 -0
  196. package/types/Utils.d.ts.map +1 -0
  197. package/js/AgoraSdk.d.ts +0 -36
  198. package/js/Private/AgoraBase.d.ts +0 -4441
  199. package/js/Private/AgoraMediaBase.d.ts +0 -1124
  200. package/js/Private/AgoraMediaPlayerTypes.d.ts +0 -408
  201. package/js/Private/IAgoraLog.d.ts +0 -80
  202. package/js/Private/IAgoraMediaEngine.d.ts +0 -183
  203. package/js/Private/IAgoraMediaPlayer.d.ts +0 -532
  204. package/js/Private/IAgoraMediaPlayerSource.d.ts +0 -82
  205. package/js/Private/IAgoraMediaRecorder.d.ts +0 -28
  206. package/js/Private/IAgoraMediaStreamingSource.d.ts +0 -41
  207. package/js/Private/IAgoraMusicContentCenter.d.ts +0 -335
  208. package/js/Private/IAgoraRhythmPlayer.d.ts +0 -64
  209. package/js/Private/IAgoraRtcEngine.d.ts +0 -4947
  210. package/js/Private/IAgoraRtcEngineEx.d.ts +0 -553
  211. package/js/Private/IAgoraSpatialAudio.d.ts +0 -265
  212. package/js/Private/IAudioDeviceManager.d.ts +0 -254
  213. package/js/Private/extension/AgoraBaseExtension.d.ts +0 -1
  214. package/js/Private/extension/AgoraMediaBaseExtension.d.ts +0 -1
  215. package/js/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -1
  216. package/js/Private/extension/IAgoraLogExtension.d.ts +0 -1
  217. package/js/Private/extension/IAgoraMediaEngineExtension.d.ts +0 -40
  218. package/js/Private/extension/IAgoraMediaPlayerExtension.d.ts +0 -46
  219. package/js/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -1
  220. package/js/Private/extension/IAgoraMediaRecorderExtension.d.ts +0 -44
  221. package/js/Private/extension/IAgoraMusicContentCenterExtension.d.ts +0 -20
  222. package/js/Private/extension/IAgoraRhythmPlayerExtension.d.ts +0 -1
  223. package/js/Private/extension/IAgoraRtcEngineExExtension.d.ts +0 -1
  224. package/js/Private/extension/IAgoraRtcEngineExtension.d.ts +0 -42
  225. package/js/Private/extension/IAgoraSpatialAudioExtension.d.ts +0 -1
  226. package/js/Private/extension/IAudioDeviceManagerExtension.d.ts +0 -1
  227. package/js/Private/impl/AgoraBaseImpl.d.ts +0 -2
  228. package/js/Private/impl/AgoraMediaBaseImpl.d.ts +0 -8
  229. package/js/Private/impl/IAgoraMediaEngineImpl.d.ts +0 -39
  230. package/js/Private/impl/IAgoraMediaPlayerImpl.d.ts +0 -140
  231. package/js/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -2
  232. package/js/Private/impl/IAgoraMediaRecorderImpl.d.ts +0 -10
  233. package/js/Private/impl/IAgoraMusicContentCenterImpl.d.ts +0 -58
  234. package/js/Private/impl/IAgoraRtcEngineExImpl.d.ts +0 -105
  235. package/js/Private/impl/IAgoraRtcEngineImpl.d.ts +0 -570
  236. package/js/Private/impl/IAgoraSpatialAudioImpl.d.ts +0 -48
  237. package/js/Private/impl/IAudioDeviceManagerImpl.d.ts +0 -64
  238. package/js/Private/internal/AudioDeviceManagerInternal.d.ts +0 -8
  239. package/js/Private/internal/IrisApiEngine.d.ts +0 -147
  240. package/js/Private/internal/LocalSpatialAudioEngineInternal.d.ts +0 -18
  241. package/js/Private/internal/MediaEngineInternal.d.ts +0 -21
  242. package/js/Private/internal/MediaPlayerInternal.d.ts +0 -33
  243. package/js/Private/internal/MediaRecorderInternal.d.ts +0 -17
  244. package/js/Private/internal/MusicContentCenterInternal.d.ts +0 -39
  245. package/js/Private/internal/RtcEngineExInternal.d.ts +0 -80
  246. package/js/Private/ti/AgoraBase-ti.d.ts +0 -7
  247. package/js/Private/ti/AgoraMediaBase-ti.d.ts +0 -13
  248. package/js/Private/ti/AgoraMediaPlayerTypes-ti.d.ts +0 -6
  249. package/js/Private/ti/IAgoraLog-ti.d.ts +0 -6
  250. package/js/Private/ti/IAgoraMediaEngine-ti.d.ts +0 -6
  251. package/js/Private/ti/IAgoraMediaPlayer-ti.d.ts +0 -7
  252. package/js/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -7
  253. package/js/Private/ti/IAgoraMediaRecorder-ti.d.ts +0 -6
  254. package/js/Private/ti/IAgoraMediaStreamingSource-ti.d.ts +0 -6
  255. package/js/Private/ti/IAgoraMusicContentCenter-ti.d.ts +0 -7
  256. package/js/Private/ti/IAgoraRhythmPlayer-ti.d.ts +0 -6
  257. package/js/Private/ti/IAgoraRtcEngine-ti.d.ts +0 -9
  258. package/js/Private/ti/IAgoraRtcEngineEx-ti.d.ts +0 -6
  259. package/js/Private/ti/IAgoraSpatialAudio-ti.d.ts +0 -6
  260. package/js/Private/ti/IAudioDeviceManager-ti.d.ts +0 -6
  261. package/js/Renderer/AgoraView.d.ts +0 -69
  262. package/js/Renderer/GlRenderer/index.d.ts +0 -59
  263. package/js/Renderer/GlRenderer/webgl-utils.d.ts +0 -0
  264. package/js/Renderer/IRenderer.d.ts +0 -21
  265. package/js/Renderer/RendererManager.d.ts +0 -152
  266. package/js/Renderer/YUVCanvasRenderer/index.d.ts +0 -16
  267. package/js/Types.d.ts +0 -271
  268. package/js/Utils.d.ts +0 -58
  269. /package/js/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +0 -0
  270. /package/ts/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +0 -0
@@ -254,36 +254,364 @@ var PriorityType;
254
254
  * The statistics of the local video stream.
255
255
  */
256
256
  class LocalVideoStats {
257
+ /**
258
+ * The user ID of the local user.
259
+ */
260
+ uid;
261
+ /**
262
+ * The actual bitrate (Kbps) while sending the local video stream.This value does not include the bitrate for resending the video after packet loss.
263
+ */
264
+ sentBitrate;
265
+ /**
266
+ * The actual frame rate (fps) while sending the local video stream.This value does not include the frame rate for resending the video after packet loss.
267
+ */
268
+ sentFrameRate;
269
+ /**
270
+ * The frame rate (fps) for capturing the local video stream.
271
+ */
272
+ captureFrameRate;
273
+ /**
274
+ * The width (px) for capturing the local video stream.
275
+ */
276
+ captureFrameWidth;
277
+ /**
278
+ * The height (px) for capturing the local video stream.
279
+ */
280
+ captureFrameHeight;
281
+ /**
282
+ * The frame rate (fps) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the frame rate of the video captured by the camera according to the video encoding configuration.
283
+ */
284
+ regulatedCaptureFrameRate;
285
+ /**
286
+ * The width (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
287
+ */
288
+ regulatedCaptureFrameWidth;
289
+ /**
290
+ * The height (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
291
+ */
292
+ regulatedCaptureFrameHeight;
293
+ /**
294
+ * The output frame rate (fps) of the local video encoder.
295
+ */
296
+ encoderOutputFrameRate;
297
+ /**
298
+ * The width of the encoded video (px).
299
+ */
300
+ encodedFrameWidth;
301
+ /**
302
+ * The height of the encoded video (px).
303
+ */
304
+ encodedFrameHeight;
305
+ /**
306
+ * The output frame rate (fps) of the local video renderer.
307
+ */
308
+ rendererOutputFrameRate;
309
+ /**
310
+ * The target bitrate (Kbps) of the current encoder. This is an estimate made by the SDK based on the current network conditions.
311
+ */
312
+ targetBitrate;
313
+ /**
314
+ * The target frame rate (fps) of the current encoder.
315
+ */
316
+ targetFrameRate;
317
+ /**
318
+ * The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See QualityAdaptIndication .
319
+ */
320
+ qualityAdaptIndication;
321
+ /**
322
+ * The bitrate (Kbps) while encoding the local video stream.This value does not include the bitrate for resending the video after packet loss.
323
+ */
324
+ encodedBitrate;
325
+ /**
326
+ * The number of the sent video frames, represented by an aggregate value.
327
+ */
328
+ encodedFrameCount;
329
+ /**
330
+ * The codec type of the local video. See VideoCodecType .
331
+ */
332
+ codecType;
333
+ /**
334
+ * The video packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
335
+ */
336
+ txPacketLossRate;
337
+ /**
338
+ * @ignore
339
+ */
340
+ captureBrightnessLevel;
341
+ /**
342
+ * @ignore
343
+ */
344
+ dualStreamEnabled;
345
+ /**
346
+ * The local video encoding acceleration type.
347
+ */
348
+ hwEncoderAccelerating;
257
349
  }
258
350
  exports.LocalVideoStats = LocalVideoStats;
259
351
  /**
260
352
  * Audio statistics of the remote user.
261
353
  */
262
354
  class RemoteAudioStats {
355
+ /**
356
+ * The user ID of the remote user.
357
+ */
358
+ uid;
359
+ /**
360
+ * The quality of the audio stream sent by the user. See QualityType .
361
+ */
362
+ quality;
363
+ /**
364
+ * The network delay (ms) from the sender to the receiver.
365
+ */
366
+ networkTransportDelay;
367
+ /**
368
+ * The network delay (ms) from the audio receiver to the jitter buffer.When the receiving end is an audience member and audienceLatencyLevel of ClientRoleOptions is 1, this parameter does not take effect.
369
+ */
370
+ jitterBufferDelay;
371
+ /**
372
+ * The frame loss rate (%) of the remote audio stream in the reported interval.
373
+ */
374
+ audioLossRate;
375
+ /**
376
+ * The number of audio channels.
377
+ */
378
+ numChannels;
379
+ /**
380
+ * The sampling rate of the received audio stream in the reported interval.
381
+ */
382
+ receivedSampleRate;
383
+ /**
384
+ * The average bitrate (Kbps) of the received audio stream in the reported interval.
385
+ */
386
+ receivedBitrate;
387
+ /**
388
+ * The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%.
389
+ */
390
+ totalFrozenTime;
391
+ /**
392
+ * The total audio freeze time as a percentage (%) of the total time when the audio is available. The audio is considered available when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.
393
+ */
394
+ frozenRate;
395
+ /**
396
+ * The quality of the remote audio stream in the reported interval. The quality is determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the audio quality.The subjective perception of audio quality corresponding to the Agora real-time audio MOS scores is as follows:MOS scorePerception of audio qualityGreater than 4Excellent. The audio sounds clear and smooth.From 3.5 to 4Good. The audio has some perceptible impairment but still sounds clear.From 3 to 3.5Fair. The audio freezes occasionally and requires attentive listening.From 2.5 to 3Poor. The audio sounds choppy and requires considerable effort to understand.From 2 to 2.5Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty.Less than 2Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible.
397
+ */
398
+ mosValue;
399
+ /**
400
+ * @ignore
401
+ */
402
+ frozenRateByCustomPlcCount;
403
+ /**
404
+ * @ignore
405
+ */
406
+ plcCount;
407
+ /**
408
+ * The total active time (ms) between the start of the audio call and the callback of the remote user.The active time refers to the total duration of the remote user without the mute state.
409
+ */
410
+ totalActiveTime;
411
+ /**
412
+ * The total duration (ms) of the remote audio stream.
413
+ */
414
+ publishDuration;
415
+ /**
416
+ * The Quality of Experience (QoE) of the local user when receiving a remote audio stream. See ExperienceQualityType .
417
+ */
418
+ qoeQuality;
419
+ /**
420
+ * Reasons why the QoE of the local user when receiving a remote audio stream is poor. See ExperiencePoorReason .
421
+ */
422
+ qualityChangedReason;
423
+ /**
424
+ * @ignore
425
+ */
426
+ rxAudioBytes;
263
427
  }
264
428
  exports.RemoteAudioStats = RemoteAudioStats;
265
429
  /**
266
430
  * Statistics of the remote video stream.
267
431
  */
268
432
  class RemoteVideoStats {
433
+ /**
434
+ * The user ID of the remote user sending the video stream.
435
+ */
436
+ uid;
437
+ /**
438
+ * Deprecated:In scenarios where audio and video are synchronized, you can get the video delay data from networkTransportDelay and jitterBufferDelay in RemoteAudioStats .The video delay (ms).
439
+ */
440
+ delay;
441
+ /**
442
+ * @ignore
443
+ */
444
+ e2eDelay;
445
+ /**
446
+ * The width (pixels) of the video.
447
+ */
448
+ width;
449
+ /**
450
+ * The height (pixels) of the video.
451
+ */
452
+ height;
453
+ /**
454
+ * The bitrate (Kbps) of the remote video received since the last count.
455
+ */
456
+ receivedBitrate;
457
+ /**
458
+ * The frame rate (fps) of decoding the remote video.
459
+ */
460
+ decoderOutputFrameRate;
461
+ /**
462
+ * The frame rate (fps) of rendering the remote video.
463
+ */
464
+ rendererOutputFrameRate;
465
+ /**
466
+ * The packet loss rate (%) of the remote video.
467
+ */
468
+ frameLossRate;
469
+ /**
470
+ * The packet loss rate (%) of the remote video after using the anti-packet-loss technology.
471
+ */
472
+ packetLossRate;
473
+ /**
474
+ * The type of the video stream. See VideoStreamType .
475
+ */
476
+ rxStreamType;
477
+ /**
478
+ * The total freeze time (ms) of the remote video stream after the remote user joins the channel. In a video session where the frame rate is set to no less than 5 fps, video freeze occurs when the time interval between two adjacent renderable video frames is more than 500 ms.
479
+ */
480
+ totalFrozenTime;
481
+ /**
482
+ * The total video freeze time as a percentage (%) of the total time the video is available. The video is considered available as long as that the remote user neither stops sending the video stream nor disables the video module after joining the channel.
483
+ */
484
+ frozenRate;
485
+ /**
486
+ * The amount of time (ms) that the audio is ahead of the video.If this value is negative, the audio is lagging behind the video.
487
+ */
488
+ avSyncTimeMs;
489
+ /**
490
+ * The total active time (ms) of the video.As long as the remote user or host neither stops sending the video stream nor disables the video module after joining the channel, the video is available.
491
+ */
492
+ totalActiveTime;
493
+ /**
494
+ * The total duration (ms) of the remote video stream.
495
+ */
496
+ publishDuration;
497
+ /**
498
+ * @ignore
499
+ */
500
+ mosValue;
501
+ /**
502
+ * @ignore
503
+ */
504
+ rxVideoBytes;
269
505
  }
270
506
  exports.RemoteVideoStats = RemoteVideoStats;
271
507
  /**
272
508
  * @ignore
273
509
  */
274
510
  class Region {
511
+ /**
512
+ * @ignore
513
+ */
514
+ uid;
515
+ /**
516
+ * @ignore
517
+ */
518
+ x;
519
+ /**
520
+ * @ignore
521
+ */
522
+ y;
523
+ /**
524
+ * @ignore
525
+ */
526
+ width;
527
+ /**
528
+ * @ignore
529
+ */
530
+ height;
531
+ /**
532
+ * @ignore
533
+ */
534
+ zOrder;
535
+ /**
536
+ * @ignore
537
+ */
538
+ alpha;
539
+ /**
540
+ * @ignore
541
+ */
542
+ renderMode;
275
543
  }
276
544
  exports.Region = Region;
277
545
  /**
278
546
  * @ignore
279
547
  */
280
548
  class VideoCompositingLayout {
549
+ /**
550
+ * @ignore
551
+ */
552
+ canvasWidth;
553
+ /**
554
+ * @ignore
555
+ */
556
+ canvasHeight;
557
+ /**
558
+ * @ignore
559
+ */
560
+ backgroundColor;
561
+ /**
562
+ * @ignore
563
+ */
564
+ regions;
565
+ /**
566
+ * @ignore
567
+ */
568
+ regionCount;
569
+ /**
570
+ * @ignore
571
+ */
572
+ appData;
573
+ /**
574
+ * @ignore
575
+ */
576
+ appDataLength;
281
577
  }
282
578
  exports.VideoCompositingLayout = VideoCompositingLayout;
283
579
  /**
284
580
  * @ignore
285
581
  */
286
582
  class InjectStreamConfig {
583
+ /**
584
+ * @ignore
585
+ */
586
+ width;
587
+ /**
588
+ * @ignore
589
+ */
590
+ height;
591
+ /**
592
+ * @ignore
593
+ */
594
+ videoGop;
595
+ /**
596
+ * @ignore
597
+ */
598
+ videoFramerate;
599
+ /**
600
+ * @ignore
601
+ */
602
+ videoBitrate;
603
+ /**
604
+ * @ignore
605
+ */
606
+ audioSampleRate;
607
+ /**
608
+ * @ignore
609
+ */
610
+ audioBitrate;
611
+ /**
612
+ * @ignore
613
+ */
614
+ audioChannels;
287
615
  }
288
616
  exports.InjectStreamConfig = InjectStreamConfig;
289
617
  /**
@@ -305,6 +633,58 @@ var RtmpStreamLifeCycleType;
305
633
  * @ignore
306
634
  */
307
635
  class PublisherConfiguration {
636
+ /**
637
+ * @ignore
638
+ */
639
+ width;
640
+ /**
641
+ * @ignore
642
+ */
643
+ height;
644
+ /**
645
+ * @ignore
646
+ */
647
+ framerate;
648
+ /**
649
+ * @ignore
650
+ */
651
+ bitrate;
652
+ /**
653
+ * @ignore
654
+ */
655
+ defaultLayout;
656
+ /**
657
+ * @ignore
658
+ */
659
+ lifecycle;
660
+ /**
661
+ * @ignore
662
+ */
663
+ owner;
664
+ /**
665
+ * @ignore
666
+ */
667
+ injectStreamWidth;
668
+ /**
669
+ * @ignore
670
+ */
671
+ injectStreamHeight;
672
+ /**
673
+ * @ignore
674
+ */
675
+ injectStreamUrl;
676
+ /**
677
+ * @ignore
678
+ */
679
+ publishUrl;
680
+ /**
681
+ * @ignore
682
+ */
683
+ rawStreamUrl;
684
+ /**
685
+ * @ignore
686
+ */
687
+ extraInfo;
308
688
  }
309
689
  exports.PublisherConfiguration = PublisherConfiguration;
310
690
  /**
@@ -343,18 +723,66 @@ var CloudProxyType;
343
723
  * The camera capturer preference.
344
724
  */
345
725
  class CameraCapturerConfiguration {
726
+ /**
727
+ * @ignore
728
+ */
729
+ cameraDirection;
730
+ /**
731
+ * This method applies to Windows only.The ID of the camera. The maximum length is MaxDeviceIdLengthType .
732
+ */
733
+ deviceId;
734
+ /**
735
+ * The format of the video frame. See VideoFormat .
736
+ */
737
+ format;
738
+ /**
739
+ * Whether to follow the video aspect ratio set in setVideoEncoderConfiguration :true: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame .false: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
740
+ */
741
+ followEncodeDimensionRatio;
346
742
  }
347
743
  exports.CameraCapturerConfiguration = CameraCapturerConfiguration;
348
744
  /**
349
745
  * The configuration of the captured screen.
350
746
  */
351
747
  class ScreenCaptureConfiguration {
748
+ /**
749
+ * Whether to capture the window on the screen:true: Capture the window.false: (Default) Capture the screen, not the window.
750
+ */
751
+ isCaptureWindow;
752
+ /**
753
+ * (macOS only) The display ID of the screen.This parameter takes effect only when you want to capture the screen on macOS.
754
+ */
755
+ displayId;
756
+ /**
757
+ * (Windows only) The relative position of the shared screen to the virtual screen.This parameter takes effect only when you want to capture the screen on Windows.
758
+ */
759
+ screenRect;
760
+ /**
761
+ * (For Windows and macOS only) Window ID.This parameter takes effect only when you want to capture the window.
762
+ */
763
+ windowId;
764
+ /**
765
+ * (For Windows and macOS only) The screen capture configuration. See ScreenCaptureParameters .
766
+ */
767
+ params;
768
+ /**
769
+ * (For Windows and macOS only) The relative position of the shared region to the whole screen. See Rectangle .If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you setwidth or height in Rectangle as 0, the whole screen is shared.
770
+ */
771
+ regionRect;
352
772
  }
353
773
  exports.ScreenCaptureConfiguration = ScreenCaptureConfiguration;
354
774
  /**
355
775
  * @ignore
356
776
  */
357
777
  class Size {
778
+ /**
779
+ * @ignore
780
+ */
781
+ width;
782
+ /**
783
+ * @ignore
784
+ */
785
+ height;
358
786
  }
359
787
  exports.Size = Size;
360
788
  /**
@@ -362,6 +790,22 @@ exports.Size = Size;
362
790
  * The default image is in the ARGB format. If you need to use another format, you need to convert the image on your own.
363
791
  */
364
792
  class ThumbImageBuffer {
793
+ /**
794
+ * The buffer of the thumbnail or icon.
795
+ */
796
+ buffer;
797
+ /**
798
+ * The buffer length of the thumbnail or icon, in bytes.
799
+ */
800
+ length;
801
+ /**
802
+ * The actual width (px) of the thumbnail or icon.
803
+ */
804
+ width;
805
+ /**
806
+ * The actual height (px) of the thumbnail or icon.
807
+ */
808
+ height;
365
809
  }
366
810
  exports.ThumbImageBuffer = ThumbImageBuffer;
367
811
  /**
@@ -390,18 +834,82 @@ var ScreenCaptureSourceType;
390
834
  * The information about the specified shareable window or screen.
391
835
  */
392
836
  class ScreenCaptureSourceInfo {
837
+ /**
838
+ * The type of the shared target. See ScreenCaptureSourceType .
839
+ */
840
+ type;
841
+ /**
842
+ * The window ID for a window or the display ID for a screen.
843
+ */
844
+ sourceId;
845
+ /**
846
+ * The name of the window or screen. UTF-8 encoding.
847
+ */
848
+ sourceName;
849
+ /**
850
+ * The image content of the thumbnail. See ThumbImageBuffer
851
+ */
852
+ thumbImage;
853
+ /**
854
+ * The image content of the icon. See ThumbImageBuffer
855
+ */
856
+ iconImage;
857
+ /**
858
+ * The process to which the window belongs. UTF-8 encoding.
859
+ */
860
+ processPath;
861
+ /**
862
+ * The title of the window. UTF-8 encoding.
863
+ */
864
+ sourceTitle;
865
+ /**
866
+ * Determines whether the screen is the primary display:true: The screen is the primary display.false: The screen is not the primary display.
867
+ */
868
+ primaryMonitor;
869
+ /**
870
+ * @ignore
871
+ */
872
+ isOccluded;
873
+ /**
874
+ * @ignore
875
+ */
876
+ position;
877
+ /**
878
+ * (For Windows only) Whether the window is minimized:true: The window is minimized.false: The window is not minimized.
879
+ */
880
+ minimizeWindow;
881
+ /**
882
+ * @ignore
883
+ */
884
+ sourceDisplayId;
393
885
  }
394
886
  exports.ScreenCaptureSourceInfo = ScreenCaptureSourceInfo;
395
887
  /**
396
888
  * The advanced options for audio.
397
889
  */
398
890
  class AdvancedAudioOptions {
891
+ /**
892
+ * The number of channels for audio preprocessing. See AudioProcessingChannels .
893
+ */
894
+ audioProcessingChannels;
399
895
  }
400
896
  exports.AdvancedAudioOptions = AdvancedAudioOptions;
401
897
  /**
402
898
  * Image configurations
403
899
  */
404
900
  class ImageTrackOptions {
901
+ /**
902
+ * The URL of the image that you want to use to replace the video feeds. The image must be in PNG format. This method supports adding an image from the local absolute or relative file path.
903
+ */
904
+ imageUrl;
905
+ /**
906
+ * The frame rate of the video streams being published. The value range is [1,30]. The default value is 1.
907
+ */
908
+ fps;
909
+ /**
910
+ * @ignore
911
+ */
912
+ mirrorMode;
405
913
  }
406
914
  exports.ImageTrackOptions = ImageTrackOptions;
407
915
  /**
@@ -409,6 +917,128 @@ exports.ImageTrackOptions = ImageTrackOptions;
409
917
  * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection . For example, publishMicrophoneTrack, publishAudioTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true.
410
918
  */
411
919
  class ChannelMediaOptions {
920
+ /**
921
+ * Whether to publish the video captured by the camera:true: (Default) Publish the video captured by the camera.false: Do not publish the video captured by the camera.
922
+ */
923
+ publishCameraTrack;
924
+ /**
925
+ * @ignore
926
+ */
927
+ publishSecondaryCameraTrack;
928
+ /**
929
+ * Whether to publish the audio captured by the microphone:true: (Default) Publish the audio captured by the microphone.false: Do not publish the audio captured by the microphone.
930
+ */
931
+ publishMicrophoneTrack;
932
+ /**
933
+ * Whether to publish the video captured from the screen:true: Publish the video captured from the screen.false: (Default) Do not publish the video captured from the screen.This parameter applies to Android and iOS only.
934
+ */
935
+ publishScreenCaptureVideo;
936
+ /**
937
+ * @ignore
938
+ */
939
+ publishScreenCaptureAudio;
940
+ /**
941
+ * @ignore
942
+ */
943
+ publishScreenTrack;
944
+ /**
945
+ * Whether to publish the video captured from the second screen:true: Publish the video captured from the second screen.false: (Default) Do not publish the video captured from the second screen.
946
+ */
947
+ publishSecondaryScreenTrack;
948
+ /**
949
+ * Whether to publish the audio captured from a custom source:true: Publish the audio captured from the custom source.false: (Default) Do not publish the audio captured from the custom source.
950
+ */
951
+ publishCustomAudioTrack;
952
+ /**
953
+ * @ignore
954
+ */
955
+ publishCustomAudioTrackId;
956
+ /**
957
+ * Whether to publish the video captured from a custom source:true: Publish the video captured from the custom source.false: (Default) Do not publish the video captured from the custom source.
958
+ */
959
+ publishCustomVideoTrack;
960
+ /**
961
+ * Whether to publish the encoded video:true: Publish the encoded video.false: (Default) Do not publish the encoded video.
962
+ */
963
+ publishEncodedVideoTrack;
964
+ /**
965
+ * Whether to publish the audio from the media player:true: Publish the audio from the media player.false: (Default) Do not publish the audio from the media player.
966
+ */
967
+ publishMediaPlayerAudioTrack;
968
+ /**
969
+ * Whether to publish the video from the media player:true: Publish the video from the media player.false: (Default) Do not publish the video from the media player.
970
+ */
971
+ publishMediaPlayerVideoTrack;
972
+ /**
973
+ * @ignore
974
+ */
975
+ publishTranscodedVideoTrack;
976
+ /**
977
+ * Whether to automatically subscribe to all remote audio streams when the user joins a channel:true: (Default) Automatically subscribe to all remote audio streams.false: Do not automatically subscribe to any remote audio streams.
978
+ */
979
+ autoSubscribeAudio;
980
+ /**
981
+ * Whether to automatically subscribe to all remote video streams when the user joins the channel:true: (Default) Automatically subscribe to all remote video streams.false: Do not automatically subscribe to any remote video streams.
982
+ */
983
+ autoSubscribeVideo;
984
+ /**
985
+ * Whether to enable audio capturing or playback:true: (Default) Enable audio capturing or playback.false: Do not enable audio capturing or playback.
986
+ */
987
+ enableAudioRecordingOrPlayout;
988
+ /**
989
+ * The ID of the media player to be published. The default value is 0.
990
+ */
991
+ publishMediaPlayerId;
992
+ /**
993
+ * The user role. See ClientRoleType .
994
+ */
995
+ clientRoleType;
996
+ /**
997
+ * The latency level of an audience member in interactive live streaming. See AudienceLatencyLevelType .
998
+ *
999
+ */
1000
+ audienceLatencyLevel;
1001
+ /**
1002
+ * The default video-stream type. See VideoStreamType .
1003
+ *
1004
+ */
1005
+ defaultVideoStreamType;
1006
+ /**
1007
+ * The channel profile. See ChannelProfileType .
1008
+ */
1009
+ channelProfile;
1010
+ /**
1011
+ * @ignore
1012
+ */
1013
+ audioDelayMs;
1014
+ /**
1015
+ * @ignore
1016
+ */
1017
+ mediaPlayerAudioDelayMs;
1018
+ /**
1019
+ * (Optional) The token generated on your server for authentication. See This parameter takes effect only when calling updateChannelMediaOptions or updateChannelMediaOptionsEx .Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the initialize method for initializing the RTC engine, and those used by the joinChannel and joinChannelEx methods for joining the channel.
1020
+ */
1021
+ token;
1022
+ /**
1023
+ * @ignore
1024
+ */
1025
+ enableBuiltInMediaEncryption;
1026
+ /**
1027
+ * Whether to publish the sound of a metronome to remote users:true: (Default) Publish the sound of the metronome. Both the local user and remote users can hear the metronome.false: Do not publish the sound of the metronome. Only the local user can hear the metronome.
1028
+ */
1029
+ publishRhythmPlayerTrack;
1030
+ /**
1031
+ * Whether to enable interactive mode:true: Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.false: (Default) Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the joinChannelEx method to join the other host's channel as an audience member, and set isInteractiveAudience to true.This parameter takes effect only when the user role is ClientRoleAudience.
1032
+ */
1033
+ isInteractiveAudience;
1034
+ /**
1035
+ * The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
1036
+ */
1037
+ customVideoTrackId;
1038
+ /**
1039
+ * Whether the audio stream being published is filtered according to the volume algorithm:true: (Default) The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.false: The audio stream is not filtered.If you need to enable this function, contact .
1040
+ */
1041
+ isAudioFilterable;
412
1042
  }
413
1043
  exports.ChannelMediaOptions = ChannelMediaOptions;
414
1044
  /**
@@ -463,24 +1093,84 @@ var ProxyType;
463
1093
  * @ignore
464
1094
  */
465
1095
  class LogUploadServerInfo {
1096
+ /**
1097
+ * @ignore
1098
+ */
1099
+ serverDomain;
1100
+ /**
1101
+ * @ignore
1102
+ */
1103
+ serverPath;
1104
+ /**
1105
+ * @ignore
1106
+ */
1107
+ serverPort;
1108
+ /**
1109
+ * @ignore
1110
+ */
1111
+ serverHttps;
466
1112
  }
467
1113
  exports.LogUploadServerInfo = LogUploadServerInfo;
468
1114
  /**
469
1115
  * @ignore
470
1116
  */
471
1117
  class AdvancedConfigInfo {
1118
+ /**
1119
+ * @ignore
1120
+ */
1121
+ logUploadServer;
472
1122
  }
473
1123
  exports.AdvancedConfigInfo = AdvancedConfigInfo;
474
1124
  /**
475
1125
  * @ignore
476
1126
  */
477
1127
  class LocalAccessPointConfiguration {
1128
+ /**
1129
+ * @ignore
1130
+ */
1131
+ ipList;
1132
+ /**
1133
+ * @ignore
1134
+ */
1135
+ ipListSize;
1136
+ /**
1137
+ * @ignore
1138
+ */
1139
+ domainList;
1140
+ /**
1141
+ * @ignore
1142
+ */
1143
+ domainListSize;
1144
+ /**
1145
+ * @ignore
1146
+ */
1147
+ verifyDomainName;
1148
+ /**
1149
+ * @ignore
1150
+ */
1151
+ mode;
1152
+ /**
1153
+ * @ignore
1154
+ */
1155
+ advancedConfig;
478
1156
  }
479
1157
  exports.LocalAccessPointConfiguration = LocalAccessPointConfiguration;
480
1158
  /**
481
1159
  * The options for leaving a channel.
482
1160
  */
483
1161
  class LeaveChannelOptions {
1162
+ /**
1163
+ * Whether to stop playing and mixing the music file when a user leaves the channel. true: (Default) Stop playing and mixing the music file.false: Do not stop playing and mixing the music file.
1164
+ */
1165
+ stopAudioMixing;
1166
+ /**
1167
+ * Whether to stop playing all audio effects when a user leaves the channel. true: (Default) Stop playing all audio effects.false: Do not stop playing any audio effect.
1168
+ */
1169
+ stopAllEffect;
1170
+ /**
1171
+ * Whether to stop microphone recording when a user leaves the channel. true: (Default) Stop microphone recording.false: Do not stop microphone recording.
1172
+ */
1173
+ stopMicrophoneRecording;
484
1174
  }
485
1175
  exports.LeaveChannelOptions = LeaveChannelOptions;
486
1176
  /**
@@ -493,6 +1183,55 @@ exports.IVideoDeviceManager = IVideoDeviceManager;
493
1183
  * Configurations for the RtcEngineContext instance.
494
1184
  */
495
1185
  class RtcEngineContext {
1186
+ /**
1187
+ * The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one IRtcEngine instance. To change your App ID, call release to destroy the current IRtcEngine instance, and then create a new one.
1188
+ */
1189
+ appId;
1190
+ /**
1191
+ * The channel profile. See ChannelProfileType .
1192
+ */
1193
+ channelProfile;
1194
+ /**
1195
+ * @ignore
1196
+ */
1197
+ license;
1198
+ /**
1199
+ * The audio scenarios. See AudioScenarioType . Under different audio scenarios, the device uses different volume types.
1200
+ */
1201
+ audioScenario;
1202
+ /**
1203
+ * The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. The area codes support bitwise operation.
1204
+ */
1205
+ areaCode;
1206
+ /**
1207
+ * The SDK log files are: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, and agorasdk.4.log.
1208
+ * The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log.
1209
+ * The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
1210
+ * The SDK writes the latest logs in agorasdk.log or agoraapi.log.
1211
+ * When agorasdk.log is full, the SDK processes the log files in the following order:
1212
+ * Delete the agorasdk.4.log file (if any).
1213
+ * Rename agorasdk.3.log to agorasdk.4.log.
1214
+ * Rename agorasdk.2.log to agorasdk.3.log.
1215
+ * Rename agorasdk.1.log to agorasdk.2.log.
1216
+ * Create a new agorasdk.log file. The overwrite rules for the agoraapi.log file are the same as for agorasdk.log. Sets the log file size. See LogConfig .By default, the SDK generates five SDK log files and five API call log files with the following rules:
1217
+ */
1218
+ logConfig;
1219
+ /**
1220
+ * @ignore
1221
+ */
1222
+ threadPriority;
1223
+ /**
1224
+ * @ignore
1225
+ */
1226
+ useExternalEglContext;
1227
+ /**
1228
+ * Whether to enable domain name restriction:true: Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.false: (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
1229
+ */
1230
+ domainLimit;
1231
+ /**
1232
+ * @ignore
1233
+ */
1234
+ autoRegisterAgoraExtensions;
496
1235
  }
497
1236
  exports.RtcEngineContext = RtcEngineContext;
498
1237
  /**
@@ -531,6 +1270,22 @@ var MaxMetadataSizeType;
531
1270
  * Media metadata.
532
1271
  */
533
1272
  class Metadata {
1273
+ /**
1274
+ * The user ID.For the recipient:the ID of the remote user who sent the Metadata.Ignore it for sender.
1275
+ */
1276
+ uid;
1277
+ /**
1278
+ * Buffer size for received or sent Metadata.
1279
+ */
1280
+ size;
1281
+ /**
1282
+ * The buffer address of the received or sent Metadata.
1283
+ */
1284
+ buffer;
1285
+ /**
1286
+ * The timestamp (ms) of Metadata.
1287
+ */
1288
+ timeStampMs;
534
1289
  }
535
1290
  exports.Metadata = Metadata;
536
1291
  /**
@@ -593,18 +1348,82 @@ var DirectCdnStreamingState;
593
1348
  * The statistics of the current CDN streaming.
594
1349
  */
595
1350
  class DirectCdnStreamingStats {
1351
+ /**
1352
+ * The width (px) of the video frame.
1353
+ */
1354
+ videoWidth;
1355
+ /**
1356
+ * The height (px) of the video frame.
1357
+ */
1358
+ videoHeight;
1359
+ /**
1360
+ * The frame rate (fps) of the current video frame.
1361
+ */
1362
+ fps;
1363
+ /**
1364
+ * The bitrate (bps) of the current video frame.
1365
+ */
1366
+ videoBitrate;
1367
+ /**
1368
+ * The bitrate (bps) of the current audio frame.
1369
+ */
1370
+ audioBitrate;
596
1371
  }
597
1372
  exports.DirectCdnStreamingStats = DirectCdnStreamingStats;
598
1373
  /**
599
1374
  * The media setting options for the host.
600
1375
  */
601
1376
  class DirectCdnStreamingMediaOptions {
1377
+ /**
1378
+ * Sets whether to publish the video captured by the camera:true: Publish the video captured by the camera.false: (Default) Do not publish the video captured by the camera.
1379
+ */
1380
+ publishCameraTrack;
1381
+ /**
1382
+ * Sets whether to publish the audio captured by the microphone:true: Publish the audio captured by the microphone.false: (Default) Do not publish the audio captured by the microphone.
1383
+ */
1384
+ publishMicrophoneTrack;
1385
+ /**
1386
+ * Sets whether to publish the captured audio from a custom source:true: Publish the captured audio from a custom source.false: (Default) Do not publish the captured audio from the custom source.
1387
+ */
1388
+ publishCustomAudioTrack;
1389
+ /**
1390
+ * Sets whether to publish the captured video from a custom source:true: Publish the captured video from a custom source.false: (Default) Do not publish the captured video from the custom source.
1391
+ */
1392
+ publishCustomVideoTrack;
1393
+ /**
1394
+ * @ignore
1395
+ */
1396
+ publishMediaPlayerAudioTrack;
1397
+ /**
1398
+ * @ignore
1399
+ */
1400
+ publishMediaPlayerId;
1401
+ /**
1402
+ * The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
1403
+ */
1404
+ customVideoTrackId;
602
1405
  }
603
1406
  exports.DirectCdnStreamingMediaOptions = DirectCdnStreamingMediaOptions;
604
1407
  /**
605
1408
  * @ignore
606
1409
  */
607
1410
  class ExtensionInfo {
1411
+ /**
1412
+ * @ignore
1413
+ */
1414
+ mediaSourceType;
1415
+ /**
1416
+ * @ignore
1417
+ */
1418
+ remoteUid;
1419
+ /**
1420
+ * @ignore
1421
+ */
1422
+ channelId;
1423
+ /**
1424
+ * @ignore
1425
+ */
1426
+ localUid;
608
1427
  }
609
1428
  exports.ExtensionInfo = ExtensionInfo;
610
1429
  /**
@@ -948,17 +1767,41 @@ var VideoProfileType;
948
1767
  * SDK version information.
949
1768
  */
950
1769
  class SDKBuildInfo {
1770
+ /**
1771
+ * SDK build index.
1772
+ */
1773
+ build;
1774
+ /**
1775
+ * SDK version information. String format, such as 4.0.0.
1776
+ */
1777
+ version;
951
1778
  }
952
1779
  exports.SDKBuildInfo = SDKBuildInfo;
953
1780
  /**
954
1781
  * The VideoDeviceInfo class that contains the ID and device name of the video devices.
955
1782
  */
956
1783
  class VideoDeviceInfo {
1784
+ /**
1785
+ * The device ID.
1786
+ */
1787
+ deviceId;
1788
+ /**
1789
+ * The device name.
1790
+ */
1791
+ deviceName;
957
1792
  }
958
1793
  exports.VideoDeviceInfo = VideoDeviceInfo;
959
1794
  /**
960
1795
  * The AudioDeviceInfo class that contains the ID and device name of the audio devices.
961
1796
  */
962
1797
  class AudioDeviceInfo {
1798
+ /**
1799
+ * The device ID.
1800
+ */
1801
+ deviceId;
1802
+ /**
1803
+ * The device name.
1804
+ */
1805
+ deviceName;
963
1806
  }
964
1807
  exports.AudioDeviceInfo = AudioDeviceInfo;