agora-electron-sdk 4.5.2 → 4.5.3-dev.2

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 (411) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +6 -3
  3. package/js/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.js +395 -0
  4. package/js/{AgoraSdk.js → ts/AgoraSdk.js} +2 -12
  5. package/js/{Decoder → ts/Decoder}/index.js +1 -1
  6. package/js/{Private → ts/Private}/AgoraBase.js +829 -674
  7. package/js/{Private → ts/Private}/AgoraMediaBase.js +154 -151
  8. package/js/{Private → ts/Private}/AgoraMediaPlayerTypes.js +58 -54
  9. package/js/{Private → ts/Private}/IAgoraLog.js +13 -13
  10. package/js/{Private → ts/Private}/IAgoraMediaEngine.js +4 -4
  11. package/js/{Private → ts/Private}/IAgoraMediaPlayer.js +2 -2
  12. package/js/{Private → ts/Private}/IAgoraMusicContentCenter.js +1 -1
  13. package/js/{Private → ts/Private}/IAgoraRhythmPlayer.js +13 -13
  14. package/js/{Private → ts/Private}/IAgoraRtcEngine.js +150 -94
  15. package/js/{Private → ts/Private}/IAgoraRtcEngineEx.js +3 -3
  16. package/js/{Private → ts/Private}/IAgoraSpatialAudio.js +4 -4
  17. package/js/{Private → ts/Private}/IAudioDeviceManager.js +2 -2
  18. package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.js +10 -0
  19. package/js/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.js +74 -0
  20. package/js/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.js +233 -1
  21. package/js/{Private → ts/Private}/internal/IrisApiEngine.js +45 -0
  22. package/js/{Private → ts/Private}/internal/RtcEngineExInternal.js +74 -4
  23. package/js/ts/Private/internal/VideoEffectObjectInternal.js +14 -0
  24. package/js/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.js +2 -0
  25. package/js/{Renderer → ts/Renderer}/AgoraView.js +19 -2
  26. package/js/{Renderer → ts/Renderer}/IRenderer.js +7 -4
  27. package/js/{Renderer → ts/Renderer}/IRendererCache.js +17 -1
  28. package/js/ts/Renderer/RendererCache.js +252 -0
  29. package/js/{Renderer → ts/Renderer}/RendererManager.js +13 -64
  30. package/js/{Renderer → ts/Renderer}/WebCodecsRenderer/index.js +5 -5
  31. package/js/{Renderer → ts/Renderer}/WebCodecsRendererCache.js +13 -1
  32. package/js/{Renderer → ts/Renderer}/WebGLRenderer/index.js +179 -26
  33. package/js/{Renderer → ts/Renderer}/YUVCanvasRenderer/index.js +12 -5
  34. package/js/{Utils.js → ts/Utils.js} +7 -7
  35. package/package.json +25 -12
  36. package/scripts/checkElectron.js +4 -2
  37. package/scripts/download.js +102 -0
  38. package/scripts/downloadPrebuild.js +2 -1
  39. package/scripts/synclib.js +2 -2
  40. package/ts/AgoraSdk.ts +2 -12
  41. package/ts/Decoder/index.ts +5 -1
  42. package/ts/Private/AgoraBase.ts +1259 -1060
  43. package/ts/Private/AgoraMediaBase.ts +351 -324
  44. package/ts/Private/AgoraMediaPlayerTypes.ts +94 -91
  45. package/ts/Private/IAgoraLog.ts +20 -18
  46. package/ts/Private/IAgoraMediaEngine.ts +86 -81
  47. package/ts/Private/IAgoraMediaPlayer.ts +196 -181
  48. package/ts/Private/IAgoraMediaPlayerSource.ts +40 -40
  49. package/ts/Private/IAgoraMusicContentCenter.ts +3 -3
  50. package/ts/Private/IAgoraRhythmPlayer.ts +15 -15
  51. package/ts/Private/IAgoraRtcEngine.ts +2492 -2047
  52. package/ts/Private/IAgoraRtcEngineEx.ts +434 -335
  53. package/ts/Private/IAgoraSpatialAudio.ts +43 -45
  54. package/ts/Private/IAudioDeviceManager.ts +106 -97
  55. package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +12 -0
  56. package/ts/Private/impl/IAgoraRtcEngineExImpl.ts +138 -0
  57. package/ts/Private/impl/IAgoraRtcEngineImpl.ts +331 -0
  58. package/ts/Private/internal/IrisApiEngine.ts +47 -0
  59. package/ts/Private/internal/RtcEngineExInternal.ts +106 -9
  60. package/ts/Private/internal/VideoEffectObjectInternal.ts +14 -0
  61. package/ts/Private/ti/IAgoraRtcEngine-ti.ts +2 -0
  62. package/ts/Renderer/AgoraView.ts +32 -3
  63. package/ts/Renderer/IRenderer.ts +8 -3
  64. package/ts/Renderer/IRendererCache.ts +33 -0
  65. package/ts/Renderer/RendererCache.ts +211 -12
  66. package/ts/Renderer/RendererManager.ts +21 -99
  67. package/ts/Renderer/WebCodecsRenderer/index.ts +9 -6
  68. package/ts/Renderer/WebCodecsRendererCache.ts +17 -1
  69. package/ts/Renderer/WebGLRenderer/index.ts +246 -40
  70. package/ts/Renderer/YUVCanvasRenderer/index.ts +29 -16
  71. package/ts/Types.ts +14 -9
  72. package/ts/Utils.ts +8 -7
  73. package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts +168 -0
  74. package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts.map +1 -0
  75. package/types/{AgoraSdk.d.ts → ts/AgoraSdk.d.ts} +2 -12
  76. package/types/ts/AgoraSdk.d.ts.map +1 -0
  77. package/types/ts/Decoder/gpu-utils.d.ts.map +1 -0
  78. package/types/ts/Decoder/index.d.ts.map +1 -0
  79. package/types/ts/Private/AgoraBase.d.ts +5504 -0
  80. package/types/ts/Private/AgoraBase.d.ts.map +1 -0
  81. package/types/ts/Private/AgoraMediaBase.d.ts +1695 -0
  82. package/types/ts/Private/AgoraMediaBase.d.ts.map +1 -0
  83. package/types/ts/Private/AgoraMediaPlayerTypes.d.ts +456 -0
  84. package/types/ts/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
  85. package/types/ts/Private/IAgoraH265Transcoder.d.ts.map +1 -0
  86. package/types/ts/Private/IAgoraLog.d.ts +91 -0
  87. package/types/ts/Private/IAgoraLog.d.ts.map +1 -0
  88. package/types/ts/Private/IAgoraMediaEngine.d.ts +255 -0
  89. package/types/ts/Private/IAgoraMediaEngine.d.ts.map +1 -0
  90. package/types/ts/Private/IAgoraMediaPlayer.d.ts +662 -0
  91. package/types/ts/Private/IAgoraMediaPlayer.d.ts.map +1 -0
  92. package/types/ts/Private/IAgoraMediaPlayerSource.d.ts +109 -0
  93. package/types/ts/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
  94. package/types/ts/Private/IAgoraMediaRecorder.d.ts.map +1 -0
  95. package/types/ts/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
  96. package/types/{Private → ts/Private}/IAgoraMusicContentCenter.d.ts +3 -3
  97. package/types/ts/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
  98. package/types/ts/Private/IAgoraRhythmPlayer.d.ts +65 -0
  99. package/types/ts/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
  100. package/types/ts/Private/IAgoraRtcEngine.d.ts +6504 -0
  101. package/types/ts/Private/IAgoraRtcEngine.d.ts.map +1 -0
  102. package/types/ts/Private/IAgoraRtcEngineEx.d.ts +817 -0
  103. package/types/ts/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
  104. package/types/ts/Private/IAgoraSpatialAudio.d.ts +194 -0
  105. package/types/ts/Private/IAgoraSpatialAudio.d.ts.map +1 -0
  106. package/types/ts/Private/IAudioDeviceManager.d.ts +321 -0
  107. package/types/ts/Private/IAudioDeviceManager.d.ts.map +1 -0
  108. package/types/ts/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
  109. package/types/ts/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
  110. package/types/ts/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
  111. package/types/ts/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +1 -0
  112. package/types/ts/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
  113. package/types/ts/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
  114. package/types/ts/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
  115. package/types/ts/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
  116. package/types/ts/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
  117. package/types/ts/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
  118. package/types/ts/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
  119. package/types/ts/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
  120. package/types/ts/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
  121. package/types/ts/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
  122. package/types/ts/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
  123. package/types/ts/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
  124. package/types/ts/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
  125. package/types/ts/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +1 -0
  126. package/types/ts/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
  127. package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.d.ts +2 -0
  128. package/types/ts/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
  129. package/types/ts/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
  130. package/types/ts/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
  131. package/types/ts/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
  132. package/types/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.d.ts +7 -1
  133. package/types/ts/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
  134. package/types/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.d.ts +27 -1
  135. package/types/ts/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
  136. package/types/ts/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
  137. package/types/ts/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
  138. package/types/ts/Private/internal/AgoraH265TranscoderInternal.d.ts.map +1 -0
  139. package/types/ts/Private/internal/AgoraMediaBaseInternal.d.ts.map +1 -0
  140. package/types/ts/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
  141. package/types/ts/Private/internal/IrisApiEngine.d.ts.map +1 -0
  142. package/types/ts/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
  143. package/types/ts/Private/internal/MediaEngineInternal.d.ts.map +1 -0
  144. package/types/ts/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
  145. package/types/ts/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
  146. package/types/ts/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
  147. package/types/{Private → ts/Private}/internal/RtcEngineExInternal.d.ts +10 -4
  148. package/types/ts/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
  149. package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts +7 -0
  150. package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts.map +1 -0
  151. package/types/{Private → ts/Private}/ipc/main.d.ts.map +1 -1
  152. package/types/ts/Private/ipc/renderer.d.ts.map +1 -0
  153. package/types/ts/Private/ti/AgoraBase-ti.d.ts.map +1 -0
  154. package/types/ts/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
  155. package/types/ts/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
  156. package/types/ts/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +1 -0
  157. package/types/ts/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
  158. package/types/ts/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
  159. package/types/ts/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
  160. package/types/ts/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
  161. package/types/ts/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
  162. package/types/ts/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
  163. package/types/ts/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
  164. package/types/ts/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
  165. package/types/ts/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
  166. package/types/ts/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
  167. package/types/ts/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
  168. package/types/ts/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
  169. package/types/{Renderer → ts/Renderer}/AgoraView.d.ts +6 -0
  170. package/types/ts/Renderer/AgoraView.d.ts.map +1 -0
  171. package/types/ts/Renderer/CapabilityManager.d.ts.map +1 -0
  172. package/types/{Renderer → ts/Renderer}/IRenderer.d.ts +2 -2
  173. package/types/ts/Renderer/IRenderer.d.ts.map +1 -0
  174. package/types/{Renderer → ts/Renderer}/IRendererCache.d.ts +21 -1
  175. package/types/ts/Renderer/IRendererCache.d.ts.map +1 -0
  176. package/types/{Renderer → ts/Renderer}/RendererCache.d.ts +27 -0
  177. package/types/ts/Renderer/RendererCache.d.ts.map +1 -0
  178. package/types/{Renderer → ts/Renderer}/RendererManager.d.ts +4 -17
  179. package/types/ts/Renderer/RendererManager.d.ts.map +1 -0
  180. package/types/{Renderer → ts/Renderer}/WebCodecsRenderer/index.d.ts +3 -3
  181. package/types/ts/Renderer/WebCodecsRenderer/index.d.ts.map +1 -0
  182. package/types/{Renderer → ts/Renderer}/WebCodecsRendererCache.d.ts +7 -0
  183. package/types/ts/Renderer/WebCodecsRendererCache.d.ts.map +1 -0
  184. package/types/{Renderer → ts/Renderer}/WebGLRenderer/index.d.ts +12 -2
  185. package/types/ts/Renderer/WebGLRenderer/index.d.ts.map +1 -0
  186. package/types/ts/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
  187. package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts +10 -0
  188. package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
  189. package/types/ts/Renderer/index.d.ts.map +1 -0
  190. package/types/{Types.d.ts → ts/Types.d.ts} +11 -6
  191. package/types/ts/Types.d.ts.map +1 -0
  192. package/types/{Utils.d.ts → ts/Utils.d.ts} +1 -1
  193. package/types/ts/Utils.d.ts.map +1 -0
  194. package/js/Renderer/RendererCache.js +0 -100
  195. package/types/AgoraSdk.d.ts.map +0 -1
  196. package/types/Decoder/gpu-utils.d.ts.map +0 -1
  197. package/types/Decoder/index.d.ts.map +0 -1
  198. package/types/Private/AgoraBase.d.ts +0 -5310
  199. package/types/Private/AgoraBase.d.ts.map +0 -1
  200. package/types/Private/AgoraMediaBase.d.ts +0 -1668
  201. package/types/Private/AgoraMediaBase.d.ts.map +0 -1
  202. package/types/Private/AgoraMediaPlayerTypes.d.ts +0 -453
  203. package/types/Private/AgoraMediaPlayerTypes.d.ts.map +0 -1
  204. package/types/Private/IAgoraH265Transcoder.d.ts.map +0 -1
  205. package/types/Private/IAgoraLog.d.ts +0 -89
  206. package/types/Private/IAgoraLog.d.ts.map +0 -1
  207. package/types/Private/IAgoraMediaEngine.d.ts +0 -250
  208. package/types/Private/IAgoraMediaEngine.d.ts.map +0 -1
  209. package/types/Private/IAgoraMediaPlayer.d.ts +0 -648
  210. package/types/Private/IAgoraMediaPlayer.d.ts.map +0 -1
  211. package/types/Private/IAgoraMediaPlayerSource.d.ts +0 -109
  212. package/types/Private/IAgoraMediaPlayerSource.d.ts.map +0 -1
  213. package/types/Private/IAgoraMediaRecorder.d.ts.map +0 -1
  214. package/types/Private/IAgoraMediaStreamingSource.d.ts.map +0 -1
  215. package/types/Private/IAgoraMusicContentCenter.d.ts.map +0 -1
  216. package/types/Private/IAgoraRhythmPlayer.d.ts +0 -65
  217. package/types/Private/IAgoraRhythmPlayer.d.ts.map +0 -1
  218. package/types/Private/IAgoraRtcEngine.d.ts +0 -6103
  219. package/types/Private/IAgoraRtcEngine.d.ts.map +0 -1
  220. package/types/Private/IAgoraRtcEngineEx.d.ts +0 -741
  221. package/types/Private/IAgoraRtcEngineEx.d.ts.map +0 -1
  222. package/types/Private/IAgoraSpatialAudio.d.ts +0 -196
  223. package/types/Private/IAgoraSpatialAudio.d.ts.map +0 -1
  224. package/types/Private/IAudioDeviceManager.d.ts +0 -312
  225. package/types/Private/IAudioDeviceManager.d.ts.map +0 -1
  226. package/types/Private/extension/AgoraBaseExtension.d.ts.map +0 -1
  227. package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +0 -1
  228. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +0 -1
  229. package/types/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +0 -1
  230. package/types/Private/extension/IAgoraLogExtension.d.ts.map +0 -1
  231. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +0 -1
  232. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +0 -1
  233. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +0 -1
  234. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +0 -1
  235. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +0 -1
  236. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +0 -1
  237. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +0 -1
  238. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +0 -1
  239. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +0 -1
  240. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +0 -1
  241. package/types/Private/impl/AgoraBaseImpl.d.ts.map +0 -1
  242. package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +0 -1
  243. package/types/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +0 -1
  244. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +0 -1
  245. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +0 -1
  246. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +0 -1
  247. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +0 -1
  248. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +0 -1
  249. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +0 -1
  250. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +0 -1
  251. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +0 -1
  252. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +0 -1
  253. package/types/Private/internal/AgoraH265TranscoderInternal.d.ts.map +0 -1
  254. package/types/Private/internal/AgoraMediaBaseInternal.d.ts.map +0 -1
  255. package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +0 -1
  256. package/types/Private/internal/IrisApiEngine.d.ts.map +0 -1
  257. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +0 -1
  258. package/types/Private/internal/MediaEngineInternal.d.ts.map +0 -1
  259. package/types/Private/internal/MediaPlayerInternal.d.ts.map +0 -1
  260. package/types/Private/internal/MediaRecorderInternal.d.ts.map +0 -1
  261. package/types/Private/internal/MusicContentCenterInternal.d.ts.map +0 -1
  262. package/types/Private/internal/RtcEngineExInternal.d.ts.map +0 -1
  263. package/types/Private/ipc/renderer.d.ts.map +0 -1
  264. package/types/Private/ti/AgoraBase-ti.d.ts.map +0 -1
  265. package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +0 -1
  266. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +0 -1
  267. package/types/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +0 -1
  268. package/types/Private/ti/IAgoraLog-ti.d.ts.map +0 -1
  269. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +0 -1
  270. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +0 -1
  271. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +0 -1
  272. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +0 -1
  273. package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +0 -1
  274. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +0 -1
  275. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +0 -1
  276. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +0 -1
  277. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +0 -1
  278. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +0 -1
  279. package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +0 -1
  280. package/types/Renderer/AgoraView.d.ts.map +0 -1
  281. package/types/Renderer/CapabilityManager.d.ts.map +0 -1
  282. package/types/Renderer/IRenderer.d.ts.map +0 -1
  283. package/types/Renderer/IRendererCache.d.ts.map +0 -1
  284. package/types/Renderer/RendererCache.d.ts.map +0 -1
  285. package/types/Renderer/RendererManager.d.ts.map +0 -1
  286. package/types/Renderer/WebCodecsRenderer/index.d.ts.map +0 -1
  287. package/types/Renderer/WebCodecsRendererCache.d.ts.map +0 -1
  288. package/types/Renderer/WebGLRenderer/index.d.ts.map +0 -1
  289. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +0 -1
  290. package/types/Renderer/YUVCanvasRenderer/index.d.ts +0 -9
  291. package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +0 -1
  292. package/types/Renderer/index.d.ts.map +0 -1
  293. package/types/Types.d.ts.map +0 -1
  294. package/types/Utils.d.ts.map +0 -1
  295. /package/js/{Decoder → ts/Decoder}/gpu-utils.js +0 -0
  296. /package/js/{Private → ts/Private}/IAgoraH265Transcoder.js +0 -0
  297. /package/js/{Private → ts/Private}/IAgoraMediaPlayerSource.js +0 -0
  298. /package/js/{Private → ts/Private}/IAgoraMediaRecorder.js +0 -0
  299. /package/js/{Private → ts/Private}/IAgoraMediaStreamingSource.js +0 -0
  300. /package/js/{Private → ts/Private}/extension/AgoraBaseExtension.js +0 -0
  301. /package/js/{Private → ts/Private}/extension/AgoraMediaBaseExtension.js +0 -0
  302. /package/js/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.js +0 -0
  303. /package/js/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.js +0 -0
  304. /package/js/{Private → ts/Private}/extension/IAgoraLogExtension.js +0 -0
  305. /package/js/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.js +0 -0
  306. /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.js +0 -0
  307. /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.js +0 -0
  308. /package/js/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.js +0 -0
  309. /package/js/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.js +0 -0
  310. /package/js/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.js +0 -0
  311. /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.js +0 -0
  312. /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.js +0 -0
  313. /package/js/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.js +0 -0
  314. /package/js/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.js +0 -0
  315. /package/js/{Private → ts/Private}/impl/AgoraBaseImpl.js +0 -0
  316. /package/js/{Private → ts/Private}/impl/AgoraMediaBaseImpl.js +0 -0
  317. /package/js/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.js +0 -0
  318. /package/js/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.js +0 -0
  319. /package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.js +0 -0
  320. /package/js/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.js +0 -0
  321. /package/js/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.js +0 -0
  322. /package/js/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.js +0 -0
  323. /package/js/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.js +0 -0
  324. /package/js/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.js +0 -0
  325. /package/js/{Private → ts/Private}/internal/AgoraMediaBaseInternal.js +0 -0
  326. /package/js/{Private → ts/Private}/internal/AudioDeviceManagerInternal.js +0 -0
  327. /package/js/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.js +0 -0
  328. /package/js/{Private → ts/Private}/internal/MediaEngineInternal.js +0 -0
  329. /package/js/{Private → ts/Private}/internal/MediaPlayerInternal.js +0 -0
  330. /package/js/{Private → ts/Private}/internal/MediaRecorderInternal.js +0 -0
  331. /package/js/{Private → ts/Private}/internal/MusicContentCenterInternal.js +0 -0
  332. /package/js/{Private → ts/Private}/ipc/main.js +0 -0
  333. /package/js/{Private → ts/Private}/ipc/renderer.js +0 -0
  334. /package/js/{Private → ts/Private}/ti/AgoraBase-ti.js +0 -0
  335. /package/js/{Private → ts/Private}/ti/AgoraMediaBase-ti.js +0 -0
  336. /package/js/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.js +0 -0
  337. /package/js/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.js +0 -0
  338. /package/js/{Private → ts/Private}/ti/IAgoraLog-ti.js +0 -0
  339. /package/js/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.js +0 -0
  340. /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.js +0 -0
  341. /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.js +0 -0
  342. /package/js/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.js +0 -0
  343. /package/js/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.js +0 -0
  344. /package/js/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.js +0 -0
  345. /package/js/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.js +0 -0
  346. /package/js/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.js +0 -0
  347. /package/js/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.js +0 -0
  348. /package/js/{Private → ts/Private}/ti/IAudioDeviceManager-ti.js +0 -0
  349. /package/js/{Renderer → ts/Renderer}/CapabilityManager.js +0 -0
  350. /package/js/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.js +0 -0
  351. /package/js/{Renderer → ts/Renderer}/index.js +0 -0
  352. /package/js/{Types.js → ts/Types.js} +0 -0
  353. /package/types/{Decoder → ts/Decoder}/gpu-utils.d.ts +0 -0
  354. /package/types/{Decoder → ts/Decoder}/index.d.ts +0 -0
  355. /package/types/{Private → ts/Private}/IAgoraH265Transcoder.d.ts +0 -0
  356. /package/types/{Private → ts/Private}/IAgoraMediaRecorder.d.ts +0 -0
  357. /package/types/{Private → ts/Private}/IAgoraMediaStreamingSource.d.ts +0 -0
  358. /package/types/{Private → ts/Private}/extension/AgoraBaseExtension.d.ts +0 -0
  359. /package/types/{Private → ts/Private}/extension/AgoraMediaBaseExtension.d.ts +0 -0
  360. /package/types/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -0
  361. /package/types/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.d.ts +0 -0
  362. /package/types/{Private → ts/Private}/extension/IAgoraLogExtension.d.ts +0 -0
  363. /package/types/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.d.ts +0 -0
  364. /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.d.ts +0 -0
  365. /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -0
  366. /package/types/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.d.ts +0 -0
  367. /package/types/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.d.ts +0 -0
  368. /package/types/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.d.ts +0 -0
  369. /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.d.ts +0 -0
  370. /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.d.ts +0 -0
  371. /package/types/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.d.ts +0 -0
  372. /package/types/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.d.ts +0 -0
  373. /package/types/{Private → ts/Private}/impl/AgoraBaseImpl.d.ts +0 -0
  374. /package/types/{Private → ts/Private}/impl/AgoraMediaBaseImpl.d.ts +0 -0
  375. /package/types/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.d.ts +0 -0
  376. /package/types/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.d.ts +0 -0
  377. /package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -0
  378. /package/types/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.d.ts +0 -0
  379. /package/types/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.d.ts +0 -0
  380. /package/types/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.d.ts +0 -0
  381. /package/types/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.d.ts +0 -0
  382. /package/types/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.d.ts +0 -0
  383. /package/types/{Private → ts/Private}/internal/AgoraMediaBaseInternal.d.ts +0 -0
  384. /package/types/{Private → ts/Private}/internal/AudioDeviceManagerInternal.d.ts +0 -0
  385. /package/types/{Private → ts/Private}/internal/IrisApiEngine.d.ts +0 -0
  386. /package/types/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.d.ts +0 -0
  387. /package/types/{Private → ts/Private}/internal/MediaEngineInternal.d.ts +0 -0
  388. /package/types/{Private → ts/Private}/internal/MediaPlayerInternal.d.ts +0 -0
  389. /package/types/{Private → ts/Private}/internal/MediaRecorderInternal.d.ts +0 -0
  390. /package/types/{Private → ts/Private}/internal/MusicContentCenterInternal.d.ts +0 -0
  391. /package/types/{Private → ts/Private}/ipc/main.d.ts +0 -0
  392. /package/types/{Private → ts/Private}/ipc/renderer.d.ts +0 -0
  393. /package/types/{Private → ts/Private}/ti/AgoraBase-ti.d.ts +0 -0
  394. /package/types/{Private → ts/Private}/ti/AgoraMediaBase-ti.d.ts +0 -0
  395. /package/types/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.d.ts +0 -0
  396. /package/types/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.d.ts +0 -0
  397. /package/types/{Private → ts/Private}/ti/IAgoraLog-ti.d.ts +0 -0
  398. /package/types/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.d.ts +0 -0
  399. /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.d.ts +0 -0
  400. /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -0
  401. /package/types/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.d.ts +0 -0
  402. /package/types/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.d.ts +0 -0
  403. /package/types/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.d.ts +0 -0
  404. /package/types/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.d.ts +0 -0
  405. /package/types/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.d.ts +0 -0
  406. /package/types/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.d.ts +0 -0
  407. /package/types/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.d.ts +0 -0
  408. /package/types/{Private → ts/Private}/ti/IAudioDeviceManager-ti.d.ts +0 -0
  409. /package/types/{Renderer → ts/Renderer}/CapabilityManager.d.ts +0 -0
  410. /package/types/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.d.ts +0 -0
  411. /package/types/{Renderer → ts/Renderer}/index.d.ts +0 -0
@@ -1,29 +1,29 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.StreamLayerIndex = exports.SimulcastStreamConfig = exports.SimulcastStreamMode = exports.DataStreamConfig = exports.VideoEncoderConfiguration = exports.FocalLengthInfo = exports.CodecCapInfo = exports.CodecCapLevels = exports.CodecCapMask = exports.HdrCapability = exports.VideoModuleType = exports.CameraFormatType = exports.VideoMirrorModeType = exports.AdvanceOptions = exports.EncodingPreference = exports.CompressionPreference = exports.EncodedVideoFrameInfo = exports.MaxUserAccountLengthType = exports.VideoSubscriptionOptions = exports.VideoStreamType = exports.H264PacketizeMode = exports.AudioPcmDataInfo = exports.EncodedAudioFrameInfo = exports.EncodedAudioFrameAdvancedSettings = exports.WatermarkFitMode = exports.AudioEncodingType = exports.AudioCodecType = exports.SenderOptions = exports.TCcMode = exports.CameraFocalLengthType = exports.VideoCodecType = exports.VideoCodecCapabilityLevel = exports.ScreenCaptureFramerateCapability = exports.VideoDimensions = exports.DegradationPreference = exports.OrientationMode = exports.VideoFrameType = exports.FrameHeight = exports.FrameWidth = exports.FrameRate = exports.VideoOrientation = exports.FitModeType = exports.QualityType = exports.InterfaceIdType = exports.UserOfflineReasonType = exports.AudioSessionOperationRestriction = exports.LicenseErrorType = exports.ErrorCodeType = exports.WarnCodeType = exports.ChannelProfileType = void 0;
4
- exports.TranscodingVideoStream = exports.LiveTranscoding = exports.TranscodingUser = exports.ConnectionStateType = exports.LiveStreamAdvancedFeature = exports.RtcImage = exports.RtmpStreamingEvent = exports.RtmpStreamPublishReason = exports.RtmpStreamPublishState = exports.LocalAudioStats = exports.AudioCodecProfileType = exports.VideoCodecProfileType = exports.VideoCodecTypeForStream = exports.AudioSampleRateType = exports.Packet = exports.DeviceInfo = exports.AudioVolumeInfo = exports.RemoteVideoDownscaleLevel = exports.VideoTrackInfo = exports.RemoteUserState = exports.RemoteVideoStateReason = exports.RemoteVideoState = exports.RemoteAudioStateReason = exports.RemoteAudioState = exports.LocalVideoStreamReason = exports.LocalVideoStreamState = exports.LocalAudioStreamReason = exports.LocalAudioStreamState = exports.CameraStabilizationMode = exports.CaptureBrightnessLevelType = exports.VideoQoePreferenceType = exports.VideoApplicationScenarioType = exports.ScreenScenarioType = exports.VideoContentHint = exports.VideoFormat = exports.AudioScenarioType = exports.AudioProfileType = exports.AudioAinsMode = exports.ExperiencePoorReason = exports.ExperienceQualityType = exports.ClientRoleOptions = exports.AudienceLatencyLevelType = exports.QualityAdaptIndication = exports.ClientRoleType = exports.RtcStats = exports.WatermarkOptions = exports.WatermarkRatio = exports.Rectangle = exports.SimulcastConfig = exports.StreamLayerConfig = void 0;
5
- exports.AreaCodeEx = exports.AreaCode = exports.AudioEncodedFrameObserverConfig = exports.AudioRecordingConfiguration = exports.AudioEncodedFrameObserverPosition = exports.AudioFileRecordingType = exports.AudioRecordingQualityType = exports.ScreenCaptureParameters = exports.VoiceAiTunerType = exports.HeadphoneEqualizerPreset = exports.VoiceConversionPreset = exports.AudioEffectPreset = exports.VoiceBeautifierPreset = exports.AudioTrackConfig = exports.AudioTrackType = exports.SegmentationProperty = exports.SegModelType = exports.VirtualBackgroundSource = exports.BackgroundBlurDegree = exports.BackgroundSourceType = exports.ColorEnhanceOptions = exports.VideoDenoiserOptions = exports.VideoDenoiserLevel = exports.VideoDenoiserMode = exports.LowlightEnhanceOptions = exports.LowLightEnhanceLevel = exports.LowLightEnhanceMode = exports.FilterEffectOptions = exports.FaceShapeBeautyOptions = exports.FaceShapeBeautyStyle = exports.FaceShapeAreaOptions = exports.FaceShapeArea = exports.BeautyOptions = exports.LighteningContrastLevel = exports.VideoCanvas = exports.VideoViewSetupMode = exports.NetworkType = exports.WlAccStats = exports.WlaccSuggestAction = exports.WlaccMessageReason = exports.ClientRoleChangeFailedReason = exports.ConnectionChangedReasonType = exports.LastmileProbeResult = exports.LastmileProbeOneWayResult = exports.LastmileProbeResultState = exports.LastmileProbeConfig = exports.LocalAudioMixerConfiguration = exports.MixedAudioStream = exports.VideoTranscoderError = exports.LocalTranscoderConfiguration = void 0;
6
- exports.VideoLayout = exports.SpatialAudioParams = exports.RecorderStreamInfo = exports.RecorderStreamType = exports.LocalAccessPointConfiguration = exports.AdvancedConfigInfo = exports.LogUploadServerInfo = exports.LocalProxyMode = exports.ConfigFetchType = exports.VideoRenderingTracingInfo = exports.MediaTraceEvent = exports.ScreenCaptureParameters2 = exports.ScreenAudioParameters = exports.ScreenVideoParameters = exports.ThreadPriorityType = exports.EarMonitoringFilterType = exports.UserInfo = exports.EchoTestConfiguration = exports.StreamPublishState = exports.StreamSubscribeState = exports.PermissionType = exports.UploadErrorReason = exports.EncryptionErrorType = exports.EncryptionConfig = exports.EncryptionMode = exports.DownlinkNetworkInfo = exports.PeerDownlinkInfo = exports.UplinkNetworkInfo = exports.ChannelMediaRelayConfiguration = exports.ChannelMediaInfo = exports.ChannelMediaRelayState = exports.ChannelMediaRelayError = void 0;
4
+ exports.RtcImage = exports.RtmpStreamingEvent = exports.RtmpStreamPublishReason = exports.RtmpStreamPublishState = exports.LocalAudioStats = exports.AudioCodecProfileType = exports.VideoCodecProfileType = exports.VideoCodecTypeForStream = exports.AudioSampleRateType = exports.Packet = exports.DeviceInfo = exports.AudioVolumeInfo = exports.RemoteVideoDownscaleLevel = exports.VideoTrackInfo = exports.RemoteUserState = exports.RemoteVideoStateReason = exports.RemoteVideoState = exports.RemoteAudioStateReason = exports.RemoteAudioState = exports.LocalVideoStreamReason = exports.LocalVideoEventType = exports.LocalVideoStreamState = exports.LocalAudioStreamReason = exports.LocalAudioStreamState = exports.CameraStabilizationMode = exports.CaptureBrightnessLevelType = exports.VideoQoePreferenceType = exports.VideoApplicationScenarioType = exports.ScreenScenarioType = exports.VideoContentHint = exports.VideoFormat = exports.AudioScenarioType = exports.AudioProfileType = exports.AudioAinsMode = exports.ExperiencePoorReason = exports.ExperienceQualityType = exports.ClientRoleOptions = exports.AudienceLatencyLevelType = exports.QualityAdaptIndication = exports.ClientRoleType = exports.RtcStats = exports.MultipathStats = exports.PathStats = exports.MultipathType = exports.MultipathMode = exports.WatermarkOptions = exports.WatermarkRatio = exports.Rectangle = exports.SimulcastConfig = exports.StreamLayerConfig = void 0;
5
+ exports.AudioRecordingQualityType = exports.ScreenCaptureParameters = exports.ScreenAudioParameters = exports.VoiceAiTunerType = exports.HeadphoneEqualizerPreset = exports.VoiceConversionPreset = exports.AudioEffectPreset = exports.VoiceBeautifierPreset = exports.AudioTrackConfig = exports.AudioTrackType = exports.SegmentationProperty = exports.SegModelType = exports.VirtualBackgroundSource = exports.BackgroundBlurDegree = exports.BackgroundSourceType = exports.ColorEnhanceOptions = exports.VideoDenoiserOptions = exports.VideoDenoiserLevel = exports.VideoDenoiserMode = exports.LowlightEnhanceOptions = exports.LowLightEnhanceLevel = exports.LowLightEnhanceMode = exports.FilterEffectOptions = exports.FaceShapeBeautyOptions = exports.FaceShapeBeautyStyle = exports.FaceShapeAreaOptions = exports.FaceShapeArea = exports.BeautyOptions = exports.LighteningContrastLevel = exports.VideoCanvas = exports.VideoViewSetupMode = exports.NetworkType = exports.WlAccStats = exports.WlaccSuggestAction = exports.WlaccMessageReason = exports.ClientRoleChangeFailedReason = exports.ConnectionChangedReasonType = exports.LastmileProbeResult = exports.LastmileProbeOneWayResult = exports.LastmileProbeResultState = exports.LastmileProbeConfig = exports.LocalAudioMixerConfiguration = exports.MixedAudioStream = exports.VideoTranscoderError = exports.LocalTranscoderConfiguration = exports.TranscodingVideoStream = exports.LiveTranscoding = exports.TranscodingUser = exports.ConnectionStateType = exports.LiveStreamAdvancedFeature = void 0;
6
+ exports.VideoLayout = exports.SpatialAudioParams = exports.RecorderStreamInfo = exports.RecorderStreamType = exports.LocalAccessPointConfiguration = exports.AdvancedConfigInfo = exports.LogUploadServerInfo = exports.LocalProxyMode = exports.ConfigFetchType = exports.VideoRenderingTracingInfo = exports.MediaTraceEvent = exports.ScreenCaptureParameters2 = exports.ScreenVideoParameters = exports.ThreadPriorityType = exports.EarMonitoringFilterType = exports.UserInfo = exports.EchoTestConfiguration = exports.StreamPublishState = exports.StreamSubscribeState = exports.PermissionType = exports.UploadErrorReason = exports.EncryptionErrorType = exports.EncryptionConfig = exports.EncryptionMode = exports.DownlinkNetworkInfo = exports.PeerDownlinkInfo = exports.UplinkNetworkInfo = exports.ChannelMediaRelayConfiguration = exports.ChannelMediaInfo = exports.ChannelMediaRelayState = exports.ChannelMediaRelayError = exports.AreaCodeEx = exports.AreaCode = exports.AudioEncodedFrameObserverConfig = exports.AudioRecordingConfiguration = exports.AudioEncodedFrameObserverPosition = exports.AudioFileRecordingType = void 0;
7
7
  require("./extension/AgoraBaseExtension");
