agora-electron-sdk 4.0.0-test.2 → 4.0.0

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 (57) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +4 -5
  3. package/js/Private/AgoraBase.d.ts +28 -21
  4. package/js/Private/AgoraBase.js +16 -12
  5. package/js/Private/AgoraMediaBase.d.ts +1 -1
  6. package/js/Private/IAgoraMediaPlayer.d.ts +13 -12
  7. package/js/Private/IAgoraRtcEngine.d.ts +61 -106
  8. package/js/Private/IAgoraRtcEngineEx.d.ts +27 -46
  9. package/js/Private/IAgoraSpatialAudio.d.ts +1 -0
  10. package/js/Private/IAgoraSpatialAudio.js +1 -0
  11. package/js/Private/IAudioDeviceManager.d.ts +1 -1
  12. package/js/Private/extension/IAgoraMediaEngineExtension.d.ts +12 -3
  13. package/js/Private/extension/IAgoraMediaPlayerExtension.d.ts +16 -4
  14. package/js/Private/extension/IAgoraMediaRecorderExtension.d.ts +12 -3
  15. package/js/Private/extension/IAgoraRtcEngineExtension.d.ts +12 -3
  16. package/js/Private/impl/IAgoraMediaEngineImpl.js +1 -0
  17. package/js/Private/impl/IAgoraMediaPlayerImpl.js +2 -0
  18. package/js/Private/impl/IAgoraMediaRecorderImpl.js +1 -0
  19. package/js/Private/impl/IAgoraRtcEngineExImpl.js +1 -0
  20. package/js/Private/impl/IAgoraRtcEngineImpl.js +2 -0
  21. package/js/Private/impl/IAgoraSpatialAudioImpl.js +2 -0
  22. package/js/Private/impl/IAudioDeviceManagerImpl.js +1 -0
  23. package/js/Private/internal/IrisApiEngine.js +7 -7
  24. package/js/Renderer/AgoraView.d.ts +1 -6
  25. package/package.json +2 -2
  26. package/ts/Private/AgoraBase.ts +27 -20
  27. package/ts/Private/AgoraMediaBase.ts +1 -1
  28. package/ts/Private/IAgoraMediaPlayer.ts +13 -12
  29. package/ts/Private/IAgoraRtcEngine.ts +61 -106
  30. package/ts/Private/IAgoraRtcEngineEx.ts +27 -46
  31. package/ts/Private/IAgoraSpatialAudio.ts +1 -0
  32. package/ts/Private/IAudioDeviceManager.ts +1 -1
  33. package/ts/Private/extension/IAgoraMediaEngineExtension.ts +12 -3
  34. package/ts/Private/extension/IAgoraMediaPlayerExtension.ts +16 -4
  35. package/ts/Private/extension/IAgoraMediaRecorderExtension.ts +12 -3
  36. package/ts/Private/extension/IAgoraRtcEngineExtension.ts +12 -3
  37. package/ts/Private/impl/IAgoraMediaEngineImpl.ts +1 -0
  38. package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +2 -0
  39. package/ts/Private/impl/IAgoraMediaRecorderImpl.ts +1 -0
  40. package/ts/Private/impl/IAgoraRtcEngineExImpl.ts +1 -0
  41. package/ts/Private/impl/IAgoraRtcEngineImpl.ts +2 -0
  42. package/ts/Private/impl/IAgoraSpatialAudioImpl.ts +2 -0
  43. package/ts/Private/impl/IAudioDeviceManagerImpl.ts +1 -0
  44. package/ts/Private/internal/IrisApiEngine.ts +8 -7
  45. package/ts/Renderer/AgoraView.ts +1 -6
  46. package/types/Private/AgoraBase.d.ts +28 -21
  47. package/types/Private/AgoraMediaBase.d.ts +1 -1
  48. package/types/Private/IAgoraMediaPlayer.d.ts +13 -12
  49. package/types/Private/IAgoraRtcEngine.d.ts +61 -106
  50. package/types/Private/IAgoraRtcEngineEx.d.ts +27 -46
  51. package/types/Private/IAgoraSpatialAudio.d.ts +1 -0
  52. package/types/Private/IAudioDeviceManager.d.ts +1 -1
  53. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts +12 -3
  54. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts +16 -4
  55. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts +12 -3
  56. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts +12 -3
  57. package/types/Renderer/AgoraView.d.ts +1 -6