8
8
  /**
9
- * The channel profile.
9
+ * Channel scenarios.
10
10
  */
11
11
  var ChannelProfileType;
12
12
  (function (ChannelProfileType) {
13
13
  /**
14
- * 0: Communication. Use this profile when there are only two users in the channel.
14
+ * 0: Communication scenario. Agora recommends using the live broadcasting scenario for better audio and video experience.
15
15
  */
16
16
  ChannelProfileType[ChannelProfileType["ChannelProfileCommunication"] = 0] = "ChannelProfileCommunication";
17
17
  /**
18
- * 1: Live streaming. Live streaming. Use this profile when there are more than two users in the channel.
18
+ * 1: (Default) Live broadcasting scenario.
19
19
  */
20
20
  ChannelProfileType[ChannelProfileType["ChannelProfileLiveBroadcasting"] = 1] = "ChannelProfileLiveBroadcasting";
21
21
  /**
22
- * 2: Gaming. This profile is deprecated.
22
+ * 2: Gaming scenario. Deprecated: Use ChannelProfileLiveBroadcasting instead.
23
23
  */
24
24
  ChannelProfileType[ChannelProfileType["ChannelProfileGame"] = 2] = "ChannelProfileGame";
25
25
  /**
26
- * Cloud gaming. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users.
26
+ * 3: Interactive scenario. This scenario is optimized for latency. If your scenario involves frequent user interaction, it is recommended to use this one. Deprecated: Use ChannelProfileLiveBroadcasting instead.
27
27
  */
28
28
  ChannelProfileType[ChannelProfileType["ChannelProfileCloudGaming"] = 3] = "ChannelProfileCloudGaming";
29
29
  /**
@@ -132,6 +132,10 @@ var WarnCodeType;
132
132
  * @ignore
133
133
  */
134
134
  WarnCodeType[WarnCodeType["WarnAdmPlayoutAudioLowlevel"] = 1032] = "WarnAdmPlayoutAudioLowlevel";
135
+ /**
136
+ * @ignore
137
+ */
138
+ WarnCodeType[WarnCodeType["WarnAdmRecordIsOccupied"] = 1033] = "WarnAdmRecordIsOccupied";
135
139
  /**
136
140
  * @ignore
137
141
  */
@@ -168,7 +172,7 @@ var WarnCodeType;
168
172
  /**
169
173
  * Error codes.
170
174
  *
171
- * An error code indicates that the SDK encountered an unrecoverable error that requires application intervention. For example, an error is returned when the camera fails to open, and the app needs to inform the user that the camera cannot be used.
175
+ * Error codes indicate that the SDK has encountered an unrecoverable error and requires intervention from the application. For example, an error is returned when the camera fails to open, and the app needs to prompt the user that the camera cannot be used.
172
176
  */
173
177
  var ErrorCodeType;
174
178
  (function (ErrorCodeType) {
@@ -177,32 +181,30 @@ var ErrorCodeType;
177
181
  */
178
182
  ErrorCodeType[ErrorCodeType["ErrOk"] = 0] = "ErrOk";
179
183
  /**
180
- * 1: General error with no classified reason. Try calling the method again.
184
+ * 1: A general error (no specific classification of the error cause). Please try calling the method again.
181
185
  */
182
186
  ErrorCodeType[ErrorCodeType["ErrFailed"] = 1] = "ErrFailed";
183
187
  /**
184
- * 2: An invalid parameter is used. For example, the specified channel name includes illegal characters. Reset the parameter.
188
+ * 2: An invalid parameter was set in the method. For example, the specified channel name contains illegal characters. Please reset the parameter.
185
189
  */
186
190
  ErrorCodeType[ErrorCodeType["ErrInvalidArgument"] = 2] = "ErrInvalidArgument";
187
191
  /**
188
- * 3: The SDK is not ready. Possible reasons include the following:
189
- * The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
190
- * No user has joined the channel when the method is called. Check the code logic.
191
- * The user has not left the channel when the rate or complain method is called. Check the code logic.
192
- * The audio module is disabled.
193
- * The program is not complete.
192
+ * 3: The SDK is not ready. Possible reasons: IRtcEngine failed to initialize. Please reinitialize IRtcEngine.
193
+ * The user has not joined the channel when calling the method. Please check the method call logic.
194
+ * The user has not left the channel when calling the rate or complain method. Please check the method call logic.
195
+ * The audio module is not enabled.
196
+ * The assembly is incomplete.
194
197
  */
195
198
  ErrorCodeType[ErrorCodeType["ErrNotReady"] = 3] = "ErrNotReady";
196
199
  /**
197
- * 4: The IRtcEngine does not support the request. Possible reasons include the following:
198
- * The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
200
+ * 4: The current state of IRtcEngine does not support this operation. Possible reasons:
201
+ * When using built-in encryption, the encryption mode is incorrect, or loading the external encryption library failed. Please check whether the encryption enum value is correct or reload the external encryption library.
199
202
  */
200
203
  ErrorCodeType[ErrorCodeType["ErrNotSupported"] = 4] = "ErrNotSupported";
201
204
  /**
202
- * 5: The request is rejected. Possible reasons include the following:
203
- * The IRtcEngine initialization fails. Reinitialize the IRtcEngine.
204
- * The channel name is set as the empty string "" when joining the channel. Reset the channel name.
205
- * When the joinChannelEx method is called to join multiple channels, the specified channel name is already in use. Reset the channel name.
205
+ * 5: This method call was rejected. Possible reasons: IRtcEngine failed to initialize. Please reinitialize IRtcEngine.
206
+ * The channel name was set to an empty string "" when joining the channel. Please reset the channel name.
207
+ * In multi-channel scenarios, the channel name already exists when calling joinChannelEx to join a channel. Please reset the channel name.
206
208
  */
207
209
  ErrorCodeType[ErrorCodeType["ErrRefused"] = 5] = "ErrRefused";
208
210
  /**
@@ -210,19 +212,19 @@ var ErrorCodeType;
210
212
  */
211
213
  ErrorCodeType[ErrorCodeType["ErrBufferTooSmall"] = 6] = "ErrBufferTooSmall";
212
214
  /**
213
- * 7: A method is called before the initialization of IRtcEngine. Ensure that the IRtcEngine object is initialized before using this method.
215
+ * 7: The method was called before IRtcEngine was initialized. Please ensure that the IRtcEngine object is created and initialized before calling this method.
214
216
  */
215
217
  ErrorCodeType[ErrorCodeType["ErrNotInitialized"] = 7] = "ErrNotInitialized";
216
218
  /**
217
- * 8: Invalid state.
219
+ * 8: The current state is invalid.
218
220
  */
219
221
  ErrorCodeType[ErrorCodeType["ErrInvalidState"] = 8] = "ErrInvalidState";
220
222
  /**
221
- * 9: Permission to access is not granted. Check whether your app has access to the audio and video device.
223
+ * 9: No permission to operate. Please check whether the user has granted the app permission to use audio and video devices.
222
224
  */
223
225
  ErrorCodeType[ErrorCodeType["ErrNoPermission"] = 9] = "ErrNoPermission";
224
226
  /**
225
- * 10: A timeout occurs. Some API calls require the SDK to return the execution result. This error occurs if the SDK takes too long (more than 10 seconds) to return the result.
227
+ * 10: Method call timed out. Some method calls require a response from the SDK. If the SDK takes too long to process the event and does not return within 10 seconds, this error occurs.
226
228
  */
227
229
  ErrorCodeType[ErrorCodeType["ErrTimedout"] = 10] = "ErrTimedout";
228
230
  /**
@@ -242,61 +244,61 @@ var ErrorCodeType;
242
244
  */
243
245
  ErrorCodeType[ErrorCodeType["ErrNetDown"] = 14] = "ErrNetDown";
244
246
  /**
245
- * 17: The request to join the channel is rejected. Possible reasons include the following:
246
- * The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
247
- * After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
247
+ * 17: Joining the channel was rejected. Possible reasons:
248
+ * The user is already in the channel. It is recommended to determine whether the user is in the channel via the onConnectionStateChanged callback. Do not call this method again to join the channel unless receiving the ConnectionStateDisconnected (1) state.
249
+ * The user attempted to join the channel without calling stopEchoTest after initiating a call test with startEchoTest. After starting a call test, you must call stopEchoTest to end the current test before joining the channel.
248
250
  */
249
251
  ErrorCodeType[ErrorCodeType["ErrJoinChannelRejected"] = 17] = "ErrJoinChannelRejected";
250
252
  /**
251
- * 18: Fails to leave the channel. Possible reasons include the following:
252
- * The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error.
253
- * The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.
253
+ * 18: Failed to leave the channel. Possible reasons:
254
+ * The user has already left the channel before calling leaveChannel. Stop calling this method.
255
+ * The user called leaveChannel before joining the channel. No additional action is needed in this case.
254
256
  */
255
257
  ErrorCodeType[ErrorCodeType["ErrLeaveChannelRejected"] = 18] = "ErrLeaveChannelRejected";
256
258
  /**
257
- * 19: Resources are already in use.
259
+ * 19: The resource is already in use and cannot be reused.
258
260
  */
259
261
  ErrorCodeType[ErrorCodeType["ErrAlreadyInUse"] = 19] = "ErrAlreadyInUse";
260
262
  /**
261
- * 20: The request is abandoned by the SDK, possibly because the request has been sent too frequently.
263
+ * 20: The SDK aborted the request, possibly due to too many requests.
262
264
  */
263
265
  ErrorCodeType[ErrorCodeType["ErrAborted"] = 20] = "ErrAborted";
264
266
  /**
265
- * 21: The IRtcEngine fails to initialize and has crashed because of specific Windows firewall settings.
267
+ * 21: On Windows, specific firewall settings caused IRtcEngine to fail initialization and crash.
266
268
  */
267
269
  ErrorCodeType[ErrorCodeType["ErrInitNetEngine"] = 21] = "ErrInitNetEngine";
268
270
  /**
269
- * 22: The SDK fails to allocate resources because your app uses too many system resources or system resources are insufficient.
271
+ * 22: The SDK failed to allocate resources, possibly because the app is using too many resources or system resources are exhausted.
270
272
  */
271
273
  ErrorCodeType[ErrorCodeType["ErrResourceLimited"] = 22] = "ErrResourceLimited";
272
274
  /**
273
- * 101: The specified App ID is invalid. Rejoin the channel with a valid App ID.
275
+ * 101: Invalid App ID. Please use a valid App ID to rejoin the channel.
274
276
  */
275
277
  ErrorCodeType[ErrorCodeType["ErrInvalidAppId"] = 101] = "ErrInvalidAppId";
276
278
  /**
277
- * 102: The specified channel name is invalid. A possible reason is that the parameter's data type is incorrect. Rejoin the channel with a valid channel name.
279
+ * 102: Invalid channel name. Possible reason is an incorrect data type for the parameter. Please use a valid channel name to rejoin the channel.
278
280
  */
279
281
  ErrorCodeType[ErrorCodeType["ErrInvalidChannelName"] = 102] = "ErrInvalidChannelName";
280
282
  /**
281
- * 103: Fails to get server resources in the specified region. Try another region when initializing IRtcEngine.
283
+ * 103: Unable to obtain server resources in the current region. Try specifying another region when initializing IRtcEngine.
282
284
  */
283
285
  ErrorCodeType[ErrorCodeType["ErrNoServerResources"] = 103] = "ErrNoServerResources";
284
286
  /**
285
- * 109: The current token has expired. Apply for a new token on the server and call renewToken. Deprecated: This enumerator is deprecated. Use ConnectionChangedTokenExpired (9) in the onConnectionStateChanged callback instead.
287
+ * 109: The current Token has expired and is no longer valid. Please request a new Token from your server and call renewToken to update the Token. Deprecated: This enum is deprecated. Use the ConnectionChangedTokenExpired (9) in the onConnectionStateChanged callback instead.
286
288
  */
287
289
  ErrorCodeType[ErrorCodeType["ErrTokenExpired"] = 109] = "ErrTokenExpired";
288
290
  /**
289
- * 110: Invalid token. Typical reasons include the following:
290
- * App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.
291
- * The uid used to generate the token is not the same as the uid used to join the channel. Deprecated: This enumerator is deprecated. Use ConnectionChangedInvalidToken (8) in the onConnectionStateChanged callback instead.
291
+ * Deprecated: This enum is deprecated. Use the ConnectionChangedInvalidToken (8) in the onConnectionStateChanged callback instead. 110: Invalid Token. Common reasons:
292
+ * App certificate is enabled in the console, but App ID + Token authentication is not used. When the project has App certificate enabled, Token authentication must be used.
293
+ * The uid field used when generating the Token does not match the uid used when joining the channel.
292
294
  */
293
295
  ErrorCodeType[ErrorCodeType["ErrInvalidToken"] = 110] = "ErrInvalidToken";
294
296
  /**
295
- * 111: The network connection is interrupted. The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established.
297
+ * 111: Network connection interrupted. After the SDK establishes a connection with the server, it loses the network connection for more than 4 seconds.
296
298
  */
297
299
  ErrorCodeType[ErrorCodeType["ErrConnectionInterrupted"] = 111] = "ErrConnectionInterrupted";
298
300
  /**
299
- * 112: The network connection is lost. Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
301
+ * 112: Network connection lost. The network is disconnected and the SDK fails to reconnect to the server within 10 seconds.
300
302
  */
301
303
  ErrorCodeType[ErrorCodeType["ErrConnectionLost"] = 112] = "ErrConnectionLost";
302
304
  /**
@@ -304,43 +306,43 @@ var ErrorCodeType;
304
306
  */
305
307
  ErrorCodeType[ErrorCodeType["ErrNotInChannel"] = 113] = "ErrNotInChannel";
306
308
  /**
307
- * 114: The data size exceeds 1 KB when calling the sendStreamMessage method.
309
+ * 114: The data length exceeds 1 KB when calling sendStreamMessage.
308
310
  */
309
311
  ErrorCodeType[ErrorCodeType["ErrSizeTooLarge"] = 114] = "ErrSizeTooLarge";
310
312
  /**
311
- * 115: The data bitrate exceeds 6 KB/s when calling the sendStreamMessage method.
313
+ * 115: The data sending frequency exceeds the limit (6 KB/s) when calling sendStreamMessage.
312
314
  */
313
315
  ErrorCodeType[ErrorCodeType["ErrBitrateLimit"] = 115] = "ErrBitrateLimit";
314
316
  /**
315
- * 116: More than five data streams are created when calling the createDataStream method.
317
+ * 116: The number of data streams created exceeds the limit (5 streams) when calling createDataStream.
316
318
  */
317
319
  ErrorCodeType[ErrorCodeType["ErrTooManyDataStreams"] = 116] = "ErrTooManyDataStreams";
318
320
  /**
319
- * 117: The data stream transmission times out.
321
+ * 117: Data stream sending timed out.
320
322
  */
321
323
  ErrorCodeType[ErrorCodeType["ErrStreamMessageTimeout"] = 117] = "ErrStreamMessageTimeout";
322
324
  /**
323
- * 119: Switching roles fails, try rejoining the channel.
325
+ * 119: Failed to switch user role. Please try rejoining the channel.
324
326
  */
325
327
  ErrorCodeType[ErrorCodeType["ErrSetClientRoleNotAuthorized"] = 119] = "ErrSetClientRoleNotAuthorized";
326
328
  /**
327
- * 120: Media streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel.
329
+ * 120: Media stream decryption failed. Possibly due to an incorrect key used when the user joined the channel. Please check the key entered when joining the channel or guide the user to try rejoining the channel.
328
330
  */
329
331
  ErrorCodeType[ErrorCodeType["ErrDecryptionFailed"] = 120] = "ErrDecryptionFailed";
330
332
  /**
331
- * 121: The user ID is invalid.
333
+ * 121: Invalid user ID.
332
334
  */
333
335
  ErrorCodeType[ErrorCodeType["ErrInvalidUserId"] = 121] = "ErrInvalidUserId";
334
336
  /**
335
- * 122: Data streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel.
337
+ * 122: Data stream decryption failed. Possibly due to an incorrect key used when the user joined the channel. Please check the key entered when joining the channel or guide the user to try rejoining the channel.
336
338
  */
337
339
  ErrorCodeType[ErrorCodeType["ErrDatastreamDecryptionFailed"] = 122] = "ErrDatastreamDecryptionFailed";
338
340
  /**
339
- * 123: The user is banned from the server.
341
+ * 123: The user is banned by the server.
340
342
  */
341
343
  ErrorCodeType[ErrorCodeType["ErrClientIsBannedByServer"] = 123] = "ErrClientIsBannedByServer";
342
344
  /**
343
- * 130: The SDK does not support pushing encrypted streams to CDN.
345
+ * 130: The SDK does not support pushing encrypted streams to the CDN.
344
346
  */
345
347
  ErrorCodeType[ErrorCodeType["ErrEncryptedStreamNotAllowedPublish"] = 130] = "ErrEncryptedStreamNotAllowedPublish";
346
348
  /**
@@ -348,7 +350,7 @@ var ErrorCodeType;
348
350
  */
349
351
  ErrorCodeType[ErrorCodeType["ErrLicenseCredentialInvalid"] = 131] = "ErrLicenseCredentialInvalid";
350
352
  /**
351
- * 134: The user account is invalid, possibly because it contains invalid parameters.
353
+ * 134: Invalid user account, possibly due to invalid parameters.
352
354
  */
353
355
  ErrorCodeType[ErrorCodeType["ErrInvalidUserAccount"] = 134] = "ErrInvalidUserAccount";
354
356
  /**
@@ -356,7 +358,7 @@ var ErrorCodeType;
356
358
  */
357
359
  ErrorCodeType[ErrorCodeType["ErrModuleNotFound"] = 157] = "ErrModuleNotFound";
358
360
  /**
359
- * 1001: The SDK fails to load the media engine.
361
+ * 1001: Failed to load media engine.
360
362
  */
361
363
  ErrorCodeType[ErrorCodeType["ErrCertRaw"] = 157] = "ErrCertRaw";
362
364
  /**
@@ -404,11 +406,11 @@ var ErrorCodeType;
404
406
  */
405
407
  ErrorCodeType[ErrorCodeType["ErrCertRequest"] = 168] = "ErrCertRequest";
406
408
  /**
407
- * @ignore
409
+ * 200: Unsupported PCM format.
408
410
  */
409
411
  ErrorCodeType[ErrorCodeType["ErrPcmsendFormat"] = 200] = "ErrPcmsendFormat";
410
412
  /**
411
- * @ignore
413
+ * 201: Buffer overflow due to PCM sending rate being too fast.
412
414
  */
413
415
  ErrorCodeType[ErrorCodeType["ErrPcmsendBufferoverflow"] = 201] = "ErrPcmsendBufferoverflow";
414
416
  /**
@@ -420,35 +422,35 @@ var ErrorCodeType;
420
422
  */
421
423
  ErrorCodeType[ErrorCodeType["ErrLoadMediaEngine"] = 1001] = "ErrLoadMediaEngine";
422
424
  /**
423
- * 1005: A general error occurs (no specified reason). Check whether the audio device is already in use by another app, or try rejoining the channel.
425
+ * 1005: Audio device error (unspecified). Please check whether the audio device is occupied by another application or try rejoining the channel.
424
426
  */
425
427
  ErrorCodeType[ErrorCodeType["ErrAdmGeneralError"] = 1005] = "ErrAdmGeneralError";
426
428
  /**
427
- * 1008: An error occurs when initializing the playback device. Check whether the playback device is already in use by another app, or try rejoining the channel.
429
+ * 1008: Failed to initialize playback device. Please check whether the playback device is occupied by another application or try rejoining the channel.
428
430
  */
429
431
  ErrorCodeType[ErrorCodeType["ErrAdmInitPlayout"] = 1008] = "ErrAdmInitPlayout";
430
432
  /**
431
- * 1009: An error occurs when starting the playback device. Check the playback device.
433
+ * 1009: Failed to start playback device. Please check whether the playback device is functioning properly.
432
434
  */
433
435
  ErrorCodeType[ErrorCodeType["ErrAdmStartPlayout"] = 1009] = "ErrAdmStartPlayout";
434
436
  /**
435
- * 1010: An error occurs when stopping the playback device.
437
+ * 1010: Failed to stop playback device.
436
438
  */
437
439
  ErrorCodeType[ErrorCodeType["ErrAdmStopPlayout"] = 1010] = "ErrAdmStopPlayout";
438
440
  /**
439
- * 1011: An error occurs when initializing the recording device. Check the recording device, or try rejoining the channel.
441
+ * 1011: Failed to initialize recording device. Please check whether the recording device is functioning properly or try rejoining the channel.
440
442
  */
441
443
  ErrorCodeType[ErrorCodeType["ErrAdmInitRecording"] = 1011] = "ErrAdmInitRecording";
442
444
  /**
443
- * 1012: An error occurs when starting the recording device. Check the recording device.
445
+ * 1012: Failed to start recording device. Please check whether the recording device is functioning properly.
444
446
  */
445
447
  ErrorCodeType[ErrorCodeType["ErrAdmStartRecording"] = 1012] = "ErrAdmStartRecording";
446
448
  /**
447
- * 1013: An error occurs when stopping the recording device.
449
+ * 1013: Failed to stop recording device.
448
450
  */
449
451
  ErrorCodeType[ErrorCodeType["ErrAdmStopRecording"] = 1013] = "ErrAdmStopRecording";
450
452
  /**
451
- * 1501: Permission to access the camera is not granted. Check whether permission to access the camera permission is granted.
453
+ * 1501: No permission to use the camera. Please check whether camera permission is enabled.
452
454
  */
453
455
  ErrorCodeType[ErrorCodeType["ErrVdmCameraNotAuthorized"] = 1501] = "ErrVdmCameraNotAuthorized";
454
456
  })(ErrorCodeType = exports.ErrorCodeType || (exports.ErrorCodeType = {}));
@@ -483,60 +485,60 @@ var LicenseErrorType;
483
485
  LicenseErrorType[LicenseErrorType["LicenseErrInternal"] = 99] = "LicenseErrInternal";
484
486
  })(LicenseErrorType = exports.LicenseErrorType || (exports.LicenseErrorType = {}));
485
487
  /**
486
- * The operation permissions of the SDK on the audio session.
488
+ * SDK operation permissions for Audio Session.
487
489
  */
488
490
  var AudioSessionOperationRestriction;
489
491
  (function (AudioSessionOperationRestriction) {
490
492
  /**
491
- * No restriction, the SDK can change the audio session.
493
+ * 0: No restriction. The SDK can modify the Audio Session.
492
494
  */
493
495
  AudioSessionOperationRestriction[AudioSessionOperationRestriction["AudioSessionOperationRestrictionNone"] = 0] = "AudioSessionOperationRestrictionNone";
494
496
  /**
495
- * The SDK cannot change the audio session category.
497
+ * 1: The SDK cannot change the Audio Session category.
496
498
  */
497
499
  AudioSessionOperationRestriction[AudioSessionOperationRestriction["AudioSessionOperationRestrictionSetCategory"] = 1] = "AudioSessionOperationRestrictionSetCategory";
498
500
  /**
499
- * The SDK cannot change the audio session category, mode, or categoryOptions.
501
+ * 2: The SDK cannot change the Audio Session category, mode, or categoryOptions.
500
502
  */
501
503
  AudioSessionOperationRestriction[AudioSessionOperationRestriction["AudioSessionOperationRestrictionConfigureSession"] = 2] = "AudioSessionOperationRestrictionConfigureSession";
502
504
  /**
503
- * The SDK keeps the audio session active when the user leaves the channel, for example, to play an audio file in the background.
505
+ * 4: When leaving the channel, the SDK keeps the Audio Session active, for example, to play audio in the background.
504
506
  */
505
507
  AudioSessionOperationRestriction[AudioSessionOperationRestriction["AudioSessionOperationRestrictionDeactivateSession"] = 4] = "AudioSessionOperationRestrictionDeactivateSession";
506
508
  /**
507
- * Completely restricts the operation permissions of the SDK on the audio session; the SDK cannot change the audio session.
509
+ * 128: Completely restricts the SDK from operating on the Audio Session. The SDK can no longer make any changes to the Audio Session.
508
510
  */
509
511
  AudioSessionOperationRestriction[AudioSessionOperationRestriction["AudioSessionOperationRestrictionAll"] = 128] = "AudioSessionOperationRestrictionAll";
510
512
  })(AudioSessionOperationRestriction = exports.AudioSessionOperationRestriction || (exports.AudioSessionOperationRestriction = {}));
511
513
  /**
512
- * Reasons for a user being offline.
514
+ * Reason for user going offline.
513
515
  */
514
516
  var UserOfflineReasonType;
515
517
  (function (UserOfflineReasonType) {
516
518
  /**
517
- * 0: The user quits the call.
519
+ * 0: User left voluntarily.
518
520
  */
519
521
  UserOfflineReasonType[UserOfflineReasonType["UserOfflineQuit"] = 0] = "UserOfflineQuit";
520
522
  /**
521
- * 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
523
+ * 1: Timed out due to not receiving packets from the peer for a long time. Since the SDK uses an unreliable channel, it is also possible that the peer left the channel voluntarily, but the local side did not receive the leave message and mistakenly judged it as a timeout.
522
524
  */
523
525
  UserOfflineReasonType[UserOfflineReasonType["UserOfflineDropped"] = 1] = "UserOfflineDropped";
524
526
  /**
525
- * 2: The user switches the client role from the host to the audience.
527
+ * 2: User role changed from broadcaster to audience.
526
528
  */
527
529
  UserOfflineReasonType[UserOfflineReasonType["UserOfflineBecomeAudience"] = 2] = "UserOfflineBecomeAudience";
528
530
  })(UserOfflineReasonType = exports.UserOfflineReasonType || (exports.UserOfflineReasonType = {}));
529
531
  /**
530
- * The interface class.
532
+ * Interface classes.
531
533
  */
532
534
  var InterfaceIdType;
533
535
  (function (InterfaceIdType) {
534
536
  /**
535
- * 1: The IAudioDeviceManager interface class.
537
+ * 1: IAudioDeviceManager interface class.
536
538
  */
537
539
  InterfaceIdType[InterfaceIdType["AgoraIidAudioDeviceManager"] = 1] = "AgoraIidAudioDeviceManager";
538
540
  /**
539
- * 2: The IVideoDeviceManager interface class.
541
+ * 2: IVideoDeviceManager interface class.
540
542
  */
541
543
  InterfaceIdType[InterfaceIdType["AgoraIidVideoDeviceManager"] = 2] = "AgoraIidVideoDeviceManager";
542
544
  /**
@@ -544,7 +546,7 @@ var InterfaceIdType;
544
546
  */
545
547
  InterfaceIdType[InterfaceIdType["AgoraIidParameterEngine"] = 3] = "AgoraIidParameterEngine";
546
548
  /**
547
- * 4: The IMediaEngine interface class.
549
+ * 4: IMediaEngine interface class.
548
550
  */
549
551
  InterfaceIdType[InterfaceIdType["AgoraIidMediaEngine"] = 4] = "AgoraIidMediaEngine";
550
552
  /**
@@ -560,7 +562,7 @@ var InterfaceIdType;
560
562
  */
561
563
  InterfaceIdType[InterfaceIdType["AgoraIidRtcConnection"] = 7] = "AgoraIidRtcConnection";
562
564
  /**
563
- * @ignore
565
+ * 8: This interface class is deprecated.
564
566
  */
565
567
  InterfaceIdType[InterfaceIdType["AgoraIidSignalingEngine"] = 8] = "AgoraIidSignalingEngine";
566
568
  /**
@@ -568,7 +570,7 @@ var InterfaceIdType;
568
570
  */
569
571
  InterfaceIdType[InterfaceIdType["AgoraIidMediaEngineRegulator"] = 9] = "AgoraIidMediaEngineRegulator";
570
572
  /**
571
- * @ignore
573
+ * 11: ILocalSpatialAudioEngine interface class.
572
574
  */
573
575
  InterfaceIdType[InterfaceIdType["AgoraIidLocalSpatialAudio"] = 11] = "AgoraIidLocalSpatialAudio";
574
576
  /**
@@ -580,7 +582,7 @@ var InterfaceIdType;
580
582
  */
581
583
  InterfaceIdType[InterfaceIdType["AgoraIidMetaService"] = 14] = "AgoraIidMetaService";
582
584
  /**
583
- * @ignore
585
+ * 15: IMusicContentCenter interface class.
584
586
  */
585
587
  InterfaceIdType[InterfaceIdType["AgoraIidMusicContentCenter"] = 15] = "AgoraIidMusicContentCenter";
586
588
  /**
@@ -589,36 +591,36 @@ var InterfaceIdType;
589
591
  InterfaceIdType[InterfaceIdType["AgoraIidH265Transcoder"] = 16] = "AgoraIidH265Transcoder";
590
592
  })(InterfaceIdType = exports.InterfaceIdType || (exports.InterfaceIdType = {}));
591
593
  /**
592
- * Network quality types.
594
+ * Network quality.
593
595
  */
594
596
  var QualityType;
595
597
  (function (QualityType) {
596
598
  /**
597
- * 0: The network quality is unknown.
599
+ * 0: Network quality unknown.
598
600
  */
599
601
  QualityType[QualityType["QualityUnknown"] = 0] = "QualityUnknown";
600
602
  /**
601
- * 1: The network quality is excellent.
603
+ * 1: Excellent network quality.
602
604
  */
603
605
  QualityType[QualityType["QualityExcellent"] = 1] = "QualityExcellent";
604
606
  /**
605
- * 2: The network quality is quite good, but the bitrate may be slightly lower than excellent.
607
+ * 2: User perception is similar to excellent, but the bitrate may be slightly lower.
606
608
  */
607
609
  QualityType[QualityType["QualityGood"] = 2] = "QualityGood";
608
610
  /**
609
- * 3: Users can feel the communication is slightly impaired.
611
+ * 3: Slight flaws in user experience but communication is not affected.
610
612
  */
611
613
  QualityType[QualityType["QualityPoor"] = 3] = "QualityPoor";
612
614
  /**
613
- * 4: Users cannot communicate smoothly.
615
+ * 4: Barely able to communicate, but not smoothly.
614
616
  */
615
617
  QualityType[QualityType["QualityBad"] = 4] = "QualityBad";
616
618
  /**
617
- * 5: The quality is so bad that users can barely communicate.
619
+ * 5: Very poor network quality, communication is nearly impossible.
618
620
  */
619
621
  QualityType[QualityType["QualityVbad"] = 5] = "QualityVbad";
620
622
  /**
621
- * 6: The network is down and users cannot communicate at all.
623
+ * 6: Completely unable to communicate.
622
624
  */
623
625
  QualityType[QualityType["QualityDown"] = 6] = "QualityDown";
624
626
  /**
@@ -626,7 +628,7 @@ var QualityType;
626
628
  */
627
629
  QualityType[QualityType["QualityUnsupported"] = 7] = "QualityUnsupported";
628
630
  /**
629
- * 8: The last-mile network probe test is in progress.
631
+ * 8: Network quality detection in progress.
630
632
  */
631
633
  QualityType[QualityType["QualityDetecting"] = 8] = "QualityDetecting";
632
634
  })(QualityType = exports.QualityType || (exports.QualityType = {}));
@@ -645,58 +647,58 @@ var FitModeType;
645
647
  FitModeType[FitModeType["ModeContain"] = 2] = "ModeContain";
646
648
  })(FitModeType = exports.FitModeType || (exports.FitModeType = {}));