package/CHANGELOG.md CHANGED
@@ -1,3 +1,28 @@
1
+ # [4.0.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.0.0-rc.3...v4.0.0) (2022-09-28)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * set windows msvc link as MT ([341c9ee](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/341c9ee600d5230ac40dd8c6b0226dfaaf96354e))
7
+ * some AudioFrameObserver & VideoFrameObserver issue ([58063be](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/58063be50f8156e24118b707dfe14fd28f03f405))
8
+
9
+
10
+ ### Features
11
+
12
+ * complete,hook ([#881](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/881)) ([a9f679b](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/a9f679b73bb6896e84106a3284e49c86b8ba4927))
13
+
14
+
15
+ ### Reverts
16
+
17
+ * iris url ([60492eb](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/60492ebccb79929a0ff206f013ffd24ba2b2e106))
18
+
19
+ # [4.0.0-rc.3](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.0.0-rc.2...v4.0.0-rc.3) (2022-09-14)
20
+
21
+
22
+ ### Bug Fixes
23
+
24
+ * npm install failed ([8b04ff4](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/8b04ff49a6d7b2b5d54188bb7628bb095f629736))
25
+
1
26
  # [4.0.0-rc.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.0.0-rc.1...v4.0.0-rc.2) (2022-09-13)
2
27
 
3
28
 
package/README.md CHANGED
@@ -1,3 +1,6 @@
1
+ > NOTE: These sdk and samples only for the Agora Video 4.x APIs. For examples using previous releases please see the following branches:
2
+ > - [3.x](https://github.com/AgoraIO-Extensions/Electron-SDK/tree/3.x)
3
+
1
4
  # Agora RTC SDK for Electron
2
5
 
3
6
  <div align="left">
@@ -6,7 +9,6 @@
6
9
  <a href="https://www.npmjs.com/package/agora-electron-sdk"><img alt="npm" src="https://img.shields.io/npm/dm/agora-electron-sdk?color=blue&style=flat-square&logo=npm"></a>
7
10
  <a href="./LICENSE"><img src="https://img.shields.io/github/license/agoraio-extensions/electron-sdk?color=blue&style=flat-square" alt="License"/></a>
8
11
  <a href="https://github.com/AgoraIO-Extensions/Electron-SDK/issues"><img src="https://flat.badgen.net/github/label-issues/AgoraIO-Extensions/Electron-SDK/help%20wanted/open" alt="License"/></a>
9
-
10
12
  </div>
11
13
 
12
14
  ## ✨ Features
@@ -85,10 +87,7 @@ set `externals` property of your webpack config to `{"agora-electron-sdk": "comm
85
87
 
86
88
  ## 🔗 Links
87
89
 
88
- - [Document](https://docs.agora.io/en/Video/API%20Reference/electron/index.html) - Official document
89
-
90
- - [e-Education Application](https://github.com/AgoraIO/ARD-eEducation-with-Electron) - A complete e-education
91
- Application based on this repo
90
+ - [Document](https://docs.agora.io/en/video-call-4.x/API%20Reference/electron_ng/API/rtc_api_overview_ng.html) - Official document
92
91
 
93
92
  - [Demo](./example/) - A quick start demo based on Vue/React and this repo
94
93
 
@@ -514,7 +514,11 @@ export declare enum InterfaceIdType {
514
514
  /**
515
515
  * The IMediaRecorder interface class.
516
516
  */
517
- AgoraIidMediaRecorder = 12
517
+ AgoraIidMediaRecorder = 12,
518
+ /**
519
+ * @ignore
520
+ */
521
+ AgoraIidMusicContentCenter = 13
518
522
  }
519
523
  /**
520
524
  * Network quality types.
@@ -1130,7 +1134,7 @@ export declare enum SimulcastStreamMode {
1130
1134
  /**
1131
1135
  * @ignore
1132
1136
  */
1133
- DisableSimulcastStrem = 0,
1137
+ DisableSimulcastStream = 0,
1134
1138
  /**
1135
1139
  * @ignore
1136
1140
  */
@@ -1877,7 +1881,7 @@ export declare enum LocalVideoStreamError {
1877
1881
  */
1878
1882
  export declare enum RemoteAudioState {
1879
1883
  /**
1880
- * 0: The local audio is in the initial state. The SDK reports this state in the case of RemoteAudioReasonLocalMuted, RemoteAudioReasonRemoteMuted or RemoteAudioReasonRemoteOffline.
1884
+ * 0: The local audio is in the initial state. The SDK reports this state in the case of RemoteAudioLocalMuted, RemoteAudioReasonRemoteMuted or RemoteAudioReasonRemoteOffline.
1881
1885
  */
1882
1886
  RemoteAudioStateStopped = 0,
1883
1887
  /**
@@ -1885,11 +1889,11 @@ export declare enum RemoteAudioState {
1885
1889
  */
1886
1890
  RemoteAudioStateStarting = 1,
1887
1891
  /**
1888
- * 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of RemoteAudioReasonNetworkRecovery, RemoteAudioReasonLocalUnmuted or RemoteAudioReasonRemoteUnmuted.
1892
+ * 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of RemoteAudioNetworkRecovery, RemoteAudioReasonLocalUnmuted or RemoteAudioReasonRemoteUnmuted.
1889
1893
  */
1890
1894
  RemoteAudioStateDecoding = 2,
1891
1895
  /**
1892
- * 3: The remote audio is frozen. The SDK reports this state in the case of RemoteAudioReasonNetworkCongestion.
1896
+ * 3: The remote audio is frozen. The SDK reports this state in the case of RemoteAudioNetworkCongestion.
1893
1897
  */
1894
1898
  RemoteAudioStateFrozen = 3,
1895
1899
  /**
@@ -1906,15 +1910,15 @@ export declare enum RemoteAudioStateReason {
1906
1910
  */
1907
1911
  RemoteAudioReasonInternal = 0,
1908
1912
  /**
1909
- * 1: Network congestion.
1913
+ * @ignore
1910
1914
  */
1911
1915
  RemoteAudioReasonNetworkCongestion = 1,
1912
1916
  /**
1913
- * 2: Network recovery.
1917
+ * @ignore
1914
1918
  */
1915
1919
  RemoteAudioReasonNetworkRecovery = 2,
1916
1920
  /**
1917
- * 3: The local user stops receiving the remote audio stream or disables the audio module.
1921
+ * @ignore
1918
1922
  */
1919
1923
  RemoteAudioReasonLocalMuted = 3,
1920
1924
  /**
@@ -2639,15 +2643,15 @@ export declare class LocalTranscoderConfiguration {
2639
2643
  */
2640
2644
  export declare class LastmileProbeConfig {
2641
2645
  /**
2642
- * Sets whether to test the uplink network. Some users, for example, the audience members in a LIVE_BROADCASTING channel, do not need such a test.true: Test.false: Not test.
2646
+ * Sets whether to test the uplink network. Some users, for example, the audience members in a LIVE_BROADCASTING channel, do not need such a test.true: Test the uplink network.false: Do not test the uplink network.
2643
2647
  */
2644
2648
  probeUplink?: boolean;
2645
2649
  /**
2646
- * Sets whether to test the downlink network:true: Test.false: Not test.
2650
+ * Sets whether to test the downlink network:true: Test the downlink network.false: Do not test the downlink network.
2647
2651
  */
2648
2652
  probeDownlink?: boolean;
2649
2653
  /**
2650
- * The expected maximum uplink bitrate (bps) of the local user. The value range is [100000, 5000000]. Agora recommends setVideoEncoderConfiguration referring to to set the value.
2654
+ * The expected maximum uplink bitrate (bps) of the local user. The value range is [100000, 5000000]. Agora recommends referring to setVideoEncoderConfiguration to set the value.
2651
2655
  */
2652
2656
  expectedUplinkBitrate?: number;
2653
2657
  /**
@@ -3069,11 +3073,11 @@ export declare enum VideoDenoiserLevel {
3069
3073
  */
3070
3074
  VideoDenoiserLevelHighQuality = 0,
3071
3075
  /**
3072
- * 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 FAST when the camera is fixed.
3076
+ * 1: Promotes reducing performance consumption during video noise reduction. 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 settinging when the camera is fixed.
3073
3077
  */
3074
3078
  VideoDenoiserLevelFast = 1,
3075
3079
  /**
3076
- * 2: Enhanced video noise reduction. It prioritizes video noise reduction quality over reducing performance consumption. The performance consumption is higher, the video noise reduction speed is slower, and the video noise reduction quality is better. If is not enough for your video noise reduction needs, you can use this enumerator.VideoDenoiserLevelHighQuality
3080
+ * 2: Enhanced video noise reduction. prioritizes video noise reduction quality over reducing performance consumption. The performance consumption is higher, the video noise reduction speed is slower, and the video noise reduction quality is better. If VideoDenoiserLevelHighQuality is not enough for your video noise reduction needs, you can use this enumerator.
3077
3081
  */
3078
3082
  VideoDenoiserLevelStrength = 2
3079
3083
  }
@@ -3471,8 +3475,7 @@ export declare class AudioRecordingConfiguration {
3471
3475
  */
3472
3476
  encode?: boolean;
3473
3477
  /**
3474
- * Recording sample rate (Hz).
3475
- * 16000(Default) 320004410048000If you set this parameter to 44100 or 48000, Agora recommends recording WAV files, or AAC files with quality to be AgoraAudioRecordingQualityMedium or AgoraAudioRecordingQualityHigh for better recording quality.
3478
+ * Recording sample rate (Hz).16000(Default) 320004410048000If you set this parameter to 44100 or 48000, Agora recommends recording WAV files, or AAC files with quality set as AudioRecordingQualityMedium or AudioRecordingQualityHigh for better recording quality.
3476
3479
  */
3477
3480
  sampleRate?: number;
3478
3481
  /**
@@ -3509,7 +3512,9 @@ export interface IAudioEncodedFrameObserver {
3509
3512
  * Gets the encoded audio data of the local user.
3510
3513
  * After calling registerAudioEncodedFrameObserver and setting the encoded audio as AudioEncodedFrameObserverPositionRecord, you can get the encoded audio data of the local user from this callback.
3511
3514
  *
3512
- * @param channels The number of channels.1: Mono.2: Stereo. If the channel uses stereo, the data is interleaved.
3515
+ * @param channels The number of channels.
3516
+ * 1: Mono.
3517
+ * 2: Stereo. If the channel uses stereo, the data is interleaved.
3513
3518
  *
3514
3519
  * @param frameBuffer The audio buffer.
3515
3520
  *
@@ -3543,7 +3548,9 @@ export interface IAudioEncodedFrameObserver {
3543
3548
  *
3544
3549
  * @param samplesPerSec Recording sample rate (Hz).
3545
3550
  *
3546
- * @param channels The number of channels.1: Mono.2: Stereo. If the channel uses stereo, the data is interleaved.
3551
+ * @param channels The number of channels.
3552
+ * 1: Mono.
3553
+ * 2: Stereo. If the channel uses stereo, the data is interleaved.
3547
3554
  *
3548
3555
  * @param samplesPerChannel The number of samples per channel in the audio frame.
3549
3556
  *
@@ -4031,7 +4038,7 @@ export declare class EchoTestConfiguration {
4031
4038
  */
4032
4039
  enableVideo?: boolean;
4033
4040
  /**
4034
- * The token used to secure the audio and video call loop test. If you do not enable App Certificate in Agora Console, you do not need to pass a value in this parameter; if you have enabled App Certificate in Agora Console, you must pass a token in this parameter; the uid used when you generate the token must be 0xFFFFFFFF, and the channel name used must be the channel name that identifies each audio and video call loop tested. For server-side token generation, see Authenticate Your Users with Tokens.
4041
+ * @ignore
4035
4042
  */
4036
4043
  token?: string;
4037
4044
  /**
@@ -4057,15 +4064,15 @@ export declare class UserInfo {
4057
4064
  */
4058
4065
  export declare enum EarMonitoringFilterType {
4059
4066
  /**
4060
- * 1: Do not add an audio filter to the in-ear monitor.
4067
+ * 1<<0: Do not add an audio filter to the in-ear monitor.
4061
4068
  */
4062
4069
  EarMonitoringFilterNone = 1,
4063
4070
  /**
4064
- * 2: Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
4071
+ * 1<<1: Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
4065
4072
  */
4066
4073
  EarMonitoringFilterBuiltInAudioFilters = 2,
4067
4074
  /**
4068
- * 4: Enable noise suppression to the in-ear monitor.
4075
+ * 1<<2: Enable noise suppression to the in-ear monitor.
4069
4076
  */
4070
4077
  EarMonitoringFilterNoiseSuppression = 4
4071
4078
  }
@@ -525,6 +525,10 @@ var InterfaceIdType;
525
525
  * The IMediaRecorder interface class.
526
526
  */
527
527
  InterfaceIdType[InterfaceIdType["AgoraIidMediaRecorder"] = 12] = "AgoraIidMediaRecorder";
528
+ /**
529
+ * @ignore
530
+ */
531
+ InterfaceIdType[InterfaceIdType["AgoraIidMusicContentCenter"] = 13] = "AgoraIidMusicContentCenter";
528
532
  })(InterfaceIdType = exports.InterfaceIdType || (exports.InterfaceIdType = {}));
529
533
  /**
530
534
  * Network quality types.
@@ -1007,7 +1011,7 @@ var SimulcastStreamMode;
1007
1011
  /**
1008
1012
  * @ignore
1009
1013
  */
1010
- SimulcastStreamMode[SimulcastStreamMode["DisableSimulcastStrem"] = 0] = "DisableSimulcastStrem";
1014
+ SimulcastStreamMode[SimulcastStreamMode["DisableSimulcastStream"] = 0] = "DisableSimulcastStream";
1011
1015
  /**
1012
1016
  * @ignore
1013
1017
  */
@@ -1510,7 +1514,7 @@ var LocalVideoStreamError;
1510
1514
  var RemoteAudioState;
1511
1515
  (function (RemoteAudioState) {
1512
1516
  /**
1513
- * 0: The local audio is in the initial state. The SDK reports this state in the case of RemoteAudioReasonLocalMuted, RemoteAudioReasonRemoteMuted or RemoteAudioReasonRemoteOffline.
1517
+ * 0: The local audio is in the initial state. The SDK reports this state in the case of RemoteAudioLocalMuted, RemoteAudioReasonRemoteMuted or RemoteAudioReasonRemoteOffline.
1514
1518
  */
1515
1519
  RemoteAudioState[RemoteAudioState["RemoteAudioStateStopped"] = 0] = "RemoteAudioStateStopped";
1516
1520
  /**
@@ -1518,11 +1522,11 @@ var RemoteAudioState;
1518
1522
  */
1519
1523
  RemoteAudioState[RemoteAudioState["RemoteAudioStateStarting"] = 1] = "RemoteAudioStateStarting";
1520
1524
  /**
1521
- * 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of RemoteAudioReasonNetworkRecovery, RemoteAudioReasonLocalUnmuted or RemoteAudioReasonRemoteUnmuted.
1525
+ * 2: The remote audio stream is decoded and plays normally. The SDK reports this state in the case of RemoteAudioNetworkRecovery, RemoteAudioReasonLocalUnmuted or RemoteAudioReasonRemoteUnmuted.
1522
1526
  */
1523
1527
  RemoteAudioState[RemoteAudioState["RemoteAudioStateDecoding"] = 2] = "RemoteAudioStateDecoding";
1524
1528
  /**
1525
- * 3: The remote audio is frozen. The SDK reports this state in the case of RemoteAudioReasonNetworkCongestion.
1529
+ * 3: The remote audio is frozen. The SDK reports this state in the case of RemoteAudioNetworkCongestion.
1526
1530
  */
1527
1531
  RemoteAudioState[RemoteAudioState["RemoteAudioStateFrozen"] = 3] = "RemoteAudioStateFrozen";
1528
1532
  /**
@@ -1540,15 +1544,15 @@ var RemoteAudioStateReason;
1540
1544
  */
1541
1545
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonInternal"] = 0] = "RemoteAudioReasonInternal";
1542
1546
  /**
1543
- * 1: Network congestion.
1547
+ * @ignore
1544
1548
  */
1545
1549
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonNetworkCongestion"] = 1] = "RemoteAudioReasonNetworkCongestion";
1546
1550
  /**
1547
- * 2: Network recovery.
1551
+ * @ignore
1548
1552
  */
1549
1553
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonNetworkRecovery"] = 2] = "RemoteAudioReasonNetworkRecovery";
1550
1554
  /**
1551
- * 3: The local user stops receiving the remote audio stream or disables the audio module.
1555
+ * @ignore
1552
1556
  */
1553
1557
  RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonLocalMuted"] = 3] = "RemoteAudioReasonLocalMuted";
1554
1558
  /**
@@ -2319,11 +2323,11 @@ var VideoDenoiserLevel;
2319
2323
  */
2320
2324
  VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelHighQuality"] = 0] = "VideoDenoiserLevelHighQuality";
2321
2325
  /**
2322
- * 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 FAST when the camera is fixed.
2326
+ * 1: Promotes reducing performance consumption during video noise reduction. 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 settinging when the camera is fixed.
2323
2327
  */
2324
2328
  VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelFast"] = 1] = "VideoDenoiserLevelFast";
2325
2329
  /**
2326
- * 2: Enhanced video noise reduction. It prioritizes video noise reduction quality over reducing performance consumption. The performance consumption is higher, the video noise reduction speed is slower, and the video noise reduction quality is better. If is not enough for your video noise reduction needs, you can use this enumerator.VideoDenoiserLevelHighQuality
2330
+ * 2: Enhanced video noise reduction. prioritizes video noise reduction quality over reducing performance consumption. The performance consumption is higher, the video noise reduction speed is slower, and the video noise reduction quality is better. If VideoDenoiserLevelHighQuality is not enough for your video noise reduction needs, you can use this enumerator.
2327
2331
  */
2328
2332
  VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelStrength"] = 2] = "VideoDenoiserLevelStrength";
2329
2333
  })(VideoDenoiserLevel = exports.VideoDenoiserLevel || (exports.VideoDenoiserLevel = {}));
@@ -3071,15 +3075,15 @@ exports.UserInfo = UserInfo;
3071
3075
  var EarMonitoringFilterType;
3072
3076
  (function (EarMonitoringFilterType) {
3073
3077
  /**
3074
- * 1: Do not add an audio filter to the in-ear monitor.
3078
+ * 1<<0: Do not add an audio filter to the in-ear monitor.
3075
3079
  */
3076
3080
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterNone"] = 1] = "EarMonitoringFilterNone";
3077
3081
  /**
3078
- * 2: Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
3082
+ * 1<<1: Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
3079
3083
  */
3080
3084
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterBuiltInAudioFilters"] = 2] = "EarMonitoringFilterBuiltInAudioFilters";
3081
3085
  /**
3082
- * 4: Enable noise suppression to the in-ear monitor.
3086
+ * 1<<2: Enable noise suppression to the in-ear monitor.
3083
3087
  */
3084
3088
  EarMonitoringFilterType[EarMonitoringFilterType["EarMonitoringFilterNoiseSuppression"] = 4] = "EarMonitoringFilterNoiseSuppression";
3085
3089
  })(EarMonitoringFilterType = exports.EarMonitoringFilterType || (exports.EarMonitoringFilterType = {}));
@@ -1000,7 +1000,7 @@ export declare enum RecorderErrorCode {
1000
1000
  */
1001
1001
  export declare class MediaRecorderConfiguration {
1002
1002
  /**
1003
- * The absolute path (including the filename extensions) of the recording file. For example:Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4iOS: /AppSandbox/Library/Caches/example.mp4macOS: ~/Library/Logs/example.mp4Android: /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4Ensure that the directory for the log files exists and is writable.
1003
+ * The absolute path (including the filename extensions) of the recording file. For example:Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4iOS: /App Sandbox/Library/Caches/example.mp4macOS: /Library/Logs/example.mp4Android: /storage/emulated/0/Android/data/<package name>/files/example.mp4Ensure that the directory for the log files exists and is writable.
1004
1004
  */
1005
1005
  storagePath?: string;
1006
1006
  /**
@@ -16,7 +16,7 @@ export declare abstract class IMediaPlayer {
16
16
  abstract getMediaPlayerId(): number;
17
17
  /**
18
18
  * Opens the media resource.
19
- * This method is called asynchronously. If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.
19
+ * This method is called asynchronously.If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.
20
20
  *
21
21
  * @param url The path of the media file. Both local path and online path are supported.On the Android platform, if you need to open a file in URI format, use open .
22
22
  *
@@ -278,7 +278,9 @@ export declare abstract class IMediaPlayer {
278
278
  abstract getPlaySrc(): string;
279
279
  /**
280
280
  * Opens a media resource and requests all the CDN routes of the media resources through the self-developed scheduling center.
281
- * This method is called asynchronously. If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.After you call this method, Agora opens the media resources and tries to obtain all the CDN routes for playing the media resource. By default, Agora uses the first CDN route for playing, and you can call the switchAgoraCDNLineByIndex method to switch routes.If you want to ensure the security of the connection and media files, to determine the sign and the ts fields for authentication. Once the fields are determined, use them as the query parameter of the URL to update the URL of the media resource. For example:The URL of the media file to be opened: rtmp://$domain/$appName/$streamNameThe URL updated by the authentication of the media file to be opened: rtmp://$domain/$appName/$streamName?ts=$ts&sign=$signAuthentication information:sign: An encrypted string calculated according to the MD5 algorithm based on authKey, appName, streamName, and ts. You need to for your authKey.ts: The timestamp when the authentication information expires. You can set the validity period of the authentication information according to your scenarios. For example, 24h or 1h30m20s.
281
+ * This method is called asynchronously.
282
+ * If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.
283
+ * After you call this method, Agora opens the media resources and tries to obtain all the CDN routes for playing the media resource. By default, Agora uses the first CDN route for playing, and you can call the switchAgoraCDNLineByIndex method to switch routes.If you want to ensure the security of the connection and media files, to determine the sign and the ts fields for authentication. Once the fields are determined, use them as the query parameter of the URL to update the URL of the media resource. For example:The URL of the media file to be opened: rtmp://$domain/$appName/$streamNameThe URL updated by the authentication of the media file to be opened: rtmp://$domain/$appName/$streamName?ts=$ts&sign=$signAuthentication information:sign: An encrypted string calculated according to the MD5 algorithm based on authKey, appName, streamName, and ts. You need to for your authKey.ts: The timestamp when the authentication information expires. You can set the validity period of the authentication information according to your scenarios. For example, 24h or 1h30m20s.
282
284
  *
283
285
  * @param src The URL of the media resource.
284
286
  *
@@ -410,7 +412,7 @@ export declare abstract class IMediaPlayer {
410
412
  */
411
413
  abstract registerAudioFrameObserver(observer: IMediaPlayerAudioFrameObserver): number;
412
414
  /**
413
- * Unregisters an audio frame observer.
415
+ * Unregisters an audio observer.
414
416
  *
415
417
  * @param observer The audio observer. See IMediaPlayerAudioFrameObserver .
416
418
  *
@@ -429,7 +431,7 @@ export declare abstract class IMediaPlayer {
429
431
  */
430
432
  abstract registerVideoFrameObserver(observer: IMediaPlayerVideoFrameObserver): number;
431
433
  /**
432
- * Unregisters a video frame observer.
434
+ * Unregisters the video frame observer.
433
435
  *
434
436
  * @param observer The video observer, reporting the reception of each video frame. See IMediaPlayerVideoFrameObserver .
435
437
  *
@@ -482,8 +484,7 @@ export declare abstract class IMediaPlayerCacheManager {
482
484
  * @param uri The URI (Uniform Resource Identifier) of the media file to be deleted.
483
485
  *
484
486
  * @returns
485
- * 0: Success.
486
- * < 0: Failure. See MediaPlayerError .
487
+ * 0: Success.< 0: Failure. See MediaPlayerError .
487
488
  */
488
489
  abstract removeCacheByUri(uri: string): number;
489
490
  /**
@@ -493,7 +494,8 @@ export declare abstract class IMediaPlayerCacheManager {
493
494
  * @param path The absolute path of the media files to be cached. Ensure that the directory for the media files exists and is writable.
494
495
  *
495
496
  * @returns
496
- * 0: Success.< 0: Failure. See MediaPlayerError .
497
+ * 0: Success.
498
+ * < 0: Failure. See MediaPlayerError .
497
499
  */
498
500
  abstract setCacheDir(path: string): number;
499
501
  /**
@@ -502,8 +504,7 @@ export declare abstract class IMediaPlayerCacheManager {
502
504
  * @param count The maximum number of media files that can be cached. The default value is 1,000.
503
505
  *
504
506
  * @returns
505
- * 0: Success.
506
- * < 0: Failure. See MediaPlayerError .
507
+ * 0: Success.< 0: Failure. See MediaPlayerError .
507
508
  */
508
509
  abstract setMaxCacheFileCount(count: number): number;
509
510
  /**
@@ -512,8 +513,7 @@ export declare abstract class IMediaPlayerCacheManager {
512
513
  * @param cacheSize The maximum size (bytes) of the aggregate storage space for cached media files. The default value is 1 GB.
513
514
  *
514
515
  * @returns
515
- * 0: Success.
516
- * < 0: Failure. See MediaPlayerError .
516
+ * 0: Success.< 0: Failure. See MediaPlayerError .
517
517
  */
518
518
  abstract setMaxCacheFileSize(cacheSize: number): number;
519
519
  /**
@@ -523,7 +523,8 @@ export declare abstract class IMediaPlayerCacheManager {
523
523
  * @param enable Whether to enable the SDK to delete cached media files automatically:true: Delete cached media files automatically.false: (Default) Do not delete cached media files automatically.
524
524
  *
525
525
  * @returns
526
- * 0: Success.< 0: Failure. See MediaPlayerError .
526
+ * 0: Success.
527
+ * < 0: Failure. See MediaPlayerError .
527
528
  */
528
529
  abstract enableAutoRemoveCache(enable: boolean): number;
529
530
  /**