647
649
  /**
648
- * The clockwise rotation of the video.
650
+ * Clockwise video rotation information.
649
651
  */
650
652
  var VideoOrientation;
651
653
  (function (VideoOrientation) {
652
654
  /**
653
- * 0: (Default) No rotation.
655
+ * 0: (Default) Rotates clockwise by 0 degrees.
654
656
  */
655
657
  VideoOrientation[VideoOrientation["VideoOrientation0"] = 0] = "VideoOrientation0";
656
658
  /**
657
- * 90: 90 degrees.
659
+ * 90: Rotates clockwise by 90 degrees.
658
660
  */
659
661
  VideoOrientation[VideoOrientation["VideoOrientation90"] = 90] = "VideoOrientation90";
660
662
  /**
661
- * 180: 180 degrees.
663
+ * 180: Rotates clockwise by 180 degrees.
662
664
  */
663
665
  VideoOrientation[VideoOrientation["VideoOrientation180"] = 180] = "VideoOrientation180";
664
666
  /**
665
- * 270: 270 degrees.
667
+ * 270: Rotates clockwise by 270 degrees.
666
668
  */
667
669
  VideoOrientation[VideoOrientation["VideoOrientation270"] = 270] = "VideoOrientation270";
668
670
  })(VideoOrientation = exports.VideoOrientation || (exports.VideoOrientation = {}));
669
671
  /**
670
- * The video frame rate.
672
+ * Video frame rate.
671
673
  */
672
674
  var FrameRate;
673
675
  (function (FrameRate) {
674
676
  /**
675
- * 1: 1 fps
677
+ * 1: 1 fps.
676
678
  */
677
679
  FrameRate[FrameRate["FrameRateFps1"] = 1] = "FrameRateFps1";
678
680
  /**
679
- * 7: 7 fps
681
+ * 7: 7 fps.
680
682
  */
681
683
  FrameRate[FrameRate["FrameRateFps7"] = 7] = "FrameRateFps7";
682
684
  /**
683
- * 10: 10 fps
685
+ * 10: 10 fps.
684
686
  */
685
687
  FrameRate[FrameRate["FrameRateFps10"] = 10] = "FrameRateFps10";
686
688
  /**
687
- * 15: 15 fps
689
+ * 15: 15 fps.
688
690
  */
689
691
  FrameRate[FrameRate["FrameRateFps15"] = 15] = "FrameRateFps15";
690
692
  /**
691
- * 24: 24 fps
693
+ * 24: 24 fps.
692
694
  */
693
695
  FrameRate[FrameRate["FrameRateFps24"] = 24] = "FrameRateFps24";
694
696
  /**
695
- * 30: 30 fps
697
+ * 30: 30 fps.
696
698
  */
697
699
  FrameRate[FrameRate["FrameRateFps30"] = 30] = "FrameRateFps30";
698
700
  /**
699
- * 60: 60 fps
701
+ * 60: 60 fps.
700
702
  */
701
703
  FrameRate[FrameRate["FrameRateFps60"] = 60] = "FrameRateFps60";
702
704
  })(FrameRate = exports.FrameRate || (exports.FrameRate = {}));
@@ -721,12 +723,12 @@ var FrameHeight;
721
723
  FrameHeight[FrameHeight["FrameHeight540"] = 540] = "FrameHeight540";
722
724
  })(FrameHeight = exports.FrameHeight || (exports.FrameHeight = {}));
723
725
  /**
724
- * The video frame type.
726
+ * Video frame type.
725
727
  */
726
728
  var VideoFrameType;
727
729
  (function (VideoFrameType) {
728
730
  /**
729
- * 0: A black frame.
731
+ * 0: Black frame.
730
732
  */
731
733
  VideoFrameType[VideoFrameType["VideoFrameTypeBlankFrame"] = 0] = "VideoFrameTypeBlankFrame";
732
734
  /**
@@ -738,11 +740,11 @@ var VideoFrameType;
738
740
  */
739
741
  VideoFrameType[VideoFrameType["VideoFrameTypeDeltaFrame"] = 4] = "VideoFrameTypeDeltaFrame";
740
742
  /**
741
- * 5: The B frame.
743
+ * 5: B frame.
742
744
  */
743
745
  VideoFrameType[VideoFrameType["VideoFrameTypeBFrame"] = 5] = "VideoFrameTypeBFrame";
744
746
  /**
745
- * 6: A discarded frame.
747
+ * 6: Droppable frame.
746
748
  */
747
749
  VideoFrameType[VideoFrameType["VideoFrameTypeDroppableFrame"] = 6] = "VideoFrameTypeDroppableFrame";
748
750
  /**
@@ -751,14 +753,14 @@ var VideoFrameType;
751
753
  VideoFrameType[VideoFrameType["VideoFrameTypeUnknow"] = 7] = "VideoFrameTypeUnknow";
752
754
  })(VideoFrameType = exports.VideoFrameType || (exports.VideoFrameType = {}));
753
755
  /**
754
- * Video output orientation mode.
756
+ * Orientation mode for video encoding.
755
757
  */
756
758
  var OrientationMode;
757
759
  (function (OrientationMode) {
758
760
  /**
759
- * 0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver.
760
- * If the captured video is in landscape mode, the output video is in landscape mode.
761
- * If the captured video is in portrait mode, the output video is in portrait mode.
761
+ * 0: (Default) In this mode, the SDK outputs video in the same orientation as the captured video. The receiver rotates the video according to the rotation information. This mode is suitable when the receiver can adjust the video orientation.
762
+ * If the captured video is in landscape mode, the output video is also in landscape mode.
763
+ * If the captured video is in portrait mode, the output video is also in portrait mode.
762
764
  */
763
765
  OrientationMode[OrientationMode["OrientationModeAdaptive"] = 0] = "OrientationModeAdaptive";
764
766
  /**
@@ -771,28 +773,28 @@ var OrientationMode;
771
773
  OrientationMode[OrientationMode["OrientationModeFixedPortrait"] = 2] = "OrientationModeFixedPortrait";
772
774
  })(OrientationMode = exports.OrientationMode || (exports.OrientationMode = {}));
773
775
  /**
774
- * Video degradation preferences when the bandwidth is a constraint.
776
+ * Video encoding degradation preference when bandwidth is limited.
775
777
  */
776
778
  var DegradationPreference;
777
779
  (function (DegradationPreference) {
778
780
  /**
779
- * 0: (Default) Automatic mode. The SDK will automatically select MaintainFramerate, MaintainBalanced or MaintainResolution based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
781
+ * -1: (Default) Auto mode. The SDK automatically selects MaintainFramerate, MaintainBalanced, or MaintainResolution based on the video scenario you set, to achieve the best overall quality of experience (QoE).
780
782
  */
781
783
  DegradationPreference[DegradationPreference["MaintainAuto"] = -1] = "MaintainAuto";
782
784
  /**
783
- * 0: Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized. Deprecated: This enumerator is deprecated. Use other enumerations instead.
785
+ * 0: When bandwidth is limited, the SDK prioritizes reducing frame rate while maintaining resolution during video encoding. This preference is suitable for scenarios where video quality is prioritized. Deprecated: This enum is deprecated. Use other enums instead.
784
786
  */
785
787
  DegradationPreference[DegradationPreference["MaintainQuality"] = 0] = "MaintainQuality";
786
788
  /**
787
- * 1: Reduces the video resolution while maintaining the video frame rate during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where smoothness is prioritized and video quality is allowed to be reduced.
789
+ * 1: When bandwidth is limited, the SDK prioritizes reducing resolution while maintaining frame rate during video encoding. This preference is suitable for scenarios where smoothness is prioritized and some quality degradation is acceptable.
788
790
  */
789
791
  DegradationPreference[DegradationPreference["MaintainFramerate"] = 1] = "MaintainFramerate";
790
792
  /**
791
- * 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The MaintainBalanced has a lower reduction than MaintainQuality and MaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority. The resolution of the video sent may change, so remote users need to handle this issue. See onVideoSizeChanged.
793
+ * 2: When bandwidth is limited, the SDK reduces both frame rate and resolution during video encoding. The degradation is less severe than MaintainQuality and MaintainFramerate, and is suitable for scenarios where both smoothness and quality are moderately important. The resolution of locally sent video may change. Remote users must be able to handle this. See onVideoSizeChanged.
792
794
  */
793
795
  DegradationPreference[DegradationPreference["MaintainBalanced"] = 2] = "MaintainBalanced";
794
796
  /**
795
- * 3: Reduces the video frame rate while maintaining the video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized.
797
+ * 3: When bandwidth is limited, the SDK prioritizes reducing frame rate while maintaining resolution during video encoding. This preference is suitable for scenarios where video quality is prioritized.
796
798
  */
797
799
  DegradationPreference[DegradationPreference["MaintainResolution"] = 3] = "MaintainResolution";
798
800
  /**
@@ -801,7 +803,7 @@ var DegradationPreference;
801
803
  DegradationPreference[DegradationPreference["Disabled"] = 100] = "Disabled";
802
804
  })(DegradationPreference = exports.DegradationPreference || (exports.DegradationPreference = {}));
803
805
  /**
804
- * The video dimension.
806
+ * Video dimensions.
805
807
  */
806
808
  class VideoDimensions {
807
809
  }
@@ -851,12 +853,12 @@ var VideoCodecCapabilityLevel;
851
853
  VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevel4k60fps"] = 30] = "CodecCapabilityLevel4k60fps";
852
854
  })(VideoCodecCapabilityLevel = exports.VideoCodecCapabilityLevel || (exports.VideoCodecCapabilityLevel = {}));
853
855
  /**
854
- * Video codec types.
856
+ * Video codec format.
855
857
  */
856
858
  var VideoCodecType;
857
859
  (function (VideoCodecType) {
858
860
  /**
859
- * 0: (Default) Unspecified codec format. The SDK automatically matches the appropriate codec format based on the current video stream's resolution and device performance.
861
+ * 0: (Default) No specific codec format. The SDK automatically selects a suitable codec format based on the resolution of the current video stream and device performance.
860
862
  */
861
863
  VideoCodecType[VideoCodecType["VideoCodecNone"] = 0] = "VideoCodecNone";
862
864
  /**
@@ -872,7 +874,7 @@ var VideoCodecType;
872
874
  */
873
875
  VideoCodecType[VideoCodecType["VideoCodecH265"] = 3] = "VideoCodecH265";
874
876
  /**
875
- * 6: Generic. This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
877
+ * 6: Generic. This type is mainly used for transmitting raw video data (such as user-encrypted video frames). The video frames of this type are returned to the user via callback, and you need to decode and render them yourself.
876
878
  */
877
879
  VideoCodecType[VideoCodecType["VideoCodecGeneric"] = 6] = "VideoCodecGeneric";
878
880
  /**
@@ -888,7 +890,7 @@ var VideoCodecType;
888
890
  */
889
891
  VideoCodecType[VideoCodecType["VideoCodecVp9"] = 13] = "VideoCodecVp9";
890
892
  /**
891
- * 20: Generic JPEG. This type consumes minimum computing resources and applies to IoT devices.
893
+ * 20: Generic JPEG. This type requires less computing power and can be used on IoT devices with limited capabilities.
892
894
  */
893
895
  VideoCodecType[VideoCodecType["VideoCodecGenericJpeg"] = 20] = "VideoCodecGenericJpeg";
894
896
  })(VideoCodecType = exports.VideoCodecType || (exports.VideoCodecType = {}));
@@ -935,7 +937,7 @@ class SenderOptions {
935
937
  }
936
938
  exports.SenderOptions = SenderOptions;
937
939
  /**
938
- * The codec type of audio.
940
+ * Audio codec format.
939
941
  */
940
942
  var AudioCodecType;
941
943
  (function (AudioCodecType) {
@@ -986,61 +988,61 @@ var AudioCodecType;
986
988
  var AudioEncodingType;
987
989
  (function (AudioEncodingType) {
988
990
  /**
989
- * AAC encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
991
+ * 0x010101: AAC encoding format, 16000 Hz sample rate, low quality. The encoded file size of a 10-minute audio is approximately 1.2 MB.
990
992
  */
991
993
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac16000Low"] = 65793] = "AudioEncodingTypeAac16000Low";
992
994
  /**
993
- * AAC encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
995
+ * 0x010102: AAC encoding format, 16000 Hz sample rate, medium quality. The encoded file size of a 10-minute audio is approximately 2 MB.
994
996
  */
995
997
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac16000Medium"] = 65794] = "AudioEncodingTypeAac16000Medium";
996
998
  /**
997
- * AAC encoding format, 32000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 1.2 MB after encoding.
999
+ * 0x010201: AAC encoding format, 32000 Hz sample rate, low quality. The encoded file size of a 10-minute audio is approximately 1.2 MB.
998
1000
  */
999
1001
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac32000Low"] = 66049] = "AudioEncodingTypeAac32000Low";
1000
1002
  /**
1001
- * AAC encoding format, 32000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
1003
+ * 0x010202: AAC encoding format, 32000 Hz sample rate, medium quality. The encoded file size of a 10-minute audio is approximately 2 MB.
1002
1004
  */
1003
1005
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac32000Medium"] = 66050] = "AudioEncodingTypeAac32000Medium";
1004
1006
  /**
1005
- * AAC encoding format, 32000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
1007
+ * 0x010203: AAC encoding format, 32000 Hz sample rate, high quality. The encoded file size of a 10-minute audio is approximately 3.5 MB.
1006
1008
  */
1007
1009
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac32000High"] = 66051] = "AudioEncodingTypeAac32000High";
1008
1010
  /**
1009
- * AAC encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
1011
+ * 0x010302: AAC encoding format, 48000 Hz sample rate, medium quality. The encoded file size of a 10-minute audio is approximately 2 MB.
1010
1012
  */
1011
1013
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac48000Medium"] = 66306] = "AudioEncodingTypeAac48000Medium";
1012
1014
  /**
1013
- * AAC encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
1015
+ * 0x010303: AAC encoding format, 48000 Hz sample rate, high quality. The encoded file size of a 10-minute audio is approximately 3.5 MB.
1014
1016
  */
1015
1017
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeAac48000High"] = 66307] = "AudioEncodingTypeAac48000High";
1016
1018
  /**
1017
- * OPUS encoding format, 16000 Hz sampling rate, bass quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
1019
+ * 0x020101: OPUS encoding format, 16000 Hz sample rate, low quality. The encoded file size of a 10-minute audio is approximately 2 MB.
1018
1020
  */
1019
1021
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeOpus16000Low"] = 131329] = "AudioEncodingTypeOpus16000Low";
1020
1022
  /**
1021
- * OPUS encoding format, 16000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
1023
+ * 0x020102: OPUS encoding format, 16000 Hz sample rate, medium quality. The encoded file size of a 10-minute audio is approximately 2 MB.
1022
1024
  */
1023
1025
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeOpus16000Medium"] = 131330] = "AudioEncodingTypeOpus16000Medium";
1024
1026
  /**
1025
- * OPUS encoding format, 48000 Hz sampling rate, medium sound quality. A file with an audio duration of 10 minutes is approximately 2 MB after encoding.
1027
+ * 0x020302: OPUS encoding format, 48000 Hz sample rate, medium quality. The encoded file size of a 10-minute audio is approximately 2 MB.
1026
1028
  */
1027
1029
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeOpus48000Medium"] = 131842] = "AudioEncodingTypeOpus48000Medium";
1028
1030
  /**
1029
- * OPUS encoding format, 48000 Hz sampling rate, high sound quality. A file with an audio duration of 10 minutes is approximately 3.5 MB after encoding.
1031
+ * 0x020303: OPUS encoding format, 48000 Hz sample rate, high quality. The encoded file size of a 10-minute audio is approximately 3.5 MB.
1030
1032
  */
1031
1033
  AudioEncodingType[AudioEncodingType["AudioEncodingTypeOpus48000High"] = 131843] = "AudioEncodingTypeOpus48000High";
1032
1034
  })(AudioEncodingType = exports.AudioEncodingType || (exports.AudioEncodingType = {}));
1033
1035
  /**
1034
- * The adaptation mode of the watermark.
1036
+ * Watermark fit mode.
1035
1037
  */
1036
1038
  var WatermarkFitMode;
1037
1039
  (function (WatermarkFitMode) {
1038
1040
  /**
1039
- * Use the positionInLandscapeMode and positionInPortraitMode values you set in WatermarkOptions. The settings in WatermarkRatio are invalid.
1041
+ * 0: Uses the positionInLandscapeMode and positionInPortraitMode values set in WatermarkOptions. In this case, the settings in WatermarkRatio are ignored.
1040
1042
  */
1041
1043
  WatermarkFitMode[WatermarkFitMode["FitModeCoverPosition"] = 0] = "FitModeCoverPosition";
1042
1044
  /**
1043
- * Use the value you set in WatermarkRatio. The settings in positionInLandscapeMode and positionInPortraitMode in WatermarkOptions are invalid.
1045
+ * 1: Uses the values set in WatermarkRatio. In this case, the positionInLandscapeMode and positionInPortraitMode settings in WatermarkOptions are ignored.
1044
1046
  */
1045
1047
  WatermarkFitMode[WatermarkFitMode["FitModeUseImageRatio"] = 1] = "FitModeUseImageRatio";
1046
1048
  })(WatermarkFitMode = exports.WatermarkFitMode || (exports.WatermarkFitMode = {}));
@@ -1051,7 +1053,7 @@ class EncodedAudioFrameAdvancedSettings {
1051
1053
  }
1052
1054
  exports.EncodedAudioFrameAdvancedSettings = EncodedAudioFrameAdvancedSettings;
1053
1055
  /**
1054
- * Audio information after encoding.
1056
+ * Information of the encoded audio.
1055
1057
  */
1056
1058
  class EncodedAudioFrameInfo {
1057
1059
  }
@@ -1077,16 +1079,16 @@ var H264PacketizeMode;
1077
1079
  H264PacketizeMode[H264PacketizeMode["SingleNalUnit"] = 1] = "SingleNalUnit";
1078
1080
  })(H264PacketizeMode = exports.H264PacketizeMode || (exports.H264PacketizeMode = {}));
1079
1081
  /**
1080
- * The type of video streams.
1082
+ * Video stream type.
1081
1083
  */
1082
1084
  var VideoStreamType;
1083
1085
  (function (VideoStreamType) {
1084
1086
  /**
1085
- * 0: High-quality video stream.
1087
+ * 0: High stream, i.e., high-resolution and high-bitrate video stream.
1086
1088
  */
1087
1089
  VideoStreamType[VideoStreamType["VideoStreamHigh"] = 0] = "VideoStreamHigh";
1088
1090
  /**
1089
- * 1: Low-quality video stream.
1091
+ * 1: Low stream, i.e., low-resolution and low-bitrate video stream.
1090
1092
  */
1091
1093
  VideoStreamType[VideoStreamType["VideoStreamLow"] = 1] = "VideoStreamLow";
1092
1094
  /**
@@ -1115,18 +1117,18 @@ var VideoStreamType;
1115
1117
  VideoStreamType[VideoStreamType["VideoStreamLayer6"] = 9] = "VideoStreamLayer6";
1116
1118
  })(VideoStreamType = exports.VideoStreamType || (exports.VideoStreamType = {}));
1117
1119
  /**
1118
- * Video subscription options.
1120
+ * Video subscription settings.
1119
1121
  */
1120
1122
  class VideoSubscriptionOptions {
1121
1123
  }
1122
1124
  exports.VideoSubscriptionOptions = VideoSubscriptionOptions;
1123
1125
  /**
1124
- * The maximum length of the user account.
1126
+ * Maximum length of the user account.
1125
1127
  */
1126
1128
  var MaxUserAccountLengthType;
1127
1129
  (function (MaxUserAccountLengthType) {
1128
1130
  /**
1129
- * The maximum length of the user account is 256 bytes.
1131
+ * The maximum length of the user account is 255 characters.
1130
1132
  */
1131
1133
  MaxUserAccountLengthType[MaxUserAccountLengthType["MaxUserAccountLength"] = 256] = "MaxUserAccountLength";
1132
1134
  })(MaxUserAccountLengthType = exports.MaxUserAccountLengthType || (exports.MaxUserAccountLengthType = {}));
@@ -1137,20 +1139,20 @@ class EncodedVideoFrameInfo {
1137
1139
  }
1138
1140
  exports.EncodedVideoFrameInfo = EncodedVideoFrameInfo;
1139
1141
  /**
1140
- * Compression preference for video encoding.
1142
+ * Compression preference types for video encoding.
1141
1143
  */
1142
1144
  var CompressionPreference;
1143
1145
  (function (CompressionPreference) {
1144
1146
  /**
1145
- * -1: (Default) Automatic mode. The SDK will automatically select PreferLowLatency or PreferQuality based on the video scenario you set to achieve the best user experience.
1147
+ * -1: (Default) Auto mode. The SDK automatically selects PreferLowLatency or PreferQuality based on the video scenario you set to provide the best user experience.
1146
1148
  */
1147
1149
  CompressionPreference[CompressionPreference["PreferCompressionAuto"] = -1] = "PreferCompressionAuto";
1148
1150
  /**
1149
- * 0: Low latency preference. The SDK compresses video frames to reduce latency. This preference is suitable for scenarios where smoothness is prioritized and reduced video quality is acceptable.
1151
+ * 0: Low latency preference. The SDK compresses video frames to reduce latency. This preference is suitable for scenarios where smoothness is prioritized and some quality loss is acceptable.
1150
1152
  */
1151
1153
  CompressionPreference[CompressionPreference["PreferLowLatency"] = 0] = "PreferLowLatency";
1152
1154
  /**
1153
- * 1: High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.
1155
+ * 1: High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is a priority.
1154
1156
  */
1155
1157
  CompressionPreference[CompressionPreference["PreferQuality"] = 1] = "PreferQuality";
1156
1158
  })(CompressionPreference = exports.CompressionPreference || (exports.CompressionPreference = {}));
@@ -1160,15 +1162,15 @@ var CompressionPreference;
1160
1162
  var EncodingPreference;
1161
1163
  (function (EncodingPreference) {
1162
1164
  /**
1163
- * -1: Adaptive preference. The SDK automatically selects the optimal encoding type for encoding based on factors such as platform and device type.
1165
+ * -1: Adaptive preference. The SDK automatically selects the optimal encoding type based on platform, device type, and other factors.
1164
1166
  */
1165
1167
  EncodingPreference[EncodingPreference["PreferAuto"] = -1] = "PreferAuto";
1166
1168
  /**
1167
- * 0: Software coding preference. The SDK prefers software encoders for video encoding.
1169
+ * 0: Software encoding preference. The SDK prioritizes using software encoders for video encoding.
1168
1170
  */
1169
1171
  EncodingPreference[EncodingPreference["PreferSoftware"] = 0] = "PreferSoftware";
1170
1172
  /**
1171
- * 1: Hardware encoding preference. The SDK prefers a hardware encoder for video encoding. When the device does not support hardware encoding, the SDK automatically uses software encoding and reports the currently used video encoder type through hwEncoderAccelerating in the onLocalVideoStats callback.
1173
+ * 1: Hardware encoding preference. The SDK prioritizes using hardware encoders for video encoding. If the device does not support hardware encoding, the SDK automatically switches to software encoding and reports the current encoder type via the onLocalVideoStats callback's hwEncoderAccelerating field.
1172
1174
  */
1173
1175
  EncodingPreference[EncodingPreference["PreferHardware"] = 1] = "PreferHardware";
1174
1176
  })(EncodingPreference = exports.EncodingPreference || (exports.EncodingPreference = {}));
@@ -1179,14 +1181,14 @@ class AdvanceOptions {
1179
1181
  }
1180
1182
  exports.AdvanceOptions = AdvanceOptions;
1181
1183
  /**
1182
- * Video mirror mode.
1184
+ * Mirror mode type.
1183
1185
  */
1184
1186
  var VideoMirrorModeType;
1185
1187
  (function (VideoMirrorModeType) {
1186
1188
  /**
1187
- * 0: The SDK determines the mirror mode.
1188
- * For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
1189
- * For the remote user: The mirror mode is disabled by default.
1189
+ * 0: Mirror mode determined by SDK.
1190
+ * Local view mirror mode: If you use the front camera, local view mirror mode is enabled by default; if you use the rear camera, it is disabled by default.
1191
+ * Remote user view mirror mode: Disabled by default.
1190
1192
  */
1191
1193
  VideoMirrorModeType[VideoMirrorModeType["VideoMirrorModeAuto"] = 0] = "VideoMirrorModeAuto";
1192
1194
  /**
@@ -1261,39 +1263,39 @@ var HdrCapability;
1261
1263
  HdrCapability[HdrCapability["HdrCapabilitySupported"] = 1] = "HdrCapabilitySupported";
1262
1264
  })(HdrCapability = exports.HdrCapability || (exports.HdrCapability = {}));
1263
1265
  /**
1264
- * The bit mask of the codec type.
1266
+ * Bit mask for codec capabilities.
1265
1267
  */
1266
1268
  var CodecCapMask;
1267
1269
  (function (CodecCapMask) {
1268
1270
  /**
1269
- * (0): The device does not support encoding or decoding.
1271
+ * (0): Codec not supported.
1270
1272
  */
1271
1273
  CodecCapMask[CodecCapMask["CodecCapMaskNone"] = 0] = "CodecCapMaskNone";
1272
1274
  /**
1273
- * (1 << 0): The device supports hardware decoding.
1275
+ * (1 << 0): Supports hardware decoding.
1274
1276
  */
1275
1277
  CodecCapMask[CodecCapMask["CodecCapMaskHwDec"] = 1] = "CodecCapMaskHwDec";
1276
1278
  /**
1277
- * (1 << 1): The device supports hardware encoding.
1279
+ * (1 << 1): Supports hardware encoding.
1278
1280
  */
1279
1281
  CodecCapMask[CodecCapMask["CodecCapMaskHwEnc"] = 2] = "CodecCapMaskHwEnc";
1280
1282
  /**
1281
- * (1 << 2): The device supports software decoding.
1283
+ * (1 << 2): Supports software decoding.
1282
1284
  */
1283
1285
  CodecCapMask[CodecCapMask["CodecCapMaskSwDec"] = 4] = "CodecCapMaskSwDec";
1284
1286
  /**
1285
- * (1 << 3): The device supports software ecoding.
1287
+ * (1 << 3): Supports software encoding.
1286
1288
  */
1287
1289
  CodecCapMask[CodecCapMask["CodecCapMaskSwEnc"] = 8] = "CodecCapMaskSwEnc";
1288
1290
  })(CodecCapMask = exports.CodecCapMask || (exports.CodecCapMask = {}));
1289
1291
  /**
1290
- * The level of the codec capability.
1292
+ * Codec capability levels.
1291
1293
  */
1292
1294
  class CodecCapLevels {
1293
1295
  }
1294
1296
  exports.CodecCapLevels = CodecCapLevels;
1295
1297
  /**
1296
- * The codec capability of the SDK.
1298
+ * Codec capability information supported by the SDK.
1297
1299
  */
1298
1300
  class CodecCapInfo {
1299
1301
  }
@@ -1305,39 +1307,44 @@ class FocalLengthInfo {
1305
1307
  }
1306
1308
  exports.FocalLengthInfo = FocalLengthInfo;
1307
1309
  /**
1308
- * Video encoder configurations.
1310
+ * Configuration of the video encoder.
1309
1311
  */
1310
1312
  class VideoEncoderConfiguration {
1311
1313
  }
1312
1314
  exports.VideoEncoderConfiguration = VideoEncoderConfiguration;
1313
1315
  /**
1314
- * The configurations for the data stream.
1316
+ * Data stream settings.
1315
1317
  *
1316
- * The following table shows the SDK behaviors under different parameter settings:
1318
+ * The table below shows the SDK behavior under different parameter settings: syncWithAudio ordered
1319
+ * SDK behavior false false
1320
+ * The SDK immediately triggers the onStreamMessage callback when the receiver receives the data packet. true false
1321
+ * If the data packet delay is within the audio delay range, the SDK triggers the onStreamMessage callback synchronized with the audio packet during audio playback. If the data packet delay exceeds the audio delay, the SDK immediately triggers the onStreamMessage callback upon receiving the packet; this may cause desynchronization between audio and data packets. false true
1322
+ * If the data packet delay is within 5 seconds, the SDK corrects the packet disorder. If the delay exceeds 5 seconds, the SDK discards the packet. true true
1323
+ * If the data packet delay is within the audio delay range, the SDK corrects the packet disorder. If the delay exceeds the audio delay, the SDK discards the packet.
1317
1324
  */
1318
1325
  class DataStreamConfig {
1319
1326
  }
1320
1327
  exports.DataStreamConfig = DataStreamConfig;
1321
1328
  /**
1322
- * The mode in which the video stream is sent.
1329
+ * Mode for sending video streams.
1323
1330
  */
1324
1331
  var SimulcastStreamMode;
1325
1332
  (function (SimulcastStreamMode) {
1326
1333
  /**
1327
- * -1: By default, do not send the low-quality video stream until a subscription request for the low-quality video stream is received from the receiving end, then automatically start sending low-quality video stream.
1334
+ * -1: By default, small streams are not sent until a subscription request for small streams is received from the receiver, at which point small streams are automatically sent.
1328
1335
  */
1329
1336
  SimulcastStreamMode[SimulcastStreamMode["AutoSimulcastStream"] = -1] = "AutoSimulcastStream";
1330
1337
  /**
1331
- * 0: Never send low-quality video stream.
1338
+ * 0: Never send small streams.
1332
1339
  */
1333
1340
  SimulcastStreamMode[SimulcastStreamMode["DisableSimulcastStream"] = 0] = "DisableSimulcastStream";
1334
1341
  /**
1335
- * 1: Always send low-quality video stream.
1342
+ * 1: Always send small streams.
1336
1343
  */
1337
1344
  SimulcastStreamMode[SimulcastStreamMode["EnableSimulcastStream"] = 1] = "EnableSimulcastStream";
1338
1345
  })(SimulcastStreamMode = exports.SimulcastStreamMode || (exports.SimulcastStreamMode = {}));
1339
1346
  /**
1340
- * The configuration of the low-quality video stream.
1347
+ * Configuration for the low-quality video stream.
1341
1348
  */
1342
1349
  class SimulcastStreamConfig {
1343
1350
  }
@@ -1393,67 +1400,124 @@ class SimulcastConfig {
1393
1400
  }
1394
1401
  exports.SimulcastConfig = SimulcastConfig;
1395
1402
  /**
1396
- * The location of the target area relative to the screen or window. If you do not set this parameter, the SDK selects the whole screen or window.
1403
+ * The position of the target area relative to the entire screen or window. If not specified, it refers to the entire screen or window.
1397
1404
  */
1398
1405
  class Rectangle {
1399
1406
  }
1400
1407
  exports.Rectangle = Rectangle;
1401
1408
  /**
1402
- * The position and size of the watermark on the screen.
1409
+ * Watermark position and size on screen.
1403
1410
  *
1404
- * The position and size of the watermark on the screen are determined by xRatio, yRatio, and widthRatio :
1405
- * (xRatio, yRatio) refers to the coordinates of the upper left corner of the watermark, which determines the distance from the upper left corner of the watermark to the upper left corner of the screen.
1406
- * The widthRatio determines the width of the watermark.
1411
+ * The watermark's position and size on screen are determined by xRatio, yRatio, and widthRatio :
1412
+ * (xRatio, yRatio) represents the coordinates of the top-left corner of the watermark, determining the distance from the top-left corner of the screen. widthRatio determines the width of the watermark.
1407
1413
  */
1408
1414
  class WatermarkRatio {
1409
1415
  }
1410
1416
  exports.WatermarkRatio = WatermarkRatio;
1411
1417
  /**
1412
- * Configurations of the watermark image.
1418
+ * Configure watermark image.
1419
+ *
1420
+ * Used to configure the watermark image to be added.
1413
1421
  */
1414
1422
  class WatermarkOptions {
1415
1423
  }
1416
1424
  exports.WatermarkOptions = WatermarkOptions;
1417
1425
  /**
1418
- * Statistics of a call session.
1426
+ * Modes for multipath data transmission.
1427
+ *
1428
+ * Since Added since v4.6.2.
1429
+ */
1430
+ var MultipathMode;
1431
+ (function (MultipathMode) {
1432
+ /**
1433
+ * (0): Redundant transmission mode. The same data is redundantly transmitted over all available paths.
1434
+ */
1435
+ MultipathMode[MultipathMode["Duplicate"] = 0] = "Duplicate";
1436
+ /**
1437
+ * @ignore
1438
+ */
1439
+ MultipathMode[MultipathMode["Dynamic"] = 1] = "Dynamic";
1440
+ })(MultipathMode = exports.MultipathMode || (exports.MultipathMode = {}));
1441
+ /**
1442
+ * Network path types used for multipath transmission.
1443
+ *
1444
+ * Since Added since v4.6.2.
1445
+ */
1446
+ var MultipathType;
1447
+ (function (MultipathType) {
1448
+ /**
1449
+ * (0): Local Area Network (LAN) path.
1450
+ */
1451
+ MultipathType[MultipathType["Lan"] = 0] = "Lan";
1452
+ /**
1453
+ * (1): Wi-Fi path.
1454
+ */
1455
+ MultipathType[MultipathType["Wifi"] = 1] = "Wifi";
1456
+ /**
1457
+ * (2): Mobile network path.
1458
+ */
1459
+ MultipathType[MultipathType["Mobile"] = 2] = "Mobile";
1460
+ /**
1461
+ * (99): Unknown or unspecified network path.
1462
+ */
1463
+ MultipathType[MultipathType["Unknown"] = 99] = "Unknown";
1464
+ })(MultipathType = exports.MultipathType || (exports.MultipathType = {}));
1465
+ /**
1466
+ * Used to obtain statistics for a specific network path.
1467
+ *
1468
+ * Since Available since v4.6.2.
1469
+ */
1470
+ class PathStats {
1471
+ }
1472
+ exports.PathStats = PathStats;
1473
+ /**
1474
+ * Used to aggregate statistics for each network path in multipath transmission.
1475
+ *
1476
+ * Since Available since v4.6.2.
1477
+ */
1478
+ class MultipathStats {
1479
+ }
1480
+ exports.MultipathStats = MultipathStats;
1481
+ /**
1482
+ * Call-related statistics.
1419
1483
  */
1420
1484
  class RtcStats {
1421
1485
  }
1422
1486
  exports.RtcStats = RtcStats;
1423
1487
  /**
1424
- * The user role in the interactive live streaming.
1488
+ * User roles in live broadcasting scenario.
1425
1489
  */
1426
1490
  var ClientRoleType;
1427
1491
  (function (ClientRoleType) {
1428
1492
  /**
1429
- * 1: Host. A host can both send and receive streams.
1493
+ * 1: Broadcaster. A broadcaster can both send and receive streams.
1430
1494
  */
1431
1495
  ClientRoleType[ClientRoleType["ClientRoleBroadcaster"] = 1] = "ClientRoleBroadcaster";
1432
1496
  /**
1433
- * 2: (Default) Audience. An audience member can only receive streams.
1497
+ * 2: (Default) Audience. An audience member can only receive streams but not send them.
1434
1498
  */
1435
1499
  ClientRoleType[ClientRoleType["ClientRoleAudience"] = 2] = "ClientRoleAudience";
1436
1500
  })(ClientRoleType = exports.ClientRoleType || (exports.ClientRoleType = {}));
1437
1501
  /**
1438
- * Quality change of the local video in terms of target frame rate and target bit rate since last count.
1502
+ * Adaptation of local video quality since the last statistics (based on target frame rate and bitrate).
1439
1503
  */
1440
1504
  var QualityAdaptIndication;
1441
1505
  (function (QualityAdaptIndication) {
1442
1506
  /**
1443
- * 0: The local video quality stays the same.
1507
+ * 0: No change in local video quality.
1444
1508
  */
1445
1509
  QualityAdaptIndication[QualityAdaptIndication["AdaptNone"] = 0] = "AdaptNone";
1446
1510
  /**
1447
- * 1: The local video quality improves because the network bandwidth increases.
1511
+ * 1: Local video quality improves due to increased network bandwidth.
1448
1512
  */
1449
1513
  QualityAdaptIndication[QualityAdaptIndication["AdaptUpBandwidth"] = 1] = "AdaptUpBandwidth";
1450
1514
  /**
1451
- * 2: The local video quality deteriorates because the network bandwidth decreases.
1515
+ * 2: Local video quality degrades due to decreased network bandwidth.
1452
1516
  */
1453
1517
  QualityAdaptIndication[QualityAdaptIndication["AdaptDownBandwidth"] = 2] = "AdaptDownBandwidth";
1454
1518
  })(QualityAdaptIndication = exports.QualityAdaptIndication || (exports.QualityAdaptIndication = {}));
1455
1519
  /**
1456
- * The latency level of an audience member in interactive live streaming. This enum takes effect only when the user role is set to ClientRoleAudience .
1520
+ * Latency level of audience in a live broadcast channel. This enumeration is effective only when the user role is set to ClientRoleAudience.
1457
1521
  */
1458
1522
  var AudienceLatencyLevelType;
1459
1523
  (function (AudienceLatencyLevelType) {
@@ -1462,138 +1526,141 @@ var AudienceLatencyLevelType;
1462
1526
  */
1463
1527
  AudienceLatencyLevelType[AudienceLatencyLevelType["AudienceLatencyLevelLowLatency"] = 1] = "AudienceLatencyLevelLowLatency";
1464
1528
  /**
1465
- * 2: (Default) Ultra low latency.
1529
+ * 2: (Default) Ultra-low latency.
1466
1530
  */
1467
1531
  AudienceLatencyLevelType[AudienceLatencyLevelType["AudienceLatencyLevelUltraLowLatency"] = 2] = "AudienceLatencyLevelUltraLowLatency";
1468
1532
  })(AudienceLatencyLevelType = exports.AudienceLatencyLevelType || (exports.AudienceLatencyLevelType = {}));
1469
1533
  /**
1470
- * Setting of user role properties.
1534
+ * User role property settings.
1471
1535
  */
1472
1536
  class ClientRoleOptions {
1473
1537
  }
1474
1538
  exports.ClientRoleOptions = ClientRoleOptions;
1475
1539
  /**
1476
- * The Quality of Experience (QoE) of the local user when receiving a remote audio stream.
1540
+ * The subjective experience quality of the local user when receiving remote audio.
1477
1541
  */
1478
1542
  var ExperienceQualityType;
1479
1543
  (function (ExperienceQualityType) {
1480
1544
  /**
1481
- * 0: The QoE of the local user is good.
1545
+ * 0: Good subjective experience quality.
1482
1546
  */
1483
1547
  ExperienceQualityType[ExperienceQualityType["ExperienceQualityGood"] = 0] = "ExperienceQualityGood";
1484
1548
  /**
1485
- * 1: The QoE of the local user is poor.
1549
+ * 1: Poor subjective experience quality.
1486
1550
  */
1487
1551
  ExperienceQualityType[ExperienceQualityType["ExperienceQualityBad"] = 1] = "ExperienceQualityBad";
1488
1552
  })(ExperienceQualityType = exports.ExperienceQualityType || (exports.ExperienceQualityType = {}));
1489
1553
  /**
1490
- * Reasons why the QoE of the local user when receiving a remote audio stream is poor.
1554
+ * The reason for poor subjective experience quality of the local user when receiving remote audio.
1491
1555
  */
1492
1556
  var ExperiencePoorReason;
1493
1557
  (function (ExperiencePoorReason) {
1494
1558
  /**
1495
- * 0: No reason, indicating a good QoE of the local user.
1559
+ * 0: No reason, indicating good subjective experience quality.
1496
1560
  */
1497
1561
  ExperiencePoorReason[ExperiencePoorReason["ExperienceReasonNone"] = 0] = "ExperienceReasonNone";
1498
1562
  /**
1499
- * 1: The remote user's network quality is poor.
1563
+ * 1: Poor network quality of the remote user.
1500
1564
  */
1501
1565
  ExperiencePoorReason[ExperiencePoorReason["RemoteNetworkQualityPoor"] = 1] = "RemoteNetworkQualityPoor";
1502
1566
  /**
1503
- * 2: The local user's network quality is poor.
1567
+ * 2: Poor network quality of the local user.
1504
1568
  */
1505
1569
  ExperiencePoorReason[ExperiencePoorReason["LocalNetworkQualityPoor"] = 2] = "LocalNetworkQualityPoor";
1506
1570
  /**
1507
- * 4: The local user's Wi-Fi or mobile network signal is weak.
1571
+ * 4: Weak Wi-Fi or mobile data signal of the local user.
1508
1572
  */
1509
1573
  ExperiencePoorReason[ExperiencePoorReason["WirelessSignalPoor"] = 4] = "WirelessSignalPoor";
1510
1574
  /**
1511
- * 8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. As a result, audio transmission quality is undermined.
1575
+ * 8: Wi-Fi and Bluetooth are enabled simultaneously on the local device, causing signal interference and degraded audio transmission quality.
1512
1576
  */
1513
1577
  ExperiencePoorReason[ExperiencePoorReason["WifiBluetoothCoexist"] = 8] = "WifiBluetoothCoexist";
1514
1578
  })(ExperiencePoorReason = exports.ExperiencePoorReason || (exports.ExperiencePoorReason = {}));
1515
1579
  /**
1516
- * AI noise suppression modes.
1580
+ * AI noise reduction mode.
1517
1581
  */
1518
1582
  var AudioAinsMode;
1519
1583
  (function (AudioAinsMode) {
1520
1584
  /**
1521
- * 0: (Default) Balance mode. This mode allows for a balanced performance on noice suppression and time delay.
1585
+ * 0: (Default) Balanced noise reduction mode. Choose this mode if you want a balance between noise suppression and latency.
1522
1586
  */
1523
1587
  AudioAinsMode[AudioAinsMode["AinsModeBalanced"] = 0] = "AinsModeBalanced";
1524
1588
  /**
1525
- * 1: Aggressive mode. In scenarios where high performance on noise suppression is required, such as live streaming outdoor events, this mode reduces nosie more dramatically, but may sometimes affect the original character of the audio.
1589
+ * 1: Aggressive noise reduction mode. Suitable for scenarios requiring strong noise suppression, such as outdoor live streaming. This mode can significantly reduce noise but may slightly distort voice.
1526
1590
  */
1527
1591
  AudioAinsMode[AudioAinsMode["AinsModeAggressive"] = 1] = "AinsModeAggressive";
1528
1592
  /**
1529
- * 2: Aggressive mode with low latency. The noise suppression delay of this mode is about only half of that of the balance and aggressive modes. It is suitable for scenarios that have high requirements on noise suppression with low latency, such as sing together online in real time.
1593
+ * 2: Low-latency aggressive noise reduction mode. This mode has approximately half the latency of weak and aggressive noise reduction modes, making it suitable for scenarios requiring both noise reduction and low latency, such as real-time chorus.
1530
1594
  */
1531
1595
  AudioAinsMode[AudioAinsMode["AinsModeUltralowlatency"] = 2] = "AinsModeUltralowlatency";
1532
1596
  })(AudioAinsMode = exports.AudioAinsMode || (exports.AudioAinsMode = {}));
1533
1597
  /**
1534
- * The audio profile.
1598
+ * Audio encoding properties.
1535
1599
  */
1536
1600
  var AudioProfileType;
1537
1601
  (function (AudioProfileType) {
1538
1602
  /**
1539
- * 0: The default audio profile.
1540
- * For the interactive streaming profile: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
1541
- * For the communication profile:
1542
- * Windows: A sample rate of 16 kHz, audio encoding, mono, and a bitrate of up to 16 Kbps. macOS: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
1603
+ * 0: Default value.
1604
+ * In live broadcast scenarios: 48 kHz sampling rate, music encoding, mono channel, maximum bitrate 64 Kbps.
1605
+ * In communication scenarios:
1606
+ * Windows platform: 16 kHz sampling rate, speech encoding, mono channel, maximum bitrate 16 Kbps.
1607
+ * macOS platform: 32 kHz sampling rate, speech encoding, mono channel, maximum bitrate 18 Kbps.
1543
1608
  */
1544
1609
  AudioProfileType[AudioProfileType["AudioProfileDefault"] = 0] = "AudioProfileDefault";
1545
1610
  /**
1546
- * 1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
1611
+ * 1: Specifies 32 kHz sampling rate, speech encoding, mono channel, maximum bitrate 18 Kbps.
1547
1612
  */
1548
1613
  AudioProfileType[AudioProfileType["AudioProfileSpeechStandard"] = 1] = "AudioProfileSpeechStandard";
1549
1614
  /**
1550
- * 2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
1615
+ * 2: Specifies 48 kHz sampling rate, music encoding, mono channel, maximum bitrate 64 Kbps.
1551
1616
  */
1552
1617
  AudioProfileType[AudioProfileType["AudioProfileMusicStandard"] = 2] = "AudioProfileMusicStandard";
1553
1618
  /**
1554
- * 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
1619
+ * 3: Specifies 48 kHz sampling rate, music encoding, stereo channel, maximum bitrate 80 Kbps.
1620
+ * To achieve stereo, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
1555
1621
  */
1556
1622
  AudioProfileType[AudioProfileType["AudioProfileMusicStandardStereo"] = 3] = "AudioProfileMusicStandardStereo";
1557
1623
  /**
1558
- * 4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
1624
+ * 4: Specifies 48 kHz sampling rate, music encoding, mono channel, maximum bitrate 96 Kbps.
1559
1625
  */
1560
1626
  AudioProfileType[AudioProfileType["AudioProfileMusicHighQuality"] = 4] = "AudioProfileMusicHighQuality";
1561
1627
  /**
1562
- * 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
1628
+ * 5: Specifies 48 kHz sampling rate, music encoding, stereo channel, maximum bitrate 128 Kbps.
1629
+ * To achieve stereo, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
1563
1630
  */
1564
1631
  AudioProfileType[AudioProfileType["AudioProfileMusicHighQualityStereo"] = 5] = "AudioProfileMusicHighQualityStereo";
1565
1632
  /**
1566
- * 6: A sample rate of 16 kHz, audio encoding, mono, and Acoustic Echo Cancellation (AEC) enabled.
1633
+ * 6: Specifies 16 kHz sampling rate, speech encoding, mono channel, applies echo cancellation algorithm AEC.
1567
1634
  */
1568
1635
  AudioProfileType[AudioProfileType["AudioProfileIot"] = 6] = "AudioProfileIot";
1569
1636
  /**
1570
- * Enumerator boundary.
1637
+ * Enumeration value boundary.
1571
1638
  */
1572
1639
  AudioProfileType[AudioProfileType["AudioProfileNum"] = 7] = "AudioProfileNum";
1573
1640
  })(AudioProfileType = exports.AudioProfileType || (exports.AudioProfileType = {}));
1574
1641
  /**
1575
- * The audio scenarios.
1642
+ * Audio scenario.
1576
1643
  */
1577
1644
  var AudioScenarioType;
1578
1645
  (function (AudioScenarioType) {
1579
1646
  /**
1580
- * 0: (Default) Automatic scenario match, where the SDK chooses the appropriate audio quality according to the user role and audio route.
1647
+ * 0: (Default) Automatic scenario. Automatically matches the appropriate audio quality based on user role and audio routing.
1581
1648
  */
1582
1649
  AudioScenarioType[AudioScenarioType["AudioScenarioDefault"] = 0] = "AudioScenarioDefault";
1583
1650
  /**
1584
- * 3: High-quality audio scenario, where users mainly play music. For example, instrument tutoring.
1651
+ * 3: High-quality audio scenario, suitable for music-centric use cases. For example: instrument practice.
1585
1652
  */
1586
1653
  AudioScenarioType[AudioScenarioType["AudioScenarioGameStreaming"] = 3] = "AudioScenarioGameStreaming";
1587
1654
  /**
1588
- * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
1655
+ * 5: Chatroom scenario, suitable for cases where users frequently join and leave the mic. For example: educational scenarios.
1589
1656
  */
1590
1657
  AudioScenarioType[AudioScenarioType["AudioScenarioChatroom"] = 5] = "AudioScenarioChatroom";
1591
1658
  /**
1592
- * 7: Real-time chorus scenario, where users have good network conditions and require ultra-low latency.
1659
+ * 7: Chorus scenario. Suitable for real-time chorus with good network conditions and ultra-low latency requirements.
1593
1660
  */
1594
1661
  AudioScenarioType[AudioScenarioType["AudioScenarioChorus"] = 7] = "AudioScenarioChorus";
1595
1662
  /**
1596
- * 8: Meeting scenario that mainly contains the human voice.
1663
+ * 8: Meeting scenario, suitable for multi-person voice-centric conferences.
1597
1664
  */
1598
1665
  AudioScenarioType[AudioScenarioType["AudioScenarioMeeting"] = 8] = "AudioScenarioMeeting";
1599
1666
  /**
@@ -1601,92 +1668,79 @@ var AudioScenarioType;
1601
1668
  */
1602
1669
  AudioScenarioType[AudioScenarioType["AudioScenarioAiServer"] = 9] = "AudioScenarioAiServer";
1603
1670
  /**
1604
- * 10: AI conversation scenario, which is only applicable to scenarios where the user interacts with the conversational AI agent created by.
1671
+ * 10: AI conversation scenario, only applicable for interactions with agents created using the [Agora Conversational AI Engine](https://docs.agora.io/en/conversational-ai/overview/product-overview).
1605
1672
  */
1606
1673
  AudioScenarioType[AudioScenarioType["AudioScenarioAiClient"] = 10] = "AudioScenarioAiClient";
1607
1674
  /**
1608
- * The number of enumerations.
1675
+ * Number of enumerations.
1609
1676
  */
1610
1677
  AudioScenarioType[AudioScenarioType["AudioScenarioNum"] = 11] = "AudioScenarioNum";
1611
1678
  })(AudioScenarioType = exports.AudioScenarioType || (exports.AudioScenarioType = {}));
1612
1679
  /**
1613
- * The format of the video frame.
1680
+ * Video frame format.
1614
1681
  */
1615
1682
  class VideoFormat {
1616
1683
  }
1617
1684
  exports.VideoFormat = VideoFormat;
1618
1685
  /**
1619
- * The content hint for screen sharing.
1686
+ * Content type for screen sharing.
1620
1687
  */
1621
1688
  var VideoContentHint;
1622
1689
  (function (VideoContentHint) {
1623
1690
  /**
1624
- * (Default) No content hint.
1691
+ * (Default) No specified content type.
1625
1692
  */
1626
1693
  VideoContentHint[VideoContentHint["ContentHintNone"] = 0] = "ContentHintNone";
1627
1694
  /**
1628
- * Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
1695
+ * Content type is motion. Recommended when sharing videos, movies, or video games.
1629
1696
  */
1630
1697
  VideoContentHint[VideoContentHint["ContentHintMotion"] = 1] = "ContentHintMotion";
1631
1698
  /**
1632
- * Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slides, or texts.
1699
+ * Content type is details. Recommended when sharing images or text.
1633
1700
  */
1634
1701
  VideoContentHint[VideoContentHint["ContentHintDetails"] = 2] = "ContentHintDetails";
1635
1702
  })(VideoContentHint = exports.VideoContentHint || (exports.VideoContentHint = {}));
1636
1703
  /**
1637
- * The screen sharing scenario.
1704
+ * Screen sharing scenario.
1638
1705
  */
1639
1706
  var ScreenScenarioType;
1640
1707
  (function (ScreenScenarioType) {
1641
1708
  /**
1642
- * 1: (Default) Document. This scenario prioritizes the video quality of screen sharing and reduces the latency of the shared video for the receiver. If you share documents, slides, and tables, you can set this scenario.
1709
+ * 1: (Default) Document. This scenario prioritizes the quality of the shared content and reduces the latency seen by the receiver. Use this scenario when sharing documents, slides, or spreadsheets.
1643
1710
  */
1644
1711
  ScreenScenarioType[ScreenScenarioType["ScreenScenarioDocument"] = 1] = "ScreenScenarioDocument";
1645
1712
  /**
1646
- * 2: Game. This scenario prioritizes the smoothness of screen sharing. If you share games, you can set this scenario.
1713
+ * 2: Gaming. This scenario prioritizes the smoothness of the shared stream. Use this scenario when sharing games.
1647
1714
  */
1648
1715
  ScreenScenarioType[ScreenScenarioType["ScreenScenarioGaming"] = 2] = "ScreenScenarioGaming";
1649
1716
  /**
1650
- * 3: Video. This scenario prioritizes the smoothness of screen sharing. If you share movies or live videos, you can set this scenario.
1717
+ * 3: Video. This scenario prioritizes the smoothness of the shared stream. Use this scenario when sharing movies or live video.
1651
1718
  */
1652
1719
  ScreenScenarioType[ScreenScenarioType["ScreenScenarioVideo"] = 3] = "ScreenScenarioVideo";
1653
1720
  /**
1654
- * 4: Remote control. This scenario prioritizes the video quality of screen sharing and reduces the latency of the shared video for the receiver. If you share the device desktop being remotely controlled, you can set this scenario.
1721
+ * 4: Remote control. This scenario prioritizes the quality of the shared content and reduces the latency seen by the receiver. Use this scenario when sharing the desktop of a remotely controlled device.
1655
1722
  */
1656
1723
  ScreenScenarioType[ScreenScenarioType["ScreenScenarioRdc"] = 4] = "ScreenScenarioRdc";
1657
1724
  })(ScreenScenarioType = exports.ScreenScenarioType || (exports.ScreenScenarioType = {}));
1658
1725
  /**
1659
- * The video application scenarios.
1726
+ * Video application scenario type.
1660
1727
  */
1661
1728
  var VideoApplicationScenarioType;
1662
1729
  (function (VideoApplicationScenarioType) {
1663
1730
  /**
1664
- * 0: (Default) The general scenario.
1731
+ * 0: (Default) General scenario.
1665
1732
  */
1666
1733
  VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
1667
1734
  /**
1668
- * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:
1669
- * In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
1670
- * The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
1671
- * If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
1672
- * If someone subscribes to the high-quality stream, the SDK resets the high-quality stream to the VideoEncoderConfiguration configuration used in the most recent calling of setVideoEncoderConfiguration. If no configuration has been set by the user previously, the following values are used:
1673
- * Resolution: 1280 × 720
1674
- * Frame rate: 15 fps
1675
- * Bitrate: 1600 Kbps
1676
- * The SDK monitors the number of subscribers to the low-quality video stream in real time and dynamically enables or disables it based on the number of subscribers. If the user has called setDualStreamMode to set that never send low-quality video stream (DisableSimulcastStream), the dynamic adjustment of the low-quality stream in meeting scenarios will not take effect.
1677
- * If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
1678
- * If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:
1679
- * Resolution: 480 × 272
1680
- * Frame rate: 15 fps
1681
- * Bitrate: 500 Kbps 1: The meeting scenario.
1735
+ * 1: Meeting scenario.
1682
1736
  */
1683
1737
  VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioMeeting"] = 1] = "ApplicationScenarioMeeting";
1684
1738
  /**
1685
- * ApplicationScenario1v1 (2) This is applicable to the scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
1739
+ * 2: 1v1 video call
1686
1740
  */
1687
1741
  VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenario1v1"] = 2] = "ApplicationScenario1v1";
1688
1742
  /**
1689
- * ApplicationScenarioLiveshow (3) This is applicable to the scenario. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, including automatically enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call enableInstantMediaRendering), and B-frame encoding to achieve better image quality and bandwidth efficiency. The SDK also provides enhanced video quality and smooth playback, even in poor network conditions or on lower-end devices. 3. Live show scenario.
1743
+ * 3: Live show
1690
1744
  */
1691
1745
  VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioLiveshow"] = 3] = "ApplicationScenarioLiveshow";
1692
1746
  })(VideoApplicationScenarioType = exports.VideoApplicationScenarioType || (exports.VideoApplicationScenarioType = {}));
@@ -1713,7 +1767,7 @@ var VideoQoePreferenceType;
1713
1767
  VideoQoePreferenceType[VideoQoePreferenceType["VideoQoePreferenceFluencyFirst"] = 4] = "VideoQoePreferenceFluencyFirst";
1714
1768
  })(VideoQoePreferenceType = exports.VideoQoePreferenceType || (exports.VideoQoePreferenceType = {}));
1715
1769
  /**
1716
- * The brightness level of the video image captured by the local camera.
1770
+ * Brightness level of locally captured video quality.
1717
1771
  */
1718
1772
  var CaptureBrightnessLevelType;
1719
1773
  (function (CaptureBrightnessLevelType) {
@@ -1765,42 +1819,42 @@ var CameraStabilizationMode;
1765
1819
  CameraStabilizationMode[CameraStabilizationMode["CameraStabilizationModeMaxLevel"] = 3] = "CameraStabilizationModeMaxLevel";
1766
1820
  })(CameraStabilizationMode = exports.CameraStabilizationMode || (exports.CameraStabilizationMode = {}));
1767
1821
  /**
1768
- * The state of the local audio.
1822
+ * Local audio state.
1769
1823
  */
1770
1824
  var LocalAudioStreamState;
1771
1825
  (function (LocalAudioStreamState) {
1772
1826
  /**
1773
- * 0: The local audio is in the initial state.
1827
+ * 0: Default initial state of the local audio.
1774
1828
  */
1775
1829
  LocalAudioStreamState[LocalAudioStreamState["LocalAudioStreamStateStopped"] = 0] = "LocalAudioStreamStateStopped";
1776
1830
  /**
1777
- * 1: The local audio capturing device starts successfully.
1831
+ * 1: The local audio capture device is started successfully.
1778
1832
  */
1779
1833
  LocalAudioStreamState[LocalAudioStreamState["LocalAudioStreamStateRecording"] = 1] = "LocalAudioStreamStateRecording";
1780
1834
  /**
1781
- * 2: The first audio frame encodes successfully.
1835
+ * 2: The first frame of local audio is encoded successfully.
1782
1836
  */
1783
1837
  LocalAudioStreamState[LocalAudioStreamState["LocalAudioStreamStateEncoding"] = 2] = "LocalAudioStreamStateEncoding";
1784
1838
  /**
1785
- * 3: The local audio fails to start.
1839
+ * 3: Failed to start local audio.
1786
1840
  */
1787
1841
  LocalAudioStreamState[LocalAudioStreamState["LocalAudioStreamStateFailed"] = 3] = "LocalAudioStreamStateFailed";
1788
1842
  })(LocalAudioStreamState = exports.LocalAudioStreamState || (exports.LocalAudioStreamState = {}));
1789
1843
  /**
1790
- * Reasons for local audio state changes.
1844
+ * Reason for local audio state change.
1791
1845
  */
1792
1846
  var LocalAudioStreamReason;
1793
1847
  (function (LocalAudioStreamReason) {
1794
1848
  /**
1795
- * 0: The local audio is normal.
1849
+ * 0: Local audio state is normal.
1796
1850
  */
1797
1851
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonOk"] = 0] = "LocalAudioStreamReasonOk";
1798
1852
  /**
1799
- * 1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
1853
+ * 1: The reason for the local audio failure is unclear. It is recommended to prompt the user to try rejoining the channel.
1800
1854
  */
1801
1855
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonFailure"] = 1] = "LocalAudioStreamReasonFailure";
1802
1856
  /**
1803
- * 2: No permission to use the local audio capturing device. Remind your users to grant permission. Deprecated: This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
1857
+ * 2: No permission to start the local audio capture device. Prompt the user to enable permissions. Deprecated: This enumeration is deprecated. Use onPermissionError callback with RecordAudio instead.
1804
1858
  */
1805
1859
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonDeviceNoPermission"] = 2] = "LocalAudioStreamReasonDeviceNoPermission";
1806
1860
  /**
@@ -1808,19 +1862,19 @@ var LocalAudioStreamReason;
1808
1862
  */
1809
1863
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonDeviceBusy"] = 3] = "LocalAudioStreamReasonDeviceBusy";
1810
1864
  /**
1811
- * 4: The local audio capture fails.
1865
+ * 4: Local audio capture failed.
1812
1866
  */
1813
1867
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonRecordFailure"] = 4] = "LocalAudioStreamReasonRecordFailure";
1814
1868
  /**
1815
- * 5: The local audio encoding fails.
1869
+ * 5: Local audio encoding failed.
1816
1870
  */
1817
1871
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonEncodeFailure"] = 5] = "LocalAudioStreamReasonEncodeFailure";
1818
1872
  /**
1819
- * 6: No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control panel of the device or if the microphone is working properly.
1873
+ * 6: No local audio capture device. Prompt the user to check in the device control panel whether the microphone is properly connected and functioning.
1820
1874
  */
1821
1875
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonNoRecordingDevice"] = 6] = "LocalAudioStreamReasonNoRecordingDevice";
1822
1876
  /**
1823
- * 7: No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control panel of the device or if the speaker is working properly.
1877
+ * 7: No local audio playback device. Prompt the user to check in the device control panel whether the speaker is properly connected and functioning.
1824
1878
  */
1825
1879
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonNoPlayoutDevice"] = 7] = "LocalAudioStreamReasonNoPlayoutDevice";
1826
1880
  /**
@@ -1828,63 +1882,87 @@ var LocalAudioStreamReason;
1828
1882
  */
1829
1883
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonInterrupted"] = 8] = "LocalAudioStreamReasonInterrupted";
1830
1884
  /**
1831
- * 9: (Windows only) The ID of the local audio-capture device is invalid. Prompt the user to check the audio capture device ID.
1885
+ * 9: (Windows only) The ID of the local audio capture device is invalid. Prompt the user to check the audio capture device ID.
1832
1886
  */
1833
1887
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonRecordInvalidId"] = 9] = "LocalAudioStreamReasonRecordInvalidId";
1834
1888
  /**
1835
- * 10: (Windows only) The ID of the local audio-playback device is invalid. Prompt the user to check the audio playback device ID.
1889
+ * 10: (Windows only) The ID of the local audio playback device is invalid. Prompt the user to check the audio playback device ID.
1836
1890
  */
1837
1891
  LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonPlayoutInvalidId"] = 10] = "LocalAudioStreamReasonPlayoutInvalidId";
1838
1892
  })(LocalAudioStreamReason = exports.LocalAudioStreamReason || (exports.LocalAudioStreamReason = {}));
1839
1893
  /**
1840
- * Local video state types.
1894
+ * Local video state.
1841
1895
  */
1842
1896
  var LocalVideoStreamState;
1843
1897
  (function (LocalVideoStreamState) {
1844
1898
  /**
1845
- * 0: The local video is in the initial state.
1899
+ * 0: Default initial state of the local video.
1846
1900
  */
1847
1901
  LocalVideoStreamState[LocalVideoStreamState["LocalVideoStreamStateStopped"] = 0] = "LocalVideoStreamStateStopped";
1848
1902
  /**
1849
- * 1: The local video capturing device starts successfully.
1903
+ * 1: The local video capture device is started successfully.
1850
1904
  */
1851
1905
  LocalVideoStreamState[LocalVideoStreamState["LocalVideoStreamStateCapturing"] = 1] = "LocalVideoStreamStateCapturing";
1852
1906
  /**
1853
- * 2: The first video frame is successfully encoded.
1907
+ * 2: The first frame of local video is encoded successfully.
1854
1908
  */
1855
1909
  LocalVideoStreamState[LocalVideoStreamState["LocalVideoStreamStateEncoding"] = 2] = "LocalVideoStreamStateEncoding";
1856
1910
  /**
1857
- * 3: Fails to start the local video.
1911
+ * 3: Failed to start local video.
1858
1912
  */
1859
1913
  LocalVideoStreamState[LocalVideoStreamState["LocalVideoStreamStateFailed"] = 3] = "LocalVideoStreamStateFailed";
1860
1914
  })(LocalVideoStreamState = exports.LocalVideoStreamState || (exports.LocalVideoStreamState = {}));
1861
1915
  /**
1862
- * Reasons for local video state changes.
1916
+ * Local video event types.
1917
+ *
1918
+ * Since Available since v4.6.1.
1919
+ */
1920
+ var LocalVideoEventType;
1921
+ (function (LocalVideoEventType) {
1922
+ /**
1923
+ * (1): The screen capture window is hidden (Android only).
1924
+ */
1925
+ LocalVideoEventType[LocalVideoEventType["LocalVideoEventTypeScreenCaptureWindowHidden"] = 1] = "LocalVideoEventTypeScreenCaptureWindowHidden";
1926
+ /**
1927
+ * (2): The screen capture window recovers from hidden state (Android only).
1928
+ */
1929
+ LocalVideoEventType[LocalVideoEventType["LocalVideoEventTypeScreenCaptureWindowRecoverFromHidden"] = 2] = "LocalVideoEventTypeScreenCaptureWindowRecoverFromHidden";
1930
+ /**
1931
+ * (3): The screen capture is stopped by the user (Android only).
1932
+ */
1933
+ LocalVideoEventType[LocalVideoEventType["LocalVideoEventTypeScreenCaptureStoppedByUser"] = 3] = "LocalVideoEventTypeScreenCaptureStoppedByUser";
1934
+ /**
1935
+ * (4): A system internal error occurs during screen capture (Android only).
1936
+ */
1937
+ LocalVideoEventType[LocalVideoEventType["LocalVideoEventTypeScreenCaptureSystemInternalError"] = 4] = "LocalVideoEventTypeScreenCaptureSystemInternalError";
1938
+ })(LocalVideoEventType = exports.LocalVideoEventType || (exports.LocalVideoEventType = {}));
1939
+ /**
1940
+ * Reason for local video state change.
1863
1941
  */
1864
1942
  var LocalVideoStreamReason;
1865
1943
  (function (LocalVideoStreamReason) {
1866
1944
  /**
1867
- * 0: The local video is normal.
1945
+ * 0: Local video state is normal.
1868
1946
  */
1869
1947
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonOk"] = 0] = "LocalVideoStreamReasonOk";
1870
1948
  /**
1871
- * 1: No specified reason for the local video failure.
1949
+ * 1: Unknown error.
1872
1950
  */
1873
1951
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonFailure"] = 1] = "LocalVideoStreamReasonFailure";
1874
1952
  /**
1875
- * 2: No permission to use the local video capturing device. Prompt the user to grant permissions and rejoin the channel. Deprecated: This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
1953
+ * 2: No permission to start the local video capture device. Prompt the user to enable device permissions and rejoin the channel. Deprecated: This enumeration is deprecated. Use onPermissionError callback with Camera instead.
1876
1954
  */
1877
1955
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceNoPermission"] = 2] = "LocalVideoStreamReasonDeviceNoPermission";
1878
1956
  /**
1879
- * 3: The local video capturing device is in use. Prompt the user to check if the camera is being used by another app, or try to rejoin the channel.
1957
+ * 3: The local video capture device is in use. Prompt the user to check if the camera is occupied by another app or try rejoining the channel.
1880
1958
  */
1881
1959
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceBusy"] = 3] = "LocalVideoStreamReasonDeviceBusy";
1882
1960
  /**
1883
- * 4: The local video capture fails. Prompt the user to check whether the video capture device is working properly, whether the camera is used by another app, or try to rejoin the channel.
1961
+ * 4: Failed to capture local video. Prompt the user to check if the video capture device is working properly, whether the camera is occupied by another app, or try rejoining the channel.
1884
1962
  */
1885
1963
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonCaptureFailure"] = 4] = "LocalVideoStreamReasonCaptureFailure";
1886
1964
  /**
1887
- * 5: The local video encoding fails.
1965
+ * 5: Failed to encode local video.
1888
1966
  */
1889
1967
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonCodecNotSupport"] = 5] = "LocalVideoStreamReasonCodecNotSupport";
1890
1968
  /**
@@ -1896,15 +1974,15 @@ var LocalVideoStreamReason;
1896
1974
  */
1897
1975
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonCaptureMultipleForegroundApps"] = 7] = "LocalVideoStreamReasonCaptureMultipleForegroundApps";
1898
1976
  /**
1899
- * 8: Fails to find a local video capture device. Remind the user to check whether the camera is connected to the device properly or the camera is working properly, and then to rejoin the channel.
1977
+ * 8: Cannot find the local video capture device. Check if the camera is properly connected and functioning or try rejoining the channel.
1900
1978
  */
1901
1979
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceNotFound"] = 8] = "LocalVideoStreamReasonDeviceNotFound";
1902
1980
  /**
1903
- * 9: The video capture device currently in use is disconnected (such as being unplugged).
1981
+ * 9: The video capture device currently in use has been disconnected (e.g., unplugged).
1904
1982
  */
1905
1983
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceDisconnected"] = 9] = "LocalVideoStreamReasonDeviceDisconnected";
1906
1984
  /**
1907
- * 10: The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
1985
+ * 10: The SDK cannot find the video device in the device list. Check whether the video device ID is valid.
1908
1986
  */
1909
1987
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceInvalidId"] = 10] = "LocalVideoStreamReasonDeviceInvalidId";
1910
1988
  /**
@@ -1916,22 +1994,23 @@ var LocalVideoStreamReason;
1916
1994
  */
1917
1995
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceFatalError"] = 15] = "LocalVideoStreamReasonDeviceFatalError";
1918
1996
  /**
1919
- * 101: The current video capture device is unavailable due to excessive system pressure.
1997
+ * 101: The current video capture device is unavailable due to high system pressure.
1920
1998
  */
1921
1999
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceSystemPressure"] = 101] = "LocalVideoStreamReasonDeviceSystemPressure";
1922
2000
  /**
1923
- * 11: The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
2001
+ * 11: When calling startScreenCaptureByWindowId to share a window, the window is minimized. The SDK cannot share minimized windows. Prompt the user to restore the window.
1924
2002
  */
1925
2003
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowMinimized"] = 11] = "LocalVideoStreamReasonScreenCaptureWindowMinimized";
1926
2004
  /**
1927
- * 12: The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
2005
+ * 12: The window shared by window ID is closed, or the fullscreen window shared by window ID has exited fullscreen. After exiting fullscreen, remote users will not be able to see the shared window. To avoid showing a black screen to remote users, it is recommended to end the sharing session immediately.
2006
+ * Common scenarios reporting this error code:
1928
2007
  * The local user closes the shared window.
1929
- * The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
1930
- * The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
2008
+ * The local user plays a slideshow and shares the slideshow in presentation mode. When the presentation ends, the SDK reports this error code.
2009
+ * The local user views a web video or document in fullscreen and shares it. When exiting fullscreen, the SDK reports this error code.
1931
2010
  */
1932
2011
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowClosed"] = 12] = "LocalVideoStreamReasonScreenCaptureWindowClosed";
1933
2012
  /**
1934
- * 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
2013
+ * 13: (Windows only) The window to be shared is occluded by other windows. The occluded part will be blacked out by the SDK during sharing.
1935
2014
  */
1936
2015
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowOccluded"] = 13] = "LocalVideoStreamReasonScreenCaptureWindowOccluded";
1937
2016
  /**
@@ -1943,71 +2022,71 @@ var LocalVideoStreamReason;
1943
2022
  */
1944
2023
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureFailure"] = 21] = "LocalVideoStreamReasonScreenCaptureFailure";
1945
2024
  /**
1946
- * 22: No permission for screen capture.
2025
+ * 22: No permission to capture the screen.
1947
2026
  */
1948
2027
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureNoPermission"] = 22] = "LocalVideoStreamReasonScreenCaptureNoPermission";
1949
2028
  /**
1950
- * 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to window blocking failure), resulting in decreased performance, but the screen sharing process itself was not affected.
2029
+ * 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to failure to block the window), causing the screen sharing strategy to downgrade. The screen sharing process itself is not affected. During screen sharing, if blocking the specified window fails due to device driver issues, the SDK reports this event and automatically falls back to sharing the entire screen. If your use case requires blocking specific windows to protect privacy, listen for this event and implement additional privacy protection mechanisms when triggered.
1951
2030
  */
1952
2031
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureAutoFallback"] = 24] = "LocalVideoStreamReasonScreenCaptureAutoFallback";
1953
2032
  /**
1954
- * 25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
2033
+ * 25: (Windows only) The window currently being captured is hidden and not visible on the current screen.
1955
2034
  */
1956
2035
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowHidden"] = 25] = "LocalVideoStreamReasonScreenCaptureWindowHidden";
1957
2036
  /**
1958
- * 26: (Windows only) The window for screen capture has been restored from hidden state.
2037
+ * 26: (Windows only) The window being captured has recovered from a hidden state.
1959
2038
  */
1960
2039
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden"] = 26] = "LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden";
1961
2040
  /**
1962
- * 27: The window for screen capture has been restored from the minimized state.
2041
+ * 27: The window being captured has recovered from a minimized state.
1963
2042
  */
1964
2043
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized"] = 27] = "LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized";
1965
2044
  /**
1966
- * 28: (Windows only) Screen capture has been paused. Common scenarios reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
2045
+ * 28: (Windows only) Screen capture is paused. Common scenario: the screen may have switched to a secure desktop, such as a UAC dialog or Winlogon desktop.
1967
2046
  */
1968
2047
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCapturePaused"] = 28] = "LocalVideoStreamReasonScreenCapturePaused";
1969
2048
  /**
1970
- * 29: (Windows only) Screen capture has resumed from paused state.
2049
+ * 29: (Windows only) Screen capture has resumed from a paused state.
1971
2050
  */
1972
2051
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureResumed"] = 29] = "LocalVideoStreamReasonScreenCaptureResumed";
1973
2052
  /**
1974
- * 30: The displayer used for screen capture is disconnected. The current screen sharing has been paused. Prompt the user to restart the screen sharing.
2053
+ * 30: The display being captured is disconnected. When receiving this state, prompt the user that screen sharing is paused and restart screen sharing.
1975
2054
  */
1976
2055
  LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureDisplayDisconnected"] = 30] = "LocalVideoStreamReasonScreenCaptureDisplayDisconnected";
1977
2056
  })(LocalVideoStreamReason = exports.LocalVideoStreamReason || (exports.LocalVideoStreamReason = {}));
1978
2057
  /**
1979
- * Remote audio states.
2058
+ * State of the remote audio stream.
1980
2059
  */
1981
2060
  var RemoteAudioState;
1982
2061
  (function (RemoteAudioState) {
1983
2062
  /**
1984
- * 0: The local audio is in the initial state. The SDK reports this state in the case of RemoteAudioReasonLocalMuted, RemoteAudioReasonRemoteMuted or RemoteAudioReasonRemoteOffline.
2063
+ * 0: The default initial state of the remote audio. This state is reported under RemoteAudioReasonLocalMuted, RemoteAudioReasonRemoteMuted, or RemoteAudioReasonRemoteOffline.
1985
2064
  */
1986
2065
  RemoteAudioState[RemoteAudioState["RemoteAudioStateStopped"] = 0] = "RemoteAudioStateStopped";
1987
2066
  /**
1988
- * 1: The first remote audio packet is received.
2067
+ * 1: The local user has received the first packet of the remote audio.
1989
2068
  */
1990
2069
  RemoteAudioState[RemoteAudioState["RemoteAudioStateStarting"] = 1] = "RemoteAudioStateStarting";
1991
2070
  /**
1992
- * 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of RemoteAudioReasonNetworkRecovery, RemoteAudioReasonLocalUnmuted or RemoteAudioReasonRemoteUnmuted.
2071
+ * 2: The remote audio stream is being decoded and playing normally. This state is reported under RemoteAudioReasonNetworkRecovery, RemoteAudioReasonLocalUnmuted, or RemoteAudioReasonRemoteUnmuted.
1993
2072
  */
1994
2073
  RemoteAudioState[RemoteAudioState["RemoteAudioStateDecoding"] = 2] = "RemoteAudioStateDecoding";
1995
2074
  /**
1996
- * 3: The remote audio is frozen. The SDK reports this state in the case of RemoteAudioReasonNetworkCongestion.
2075
+ * 3: The remote audio stream is frozen. This state is reported under RemoteAudioReasonNetworkCongestion.
1997
2076
  */
1998
2077
  RemoteAudioState[RemoteAudioState["RemoteAudioStateFrozen"] = 3] = "RemoteAudioStateFrozen";
1999
2078
  /**
2000
- * 4: The remote audio fails to start. The SDK reports this state in the case of RemoteAudioReasonInternal.
2079
+ * 4: Failed to play the remote audio stream. This state is reported under RemoteAudioReasonInternal.
2001
2080
  */
2002
2081
  RemoteAudioState[RemoteAudioState["RemoteAudioStateFailed"] = 4] = "RemoteAudioStateFailed";
2003
2082
  })(RemoteAudioState = exports.RemoteAudioState || (exports.RemoteAudioState = {}));
2004
2083
  /**
2005
- * The reason for the remote audio state change.
2084
+ * Reason for remote audio stream state change.
2006
2085
  */
2007
2086
  var RemoteAudioStateReason;
2008
2087
  (function (RemoteAudioStateReason) {
2009
2088
  /**
2010
- * 0: The SDK reports this reason when the audio state changes.
2089
+ * 0: This reason is reported when the audio state changes.
2011
2090
  */
2012
2091
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonInternal"] = 0] = "RemoteAudioReasonInternal";
2013
2092
  /**
@@ -2015,27 +2094,27 @@ var RemoteAudioStateReason;
2015
2094
  */
2016
2095
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonNetworkCongestion"] = 1] = "RemoteAudioReasonNetworkCongestion";
2017
2096
  /**
2018
- * 2: Network recovery.
2097
+ * 2: Network recovered.
2019
2098
  */
2020
2099
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonNetworkRecovery"] = 2] = "RemoteAudioReasonNetworkRecovery";
2021
2100
  /**
2022
- * 3: The local user stops receiving the remote audio stream or disables the audio module.
2101
+ * 3: Local user stopped receiving remote audio stream or disabled the audio module.
2023
2102
  */
2024
2103
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonLocalMuted"] = 3] = "RemoteAudioReasonLocalMuted";
2025
2104
  /**
2026
- * 4: The local user resumes receiving the remote audio stream or enables the audio module.
2105
+ * 4: Local user resumed receiving remote audio stream or enabled the audio module.
2027
2106
  */
2028
2107
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonLocalUnmuted"] = 4] = "RemoteAudioReasonLocalUnmuted";
2029
2108
  /**
2030
- * 5: The remote user stops sending the audio stream or disables the audio module.
2109
+ * 5: Remote user stopped sending audio stream or disabled the audio module.
2031
2110
  */
2032
2111
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonRemoteMuted"] = 5] = "RemoteAudioReasonRemoteMuted";
2033
2112
  /**
2034
- * 6: The remote user resumes sending the audio stream or enables the audio module.
2113
+ * 6: Remote user resumed sending audio stream or enabled the audio module.
2035
2114
  */
2036
2115
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonRemoteUnmuted"] = 6] = "RemoteAudioReasonRemoteUnmuted";
2037
2116
  /**
2038
- * 7: The remote user leaves the channel.
2117
+ * 7: Remote user left the channel.
2039
2118
  */
2040
2119
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonRemoteOffline"] = 7] = "RemoteAudioReasonRemoteOffline";
2041
2120
  /**
@@ -2048,38 +2127,38 @@ var RemoteAudioStateReason;
2048
2127
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonLocalPlayFailed"] = 9] = "RemoteAudioReasonLocalPlayFailed";
2049
2128
  })(RemoteAudioStateReason = exports.RemoteAudioStateReason || (exports.RemoteAudioStateReason = {}));
2050
2129
  /**
2051
- * The state of the remote video stream.
2130
+ * State of the remote video stream.
2052
2131
  */
2053
2132
  var RemoteVideoState;
2054
2133
  (function (RemoteVideoState) {
2055
2134
  /**
2056
- * 0: The remote video is in the initial state. The SDK reports this state in the case of RemoteVideoStateReasonLocalMuted, RemoteVideoStateReasonRemoteMuted, or RemoteVideoStateReasonRemoteOffline.
2135
+ * 0: The default initial state of the remote video. This state is reported under RemoteVideoStateReasonLocalMuted, RemoteVideoStateReasonRemoteMuted, or RemoteVideoStateReasonRemoteOffline.
2057
2136
  */
2058
2137
  RemoteVideoState[RemoteVideoState["RemoteVideoStateStopped"] = 0] = "RemoteVideoStateStopped";
2059
2138
  /**
2060
- * 1: The first remote video packet is received.
2139
+ * 1: The local user has received the first packet of the remote video.
2061
2140
  */
2062
2141
  RemoteVideoState[RemoteVideoState["RemoteVideoStateStarting"] = 1] = "RemoteVideoStateStarting";
2063
2142
  /**
2064
- * 2: The remote video stream is decoded and plays normally. The SDK reports this state in the case of RemoteVideoStateReasonNetworkRecovery, RemoteVideoStateReasonLocalUnmuted, or RemoteVideoStateReasonRemoteUnmuted.
2143
+ * 2: The remote video stream is being decoded and playing normally. This state is reported under RemoteVideoStateReasonNetworkRecovery, RemoteVideoStateReasonLocalUnmuted, or RemoteVideoStateReasonRemoteUnmuted.
2065
2144
  */
2066
2145
  RemoteVideoState[RemoteVideoState["RemoteVideoStateDecoding"] = 2] = "RemoteVideoStateDecoding";
2067
2146
  /**
2068
- * 3: The remote video is frozen. The SDK reports this state in the case of RemoteVideoStateReasonNetworkCongestion.
2147
+ * 3: The remote video stream is frozen. This state is reported under RemoteVideoStateReasonNetworkCongestion.
2069
2148
  */
2070
2149
  RemoteVideoState[RemoteVideoState["RemoteVideoStateFrozen"] = 3] = "RemoteVideoStateFrozen";
2071
2150
  /**
2072
- * 4: The remote video fails to start. The SDK reports this state in the case of RemoteVideoStateReasonInternal.
2151
+ * 4: Failed to play the remote video stream. This state is reported under RemoteVideoStateReasonInternal.
2073
2152
  */
2074
2153
  RemoteVideoState[RemoteVideoState["RemoteVideoStateFailed"] = 4] = "RemoteVideoStateFailed";
2075
2154
  })(RemoteVideoState = exports.RemoteVideoState || (exports.RemoteVideoState = {}));
2076
2155
  /**
2077
- * The reason for the remote video state change.
2156
+ * Reasons for remote video stream state changes.
2078
2157
  */
2079
2158
  var RemoteVideoStateReason;
2080
2159
  (function (RemoteVideoStateReason) {
2081
2160
  /**
2082
- * 0: The SDK reports this reason when the video state changes.
2161
+ * 0: This reason is reported when the video state changes.
2083
2162
  */
2084
2163
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonInternal"] = 0] = "RemoteVideoStateReasonInternal";
2085
2164
  /**
@@ -2087,7 +2166,7 @@ var RemoteVideoStateReason;
2087
2166
  */
2088
2167
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonNetworkCongestion"] = 1] = "RemoteVideoStateReasonNetworkCongestion";
2089
2168
  /**
2090
- * 2: Network is recovered.
2169
+ * 2: Network recovery.
2091
2170
  */
2092
2171
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonNetworkRecovery"] = 2] = "RemoteVideoStateReasonNetworkRecovery";
2093
2172
  /**
@@ -2111,11 +2190,11 @@ var RemoteVideoStateReason;
2111
2190
  */
2112
2191
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonRemoteOffline"] = 7] = "RemoteVideoStateReasonRemoteOffline";
2113
2192
  /**
2114
- * 8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions.
2193
+ * 8: Under poor network conditions, the remote audio and video stream falls back to audio only.
2115
2194
  */
2116
2195
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonAudioFallback"] = 8] = "RemoteVideoStateReasonAudioFallback";
2117
2196
  /**
2118
- * 9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve.
2197
+ * 9: When the network improves, the remote audio stream recovers to audio and video.
2119
2198
  */
2120
2199
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonAudioFallbackRecovery"] = 9] = "RemoteVideoStateReasonAudioFallbackRecovery";
2121
2200
  /**
@@ -2131,7 +2210,7 @@ var RemoteVideoStateReason;
2131
2210
  */
2132
2211
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonSdkInBackground"] = 12] = "RemoteVideoStateReasonSdkInBackground";
2133
2212
  /**
2134
- * 13: The local video decoder does not support decoding the remote video stream.
2213
+ * 13: The local video decoder does not support decoding the received remote video stream.
2135
2214
  */
2136
2215
  RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonCodecNotSupport"] = 13] = "RemoteVideoStateReasonCodecNotSupport";
2137
2216
  })(RemoteVideoStateReason = exports.RemoteVideoStateReason || (exports.RemoteVideoStateReason = {}));
@@ -2190,13 +2269,13 @@ var RemoteVideoDownscaleLevel;
2190
2269
  RemoteVideoDownscaleLevel[RemoteVideoDownscaleLevel["RemoteVideoDownscaleLevel4"] = 4] = "RemoteVideoDownscaleLevel4";
2191
2270
  })(RemoteVideoDownscaleLevel = exports.RemoteVideoDownscaleLevel || (exports.RemoteVideoDownscaleLevel = {}));
2192
2271
  /**
2193
- * The volume information of users.
2272
+ * User volume information.
2194
2273
  */
2195
2274
  class AudioVolumeInfo {
2196
2275
  }
2197
2276
  exports.AudioVolumeInfo = AudioVolumeInfo;
2198
2277
  /**
2199
- * The audio device information.
2278
+ * Audio device information.
2200
2279
  */
2201
2280
  class DeviceInfo {
2202
2281
  }
@@ -2208,7 +2287,7 @@ class Packet {
2208
2287
  }
2209
2288
  exports.Packet = Packet;
2210
2289
  /**
2211
- * The audio sampling rate of the stream to be pushed to the CDN.
2290
+ * Sampling rate of audio for stream output.
2212
2291
  */
2213
2292
  var AudioSampleRateType;
2214
2293
  (function (AudioSampleRateType) {
@@ -2226,7 +2305,7 @@ var AudioSampleRateType;
2226
2305
  AudioSampleRateType[AudioSampleRateType["AudioSampleRate48000"] = 48000] = "AudioSampleRate48000";
2227
2306
  })(AudioSampleRateType = exports.AudioSampleRateType || (exports.AudioSampleRateType = {}));
2228
2307
  /**
2229
- * The codec type of the output video.
2308
+ * Codec type for transcoded output video stream.
2230
2309
  */
2231
2310
  var VideoCodecTypeForStream;
2232
2311
  (function (VideoCodecTypeForStream) {
@@ -2240,38 +2319,38 @@ var VideoCodecTypeForStream;
2240
2319
  VideoCodecTypeForStream[VideoCodecTypeForStream["VideoCodecH265ForStream"] = 2] = "VideoCodecH265ForStream";
2241
2320
  })(VideoCodecTypeForStream = exports.VideoCodecTypeForStream || (exports.VideoCodecTypeForStream = {}));
2242
2321
  /**
2243
- * Video codec profile types.
2322
+ * Codec profile for video in CDN streaming.
2244
2323
  */
2245
2324
  var VideoCodecProfileType;
2246
2325
  (function (VideoCodecProfileType) {
2247
2326
  /**
2248
- * 66: Baseline video codec profile; generally used for video calls on mobile phones.
2327
+ * 66: Baseline level video codec profile, typically used in low-end or error-tolerant applications such as video calls and mobile videos.
2249
2328
  */
2250
2329
  VideoCodecProfileType[VideoCodecProfileType["VideoCodecProfileBaseline"] = 66] = "VideoCodecProfileBaseline";
2251
2330
  /**
2252
- * 77: Main video codec profile; generally used in mainstream electronics such as MP4 players, portable video players, PSP, and iPads.
2331
+ * 77: Main level video codec profile, typically used in mainstream consumer electronics such as MP4, portable video players, PSP, iPad, etc.
2253
2332
  */
2254
2333
  VideoCodecProfileType[VideoCodecProfileType["VideoCodecProfileMain"] = 77] = "VideoCodecProfileMain";
2255
2334
  /**
2256
- * 100: (Default) High video codec profile; generally used in high-resolution live streaming or television.
2335
+ * 100: (Default) High level video codec profile, typically used in broadcasting, video disc storage, and HDTV.
2257
2336
  */
2258
2337
  VideoCodecProfileType[VideoCodecProfileType["VideoCodecProfileHigh"] = 100] = "VideoCodecProfileHigh";
2259
2338
  })(VideoCodecProfileType = exports.VideoCodecProfileType || (exports.VideoCodecProfileType = {}));
2260
2339
  /**
2261
- * Self-defined audio codec profile.
2340
+ * Audio codec profile for stream publishing output. Defaults to LC-AAC.
2262
2341
  */
2263
2342
  var AudioCodecProfileType;
2264
2343
  (function (AudioCodecProfileType) {
2265
2344
  /**
2266
- * 0: (Default) LC-AAC.
2345
+ * 0: (Default) LC-AAC profile.
2267
2346
  */
2268
2347
  AudioCodecProfileType[AudioCodecProfileType["AudioCodecProfileLcAac"] = 0] = "AudioCodecProfileLcAac";
2269
2348
  /**
2270
- * 1: HE-AAC.
2349
+ * 1: HE-AAC profile.
2271
2350
  */
2272
2351
  AudioCodecProfileType[AudioCodecProfileType["AudioCodecProfileHeAac"] = 1] = "AudioCodecProfileHeAac";
2273
2352
  /**
2274
- * 2: HE-AAC v2.
2353
+ * 2: HE-AAC v2 profile.
2275
2354
  */
2276
2355
  AudioCodecProfileType[AudioCodecProfileType["AudioCodecProfileHeAacV2"] = 2] = "AudioCodecProfileHeAacV2";
2277
2356
  })(AudioCodecProfileType = exports.AudioCodecProfileType || (exports.AudioCodecProfileType = {}));
@@ -2282,96 +2361,96 @@ class LocalAudioStats {
2282
2361
  }
2283
2362
  exports.LocalAudioStats = LocalAudioStats;
2284
2363
  /**
2285
- * States of the Media Push.
2364
+ * RTMP stream publishing state.
2286
2365
  */
2287
2366
  var RtmpStreamPublishState;
2288
2367
  (function (RtmpStreamPublishState) {
2289
2368
  /**
2290
- * 0: The Media Push has not started or has ended.
2369
+ * 0: Stream publishing not started or already ended.
2291
2370
  */
2292
2371
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateIdle"] = 0] = "RtmpStreamPublishStateIdle";
2293
2372
  /**
2294
- * 1: The streaming server and CDN server are being connected.
2373
+ * 1: Connecting to the streaming server and CDN server.
2295
2374
  */
2296
2375
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateConnecting"] = 1] = "RtmpStreamPublishStateConnecting";
2297
2376
  /**
2298
- * 2: The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
2377
+ * 2: Stream publishing is in progress. This state is returned after successful publishing.
2299
2378
  */
2300
2379
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRunning"] = 2] = "RtmpStreamPublishStateRunning";
2301
2380
  /**
2302
- * 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.
2303
- * If the SDK successfully resumes the streaming, RtmpStreamPublishStateRunning (2) returns.
2304
- * If the streaming does not resume within 60 seconds or server errors occur, RtmpStreamPublishStateFailure (4) returns. If you feel that 60 seconds is too long, you can also actively try to reconnect.
2381
+ * 3: Recovering stream publishing. When the CDN encounters an exception or the stream is briefly interrupted, the SDK automatically attempts to recover the stream and returns this state.
2382
+ * If recovery is successful, it enters the RtmpStreamPublishStateRunning(2) state.
2383
+ * If the server encounters an error or recovery fails within 60 seconds, it enters the RtmpStreamPublishStateFailure(4) state. If 60 seconds is too long, you can also try to reconnect manually.
2305
2384
  */
2306
2385
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRecovering"] = 3] = "RtmpStreamPublishStateRecovering";
2307
2386
  /**
2308
- * 4: The RTMP or RTMPS streaming fails. After a failure, you can troubleshoot the cause of the error through the returned error code.
2387
+ * 4: Stream publishing failed. After failure, you can troubleshoot the issue using the returned error code.
2309
2388
  */
2310
2389
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateFailure"] = 4] = "RtmpStreamPublishStateFailure";
2311
2390
  /**
2312
- * 5: The SDK is disconnecting from the Agora streaming server and CDN. When you call stopRtmpStream to stop the Media Push normally, the SDK reports the Media Push state as RtmpStreamPublishStateDisconnecting and RtmpStreamPublishStateIdle in sequence.
2391
+ * 5: The SDK is disconnecting from the streaming server and CDN server. When you call the stopRtmpStream method to end the stream normally, the SDK sequentially reports the stream states as RtmpStreamPublishStateDisconnecting and RtmpStreamPublishStateIdle.
2313
2392
  */
2314
2393
  RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateDisconnecting"] = 5] = "RtmpStreamPublishStateDisconnecting";
2315
2394
  })(RtmpStreamPublishState = exports.RtmpStreamPublishState || (exports.RtmpStreamPublishState = {}));
2316
2395
  /**
2317
- * Reasons for changes in the status of RTMP or RTMPS streaming.
2396
+ * The reason for RTMP stream state change.
2318
2397
  */
2319
2398
  var RtmpStreamPublishReason;
2320
2399
  (function (RtmpStreamPublishReason) {
2321
2400
  /**
2322
- * 0: The RTMP or RTMPS streaming has not started or has ended.
2401
+ * 0: Stream published successfully.
2323
2402
  */
2324
2403
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonOk"] = 0] = "RtmpStreamPublishReasonOk";
2325
2404
  /**
2326
- * 1: Invalid argument used. Check the parameter setting.
2405
+ * 1: Invalid parameter. Please check whether the input parameters are correct.
2327
2406
  */
2328
2407
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonInvalidArgument"] = 1] = "RtmpStreamPublishReasonInvalidArgument";
2329
2408
  /**
2330
- * 2: The RTMP or RTMPS streaming is encrypted and cannot be published.
2409
+ * 2: The stream is encrypted and cannot be published.
2331
2410
  */
2332
2411
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonEncryptedStreamNotAllowed"] = 2] = "RtmpStreamPublishReasonEncryptedStreamNotAllowed";
2333
2412
  /**
2334
- * 3: Timeout for the RTMP or RTMPS streaming.
2413
+ * 3: Stream publishing timed out and failed.
2335
2414
  */
2336
2415
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonConnectionTimeout"] = 3] = "RtmpStreamPublishReasonConnectionTimeout";
2337
2416
  /**
2338
- * 4: An error occurs in Agora's streaming server.
2417
+ * 4: Error occurred on the streaming server.
2339
2418
  */
2340
2419
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonInternalServerError"] = 4] = "RtmpStreamPublishReasonInternalServerError";
2341
2420
  /**
2342
- * 5: An error occurs in the CDN server.
2421
+ * 5: Error occurred on the CDN server.
2343
2422
  */
2344
2423
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonRtmpServerError"] = 5] = "RtmpStreamPublishReasonRtmpServerError";
2345
2424
  /**
2346
- * 6: The RTMP or RTMPS streaming publishes too frequently.
2425
+ * 6: Stream publishing requests are too frequent.
2347
2426
  */
2348
2427
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonTooOften"] = 6] = "RtmpStreamPublishReasonTooOften";
2349
2428
  /**
2350
- * 7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
2429
+ * 7: The number of stream URLs for a single broadcaster has reached the limit of 10. Please delete some unused stream URLs before adding new ones.
2351
2430
  */
2352
2431
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonReachLimit"] = 7] = "RtmpStreamPublishReasonReachLimit";
2353
2432
  /**
2354
- * 8: The host manipulates other hosts' URLs. For example, the host updates or stops other hosts' streams. Check your app logic.
2433
+ * 8: The broadcaster is operating on a stream that does not belong to them. For example, updating another broadcaster's stream parameters or stopping another broadcaster's stream. Please check your app logic.
2355
2434
  */
2356
2435
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonNotAuthorized"] = 8] = "RtmpStreamPublishReasonNotAuthorized";
2357
2436
  /**
2358
- * 9: Agora's server fails to find the RTMP or RTMPS streaming.
2437
+ * 9: The server did not find the stream.
2359
2438
  */
2360
2439
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonStreamNotFound"] = 9] = "RtmpStreamPublishReasonStreamNotFound";
2361
2440
  /**
2362
- * 10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
2441
+ * 10: The stream URL format is incorrect. Please check whether the stream URL format is correct.
2363
2442
  */
2364
2443
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonFormatNotSupported"] = 10] = "RtmpStreamPublishReasonFormatNotSupported";
2365
2444
  /**
2366
- * 11: The user role is not host, so the user cannot use the CDN live streaming function. Check your application code logic.
2445
+ * 11: The user is not a broadcaster and cannot use the stream publishing feature. Please check your app logic.
2367
2446
  */
2368
2447
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonNotBroadcaster"] = 11] = "RtmpStreamPublishReasonNotBroadcaster";
2369
2448
  /**
2370
- * 13: The updateRtmpTranscoding method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
2449
+ * 13: The updateRtmpTranscoding method was called to update transcoding properties without enabling transcoding. Please check your app logic.
2371
2450
  */
2372
2451
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonTranscodingNoMixStream"] = 13] = "RtmpStreamPublishReasonTranscodingNoMixStream";
2373
2452
  /**
2374
- * 14: Errors occurred in the host's network.
2453
+ * 14: The broadcaster's network encountered an error.
2375
2454
  */
2376
2455
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonNetDown"] = 14] = "RtmpStreamPublishReasonNetDown";
2377
2456
  /**
@@ -2379,7 +2458,7 @@ var RtmpStreamPublishReason;
2379
2458
  */
2380
2459
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonInvalidAppid"] = 15] = "RtmpStreamPublishReasonInvalidAppid";
2381
2460
  /**
2382
- * 16: Your project does not have permission to use streaming services.
2461
+ * 16: Your project does not have permission to use the stream publishing service.
2383
2462
  */
2384
2463
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonInvalidPrivilege"] = 16] = "RtmpStreamPublishReasonInvalidPrivilege";
2385
2464
  /**
@@ -2388,266 +2467,262 @@ var RtmpStreamPublishReason;
2388
2467
  RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamUnpublishReasonOk"] = 100] = "RtmpStreamUnpublishReasonOk";
2389
2468
  })(RtmpStreamPublishReason = exports.RtmpStreamPublishReason || (exports.RtmpStreamPublishReason = {}));
2390
2469
  /**
2391
- * Events during the Media Push.
2470
+ * Events that occur during RTMP streaming.
2392
2471
  */
2393
2472
  var RtmpStreamingEvent;
2394
2473
  (function (RtmpStreamingEvent) {
2395
2474
  /**
2396
- * 1: An error occurs when you add a background image or a watermark image in the Media Push.
2475
+ * 1: Error adding background image or watermark during RTMP streaming.
2397
2476
  */
2398
2477
  RtmpStreamingEvent[RtmpStreamingEvent["RtmpStreamingEventFailedLoadImage"] = 1] = "RtmpStreamingEventFailedLoadImage";
2399
2478
  /**
2400
- * 2: The streaming URL is already being used for Media Push. If you want to start new streaming, use a new streaming URL.
2479
+ * 2: The stream URL is already in use. If you want to start a new stream, please use a new stream URL.
2401
2480
  */
2402
2481
  RtmpStreamingEvent[RtmpStreamingEvent["RtmpStreamingEventUrlAlreadyInUse"] = 2] = "RtmpStreamingEventUrlAlreadyInUse";
2403
2482
  /**
2404
- * 3: The feature is not supported.
2483
+ * 3: Feature not supported.
2405
2484
  */
2406
2485
  RtmpStreamingEvent[RtmpStreamingEvent["RtmpStreamingEventAdvancedFeatureNotSupport"] = 3] = "RtmpStreamingEventAdvancedFeatureNotSupport";
2407
2486
  /**
2408
- * 4: Reserved.
2487
+ * 4: Reserved parameter.
2409
2488
  */
2410
2489
  RtmpStreamingEvent[RtmpStreamingEvent["RtmpStreamingEventRequestTooOften"] = 4] = "RtmpStreamingEventRequestTooOften";
2411
2490
  })(RtmpStreamingEvent = exports.RtmpStreamingEvent || (exports.RtmpStreamingEvent = {}));
2412
2491
  /**
2413
2492
  * Image properties.
2414
2493
  *
2415
- * This class sets the properties of the watermark and background images in the live video.
2494
+ * Used to set watermark and background image properties for live video.
2416
2495
  */
2417
2496
  class RtcImage {
2418
2497
  }
2419
2498
  exports.RtcImage = RtcImage;
2420
2499
  /**
2421
- * The configuration for advanced features of the RTMP or RTMPS streaming with transcoding.
2500
+ * Advanced feature configuration for live transcoding.
2422
2501
  *
2423
- * If you want to enable the advanced features of streaming with transcoding, contact.
2502
+ * To use advanced features for live transcoding, please [contact sales](mailto:support@agora.io).
2424
2503
  */
2425
2504
  class LiveStreamAdvancedFeature {
2426
2505
  }
2427
2506
  exports.LiveStreamAdvancedFeature = LiveStreamAdvancedFeature;
2428
2507
  /**
2429
- * Connection states.
2508
+ * Network connection state.
2430
2509
  */
2431
2510
  var ConnectionStateType;
2432
2511
  (function (ConnectionStateType) {
2433
2512
  /**
2434
- * 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases:
2435
- * Theinitial state before calling the joinChannel method.
2436
- * The app calls the leaveChannel method.
2513
+ * 1: Disconnected from the network. This state indicates that the SDK is:
2514
+ * In the initialization phase before calling joinChannel.
2515
+ * Or in the leave phase after calling leaveChannel.
2437
2516
  */
2438
2517
  ConnectionStateType[ConnectionStateType["ConnectionStateDisconnected"] = 1] = "ConnectionStateDisconnected";
2439
2518
  /**
2440
- * 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls joinChannel.
2441
- * If the SDK successfully joins the channel, it triggers the onConnectionStateChanged callback and the connection state switches to ConnectionStateConnected.
2442
- * After the connection is established, the SDK also initializes the media and triggers onJoinChannelSuccess when everything is ready.
2519
+ * 2: Connecting to the network. This state indicates that the SDK is establishing a connection to the specified channel after calling joinChannel.
2520
+ * If the channel is joined successfully, the app receives the onConnectionStateChanged callback indicating the network state has changed to ConnectionStateConnected.
2521
+ * After the connection is established, the SDK initializes media and triggers the onJoinChannelSuccess callback when ready.
2443
2522
  */
2444
2523
  ConnectionStateType[ConnectionStateType["ConnectionStateConnecting"] = 2] = "ConnectionStateConnecting";
2445
2524
  /**
2446
- * 3: The SDK is connected to the Agora edge server. This state also indicates that the user has joined a channel and can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, if the network is down or switched, the SDK automatically tries to reconnect and triggers onConnectionStateChanged callback, notifying that the current network state becomes ConnectionStateReconnecting.
2525
+ * 3: Connected to the network. This state indicates that the user has joined the channel and can publish or subscribe to media streams. If the connection is interrupted due to network issues or switching, the SDK automatically reconnects. The app receives the onConnectionStateChanged callback indicating the network state has changed to ConnectionStateReconnecting.
2447
2526
  */
2448
2527
  ConnectionStateType[ConnectionStateType["ConnectionStateConnected"] = 3] = "ConnectionStateConnected";
2449
2528
  /**
2450
- * 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
2451
- * If the SDK cannot rejoin the channel within 10 seconds, it triggers onConnectionLost, stays in the ConnectionStateReconnecting state, and keeps rejoining the channel.
2452
- * If the SDK fails to rejoin the channel 20 minutes after being disconnected from the Agora edge server, the SDK triggers the onConnectionStateChanged callback, switches to the ConnectionStateFailed state, and stops rejoining the channel.
2529
+ * 4: Reconnecting to the network. This state indicates that the SDK was previously connected to the channel but the connection was interrupted due to network issues. The SDK is now trying to reconnect to the channel.
2530
+ * If the SDK fails to rejoin the channel within 10 seconds, onConnectionLost is triggered. The SDK remains in the ConnectionStateReconnecting state and continues trying to rejoin.
2531
+ * If the SDK fails to rejoin the channel within 20 minutes after disconnection, the app receives the onConnectionStateChanged callback indicating the network state has changed to ConnectionStateFailed, and the SDK stops trying to reconnect.
2453
2532
  */
2454
2533
  ConnectionStateType[ConnectionStateType["ConnectionStateReconnecting"] = 4] = "ConnectionStateReconnecting";
2455
2534
  /**
2456
- * 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call leaveChannel to leave the channel.
2457
- * You can call joinChannel to rejoin the channel.
2458
- * If the SDK is banned from joining the channel by the Agora edge server through the RESTful API, the SDK triggers the onConnectionStateChanged callback.
2535
+ * 5: Network connection failed. This state indicates that the SDK has stopped trying to rejoin the channel. You need to call leaveChannel to leave the channel.
2536
+ * If the user wants to rejoin the channel, call joinChannel again.
2537
+ * If the SDK is banned from joining the channel by the server using RESTful API, the app receives the onConnectionStateChanged callback.
2459
2538
  */
2460
2539
  ConnectionStateType[ConnectionStateType["ConnectionStateFailed"] = 5] = "ConnectionStateFailed";
2461
2540
  })(ConnectionStateType = exports.ConnectionStateType || (exports.ConnectionStateType = {}));
2462
2541
  /**
2463
- * Transcoding configurations of each host.
2542
+ * Settings for each host participating in the transcoding mix.
2464
2543
  */
2465
2544
  class TranscodingUser {
2466
2545
  }
2467
2546
  exports.TranscodingUser = TranscodingUser;
2468
2547
  /**
2469
- * Transcoding configurations for Media Push.
2548
+ * Transcoding properties for RTMP streaming.
2470
2549
  */
2471
2550
  class LiveTranscoding {
2472
2551
  }
2473
2552
  exports.LiveTranscoding = LiveTranscoding;
2474
2553
  /**
2475
- * The video streams for local video mixing.
2554
+ * Video stream participating in local compositing.
2476
2555
  */
2477
2556
  class TranscodingVideoStream {
2478
2557
  }
2479
2558
  exports.TranscodingVideoStream = TranscodingVideoStream;
2480
2559
  /**
2481
- * The configuration of the video mixing on the local client.
2560
+ * Configuration for local video compositing.
2482
2561
  */
2483
2562
  class LocalTranscoderConfiguration {
2484
2563
  }
2485
2564
  exports.LocalTranscoderConfiguration = LocalTranscoderConfiguration;
2486
2565
  /**
2487
- * The error code of the local video mixing failure.
2566
+ * Local composition error codes.
2488
2567
  */
2489
2568
  var VideoTranscoderError;
2490
2569
  (function (VideoTranscoderError) {
2491
2570
  /**
2492
- * 1: The selected video source has not started video capture. You need to create a video track for it and start video capture.
2571
+ * 1: The specified video source has not started video capture. You need to create a video track for it and start video capture.
2493
2572
  */
2494
2573
  VideoTranscoderError[VideoTranscoderError["VtErrVideoSourceNotReady"] = 1] = "VtErrVideoSourceNotReady";
2495
2574
  /**
2496
- * 2: The video source type is invalid. You need to re-specify the supported video source type.
2575
+ * 2: Invalid video source type. You need to reassign a supported video source type.
2497
2576
  */
2498
2577
  VideoTranscoderError[VideoTranscoderError["VtErrInvalidVideoSourceType"] = 2] = "VtErrInvalidVideoSourceType";
2499
2578
  /**
2500
- * 3: The image path is invalid. You need to re-specify the correct image path.
2579
+ * 3: Invalid image path. You need to reassign the correct image path.
2501
2580
  */
2502
2581
  VideoTranscoderError[VideoTranscoderError["VtErrInvalidImagePath"] = 3] = "VtErrInvalidImagePath";
2503
2582
  /**
2504
- * 4: The image format is invalid. Make sure the image format is one of PNG, JPEG, or GIF.
2583
+ * 4: Invalid image format. Make sure the image format is one of PNG, JPEG, or GIF.
2505
2584
  */
2506
2585
  VideoTranscoderError[VideoTranscoderError["VtErrUnsupportImageFormat"] = 4] = "VtErrUnsupportImageFormat";
2507
2586
  /**
2508
- * 5: The video encoding resolution after video mixing is invalid.
2587
+ * 5: The encoded resolution of the composed video is invalid.
2509
2588
  */
2510
2589
  VideoTranscoderError[VideoTranscoderError["VtErrInvalidLayout"] = 5] = "VtErrInvalidLayout";
2511
2590
  /**
2512
- * 20: Unknown internal error.
2591
+ * 20: Internal unknown error.
2513
2592
  */
2514
2593
  VideoTranscoderError[VideoTranscoderError["VtErrInternal"] = 20] = "VtErrInternal";
2515
2594
  })(VideoTranscoderError = exports.VideoTranscoderError || (exports.VideoTranscoderError = {}));
2516
2595
  /**
2517
- * The source of the audio streams that are mixed locally.
2596
+ * An audio source for local audio mixing.
2518
2597
  */
2519
2598
  class MixedAudioStream {
2520
2599
  }
2521
2600
  exports.MixedAudioStream = MixedAudioStream;
2522
2601
  /**
2523
- * The configurations for mixing the lcoal audio.
2602
+ * Local audio mixing configuration.
2524
2603
  */
2525
2604
  class LocalAudioMixerConfiguration {
2526
2605
  }
2527
2606
  exports.LocalAudioMixerConfiguration = LocalAudioMixerConfiguration;
2528
2607
  /**
2529
- * Configurations of the last-mile network test.
2608
+ * Configuration for last mile network probe.
2530
2609
  */
2531
2610
  class LastmileProbeConfig {
2532
2611
  }
2533
2612
  exports.LastmileProbeConfig = LastmileProbeConfig;
2534
2613
  /**
2535
- * The status of the last-mile probe test.
2614
+ * Status of last mile quality probe result.
2536
2615
  */
2537
2616
  var LastmileProbeResultState;
2538
2617
  (function (LastmileProbeResultState) {
2539
2618
  /**
2540
- * 1: The last-mile network probe test is complete.
2619
+ * 1: Indicates the result of this last mile quality probe is complete.
2541
2620
  */
2542
2621
  LastmileProbeResultState[LastmileProbeResultState["LastmileProbeResultComplete"] = 1] = "LastmileProbeResultComplete";
2543
2622
  /**
2544
- * 2: The last-mile network probe test is incomplete because the bandwidth estimation is not available due to limited test resources. One possible reason is that testing resources are temporarily limited.
2623
+ * 2: Indicates the last mile quality probe did not perform bandwidth estimation, so the result is incomplete. One possible reason is temporary limitation of testing resources.
2545
2624
  */
2546
2625
  LastmileProbeResultState[LastmileProbeResultState["LastmileProbeResultIncompleteNoBwe"] = 2] = "LastmileProbeResultIncompleteNoBwe";
2547
2626
  /**
2548
- * 3: The last-mile network probe test is not carried out. Probably due to poor network conditions.
2627
+ * 3: Last mile quality probe was not performed. One possible reason is network disconnection.
2549
2628
  */
2550
2629
  LastmileProbeResultState[LastmileProbeResultState["LastmileProbeResultUnavailable"] = 3] = "LastmileProbeResultUnavailable";
2551
2630
  })(LastmileProbeResultState = exports.LastmileProbeResultState || (exports.LastmileProbeResultState = {}));
2552
2631
  /**
2553
- * Results of the uplink or downlink last-mile network test.
2632
+ * Last mile uplink or downlink network quality probe result.
2554
2633
  */
2555
2634
  class LastmileProbeOneWayResult {
2556
2635
  }
2557
2636
  exports.LastmileProbeOneWayResult = LastmileProbeOneWayResult;
2558
2637
  /**
2559
- * Results of the uplink and downlink last-mile network tests.
2638
+ * Last mile uplink and downlink network quality probe result.
2560
2639
  */
2561
2640
  class LastmileProbeResult {
2562
2641
  }
2563
2642
  exports.LastmileProbeResult = LastmileProbeResult;
2564
2643
  /**
2565
- * Reasons causing the change of the connection state.
2644
+ * The reason for a change in network connection state.
2566
2645
  */
2567
2646
  var ConnectionChangedReasonType;
2568
2647
  (function (ConnectionChangedReasonType) {
2569
2648
  /**
2570
- * 0: The SDK is connecting to the Agora edge server.
2649
+ * 0: Connecting to the network.
2571
2650
  */
2572
2651
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedConnecting"] = 0] = "ConnectionChangedConnecting";
2573
2652
  /**
2574
- * 1: The SDK has joined the channel successfully.
2653
+ * 1: Successfully joined the channel.
2575
2654
  */
2576
2655
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedJoinSuccess"] = 1] = "ConnectionChangedJoinSuccess";
2577
2656
  /**
2578
- * 2: The connection between the SDK and the Agora edge server is interrupted.
2657
+ * 2: Network connection interrupted.
2579
2658
  */
2580
2659
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInterrupted"] = 2] = "ConnectionChangedInterrupted";
2581
2660
  /**
2582
- * 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. For example, when a user is kicked out of the channel, this status will be returned.
2661
+ * 3: Network connection is banned by the server. For example, this status is returned when the user is kicked out of the channel.
2583
2662
  */
2584
2663
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedBannedByServer"] = 3] = "ConnectionChangedBannedByServer";
2585
2664
  /**
2586
- * 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this code will be returned and the SDK stops reconnecting to the channel. You need to prompt the user to try to switch to another network and rejoin the channel.
2665
+ * 4: Failed to join the channel. If the SDK fails to join the channel after trying for 20 minutes, this status is returned and the SDK stops attempting to reconnect. Prompt the user to switch networks and try joining the channel again.
2587
2666
  */
2588
2667
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedJoinFailed"] = 4] = "ConnectionChangedJoinFailed";
2589
2668
  /**
2590
- * 5: The SDK has left the channel.
2669
+ * 5: Left the channel.
2591
2670
  */
2592
2671
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedLeaveChannel"] = 5] = "ConnectionChangedLeaveChannel";
2593
2672
  /**
2594
- * 6: The App ID is invalid. You need to rejoin the channel with a valid APP ID and make sure the App ID you are using is consistent with the one generated in the Agora Console.
2673
+ * 6: The App ID is invalid. Use a valid App ID to rejoin the channel and ensure the App ID matches the one generated in the Agora Console.
2595
2674
  */
2596
2675
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidAppId"] = 6] = "ConnectionChangedInvalidAppId";
2597
2676
  /**
2598
- * 7: Invalid channel name. Rejoin the channel with a valid channel name. A valid channel name is a string of up to 64 bytes in length. Supported characters (89 characters in total):
2599
- * All lowercase English letters: a to z.
2600
- * All uppercase English letters: A to Z.
2601
- * All numeric characters: 0 to 9.
2602
- * "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
2677
+ * 7: The channel name is invalid. Use a valid channel name to rejoin the channel. A valid channel name is a string within 64 bytes. The supported character set includes 89 characters:
2603
2678
  */
2604
2679
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidChannelName"] = 7] = "ConnectionChangedInvalidChannelName";
2605
2680
  /**
2606
- * 8: Invalid token. Possible reasons are as follows:
2607
- * The App Certificate for the project is enabled in Agora Console, but you do not pass in a token when joining a channel.
2608
- * The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
2609
- * The generated token and the token used to join the channel are not consistent. Ensure the following:
2610
- * When your project enables App Certificate, you need to pass in a token to join a channel.
2611
- * The user ID specified when generating the token is consistent with the user ID used when joining the channel.
2612
- * The generated token is the same as the token passed in to join the channel.
2681
+ * 8: The Token is invalid. Possible reasons include:
2682
+ * Your project has App Certificate enabled but you did not use a Token to join the channel.
2683
+ * The user ID specified when calling joinChannel does not match the one used to generate the Token.
2684
+ * The Token used to join the channel does not match the generated Token. Ensure that:
2685
+ * You use a Token to join the channel if App Certificate is enabled.
2686
+ * The user ID used to generate the Token matches the one used to join the channel.
2687
+ * The Token used to join the channel matches the generated Token.
2613
2688
  */
2614
2689
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidToken"] = 8] = "ConnectionChangedInvalidToken";
2615
2690
  /**
2616
- * (9): The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
2691
+ * 9: The current Token has expired. Generate a new Token on your server and rejoin the channel with the new Token.
2617
2692
  */
2618
2693
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedTokenExpired"] = 9] = "ConnectionChangedTokenExpired";
2619
2694
  /**
2620
- * 10: The connection is rejected by server. Possible reasons are as follows:
2621
- * The user is already in the channel and still calls a method, for example, joinChannel, to join the channel. Stop calling this method to clear this error.
2622
- * The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
2695
+ * 10: This user is banned by the server. Possible reasons include:
2696
+ * The user has already joined the channel and calls the join channel API again, such as joinChannel. Stop calling this method.
2697
+ * The user tries to join a channel during a call test. Wait until the test ends before joining the channel.
2623
2698
  */
2624
2699
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRejectedByServer"] = 10] = "ConnectionChangedRejectedByServer";
2625
2700
  /**
2626
- * 11: The connection state changed to reconnecting because the SDK has set a proxy server.
2701
+ * 11: The SDK is attempting to reconnect due to proxy server settings.
2627
2702
  */
2628
2703
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedSettingProxyServer"] = 11] = "ConnectionChangedSettingProxyServer";
2629
2704
  /**
2630
- * 12: The connection state changed because the token is renewed.
2705
+ * 12: The network connection state changed due to a Token renewal.
2631
2706
  */
2632
2707
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRenewToken"] = 12] = "ConnectionChangedRenewToken";
2633
2708
  /**
2634
- * (13): Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
2709
+ * 13: The client IP address has changed. If this status code is received multiple times, prompt the user to switch networks and try rejoining the channel.
2635
2710
  */
2636
2711
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedClientIpAddressChanged"] = 13] = "ConnectionChangedClientIpAddressChanged";
2637
2712
  /**
2638
- * 14: Timeout for the keep-alive of the connection between the SDK and the Agora edge server. The SDK tries to reconnect to the server automatically.
2713
+ * 14: The connection between the SDK and the server timed out. The SDK enters automatic reconnection mode.
2639
2714
  */
2640
2715
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedKeepAliveTimeout"] = 14] = "ConnectionChangedKeepAliveTimeout";
2641
2716
  /**
2642
- * 15: The user has rejoined the channel successfully.
2717
+ * 15: Successfully rejoined the channel.
2643
2718
  */
2644
2719
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRejoinSuccess"] = 15] = "ConnectionChangedRejoinSuccess";
2645
2720
  /**
2646
- * 16: The connection between the SDK and the server is lost.
2721
+ * 16: The SDK lost connection with the server.
2647
2722
  */
2648
2723
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedLost"] = 16] = "ConnectionChangedLost";
2649
2724
  /**
2650
- * 17: The connection state changes due to the echo test.
2725
+ * 17: The connection state changed due to an echo test.
2651
2726
  */
2652
2727
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedEchoTest"] = 17] = "ConnectionChangedEchoTest";
2653
2728
  /**
@@ -2655,11 +2730,11 @@ var ConnectionChangedReasonType;
2655
2730
  */
2656
2731
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedClientIpAddressChangedByUser"] = 18] = "ConnectionChangedClientIpAddressChangedByUser";
2657
2732
  /**
2658
- * 19: The user joined the same channel from different devices with the same UID.
2733
+ * 19: The same UID joined the same channel from a different device.
2659
2734
  */
2660
2735
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedSameUidLogin"] = 19] = "ConnectionChangedSameUidLogin";
2661
2736
  /**
2662
- * 20: The number of hosts in the channel has reached the upper limit.
2737
+ * 20: The number of broadcasters in the channel has reached the limit.
2663
2738
  */
2664
2739
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedTooManyBroadcasters"] = 20] = "ConnectionChangedTooManyBroadcasters";
2665
2740
  /**
@@ -2680,24 +2755,24 @@ var ConnectionChangedReasonType;
2680
2755
  ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInconsistentAppid"] = 24] = "ConnectionChangedInconsistentAppid";
2681
2756
  })(ConnectionChangedReasonType = exports.ConnectionChangedReasonType || (exports.ConnectionChangedReasonType = {}));
2682
2757
  /**
2683
- * The reason for a user role switch failure.
2758
+ * Reasons for user role switch failure.
2684
2759
  */
2685
2760
  var ClientRoleChangeFailedReason;
2686
2761
  (function (ClientRoleChangeFailedReason) {
2687
2762
  /**
2688
- * 1: The number of hosts in the channel exceeds the limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
2763
+ * 1: The number of broadcasters in the channel has reached the limit. This enum is only reported when the 128-user feature is enabled. The broadcaster limit depends on the configuration when enabling the 128-user feature.
2689
2764
  */
2690
2765
  ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedTooManyBroadcasters"] = 1] = "ClientRoleChangeFailedTooManyBroadcasters";
2691
2766
  /**
2692
- * 2: The request is rejected by the Agora server. Agora recommends you prompt the user to try to switch their user role again.
2767
+ * 2: Request was rejected by the server. It is recommended to prompt the user to try switching roles again.
2693
2768
  */
2694
2769
  ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedNotAuthorized"] = 2] = "ClientRoleChangeFailedNotAuthorized";
2695
2770
  /**
2696
- * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
2771
+ * 3: Request timed out. It is recommended to prompt the user to check their network connection and try switching roles again. Deprecated: This enum value is deprecated since v4.4.0 and is not recommended for use.
2697
2772
  */
2698
2773
  ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedRequestTimeOut"] = 3] = "ClientRoleChangeFailedRequestTimeOut";
2699
2774
  /**
2700
- * 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the reason reported by onConnectionStateChanged. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
2775
+ * 4: Network connection lost. You can troubleshoot the specific cause based on the reason reported by onConnectionStateChanged. Deprecated: This enum value is deprecated since v4.4.0 and is not recommended for use.
2701
2776
  */
2702
2777
  ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedConnectionFailed"] = 4] = "ClientRoleChangeFailedConnectionFailed";
2703
2778
  })(ClientRoleChangeFailedReason = exports.ClientRoleChangeFailedReason || (exports.ClientRoleChangeFailedReason = {}));
@@ -2744,50 +2819,50 @@ class WlAccStats {
2744
2819
  }
2745
2820
  exports.WlAccStats = WlAccStats;
2746
2821
  /**
2747
- * Network type.
2822
+ * Type of network connection.
2748
2823
  */
2749
2824
  var NetworkType;
2750
2825
  (function (NetworkType) {
2751
2826
  /**
2752
- * -1: The network type is unknown.
2827
+ * -1: Unknown network connection type.
2753
2828
  */
2754
2829
  NetworkType[NetworkType["NetworkTypeUnknown"] = -1] = "NetworkTypeUnknown";
2755
2830
  /**
2756
- * 0: The SDK disconnects from the network.
2831
+ * 0: Network connection is disconnected.
2757
2832
  */
2758
2833
  NetworkType[NetworkType["NetworkTypeDisconnected"] = 0] = "NetworkTypeDisconnected";
2759
2834
  /**
2760
- * 1: The network type is LAN.
2835
+ * 1: Network type is LAN.
2761
2836
  */
2762
2837
  NetworkType[NetworkType["NetworkTypeLan"] = 1] = "NetworkTypeLan";
2763
2838
  /**
2764
- * 2: The network type is Wi-Fi (including hotspots).
2839
+ * 2: Network type is Wi-Fi (including hotspot).
2765
2840
  */
2766
2841
  NetworkType[NetworkType["NetworkTypeWifi"] = 2] = "NetworkTypeWifi";
2767
2842
  /**
2768
- * 3: The network type is mobile 2G.
2843
+ * 3: Network type is 2G mobile network.
2769
2844
  */
2770
2845
  NetworkType[NetworkType["NetworkTypeMobile2g"] = 3] = "NetworkTypeMobile2g";
2771
2846
  /**
2772
- * 4: The network type is mobile 3G.
2847
+ * 4: Network type is 3G mobile network.
2773
2848
  */
2774
2849
  NetworkType[NetworkType["NetworkTypeMobile3g"] = 4] = "NetworkTypeMobile3g";
2775
2850
  /**
2776
- * 5: The network type is mobile 4G.
2851
+ * 5: Network type is 4G mobile network.
2777
2852
  */
2778
2853
  NetworkType[NetworkType["NetworkTypeMobile4g"] = 5] = "NetworkTypeMobile4g";
2779
2854
  /**
2780
- * 6: The network type is mobile 5G.
2855
+ * 6: Network type is 5G mobile network.
2781
2856
  */
2782
2857
  NetworkType[NetworkType["NetworkTypeMobile5g"] = 6] = "NetworkTypeMobile5g";
2783
2858
  })(NetworkType = exports.NetworkType || (exports.NetworkType = {}));
2784
2859
  /**
2785
- * Setting mode of the view.
2860
+ * View setup mode.
2786
2861
  */
2787
2862
  var VideoViewSetupMode;
2788
2863
  (function (VideoViewSetupMode) {
2789
2864
  /**
2790
- * 0: (Default) Clear all added views and replace with a new view.
2865
+ * 0: (Default) Clears all added views and replaces them with new views.
2791
2866
  */
2792
2867
  VideoViewSetupMode[VideoViewSetupMode["VideoViewSetupReplace"] = 0] = "VideoViewSetupReplace";
2793
2868
  /**
@@ -2795,120 +2870,196 @@ var VideoViewSetupMode;
2795
2870
  */
2796
2871
  VideoViewSetupMode[VideoViewSetupMode["VideoViewSetupAdd"] = 1] = "VideoViewSetupAdd";
2797
2872
  /**
2798
- * 2: Deletes a view.
2873
+ * 2: Removes a view. When a view is no longer needed, it is recommended to set setupMode to VideoViewSetupRemove in a timely manner to remove the view, otherwise it may cause rendering resource leaks.
2799
2874
  */
2800
2875
  VideoViewSetupMode[VideoViewSetupMode["VideoViewSetupRemove"] = 2] = "VideoViewSetupRemove";
2801
2876
  })(VideoViewSetupMode = exports.VideoViewSetupMode || (exports.VideoViewSetupMode = {}));
2802
2877
  /**
2803
- * Attributes of the video canvas object.
2878
+ * Properties of the video canvas object.
2804
2879
  */
2805
2880
  class VideoCanvas {
2806
2881
  }
2807
2882
  exports.VideoCanvas = VideoCanvas;
2808
2883
  /**
2809
- * The contrast level.
2884
+ * Light contrast level.
2810
2885
  */
2811
2886
  var LighteningContrastLevel;
2812
2887
  (function (LighteningContrastLevel) {
2813
2888
  /**
2814
- * 0: Low contrast level.
2889
+ * 0: Low contrast.
2815
2890
  */
2816
2891
  LighteningContrastLevel[LighteningContrastLevel["LighteningContrastLow"] = 0] = "LighteningContrastLow";
2817
2892
  /**
2818
- * 1: (Default) Normal contrast level.
2893
+ * 1: Normal contrast.
2819
2894
  */
2820
2895
  LighteningContrastLevel[LighteningContrastLevel["LighteningContrastNormal"] = 1] = "LighteningContrastNormal";
2821
2896
  /**
2822
- * 2: High contrast level.
2897
+ * 2: High contrast.
2823
2898
  */
2824
2899
  LighteningContrastLevel[LighteningContrastLevel["LighteningContrastHigh"] = 2] = "LighteningContrastHigh";
2825
2900
  })(LighteningContrastLevel = exports.LighteningContrastLevel || (exports.LighteningContrastLevel = {}));
2826
2901
  /**
2827
- * Image enhancement options.
2902
+ * Beauty effect options.
2828
2903
  */
2829
2904
  class BeautyOptions {
2830
2905
  }
2831
2906
  exports.BeautyOptions = BeautyOptions;
2832
2907
  /**
2833
- * @ignore
2908
+ * Selects the specific face shaping area to be adjusted.
2909
+ *
2910
+ * Since Available since v4.4.0.
2834
2911
  */
2835
2912
  var FaceShapeArea;
2836
2913
  (function (FaceShapeArea) {
2837
2914
  /**
2838
- * @ignore
2915
+ * (-1): Default value, indicates an invalid area. Face shaping effect is not applied.
2839
2916
  */
2840
2917
  FaceShapeArea[FaceShapeArea["FaceShapeAreaNone"] = -1] = "FaceShapeAreaNone";
2841
2918
  /**
2842
- * @ignore
2919
+ * (100): Head area, used to achieve a smaller head effect. Value range: [0, 100], default is 50. The higher the value, the more noticeable the adjustment.
2843
2920
  */
2844
- FaceShapeArea[FaceShapeArea["FaceShapeAreaHeadscale"] = 0] = "FaceShapeAreaHeadscale";
2921
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaHeadscale"] = 100] = "FaceShapeAreaHeadscale";
2845
2922
  /**
2846
- * @ignore
2923
+ * (101): Forehead area, used to adjust the hairline height. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2847
2924
  */
2848
- FaceShapeArea[FaceShapeArea["FaceShapeAreaForehead"] = 1] = "FaceShapeAreaForehead";
2925
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaForehead"] = 101] = "FaceShapeAreaForehead";
2849
2926
  /**
2850
- * @ignore
2927
+ * (102): Face contour area, used to achieve a slimmer face effect. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2851
2928
  */
2852
- FaceShapeArea[FaceShapeArea["FaceShapeAreaFacecontour"] = 2] = "FaceShapeAreaFacecontour";
2929
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaFacecontour"] = 102] = "FaceShapeAreaFacecontour";
2853
2930
  /**
2854
- * @ignore
2931
+ * (103): Face length area, used to elongate the face. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2855
2932
  */
2856
- FaceShapeArea[FaceShapeArea["FaceShapeAreaFacelength"] = 3] = "FaceShapeAreaFacelength";
2933
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaFacelength"] = 103] = "FaceShapeAreaFacelength";
2857
2934
  /**
2858
- * @ignore
2935
+ * (104): Face width area, used to achieve a narrower face effect. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2859
2936
  */
2860
- FaceShapeArea[FaceShapeArea["FaceShapeAreaFacewidth"] = 4] = "FaceShapeAreaFacewidth";
2937
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaFacewidth"] = 104] = "FaceShapeAreaFacewidth";
2861
2938
  /**
2862
- * @ignore
2939
+ * (105): Cheekbone area, used to adjust cheekbone width. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2863
2940
  */
2864
- FaceShapeArea[FaceShapeArea["FaceShapeAreaCheekbone"] = 5] = "FaceShapeAreaCheekbone";
2941
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaCheekbone"] = 105] = "FaceShapeAreaCheekbone";
2865
2942
  /**
2866
- * @ignore
2943
+ * (106): Cheek area, used to adjust cheek width. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2867
2944
  */
2868
- FaceShapeArea[FaceShapeArea["FaceShapeAreaCheek"] = 6] = "FaceShapeAreaCheek";
2945
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaCheek"] = 106] = "FaceShapeAreaCheek";
2869
2946
  /**
2870
- * @ignore
2947
+ * (107): Jawbone area, used to adjust jawbone width. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2871
2948
  */
2872
- FaceShapeArea[FaceShapeArea["FaceShapeAreaChin"] = 7] = "FaceShapeAreaChin";
2949
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaMandible"] = 107] = "FaceShapeAreaMandible";
2873
2950
  /**
2874
- * @ignore
2951
+ * (108): Chin area, used to adjust chin length. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2875
2952
  */
2876
- FaceShapeArea[FaceShapeArea["FaceShapeAreaEyescale"] = 8] = "FaceShapeAreaEyescale";
2953
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaChin"] = 108] = "FaceShapeAreaChin";
2877
2954
  /**
2878
- * @ignore
2955
+ * (200): Eye area, used to achieve a bigger eye effect. Value range: [0, 100], default is 50. The higher the value, the more noticeable the adjustment.
2879
2956
  */
2880
- FaceShapeArea[FaceShapeArea["FaceShapeAreaNoselength"] = 9] = "FaceShapeAreaNoselength";
2957
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyescale"] = 200] = "FaceShapeAreaEyescale";
2881
2958
  /**
2882
- * @ignore
2959
+ * (201): Eye distance area, used to adjust the distance between the eyes. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2883
2960
  */
2884
- FaceShapeArea[FaceShapeArea["FaceShapeAreaNosewidth"] = 10] = "FaceShapeAreaNosewidth";
2961
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyedistance"] = 201] = "FaceShapeAreaEyedistance";
2885
2962
  /**
2886
- * @ignore
2963
+ * (202): Eye position area, used to adjust the overall position of the eyes. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2964
+ */
2965
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyeposition"] = 202] = "FaceShapeAreaEyeposition";
2966
+ /**
2967
+ * (203): Lower eyelid area, used to adjust the shape of the lower eyelid. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2968
+ */
2969
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaLowereyelid"] = 203] = "FaceShapeAreaLowereyelid";
2970
+ /**
2971
+ * (204): Pupil area, used to adjust pupil size. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2972
+ */
2973
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyepupils"] = 204] = "FaceShapeAreaEyepupils";
2974
+ /**
2975
+ * (205): Inner eye corner area, used to adjust the shape of the inner eye corner. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2976
+ */
2977
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyeinnercorner"] = 205] = "FaceShapeAreaEyeinnercorner";
2978
+ /**
2979
+ * (206): Outer eye corner area, used to adjust the shape of the outer eye corner. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2980
+ */
2981
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyeoutercorner"] = 206] = "FaceShapeAreaEyeoutercorner";
2982
+ /**
2983
+ * (300): Nose length area, used to elongate the nose. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
2984
+ */
2985
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNoselength"] = 300] = "FaceShapeAreaNoselength";
2986
+ /**
2987
+ * (301): Nose width area, used to achieve a slimmer nose effect. Value range: [0, 100], default is 0. The higher the value, the more noticeable the slimming effect.
2988
+ */
2989
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNosewidth"] = 301] = "FaceShapeAreaNosewidth";
2990
+ /**
2991
+ * (302): Nasal wing area, used to adjust the width of the nasal wings. Value range: [0, 100], default is 10. The higher the value, the more noticeable the adjustment.
2992
+ */
2993
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNosewing"] = 302] = "FaceShapeAreaNosewing";
2994
+ /**
2995
+ * (303): Nasal root area, used to adjust the height of the nasal root. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
2996
+ */
2997
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNoseroot"] = 303] = "FaceShapeAreaNoseroot";
2998
+ /**
2999
+ * (304): Nose bridge area, used to adjust the height of the nose bridge. Value range: [0, 100], default is 50. The higher the value, the more noticeable the adjustment.
3000
+ */
3001
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNosebridge"] = 304] = "FaceShapeAreaNosebridge";
3002
+ /**
3003
+ * (305): Nose tip area, used to adjust the shape of the nose tip. Value range: [0, 100], default is 50. The higher the value, the more noticeable the adjustment.
3004
+ */
3005
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNosetip"] = 305] = "FaceShapeAreaNosetip";
3006
+ /**
3007
+ * (306): Overall nose area, used to uniformly adjust the shape of the nose. Value range: [-100, 100], default is 50. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
3008
+ */
3009
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaNosegeneral"] = 306] = "FaceShapeAreaNosegeneral";
3010
+ /**
3011
+ * (400): Mouth area, used to achieve a bigger mouth effect. Value range: [-100, 100], default is 20. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
3012
+ */
3013
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaMouthscale"] = 400] = "FaceShapeAreaMouthscale";
3014
+ /**
3015
+ * (401): Mouth position area, used to adjust the overall position of the mouth. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
3016
+ */
3017
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaMouthposition"] = 401] = "FaceShapeAreaMouthposition";
3018
+ /**
3019
+ * (402): Mouth smile area, used to adjust the degree of mouth corner lift. Value range: [0, 1], default is 0. The higher the value, the more noticeable the adjustment.
3020
+ */
3021
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaMouthsmile"] = 402] = "FaceShapeAreaMouthsmile";
3022
+ /**
3023
+ * (403): Lip shape area, used to adjust the shape of the lips. Value range: [0, 100], default is 0. The higher the value, the more noticeable the adjustment.
3024
+ */
3025
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaMouthlip"] = 403] = "FaceShapeAreaMouthlip";
3026
+ /**
3027
+ * (500): Eyebrow position area, used to adjust the overall position of the eyebrows. Value range: [-100, 100], default is 0. The greater the absolute value, the more noticeable the adjustment. Negative values indicate the opposite direction.
3028
+ */
3029
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyebrowposition"] = 500] = "FaceShapeAreaEyebrowposition";
3030
+ /**
3031
+ * (501): Eyebrow thickness area, used to adjust eyebrow thickness. Value range: [-100, 100], default is 0. The higher the value, the more noticeable the adjustment.
2887
3032
  */
2888
- FaceShapeArea[FaceShapeArea["FaceShapeAreaMouthscale"] = 11] = "FaceShapeAreaMouthscale";
3033
+ FaceShapeArea[FaceShapeArea["FaceShapeAreaEyebrowthickness"] = 501] = "FaceShapeAreaEyebrowthickness";
2889
3034
  })(FaceShapeArea = exports.FaceShapeArea || (exports.FaceShapeArea = {}));
2890
3035
  /**
2891
- * @ignore
3036
+ * Filter effect options.
2892
3037
  */
2893
3038
  class FaceShapeAreaOptions {
2894
3039
  }
2895
3040
  exports.FaceShapeAreaOptions = FaceShapeAreaOptions;
2896
3041
  /**
2897
- * @ignore
3042
+ * Face shaping beauty effect style options.
3043
+ *
3044
+ * Since Available since v4.4.0.
2898
3045
  */
2899
3046
  var FaceShapeBeautyStyle;
2900
3047
  (function (FaceShapeBeautyStyle) {
2901
3048
  /**
2902
- * @ignore
3049
+ * (0): (Default) Female style beauty effect.
2903
3050
  */
2904
3051
  FaceShapeBeautyStyle[FaceShapeBeautyStyle["FaceShapeBeautyStyleFemale"] = 0] = "FaceShapeBeautyStyleFemale";
2905
3052
  /**
2906
- * @ignore
3053
+ * (1): Male style beauty effect.
2907
3054
  */
2908
3055
  FaceShapeBeautyStyle[FaceShapeBeautyStyle["FaceShapeBeautyStyleMale"] = 1] = "FaceShapeBeautyStyleMale";
3056
+ /**
3057
+ * (2): Natural style beauty effect, only minimal adjustments to facial features.
3058
+ */
3059
+ FaceShapeBeautyStyle[FaceShapeBeautyStyle["FaceShapeBeautyStyleNatural"] = 2] = "FaceShapeBeautyStyleNatural";
2909
3060
  })(FaceShapeBeautyStyle = exports.FaceShapeBeautyStyle || (exports.FaceShapeBeautyStyle = {}));
2910
3061
  /**
2911
- * @ignore
3062
+ * Face shaping style options.
2912
3063
  */
2913
3064
  class FaceShapeBeautyOptions {
2914
3065
  }
@@ -2920,81 +3071,81 @@ class FilterEffectOptions {
2920
3071
  }
2921
3072
  exports.FilterEffectOptions = FilterEffectOptions;
2922
3073
  /**
2923
- * The low-light enhancement mode.
3074
+ * Low-light enhancement mode.
2924
3075
  */
2925
3076
  var LowLightEnhanceMode;
2926
3077
  (function (LowLightEnhanceMode) {
2927
3078
  /**
2928
- * 0: (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.
3079
+ * 0: (Default) Auto mode. The SDK automatically enables or disables the low-light enhancement feature based on ambient light levels to provide appropriate lighting and prevent overexposure.
2929
3080
  */
2930
3081
  LowLightEnhanceMode[LowLightEnhanceMode["LowLightEnhanceAuto"] = 0] = "LowLightEnhanceAuto";
2931
3082
  /**
2932
- * 1: Manual mode. Users need to enable or disable the low-light enhancement feature manually.
3083
+ * 1: Manual mode. You need to manually enable or disable the low-light enhancement feature.
2933
3084
  */
2934
3085
  LowLightEnhanceMode[LowLightEnhanceMode["LowLightEnhanceManual"] = 1] = "LowLightEnhanceManual";
2935
3086
  })(LowLightEnhanceMode = exports.LowLightEnhanceMode || (exports.LowLightEnhanceMode = {}));
2936
3087
  /**
2937
- * The low-light enhancement level.
3088
+ * Low-light enhancement level.
2938
3089
  */
2939
3090
  var LowLightEnhanceLevel;
2940
3091
  (function (LowLightEnhanceLevel) {
2941
3092
  /**
2942
- * 0: (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.
3093
+ * 0: (Default) Low-light enhancement prioritizing image quality, processes video brightness, details, and noise with moderate performance consumption and processing speed, providing optimal overall image quality.
2943
3094
  */
2944
3095
  LowLightEnhanceLevel[LowLightEnhanceLevel["LowLightEnhanceLevelHighQuality"] = 0] = "LowLightEnhanceLevelHighQuality";
2945
3096
  /**
2946
- * 1: Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.
3097
+ * 1: Low-light enhancement prioritizing performance, processes video brightness and details with lower performance consumption and faster processing speed.
2947
3098
  */
2948
3099
  LowLightEnhanceLevel[LowLightEnhanceLevel["LowLightEnhanceLevelFast"] = 1] = "LowLightEnhanceLevelFast";
2949
3100
  })(LowLightEnhanceLevel = exports.LowLightEnhanceLevel || (exports.LowLightEnhanceLevel = {}));
2950
3101
  /**
2951
- * The low-light enhancement options.
3102
+ * Low-light enhancement options.
2952
3103
  */
2953
3104
  class LowlightEnhanceOptions {
2954
3105
  }
2955
3106
  exports.LowlightEnhanceOptions = LowlightEnhanceOptions;
2956
3107
  /**
2957
- * Video noise reduction mode.
3108
+ * Video denoising mode.
2958
3109
  */
2959
3110
  var VideoDenoiserMode;
2960
3111
  (function (VideoDenoiserMode) {
2961
3112
  /**
2962
- * 0: (Default) Automatic mode. The SDK automatically enables or disables the video noise reduction feature according to the ambient light.
3113
+ * 0: (Default) Auto mode. The SDK automatically enables or disables video denoising based on ambient light brightness.
2963
3114
  */
2964
3115
  VideoDenoiserMode[VideoDenoiserMode["VideoDenoiserAuto"] = 0] = "VideoDenoiserAuto";
2965
3116
  /**
2966
- * 1: Manual mode. Users need to enable or disable the video noise reduction feature manually.
3117
+ * 1: Manual mode. You need to manually enable or disable the video denoising feature.
2967
3118
  */
2968
3119
  VideoDenoiserMode[VideoDenoiserMode["VideoDenoiserManual"] = 1] = "VideoDenoiserManual";
2969
3120
  })(VideoDenoiserMode = exports.VideoDenoiserMode || (exports.VideoDenoiserMode = {}));
2970
3121
  /**
2971
- * Video noise reduction level.
3122
+ * Video denoising level.
2972
3123
  */
2973
3124
  var VideoDenoiserLevel;
2974
3125
  (function (VideoDenoiserLevel) {
2975
3126
  /**
2976
- * 0: (Default) Promotes video quality during video noise reduction. balances performance consumption and video noise reduction quality. The performance consumption is moderate, the video noise reduction speed is moderate, and the overall video quality is optimal.
3127
+ * 0: (Default) Denoising prioritizing video quality. This level balances performance consumption and denoising effect. It has moderate performance consumption, moderate denoising speed, and optimal overall image quality.
2977
3128
  */
2978
3129
  VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelHighQuality"] = 0] = "VideoDenoiserLevelHighQuality";
2979
3130
  /**
2980
- * 1: Promotes reducing performance consumption during video noise reduction. It prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this setting when the camera is fixed.
3131
+ * 1: Denoising prioritizing performance. This level focuses on saving performance at the cost of denoising effect. It has lower performance consumption and faster denoising speed. To avoid noticeable trailing artifacts in the processed video, it is recommended to use this setting when the camera is stationary.
2981
3132
  */
2982
3133
  VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelFast"] = 1] = "VideoDenoiserLevelFast";
2983
3134
  })(VideoDenoiserLevel = exports.VideoDenoiserLevel || (exports.VideoDenoiserLevel = {}));
2984
3135
  /**
2985
- * Video noise reduction options.
3136
+ * Video denoising options.
2986
3137
  */
2987
3138
  class VideoDenoiserOptions {
2988
3139
  }
2989
3140
  exports.VideoDenoiserOptions = VideoDenoiserOptions;
2990
3141
  /**
2991
- * The color enhancement options.
3142
+ * Color enhancement options.
2992
3143
  */
2993
3144
  class ColorEnhanceOptions {
2994
3145
  }
2995
3146
  exports.ColorEnhanceOptions = ColorEnhanceOptions;
2996
3147
  /**
2997
- * The custom background.
3148
+ * Custom background.
2998
3149
  */
2999
3150
  var BackgroundSourceType;
3000
3151
  (function (BackgroundSourceType) {
@@ -3003,57 +3154,57 @@ var BackgroundSourceType;
3003
3154
  */
3004
3155
  BackgroundSourceType[BackgroundSourceType["BackgroundNone"] = 0] = "BackgroundNone";
3005
3156
  /**
3006
- * 1: (Default) The background image is a solid color.
3157
+ * 1: (Default) Solid color background.
3007
3158
  */
3008
3159
  BackgroundSourceType[BackgroundSourceType["BackgroundColor"] = 1] = "BackgroundColor";
3009
3160
  /**
3010
- * 2: The background is an image in PNG or JPG format.
3161
+ * 2: Background image in PNG or JPG format.
3011
3162
  */
3012
3163
  BackgroundSourceType[BackgroundSourceType["BackgroundImg"] = 2] = "BackgroundImg";
3013
3164
  /**
3014
- * 3: The background is a blurred version of the original background.
3165
+ * 3: Background with blur effect.
3015
3166
  */
3016
3167
  BackgroundSourceType[BackgroundSourceType["BackgroundBlur"] = 3] = "BackgroundBlur";
3017
3168
  /**
3018
- * 4: The background is a local video in MP4, AVI, MKV, FLV, or other supported formats.
3169
+ * 4: Local video background in formats such as MP4, AVI, MKV, FLV.
3019
3170
  */
3020
3171
  BackgroundSourceType[BackgroundSourceType["BackgroundVideo"] = 4] = "BackgroundVideo";
3021
3172
  })(BackgroundSourceType = exports.BackgroundSourceType || (exports.BackgroundSourceType = {}));
3022
3173
  /**
3023
- * The degree of blurring applied to the custom background image.
3174
+ * Blur level of custom background image.
3024
3175
  */
3025
3176
  var BackgroundBlurDegree;
3026
3177
  (function (BackgroundBlurDegree) {
3027
3178
  /**
3028
- * 1: The degree of blurring applied to the custom background image is low. The user can almost see the background clearly.
3179
+ * 1: Low blur level for the custom background image. Users can almost clearly see the background.
3029
3180
  */
3030
3181
  BackgroundBlurDegree[BackgroundBlurDegree["BlurDegreeLow"] = 1] = "BlurDegreeLow";
3031
3182
  /**
3032
- * 2: The degree of blurring applied to the custom background image is medium. It is difficult for the user to recognize details in the background.
3183
+ * 2: Medium blur level for the custom background image. Users have difficulty seeing the background clearly.
3033
3184
  */
3034
3185
  BackgroundBlurDegree[BackgroundBlurDegree["BlurDegreeMedium"] = 2] = "BlurDegreeMedium";
3035
3186
  /**
3036
- * 3: (Default) The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background.
3187
+ * 3: (Default) High blur level for the custom background image. Users can barely see the background.
3037
3188
  */
3038
3189
  BackgroundBlurDegree[BackgroundBlurDegree["BlurDegreeHigh"] = 3] = "BlurDegreeHigh";
3039
3190
  })(BackgroundBlurDegree = exports.BackgroundBlurDegree || (exports.BackgroundBlurDegree = {}));
3040
3191
  /**
3041
- * The custom background.
3192
+ * Custom background.
3042
3193
  */
3043
3194
  class VirtualBackgroundSource {
3044
3195
  }
3045
3196
  exports.VirtualBackgroundSource = VirtualBackgroundSource;
3046
3197
  /**
3047
- * The type of algorithms to user for background processing.
3198
+ * Algorithm for background processing.
3048
3199
  */
3049
3200
  var SegModelType;
3050
3201
  (function (SegModelType) {
3051
3202
  /**
3052
- * 1: (Default) Use the algorithm suitable for all scenarios.
3203
+ * 1: (Default) Background processing algorithm suitable for all scenarios.
3053
3204
  */
3054
3205
  SegModelType[SegModelType["SegModelAi"] = 1] = "SegModelAi";
3055
3206
  /**
3056
- * 2: Use the algorithm designed specifically for scenarios with a green screen background.
3207
+ * 2: Background processing algorithm suitable only for green screen scenarios.
3057
3208
  */
3058
3209
  SegModelType[SegModelType["SegModelGreen"] = 2] = "SegModelGreen";
3059
3210
  })(SegModelType = exports.SegModelType || (exports.SegModelType = {}));
@@ -3064,7 +3215,7 @@ class SegmentationProperty {
3064
3215
  }
3065
3216
  exports.SegmentationProperty = SegmentationProperty;
3066
3217
  /**
3067
- * The type of the audio track.
3218
+ * Type of custom audio capture track.
3068
3219
  */
3069
3220
  var AudioTrackType;
3070
3221
  (function (AudioTrackType) {
@@ -3073,57 +3224,57 @@ var AudioTrackType;
3073
3224
  */
3074
3225
  AudioTrackType[AudioTrackType["AudioTrackInvalid"] = -1] = "AudioTrackInvalid";
3075
3226
  /**
3076
- * 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
3227
+ * 0: Mixable audio track. Supports mixing with other audio streams (e.g., microphone-captured audio) before local playback or publishing to the channel. Has higher latency compared to non-mixable audio tracks.
3077
3228
  */
3078
3229
  AudioTrackType[AudioTrackType["AudioTrackMixable"] = 0] = "AudioTrackMixable";
3079
3230
  /**
3080
- * 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
3231
+ * 1: Non-mixable audio track. Replaces microphone capture and does not support mixing with other audio streams. Has lower latency compared to mixable audio tracks. If AudioTrackDirect is specified, publishMicrophoneTrack in ChannelMediaOptions must be set to false when calling joinChannel, otherwise joining the channel will fail and return error code -2.
3081
3232
  */
3082
3233
  AudioTrackType[AudioTrackType["AudioTrackDirect"] = 1] = "AudioTrackDirect";
3083
3234
  })(AudioTrackType = exports.AudioTrackType || (exports.AudioTrackType = {}));
3084
3235
  /**
3085
- * The configuration of custom audio tracks.
3236
+ * Configuration options for custom audio tracks.
3086
3237
  */
3087
3238
  class AudioTrackConfig {
3088
3239
  }
3089
3240
  exports.AudioTrackConfig = AudioTrackConfig;
3090
3241
  /**
3091
- * The options for SDK preset voice beautifier effects.
3242
+ * Preset voice beautifier options.
3092
3243
  */
3093
3244
  var VoiceBeautifierPreset;
3094
3245
  (function (VoiceBeautifierPreset) {
3095
3246
  /**
3096
- * Turn off voice beautifier effects and use the original voice.
3247
+ * Original voice, i.e., disables voice beautifier effects.
3097
3248
  */
3098
3249
  VoiceBeautifierPreset[VoiceBeautifierPreset["VoiceBeautifierOff"] = 0] = "VoiceBeautifierOff";
3099
3250
  /**
3100
- * A more magnetic voice. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
3251
+ * Magnetic (male). This setting is only effective for male voices. Do not apply to female voices, or audio distortion may occur.
3101
3252
  */
3102
3253
  VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierMagnetic"] = 16843008] = "ChatBeautifierMagnetic";
3103
3254
  /**
3104
- * A fresher voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
3255
+ * Fresh (female). This setting is only effective for female voices. Do not apply to male voices, or audio distortion may occur.
3105
3256
  */
3106
3257
  VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierFresh"] = 16843264] = "ChatBeautifierFresh";
3107
3258
  /**
3108
- * A more vital voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
3259
+ * Energetic (female). This setting is only effective for female voices. Do not apply to male voices, or audio distortion may occur.
3109
3260
  */
3110
3261
  VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierVitality"] = 16843520] = "ChatBeautifierVitality";
3111
3262
  /**
3112
- * Singing beautifier effect.
3113
- * If you call setVoiceBeautifierPreset (SingingBeautifier), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion.
3114
- * If you call setVoiceBeautifierParameters (SingingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect.
3263
+ * Singing beautifier.
3264
+ * If you call setVoiceBeautifierPreset (SingingBeautifier), you can beautify male voices and add small-room reverb effects. Do not apply to female voices, or audio distortion may occur.
3265
+ * If you call setVoiceBeautifierParameters (SingingBeautifier, param1, param2), you can beautify either male or female voices and add reverb effects.
3115
3266
  */
3116
3267
  VoiceBeautifierPreset[VoiceBeautifierPreset["SingingBeautifier"] = 16908544] = "SingingBeautifier";
3117
3268
  /**
3118
- * A more vigorous voice.
3269
+ * Vigorous.
3119
3270
  */
3120
3271
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationVigorous"] = 16974080] = "TimbreTransformationVigorous";
3121
3272
  /**
3122
- * A deep voice.
3273
+ * Deep.
3123
3274
  */
3124
3275
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationDeep"] = 16974336] = "TimbreTransformationDeep";
3125
3276
  /**
3126
- * A mellower voice.
3277
+ * Mellow.
3127
3278
  */
3128
3279
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationMellow"] = 16974592] = "TimbreTransformationMellow";
3129
3280
  /**
@@ -3131,143 +3282,147 @@ var VoiceBeautifierPreset;
3131
3282
  */
3132
3283
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationFalsetto"] = 16974848] = "TimbreTransformationFalsetto";
3133
3284
  /**
3134
- * A fuller voice.
3285
+ * Full.
3135
3286
  */
3136
3287
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationFull"] = 16975104] = "TimbreTransformationFull";
3137
3288
  /**
3138
- * A clearer voice.
3289
+ * Clear.
3139
3290
  */
3140
3291
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationClear"] = 16975360] = "TimbreTransformationClear";
3141
3292
  /**
3142
- * A more resounding voice.
3293
+ * Resounding.
3143
3294
  */
3144
3295
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationResounding"] = 16975616] = "TimbreTransformationResounding";
3145
3296
  /**
3146
- * A more ringing voice.
3297
+ * Ringing.
3147
3298
  */
3148
3299
  VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationRinging"] = 16975872] = "TimbreTransformationRinging";
3149
3300
  /**
3150
- * A ultra-high quality voice, which makes the audio clearer and restores more details.
3151
- * To achieve better audio effect quality, Agora recommends that you set the profile of to AudioProfileMusicHighQuality (4) or AudioProfileMusicHighQualityStereo (5) and scenario to AudioScenarioGameStreaming (3) before calling setVoiceBeautifierPreset.
3152
- * If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.
3301
+ * Ultra-high quality voice, which makes audio clearer and richer in detail.
3302
+ * For better results, it is recommended to set the profile parameter of setAudioProfile2 to AudioProfileMusicHighQuality (4) or AudioProfileMusicHighQualityStereo (5), and the scenario parameter to AudioScenarioGameStreaming (3) before calling setVoiceBeautifierPreset.
3303
+ * If the user's audio capture device can highly reproduce audio details, it is recommended not to enable ultra-high quality voice, otherwise the SDK may over-enhance the audio details and fail to achieve the expected effect.
3153
3304
  */
3154
3305
  VoiceBeautifierPreset[VoiceBeautifierPreset["UltraHighQualityVoice"] = 17039616] = "UltraHighQualityVoice";
3155
3306
  })(VoiceBeautifierPreset = exports.VoiceBeautifierPreset || (exports.VoiceBeautifierPreset = {}));
3156
3307
  /**
3157
- * Preset audio effects.
3308
+ * Preset audio effect options.
3158
3309
  *
3159
- * To get better audio effects, Agora recommends calling setAudioProfile and setting the profile parameter as recommended below before using the preset audio effects.
3310
+ * setAudioProfile profile
3311
+ * Preset audio effects profile
3312
+ * RoomAcousticsVirtualStereo
3313
+ * RoomAcoustics3dVoice
3314
+ * RoomAcousticsVirtualSurroundSound AudioProfileMusicHighQualityStereo or AudioProfileMusicStandardStereo Other preset effects (excluding AudioEffectOff) AudioProfileMusicHighQuality or AudioProfileMusicHighQualityStereo
3160
3315
  */
3161
3316
  var AudioEffectPreset;
3162
3317
  (function (AudioEffectPreset) {
3163
3318
  /**
3164
- * Turn off voice effects, that is, use the original voice.
3319
+ * Original sound, disables voice effects.
3165
3320
  */
3166
3321
  AudioEffectPreset[AudioEffectPreset["AudioEffectOff"] = 0] = "AudioEffectOff";
3167
3322
  /**
3168
- * The voice effect typical of a KTV venue.
3323
+ * KTV.
3169
3324
  */
3170
3325
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsKtv"] = 33620224] = "RoomAcousticsKtv";
3171
3326
  /**
3172
- * The voice effect typical of a concert hall.
3327
+ * Concert.
3173
3328
  */
3174
3329
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsVocalConcert"] = 33620480] = "RoomAcousticsVocalConcert";
3175
3330
  /**
3176
- * The voice effect typical of a recording studio.
3331
+ * Studio.
3177
3332
  */
3178
3333
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsStudio"] = 33620736] = "RoomAcousticsStudio";
3179
3334
  /**
3180
- * The voice effect typical of a vintage phonograph.
3335
+ * Phonograph.
3181
3336
  */
3182
3337
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsPhonograph"] = 33620992] = "RoomAcousticsPhonograph";
3183
3338
  /**
3184
- * The virtual stereo effect, which renders monophonic audio as stereo audio.
3339
+ * Virtual stereo, where the SDK renders mono audio into stereo effect.
3185
3340
  */
3186
3341
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsVirtualStereo"] = 33621248] = "RoomAcousticsVirtualStereo";
3187
3342
  /**
3188
- * A more spatial voice effect.
3343
+ * Spacious.
3189
3344
  */
3190
3345
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsSpacial"] = 33621504] = "RoomAcousticsSpacial";
3191
3346
  /**
3192
- * A more ethereal voice effect.
3347
+ * Ethereal.
3193
3348
  */
3194
3349
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsEthereal"] = 33621760] = "RoomAcousticsEthereal";
3195
3350
  /**
3196
- * A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period. If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
3351
+ * 3D voice, where the SDK renders audio to surround the user. The default surround cycle is 10 seconds. After setting this effect, you can also call setAudioEffectParameters to modify the surround cycle. To hear the expected effect, users must use audio playback devices that support stereo when 3D voice is enabled.
3197
3352
  */
3198
3353
  AudioEffectPreset[AudioEffectPreset["RoomAcoustics3dVoice"] = 33622016] = "RoomAcoustics3dVoice";
3199
3354
  /**
3200
- * Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect. If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
3355
+ * Virtual surround sound, where the SDK generates a simulated surround sound field based on stereo to create a surround effect. To hear the expected effect, users must use audio playback devices that support stereo when virtual surround sound is enabled.
3201
3356
  */
3202
3357
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsVirtualSurroundSound"] = 33622272] = "RoomAcousticsVirtualSurroundSound";
3203
3358
  /**
3204
- * The audio effect of chorus. Agora recommends using this effect in chorus scenarios to enhance the sense of depth and dimension in the vocals.
3359
+ * Chorus. Recommended by Agora for chorus scenarios to enhance vocal spatiality.
3205
3360
  */
3206
3361
  AudioEffectPreset[AudioEffectPreset["RoomAcousticsChorus"] = 33623296] = "RoomAcousticsChorus";
3207
3362
  /**
3208
- * A middle-aged man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
3363
+ * Deep male voice. Recommended for processing male voices; otherwise, the effect may not be as expected.
3209
3364
  */
3210
3365
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectUncle"] = 33685760] = "VoiceChangerEffectUncle";
3211
3366
  /**
3212
- * An older man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
3367
+ * Elderly male. Recommended for processing male voices; otherwise, the effect may not be as expected.
3213
3368
  */
3214
3369
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectOldman"] = 33686016] = "VoiceChangerEffectOldman";
3215
3370
  /**
3216
- * A boy's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
3371
+ * Boy. Recommended for processing male voices; otherwise, the effect may not be as expected.
3217
3372
  */
3218
3373
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectBoy"] = 33686272] = "VoiceChangerEffectBoy";
3219
3374
  /**
3220
- * A young woman's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
3375
+ * Young woman. Recommended for processing female voices; otherwise, the effect may not be as expected.
3221
3376
  */
3222
3377
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectSister"] = 33686528] = "VoiceChangerEffectSister";
3223
3378
  /**
3224
- * A girl's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
3379
+ * Girl. Recommended for processing female voices; otherwise, the effect may not be as expected.
3225
3380
  */
3226
3381
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectGirl"] = 33686784] = "VoiceChangerEffectGirl";
3227
3382
  /**
3228
- * The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
3383
+ * Pig King.
3229
3384
  */
3230
3385
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectPigking"] = 33687040] = "VoiceChangerEffectPigking";
3231
3386
  /**
3232
- * The Hulk's voice.
3387
+ * Hulk.
3233
3388
  */
3234
3389
  AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectHulk"] = 33687296] = "VoiceChangerEffectHulk";
3235
3390
  /**
3236
- * The voice effect typical of R&B music.
3391
+ * R&B.
3237
3392
  */
3238
3393
  AudioEffectPreset[AudioEffectPreset["StyleTransformationRnb"] = 33751296] = "StyleTransformationRnb";
3239
3394
  /**
3240
- * The voice effect typical of popular music.
3395
+ * Pop.
3241
3396
  */
3242
3397
  AudioEffectPreset[AudioEffectPreset["StyleTransformationPopular"] = 33751552] = "StyleTransformationPopular";
3243
3398
  /**
3244
- * A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. After setting this voice effect, you can call setAudioEffectParameters to adjust the basic mode of tuning and the pitch of the main tone.
3399
+ * Auto-tune, where the SDK corrects the actual pitch based on a natural major scale with C as the tonic. After setting this effect, you can also call setAudioEffectParameters to adjust the base scale and tonic pitch.
3245
3400
  */
3246
3401
  AudioEffectPreset[AudioEffectPreset["PitchCorrection"] = 33816832] = "PitchCorrection";
3247
3402
  })(AudioEffectPreset = exports.AudioEffectPreset || (exports.AudioEffectPreset = {}));
3248
3403
  /**
3249
- * The options for SDK preset voice conversion effects.
3404
+ * Preset voice conversion options.
3250
3405
  */
3251
3406
  var VoiceConversionPreset;
3252
3407
  (function (VoiceConversionPreset) {
3253
3408
  /**
3254
- * Turn off voice conversion effects and use the original voice.
3409
+ * Original voice, i.e., disables voice conversion effects.
3255
3410
  */
3256
3411
  VoiceConversionPreset[VoiceConversionPreset["VoiceConversionOff"] = 0] = "VoiceConversionOff";
3257
3412
  /**
3258
- * A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
3413
+ * Neutral. To avoid audio distortion, ensure this effect is only applied to female voices.
3259
3414
  */
3260
3415
  VoiceConversionPreset[VoiceConversionPreset["VoiceChangerNeutral"] = 50397440] = "VoiceChangerNeutral";
3261
3416
  /**
3262
- * A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
3417
+ * Sweet. To avoid audio distortion, ensure this effect is only applied to female voices.
3263
3418
  */
3264
3419
  VoiceConversionPreset[VoiceConversionPreset["VoiceChangerSweet"] = 50397696] = "VoiceChangerSweet";
3265
3420
  /**
3266
- * A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
3421
+ * Steady. To avoid audio distortion, ensure this effect is only applied to male voices.
3267
3422
  */
3268
3423
  VoiceConversionPreset[VoiceConversionPreset["VoiceChangerSolid"] = 50397952] = "VoiceChangerSolid";
3269
3424
  /**
3270
- * A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
3425
+ * Deep. To avoid audio distortion, ensure this effect is only applied to male voices.
3271
3426
  */
3272
3427
  VoiceConversionPreset[VoiceConversionPreset["VoiceChangerBass"] = 50398208] = "VoiceChangerBass";
3273
3428
  /**
@@ -3321,20 +3476,20 @@ var VoiceConversionPreset;
3321
3476
  var HeadphoneEqualizerPreset;
3322
3477
  (function (HeadphoneEqualizerPreset) {
3323
3478
  /**
3324
- * The headphone equalizer is disabled, and the original audio is heard.
3479
+ * Turn off headphone equalizer and listen to original audio.
3325
3480
  */
3326
3481
  HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerOff"] = 0] = "HeadphoneEqualizerOff";
3327
3482
  /**
3328
- * An equalizer is used for headphones.
3483
+ * Use over-ear headphone equalizer.
3329
3484
  */
3330
3485
  HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerOverear"] = 67108865] = "HeadphoneEqualizerOverear";
3331
3486
  /**
3332
- * An equalizer is used for in-ear headphones.
3487
+ * Use in-ear headphone equalizer.
3333
3488
  */
3334
3489
  HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerInear"] = 67108866] = "HeadphoneEqualizerInear";
3335
3490
  })(HeadphoneEqualizerPreset = exports.HeadphoneEqualizerPreset || (exports.HeadphoneEqualizerPreset = {}));
3336
3491
  /**
3337
- * Voice AI tuner sound types.
3492
+ * AI tuner voice effect types.
3338
3493
  */
3339
3494
  var VoiceAiTunerType;
3340
3495
  (function (VoiceAiTunerType) {
@@ -3351,59 +3506,65 @@ var VoiceAiTunerType;
3351
3506
  */
3352
3507
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerElegantFemale"] = 2] = "VoiceAiTunerElegantFemale";
3353
3508
  /**
3354
- * 3: Sweet female voice. A high-pitched and cute female voice.
3509
+ * 3: Sweet girl voice. A high-pitched and cute female voice.
3355
3510
  */
3356
3511
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerSweetFemale"] = 3] = "VoiceAiTunerSweetFemale";
3357
3512
  /**
3358
- * 4: Warm male singing. A warm and melodious male voice.
3513
+ * 4: Warm male singing voice. A warm and melodious male voice.
3359
3514
  */
3360
3515
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerWarmMaleSinging"] = 4] = "VoiceAiTunerWarmMaleSinging";
3361
3516
  /**
3362
- * 5: Gentle female singing. A soft and delicate female voice.
3517
+ * 5: Gentle female singing voice. A soft and delicate female voice.
3363
3518
  */
3364
3519
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerGentleFemaleSinging"] = 5] = "VoiceAiTunerGentleFemaleSinging";
3365
3520
  /**
3366
- * 6: Husky male singing. A unique husky male voice.
3521
+ * 6: Husky mature male singing voice. A uniquely hoarse male voice.
3367
3522
  */
3368
3523
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerHuskyMaleSinging"] = 6] = "VoiceAiTunerHuskyMaleSinging";
3369
3524
  /**
3370
- * 7: Warm elegant female singing. A warm and mature female voice.
3525
+ * 7: Warm elegant female singing voice. A warm and mature female voice.
3371
3526
  */
3372
3527
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerWarmElegantFemaleSinging"] = 7] = "VoiceAiTunerWarmElegantFemaleSinging";
3373
3528
  /**
3374
- * 8: Powerful male singing. A strong and powerful male voice.
3529
+ * 8: Powerful male singing voice. A strong and forceful male voice.
3375
3530
  */
3376
3531
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerPowerfulMaleSinging"] = 8] = "VoiceAiTunerPowerfulMaleSinging";
3377
3532
  /**
3378
- * 9: Dreamy female singing. A dreamy and soft female voice.
3533
+ * 9: Dreamy female singing voice. A dreamy and soft female voice.
3379
3534
  */
3380
3535
  VoiceAiTunerType[VoiceAiTunerType["VoiceAiTunerDreamyFemaleSinging"] = 9] = "VoiceAiTunerDreamyFemaleSinging";
3381
3536
  })(VoiceAiTunerType = exports.VoiceAiTunerType || (exports.VoiceAiTunerType = {}));
3382
3537
  /**
3383
- * Screen sharing configurations.
3538
+ * @ignore
3539
+ */
3540
+ class ScreenAudioParameters {
3541
+ }
3542
+ exports.ScreenAudioParameters = ScreenAudioParameters;
3543
+ /**
3544
+ * Parameter configuration for screen sharing.
3384
3545
  */
3385
3546
  class ScreenCaptureParameters {
3386
3547
  }
3387
3548
  exports.ScreenCaptureParameters = ScreenCaptureParameters;
3388
3549
  /**
3389
- * Recording quality.
3550
+ * Audio recording quality.
3390
3551
  */
3391
3552
  var AudioRecordingQualityType;
3392
3553
  (function (AudioRecordingQualityType) {
3393
3554
  /**
3394
- * 0: Low quality. The sample rate is 32 kHz, and the file size is around 1.2 MB after 10 minutes of recording.
3555
+ * 0: Low quality. Sampling rate is 32 kHz, file size for 10 minutes of recording is approximately 1.2 MB.
3395
3556
  */
3396
3557
  AudioRecordingQualityType[AudioRecordingQualityType["AudioRecordingQualityLow"] = 0] = "AudioRecordingQualityLow";
3397
3558
  /**
3398
- * 1: Medium quality. The sample rate is 32 kHz, and the file size is around 2 MB after 10 minutes of recording.
3559
+ * 1: Medium quality. Sampling rate is 32 kHz, file size for 10 minutes of recording is approximately 2 MB.
3399
3560
  */
3400
3561
  AudioRecordingQualityType[AudioRecordingQualityType["AudioRecordingQualityMedium"] = 1] = "AudioRecordingQualityMedium";
3401
3562
  /**
3402
- * 2: High quality. The sample rate is 32 kHz, and the file size is around 3.75 MB after 10 minutes of recording.
3563
+ * 2: High quality. Sampling rate is 32 kHz, file size for 10 minutes of recording is approximately 3.75 MB.
3403
3564
  */
3404
3565
  AudioRecordingQualityType[AudioRecordingQualityType["AudioRecordingQualityHigh"] = 2] = "AudioRecordingQualityHigh";
3405
3566
  /**
3406
- * 3: Ultra high quality. The sample rate is 32 kHz, and the file size is around 7.5 MB after 10 minutes of recording.
3567
+ * 3: Ultra-high quality. Sampling rate is 32 kHz, file size for 10 minutes of recording is approximately 7.5 MB.
3407
3568
  */
3408
3569
  AudioRecordingQualityType[AudioRecordingQualityType["AudioRecordingQualityUltraHigh"] = 3] = "AudioRecordingQualityUltraHigh";
3409
3570
  })(AudioRecordingQualityType = exports.AudioRecordingQualityType || (exports.AudioRecordingQualityType = {}));
@@ -3413,50 +3574,50 @@ var AudioRecordingQualityType;
3413
3574
  var AudioFileRecordingType;
3414
3575
  (function (AudioFileRecordingType) {
3415
3576
  /**
3416
- * 1: Only records the audio of the local user.
3577
+ * 1: Record only the local user's audio.
3417
3578
  */
3418
3579
  AudioFileRecordingType[AudioFileRecordingType["AudioFileRecordingMic"] = 1] = "AudioFileRecordingMic";
3419
3580
  /**
3420
- * 2: Only records the audio of all remote users.
3581
+ * 2: Record only the audio of all remote users.
3421
3582
  */
3422
3583
  AudioFileRecordingType[AudioFileRecordingType["AudioFileRecordingPlayback"] = 2] = "AudioFileRecordingPlayback";
3423
3584
  /**
3424
- * 3: Records the mixed audio of the local and all remote users.
3585
+ * 3: Record the mixed audio of the local and all remote users.
3425
3586
  */
3426
3587
  AudioFileRecordingType[AudioFileRecordingType["AudioFileRecordingMixed"] = 3] = "AudioFileRecordingMixed";
3427
3588
  })(AudioFileRecordingType = exports.AudioFileRecordingType || (exports.AudioFileRecordingType = {}));
3428
3589
  /**
3429
- * Audio profile.
3590
+ * Audio encoding content.
3430
3591
  */
3431
3592
  var AudioEncodedFrameObserverPosition;
3432
3593
  (function (AudioEncodedFrameObserverPosition) {
3433
3594
  /**
3434
- * 1: Only records the audio of the local user.
3595
+ * 1: Encode only the local user's audio.
3435
3596
  */
3436
3597
  AudioEncodedFrameObserverPosition[AudioEncodedFrameObserverPosition["AudioEncodedFrameObserverPositionRecord"] = 1] = "AudioEncodedFrameObserverPositionRecord";
3437
3598
  /**
3438
- * 2: Only records the audio of all remote users.
3599
+ * 2: Encode only the audio of all remote users.
3439
3600
  */
3440
3601
  AudioEncodedFrameObserverPosition[AudioEncodedFrameObserverPosition["AudioEncodedFrameObserverPositionPlayback"] = 2] = "AudioEncodedFrameObserverPositionPlayback";
3441
3602
  /**
3442
- * 3: Records the mixed audio of the local and all remote users.
3603
+ * 3: Encode the mixed audio of the local and all remote users.
3443
3604
  */
3444
3605
  AudioEncodedFrameObserverPosition[AudioEncodedFrameObserverPosition["AudioEncodedFrameObserverPositionMixed"] = 3] = "AudioEncodedFrameObserverPositionMixed";
3445
3606
  })(AudioEncodedFrameObserverPosition = exports.AudioEncodedFrameObserverPosition || (exports.AudioEncodedFrameObserverPosition = {}));
3446
3607
  /**
3447
- * Recording configurations.
3608
+ * Recording configuration.
3448
3609
  */
3449
3610
  class AudioRecordingConfiguration {
3450
3611
  }
3451
3612
  exports.AudioRecordingConfiguration = AudioRecordingConfiguration;
3452
3613
  /**
3453
- * Observer settings for the encoded audio.
3614
+ * Observer settings for encoded audio.
3454
3615
  */
3455
3616
  class AudioEncodedFrameObserverConfig {
3456
3617
  }
3457
3618
  exports.AudioEncodedFrameObserverConfig = AudioEncodedFrameObserverConfig;
3458
3619
  /**
3459
- * The region for connection, which is the region where the server the SDK connects to is located.
3620
+ * The region where the SDK connects to the server.
3460
3621
  */
3461
3622
  var AreaCode;
3462
3623
  (function (AreaCode) {
@@ -3473,7 +3634,7 @@ var AreaCode;
3473
3634
  */
3474
3635
  AreaCode[AreaCode["AreaCodeEu"] = 4] = "AreaCodeEu";
3475
3636
  /**
3476
- * Asia, excluding Mainland China.
3637
+ * Asia excluding Mainland China.
3477
3638
  */
3478
3639
  AreaCode[AreaCode["AreaCodeAs"] = 8] = "AreaCodeAs";
3479
3640
  /**
@@ -3528,78 +3689,80 @@ var AreaCodeEx;
3528
3689
  AreaCodeEx[AreaCodeEx["AreaCodeOvs"] = 4294967294] = "AreaCodeOvs";
3529
3690
  })(AreaCodeEx = exports.AreaCodeEx || (exports.AreaCodeEx = {}));
3530
3691
  /**
3531
- * The error code of the channel media relay.
3692
+ * Error codes for cross-channel media stream relay.
3532
3693
  */
3533
3694
  var ChannelMediaRelayError;
3534
3695
  (function (ChannelMediaRelayError) {
3535
3696
  /**
3536
- * 0: No error.
3697
+ * 0: Everything is working properly.
3537
3698
  */
3538
3699
  ChannelMediaRelayError[ChannelMediaRelayError["RelayOk"] = 0] = "RelayOk";
3539
3700
  /**
3540
- * 1: An error occurs in the server response.
3701
+ * 1: Server returned an error.
3541
3702
  */
3542
3703
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerErrorResponse"] = 1] = "RelayErrorServerErrorResponse";
3543
3704
  /**
3544
- * 2: No server response. This error may be caused by poor network connections. If this error occurs when initiating a channel media relay, you can try again later; if this error occurs during channel media relay, you can call leaveChannel to leave the channel. This error can also occur if the channel media relay service is not enabled in the project. You can contact to enable the service.
3705
+ * 2: No response from the server.
3706
+ * This error may be caused by poor network conditions. If this error occurs when initiating cross-channel media relay, you can try again later; if it occurs during the relay process, you can call the leaveChannel method to leave the channel.
3707
+ * It may also be due to the current App ID not having cross-channel media relay enabled. You can [contact technical support](https://www.agora.io/cn/contact/) to request enabling this feature.
3545
3708
  */
3546
3709
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerNoResponse"] = 2] = "RelayErrorServerNoResponse";
3547
3710
  /**
3548
- * 3: The SDK fails to access the service, probably due to limited resources of the server.
3711
+ * 3: The SDK cannot access the service, possibly due to limited server resources.
3549
3712
  */
3550
3713
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorNoResourceAvailable"] = 3] = "RelayErrorNoResourceAvailable";
3551
3714
  /**
3552
- * 4: Fails to send the relay request.
3715
+ * 4: Failed to initiate cross-channel media stream relay request.
3553
3716
  */
3554
3717
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedJoinSrc"] = 4] = "RelayErrorFailedJoinSrc";
3555
3718
  /**
3556
- * 5: Fails to accept the relay request.
3719
+ * 5: Failed to accept cross-channel media stream relay request.
3557
3720
  */
3558
3721
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedJoinDest"] = 5] = "RelayErrorFailedJoinDest";
3559
3722
  /**
3560
- * 6: The server fails to receive the media stream.
3723
+ * 6: Server failed to receive cross-channel media stream.
3561
3724
  */
3562
3725
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedPacketReceivedFromSrc"] = 6] = "RelayErrorFailedPacketReceivedFromSrc";
3563
3726
  /**
3564
- * 7: The server fails to send the media stream.
3727
+ * 7: Server failed to send cross-channel media stream.
3565
3728
  */
3566
3729
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedPacketSentToDest"] = 7] = "RelayErrorFailedPacketSentToDest";
3567
3730
  /**
3568
- * 8: The SDK disconnects from the server due to poor network connections. You can call leaveChannel to leave the channel.
3731
+ * 8: SDK disconnected from the server due to poor network quality. You can call the leaveChannel method to leave the current channel.
3569
3732
  */
3570
3733
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerConnectionLost"] = 8] = "RelayErrorServerConnectionLost";
3571
3734
  /**
3572
- * 9: An internal error occurs in the server.
3735
+ * 9: Internal server error.
3573
3736
  */
3574
3737
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorInternalError"] = 9] = "RelayErrorInternalError";
3575
3738
  /**
3576
- * 10: The token of the source channel has expired.
3739
+ * 10: The token for the source channel has expired.
3577
3740
  */
3578
3741
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorSrcTokenExpired"] = 10] = "RelayErrorSrcTokenExpired";
3579
3742
  /**
3580
- * 11: The token of the destination channel has expired.
3743
+ * 11: The token for the destination channel has expired.
3581
3744
  */
3582
3745
  ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorDestTokenExpired"] = 11] = "RelayErrorDestTokenExpired";
3583
3746
  })(ChannelMediaRelayError = exports.ChannelMediaRelayError || (exports.ChannelMediaRelayError = {}));
3584
3747
  /**
3585
- * The state code of the channel media relay.
3748
+ * State codes for cross-channel media stream relay.
3586
3749
  */
3587
3750
  var ChannelMediaRelayState;
3588
3751
  (function (ChannelMediaRelayState) {
3589
3752
  /**
3590
- * 0: The initial state. After you successfully stop the channel media relay by calling stopChannelMediaRelay, the onChannelMediaRelayStateChanged callback returns this state.
3753
+ * 0: Initial state. After successfully calling stopChannelMediaRelay to stop the relay, onChannelMediaRelayStateChanged will return this state.
3591
3754
  */
3592
3755
  ChannelMediaRelayState[ChannelMediaRelayState["RelayStateIdle"] = 0] = "RelayStateIdle";
3593
3756
  /**
3594
- * 1: The SDK tries to relay the media stream to the destination channel.
3757
+ * 1: SDK is attempting cross-channel relay.
3595
3758
  */
3596
3759
  ChannelMediaRelayState[ChannelMediaRelayState["RelayStateConnecting"] = 1] = "RelayStateConnecting";
3597
3760
  /**
3598
- * 2: The SDK successfully relays the media stream to the destination channel.
3761
+ * 2: The broadcaster from the source channel has successfully joined the destination channel.
3599
3762
  */
3600
3763
  ChannelMediaRelayState[ChannelMediaRelayState["RelayStateRunning"] = 2] = "RelayStateRunning";
3601
3764
  /**
3602
- * 3: An error occurs. See code in onChannelMediaRelayStateChanged for the error code.
3765
+ * 3: An error occurred. See the code parameter in onChannelMediaRelayStateChanged for details.
3603
3766
  */
3604
3767
  ChannelMediaRelayState[ChannelMediaRelayState["RelayStateFailure"] = 3] = "RelayStateFailure";
3605
3768
  })(ChannelMediaRelayState = exports.ChannelMediaRelayState || (exports.ChannelMediaRelayState = {}));
@@ -3610,13 +3773,13 @@ class ChannelMediaInfo {
3610
3773
  }
3611
3774
  exports.ChannelMediaInfo = ChannelMediaInfo;
3612
3775
  /**
3613
- * Configuration of cross channel media relay.
3776
+ * Cross-channel media stream relay configuration.
3614
3777
  */
3615
3778
  class ChannelMediaRelayConfiguration {
3616
3779
  }
3617
3780
  exports.ChannelMediaRelayConfiguration = ChannelMediaRelayConfiguration;
3618
3781
  /**
3619
- * The uplink network information.
3782
+ * Uplink network information.
3620
3783
  */
3621
3784
  class UplinkNetworkInfo {
3622
3785
  }
@@ -3634,9 +3797,9 @@ class DownlinkNetworkInfo {
3634
3797
  }
3635
3798
  exports.DownlinkNetworkInfo = DownlinkNetworkInfo;
3636
3799
  /**
3637
- * The built-in encryption mode.
3800
+ * Built-in encryption modes.
3638
3801
  *
3639
- * Agora recommends using Aes128Gcm2 or Aes256Gcm2 encrypted mode. These two modes support the use of salt for higher security.
3802
+ * It is recommended to use Aes128Gcm2 or Aes256Gcm2 encryption modes. These modes support salt and provide higher security.
3640
3803
  */
3641
3804
  var EncryptionMode;
3642
3805
  (function (EncryptionMode) {
@@ -3665,35 +3828,35 @@ var EncryptionMode;
3665
3828
  */
3666
3829
  EncryptionMode[EncryptionMode["Aes256Gcm"] = 6] = "Aes256Gcm";
3667
3830
  /**
3668
- * 7: (Default) 128-bit AES encryption, GCM mode. This encryption mode requires the setting of salt (encryptionKdfSalt).
3831
+ * 7: (Default) 128-bit AES encryption, GCM mode. This encryption mode requires setting a salt (encryptionKdfSalt).
3669
3832
  */
3670
3833
  EncryptionMode[EncryptionMode["Aes128Gcm2"] = 7] = "Aes128Gcm2";
3671
3834
  /**
3672
- * 8: 256-bit AES encryption, GCM mode. This encryption mode requires the setting of salt (encryptionKdfSalt).
3835
+ * 8: 256-bit AES encryption, GCM mode. This encryption mode requires setting a salt (encryptionKdfSalt).
3673
3836
  */
3674
3837
  EncryptionMode[EncryptionMode["Aes256Gcm2"] = 8] = "Aes256Gcm2";
3675
3838
  /**
3676
- * Enumerator boundary.
3839
+ * Enumeration boundary value.
3677
3840
  */
3678
3841
  EncryptionMode[EncryptionMode["ModeEnd"] = 9] = "ModeEnd";
3679
3842
  })(EncryptionMode = exports.EncryptionMode || (exports.EncryptionMode = {}));
3680
3843
  /**
3681
- * Built-in encryption configurations.
3844
+ * Configures the built-in encryption mode and key.
3682
3845
  */
3683
3846
  class EncryptionConfig {
3684
3847
  }
3685
3848
  exports.EncryptionConfig = EncryptionConfig;
3686
3849
  /**
3687
- * Encryption error type.
3850
+ * Error types for built-in encryption.
3688
3851
  */
3689
3852
  var EncryptionErrorType;
3690
3853
  (function (EncryptionErrorType) {
3691
3854
  /**
3692
- * 0: Internal reason.
3855
+ * 0: Internal error.
3693
3856
  */
3694
3857
  EncryptionErrorType[EncryptionErrorType["EncryptionErrorInternalFailure"] = 0] = "EncryptionErrorInternalFailure";
3695
3858
  /**
3696
- * 1: Media stream decryption error. Ensure that the receiver and the sender use the same encryption mode and key.
3859
+ * 1: Media stream decryption error. Make sure the encryption mode or key used on the receiving and sending ends is the same.
3697
3860
  */
3698
3861
  EncryptionErrorType[EncryptionErrorType["EncryptionErrorDecryptionFailure"] = 1] = "EncryptionErrorDecryptionFailure";
3699
3862
  /**
@@ -3701,7 +3864,7 @@ var EncryptionErrorType;
3701
3864
  */
3702
3865
  EncryptionErrorType[EncryptionErrorType["EncryptionErrorEncryptionFailure"] = 2] = "EncryptionErrorEncryptionFailure";
3703
3866
  /**
3704
- * 3: Data stream decryption error. Ensure that the receiver and the sender use the same encryption mode and key.
3867
+ * 3: Data stream decryption error. Make sure the encryption mode or key used on the receiving and sending ends is the same.
3705
3868
  */
3706
3869
  EncryptionErrorType[EncryptionErrorType["EncryptionErrorDatastreamDecryptionFailure"] = 3] = "EncryptionErrorDatastreamDecryptionFailure";
3707
3870
  /**
@@ -3728,16 +3891,16 @@ var UploadErrorReason;
3728
3891
  UploadErrorReason[UploadErrorReason["UploadServerError"] = 2] = "UploadServerError";
3729
3892
  })(UploadErrorReason = exports.UploadErrorReason || (exports.UploadErrorReason = {}));
3730
3893
  /**
3731
- * The type of the device permission.
3894
+ * Type of device permission.
3732
3895
  */
3733
3896
  var PermissionType;
3734
3897
  (function (PermissionType) {
3735
3898
  /**
3736
- * 0: Permission for the audio capture device.
3899
+ * 0: Permission for audio recording device.
3737
3900
  */
3738
3901
  PermissionType[PermissionType["RecordAudio"] = 0] = "RecordAudio";
3739
3902
  /**
3740
- * 1: Permission for the camera.
3903
+ * 1: Permission for camera.
3741
3904
  */
3742
3905
  PermissionType[PermissionType["Camera"] = 1] = "Camera";
3743
3906
  /**
@@ -3746,24 +3909,24 @@ var PermissionType;
3746
3909
  PermissionType[PermissionType["ScreenCapture"] = 2] = "ScreenCapture";
3747
3910
  })(PermissionType = exports.PermissionType || (exports.PermissionType = {}));
3748
3911
  /**
3749
- * The subscribing state.
3912
+ * Subscribe state.
3750
3913
  */
3751
3914
  var StreamSubscribeState;
3752
3915
  (function (StreamSubscribeState) {
3753
3916
  /**
3754
- * 0: The initial publishing state after joining the channel.
3917
+ * 0: Initial subscribe state after joining the channel.
3755
3918
  */
3756
3919
  StreamSubscribeState[StreamSubscribeState["SubStateIdle"] = 0] = "SubStateIdle";
3757
3920
  /**
3758
- * 1: Fails to subscribe to the remote stream. Possible reasons:
3759
- * The remote user:
3760
- * Calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media stream.
3761
- * Calls disableAudio or disableVideo to disable the local audio or video module.
3762
- * Calls enableLocalAudio (false) or enableLocalVideo (false) to disable local audio or video capture.
3763
- * The role of the remote user is audience.
3764
- * The local user calls the following methods to stop receiving remote streams:
3765
- * Call muteRemoteAudioStream (true) or muteAllRemoteAudioStreams (true) to stop receiving the remote audio stream.
3766
- * Call muteRemoteVideoStream (true) or muteAllRemoteVideoStreams (true) to stop receiving the remote video stream.
3921
+ * 1: Subscription failed. Possible reasons:
3922
+ * Remote user:
3923
+ * Called muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media streams.
3924
+ * Called disableAudio or disableVideo to disable local audio or video modules.
3925
+ * Called enableLocalAudio (false) or enableLocalVideo (false) to disable local audio or video capture.
3926
+ * User role is audience.
3927
+ * Local user called the following methods to stop receiving remote media streams:
3928
+ * Called muteRemoteAudioStream (true), muteAllRemoteAudioStreams (true) to stop receiving remote audio streams.
3929
+ * Called muteRemoteVideoStream (true), muteAllRemoteVideoStreams (true) to stop receiving remote video streams.
3767
3930
  */
3768
3931
  StreamSubscribeState[StreamSubscribeState["SubStateNoSubscribed"] = 1] = "SubStateNoSubscribed";
3769
3932
  /**
@@ -3771,25 +3934,25 @@ var StreamSubscribeState;
3771
3934
  */
3772
3935
  StreamSubscribeState[StreamSubscribeState["SubStateSubscribing"] = 2] = "SubStateSubscribing";
3773
3936
  /**
3774
- * 3: The remote stream is received, and the subscription is successful.
3937
+ * 3: Remote stream received, subscription successful.
3775
3938
  */
3776
3939
  StreamSubscribeState[StreamSubscribeState["SubStateSubscribed"] = 3] = "SubStateSubscribed";
3777
3940
  })(StreamSubscribeState = exports.StreamSubscribeState || (exports.StreamSubscribeState = {}));
3778
3941
  /**
3779
- * The publishing state.
3942
+ * Publish state.
3780
3943
  */
3781
3944
  var StreamPublishState;
3782
3945
  (function (StreamPublishState) {
3783
3946
  /**
3784
- * 0: The initial publishing state after joining the channel.
3947
+ * 0: Initial publish state after joining the channel.
3785
3948
  */
3786
3949
  StreamPublishState[StreamPublishState["PubStateIdle"] = 0] = "PubStateIdle";
3787
3950
  /**
3788
- * 1: Fails to publish the local stream. Possible reasons:
3789
- * The local user calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media streams.
3790
- * The local user calls disableAudio or disableVideo to disable the local audio or video module.
3791
- * The local user calls enableLocalAudio (false) or enableLocalVideo (false) to disable the local audio or video capture.
3792
- * The role of the local user is audience.
3951
+ * 1: Publish failed. Possible reasons:
3952
+ * The local user called muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media streams.
3953
+ * The local user called disableAudio or disableVideo to disable local audio or video modules.
3954
+ * The local user called enableLocalAudio (false) or enableLocalVideo (false) to disable local audio or video capture.
3955
+ * The local user is an audience member.
3793
3956
  */
3794
3957
  StreamPublishState[StreamPublishState["PubStateNoPublished"] = 1] = "PubStateNoPublished";
3795
3958
  /**
@@ -3797,41 +3960,41 @@ var StreamPublishState;
3797
3960
  */
3798
3961
  StreamPublishState[StreamPublishState["PubStatePublishing"] = 2] = "PubStatePublishing";
3799
3962
  /**
3800
- * 3: Publishes successfully.
3963
+ * 3: Publish successful.
3801
3964
  */
3802
3965
  StreamPublishState[StreamPublishState["PubStatePublished"] = 3] = "PubStatePublished";
3803
3966
  })(StreamPublishState = exports.StreamPublishState || (exports.StreamPublishState = {}));
3804
3967
  /**
3805
- * The configuration of the audio and video call loop test.
3968
+ * Configuration for audio and video loop test.
3806
3969
  */
3807
3970
  class EchoTestConfiguration {
3808
3971
  }
3809
3972
  exports.EchoTestConfiguration = EchoTestConfiguration;
3810
3973
  /**
3811
- * The information of the user.
3974
+ * User information.
3812
3975
  */
3813
3976
  class UserInfo {
3814
3977
  }
3815
3978
  exports.UserInfo = UserInfo;
3816
3979
  /**
3817
- * The audio filter types of in-ear monitoring.
3980
+ * Ear monitoring audio filter type.
3818
3981
  */
3819
3982
  var EarMonitoringFilterType;
3820
3983
  (function (EarMonitoringFilterType) {
3821
3984
  /**
3822
- * 1<<0: No audio filter added to in-ear monitoring.
3985
+ * 1<<0: Do not add audio filters in ear monitoring.
3823
3986
  */
3824
3987
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterNone"] = 1] = "EarMonitoringFilterNone";
3825
3988
  /**
3826
- * 1<<1: Add vocal effects audio filter to in-ear monitoring. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
3989
+ * 1<<1: Add vocal effect audio filters in ear monitoring. If you implement features such as voice beautifier or sound effects, users can hear the processed sound in ear monitoring.
3827
3990
  */
3828
3991
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterBuiltInAudioFilters"] = 2] = "EarMonitoringFilterBuiltInAudioFilters";
3829
3992
  /**
3830
- * 1<<2: Add noise suppression audio filter to in-ear monitoring.
3993
+ * 1<<2: Add noise suppression audio filters in ear monitoring.
3831
3994
  */
3832
3995
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterNoiseSuppression"] = 4] = "EarMonitoringFilterNoiseSuppression";
3833
3996
  /**
3834
- * 1<<15: Reuse the audio filter that has been processed on the sending end for in-ear monitoring. This enumerator reduces CPU usage while increasing in-ear monitoring latency, which is suitable for latency-tolerant scenarios requiring low CPU consumption.
3997
+ * 1<<15: Reuse the audio filters already applied on the sending side. Reusing audio filters reduces CPU usage for ear monitoring but increases ear monitoring latency. Suitable for scenarios where low CPU usage is prioritized over latency.
3835
3998
  */
3836
3999
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterReusePostProcessingFilter"] = 32768] = "EarMonitoringFilterReusePostProcessingFilter";
3837
4000
  })(EarMonitoringFilterType = exports.EarMonitoringFilterType || (exports.EarMonitoringFilterType = {}));
@@ -3866,19 +4029,11 @@ var ThreadPriorityType;
3866
4029
  ThreadPriorityType[ThreadPriorityType["Critical"] = 5] = "Critical";
3867
4030
  })(ThreadPriorityType = exports.ThreadPriorityType || (exports.ThreadPriorityType = {}));
3868
4031
  /**
3869
- * The video configuration for the shared screen stream.
4032
+ * @ignore
3870
4033
  */
3871
4034
  class ScreenVideoParameters {
3872
4035
  }
3873
4036
  exports.ScreenVideoParameters = ScreenVideoParameters;
3874
- /**
3875
- * The audio configuration for the shared screen stream.
3876
- *
3877
- * Only available where captureAudio is true.
3878
- */
3879
- class ScreenAudioParameters {
3880
- }
3881
- exports.ScreenAudioParameters = ScreenAudioParameters;
3882
4037
  /**
3883
4038
  * @ignore
3884
4039
  */
@@ -3886,21 +4041,21 @@ class ScreenCaptureParameters2 {
3886
4041
  }
3887
4042
  exports.ScreenCaptureParameters2 = ScreenCaptureParameters2;
3888
4043
  /**
3889
- * The rendering state of the media frame.
4044
+ * Media frame rendering status.
3890
4045
  */
3891
4046
  var MediaTraceEvent;
3892
4047
  (function (MediaTraceEvent) {
3893
4048
  /**
3894
- * 0: The video frame has been rendered.
4049
+ * 0: Video frame rendered.
3895
4050
  */
3896
4051
  MediaTraceEvent[MediaTraceEvent["MediaTraceEventVideoRendered"] = 0] = "MediaTraceEventVideoRendered";
3897
4052
  /**
3898
- * 1: The video frame has been decoded.
4053
+ * 1: Video frame decoded.
3899
4054
  */
3900
4055
  MediaTraceEvent[MediaTraceEvent["MediaTraceEventVideoDecoded"] = 1] = "MediaTraceEventVideoDecoded";
3901
4056
  })(MediaTraceEvent = exports.MediaTraceEvent || (exports.MediaTraceEvent = {}));
3902
4057
  /**
3903
- * Indicators during video frame rendering progress.
4058
+ * Metrics during video frame rendering.
3904
4059
  */
3905
4060
  class VideoRenderingTracingInfo {
3906
4061
  }
@@ -3934,19 +4089,19 @@ var LocalProxyMode;
3934
4089
  LocalProxyMode[LocalProxyMode["LocalOnly"] = 1] = "LocalOnly";
3935
4090
  })(LocalProxyMode = exports.LocalProxyMode || (exports.LocalProxyMode = {}));
3936
4091
  /**
3937
- * @ignore
4092
+ * Configuration information of the log server.
3938
4093
  */
3939
4094
  class LogUploadServerInfo {
3940
4095
  }
3941
4096
  exports.LogUploadServerInfo = LogUploadServerInfo;
3942
4097
  /**
3943
- * @ignore
4098
+ * Advanced options for Local Access Point.
3944
4099
  */
3945
4100
  class AdvancedConfigInfo {
3946
4101
  }
3947
4102
  exports.AdvancedConfigInfo = AdvancedConfigInfo;
3948
4103
  /**
3949
- * @ignore
4104
+ * Local Access Point configuration.
3950
4105
  */
3951
4106
  class LocalAccessPointConfiguration {
3952
4107
  }
@@ -3972,7 +4127,7 @@ class RecorderStreamInfo {
3972
4127
  }
3973
4128
  exports.RecorderStreamInfo = RecorderStreamInfo;
3974
4129
  /**
3975
- * The spatial audio parameters.
4130
+ * Spatial audio parameters.
3976
4131
  */
3977
4132
  class SpatialAudioParams {
3978
4133
  }