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.
- package/CHANGELOG.md +39 -0
- package/README.md +6 -3
- package/js/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.js +395 -0
- package/js/{AgoraSdk.js → ts/AgoraSdk.js} +2 -12
- package/js/{Decoder → ts/Decoder}/index.js +1 -1
- package/js/{Private → ts/Private}/AgoraBase.js +829 -674
- package/js/{Private → ts/Private}/AgoraMediaBase.js +154 -151
- package/js/{Private → ts/Private}/AgoraMediaPlayerTypes.js +58 -54
- package/js/{Private → ts/Private}/IAgoraLog.js +13 -13
- package/js/{Private → ts/Private}/IAgoraMediaEngine.js +4 -4
- package/js/{Private → ts/Private}/IAgoraMediaPlayer.js +2 -2
- package/js/{Private → ts/Private}/IAgoraMusicContentCenter.js +1 -1
- package/js/{Private → ts/Private}/IAgoraRhythmPlayer.js +13 -13
- package/js/{Private → ts/Private}/IAgoraRtcEngine.js +150 -94
- package/js/{Private → ts/Private}/IAgoraRtcEngineEx.js +3 -3
- package/js/{Private → ts/Private}/IAgoraSpatialAudio.js +4 -4
- package/js/{Private → ts/Private}/IAudioDeviceManager.js +2 -2
- package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.js +10 -0
- package/js/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.js +74 -0
- package/js/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.js +233 -1
- package/js/{Private → ts/Private}/internal/IrisApiEngine.js +45 -0
- package/js/{Private → ts/Private}/internal/RtcEngineExInternal.js +74 -4
- package/js/ts/Private/internal/VideoEffectObjectInternal.js +14 -0
- package/js/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.js +2 -0
- package/js/{Renderer → ts/Renderer}/AgoraView.js +19 -2
- package/js/{Renderer → ts/Renderer}/IRenderer.js +7 -4
- package/js/{Renderer → ts/Renderer}/IRendererCache.js +17 -1
- package/js/ts/Renderer/RendererCache.js +252 -0
- package/js/{Renderer → ts/Renderer}/RendererManager.js +13 -64
- package/js/{Renderer → ts/Renderer}/WebCodecsRenderer/index.js +5 -5
- package/js/{Renderer → ts/Renderer}/WebCodecsRendererCache.js +13 -1
- package/js/{Renderer → ts/Renderer}/WebGLRenderer/index.js +179 -26
- package/js/{Renderer → ts/Renderer}/YUVCanvasRenderer/index.js +12 -5
- package/js/{Utils.js → ts/Utils.js} +7 -7
- package/package.json +25 -12
- package/scripts/checkElectron.js +4 -2
- package/scripts/download.js +102 -0
- package/scripts/downloadPrebuild.js +2 -1
- package/scripts/synclib.js +2 -2
- package/ts/AgoraSdk.ts +2 -12
- package/ts/Decoder/index.ts +5 -1
- package/ts/Private/AgoraBase.ts +1259 -1060
- package/ts/Private/AgoraMediaBase.ts +351 -324
- package/ts/Private/AgoraMediaPlayerTypes.ts +94 -91
- package/ts/Private/IAgoraLog.ts +20 -18
- package/ts/Private/IAgoraMediaEngine.ts +86 -81
- package/ts/Private/IAgoraMediaPlayer.ts +196 -181
- package/ts/Private/IAgoraMediaPlayerSource.ts +40 -40
- package/ts/Private/IAgoraMusicContentCenter.ts +3 -3
- package/ts/Private/IAgoraRhythmPlayer.ts +15 -15
- package/ts/Private/IAgoraRtcEngine.ts +2492 -2047
- package/ts/Private/IAgoraRtcEngineEx.ts +434 -335
- package/ts/Private/IAgoraSpatialAudio.ts +43 -45
- package/ts/Private/IAudioDeviceManager.ts +106 -97
- package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +12 -0
- package/ts/Private/impl/IAgoraRtcEngineExImpl.ts +138 -0
- package/ts/Private/impl/IAgoraRtcEngineImpl.ts +331 -0
- package/ts/Private/internal/IrisApiEngine.ts +47 -0
- package/ts/Private/internal/RtcEngineExInternal.ts +106 -9
- package/ts/Private/internal/VideoEffectObjectInternal.ts +14 -0
- package/ts/Private/ti/IAgoraRtcEngine-ti.ts +2 -0
- package/ts/Renderer/AgoraView.ts +32 -3
- package/ts/Renderer/IRenderer.ts +8 -3
- package/ts/Renderer/IRendererCache.ts +33 -0
- package/ts/Renderer/RendererCache.ts +211 -12
- package/ts/Renderer/RendererManager.ts +21 -99
- package/ts/Renderer/WebCodecsRenderer/index.ts +9 -6
- package/ts/Renderer/WebCodecsRendererCache.ts +17 -1
- package/ts/Renderer/WebGLRenderer/index.ts +246 -40
- package/ts/Renderer/YUVCanvasRenderer/index.ts +29 -16
- package/ts/Types.ts +14 -9
- package/ts/Utils.ts +8 -7
- package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts +168 -0
- package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts.map +1 -0
- package/types/{AgoraSdk.d.ts → ts/AgoraSdk.d.ts} +2 -12
- package/types/ts/AgoraSdk.d.ts.map +1 -0
- package/types/ts/Decoder/gpu-utils.d.ts.map +1 -0
- package/types/ts/Decoder/index.d.ts.map +1 -0
- package/types/ts/Private/AgoraBase.d.ts +5504 -0
- package/types/ts/Private/AgoraBase.d.ts.map +1 -0
- package/types/ts/Private/AgoraMediaBase.d.ts +1695 -0
- package/types/ts/Private/AgoraMediaBase.d.ts.map +1 -0
- package/types/ts/Private/AgoraMediaPlayerTypes.d.ts +456 -0
- package/types/ts/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
- package/types/ts/Private/IAgoraH265Transcoder.d.ts.map +1 -0
- package/types/ts/Private/IAgoraLog.d.ts +91 -0
- package/types/ts/Private/IAgoraLog.d.ts.map +1 -0
- package/types/ts/Private/IAgoraMediaEngine.d.ts +255 -0
- package/types/ts/Private/IAgoraMediaEngine.d.ts.map +1 -0
- package/types/ts/Private/IAgoraMediaPlayer.d.ts +662 -0
- package/types/ts/Private/IAgoraMediaPlayer.d.ts.map +1 -0
- package/types/ts/Private/IAgoraMediaPlayerSource.d.ts +109 -0
- package/types/ts/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
- package/types/ts/Private/IAgoraMediaRecorder.d.ts.map +1 -0
- package/types/ts/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
- package/types/{Private → ts/Private}/IAgoraMusicContentCenter.d.ts +3 -3
- package/types/ts/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
- package/types/ts/Private/IAgoraRhythmPlayer.d.ts +65 -0
- package/types/ts/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
- package/types/ts/Private/IAgoraRtcEngine.d.ts +6504 -0
- package/types/ts/Private/IAgoraRtcEngine.d.ts.map +1 -0
- package/types/ts/Private/IAgoraRtcEngineEx.d.ts +817 -0
- package/types/ts/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
- package/types/ts/Private/IAgoraSpatialAudio.d.ts +194 -0
- package/types/ts/Private/IAgoraSpatialAudio.d.ts.map +1 -0
- package/types/ts/Private/IAudioDeviceManager.d.ts +321 -0
- package/types/ts/Private/IAudioDeviceManager.d.ts.map +1 -0
- package/types/ts/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
- package/types/ts/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
- package/types/ts/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
- package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.d.ts +2 -0
- package/types/ts/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
- package/types/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.d.ts +7 -1
- package/types/ts/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
- package/types/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.d.ts +27 -1
- package/types/ts/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
- package/types/ts/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
- package/types/ts/Private/internal/AgoraH265TranscoderInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/AgoraMediaBaseInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/IrisApiEngine.d.ts.map +1 -0
- package/types/ts/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/MediaEngineInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
- package/types/{Private → ts/Private}/internal/RtcEngineExInternal.d.ts +10 -4
- package/types/ts/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
- package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts +7 -0
- package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts.map +1 -0
- package/types/{Private → ts/Private}/ipc/main.d.ts.map +1 -1
- package/types/ts/Private/ipc/renderer.d.ts.map +1 -0
- package/types/ts/Private/ti/AgoraBase-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
- package/types/ts/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/AgoraView.d.ts +6 -0
- package/types/ts/Renderer/AgoraView.d.ts.map +1 -0
- package/types/ts/Renderer/CapabilityManager.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/IRenderer.d.ts +2 -2
- package/types/ts/Renderer/IRenderer.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/IRendererCache.d.ts +21 -1
- package/types/ts/Renderer/IRendererCache.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/RendererCache.d.ts +27 -0
- package/types/ts/Renderer/RendererCache.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/RendererManager.d.ts +4 -17
- package/types/ts/Renderer/RendererManager.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/WebCodecsRenderer/index.d.ts +3 -3
- package/types/ts/Renderer/WebCodecsRenderer/index.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/WebCodecsRendererCache.d.ts +7 -0
- package/types/ts/Renderer/WebCodecsRendererCache.d.ts.map +1 -0
- package/types/{Renderer → ts/Renderer}/WebGLRenderer/index.d.ts +12 -2
- package/types/ts/Renderer/WebGLRenderer/index.d.ts.map +1 -0
- package/types/ts/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
- package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts +10 -0
- package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
- package/types/ts/Renderer/index.d.ts.map +1 -0
- package/types/{Types.d.ts → ts/Types.d.ts} +11 -6
- package/types/ts/Types.d.ts.map +1 -0
- package/types/{Utils.d.ts → ts/Utils.d.ts} +1 -1
- package/types/ts/Utils.d.ts.map +1 -0
- package/js/Renderer/RendererCache.js +0 -100
- package/types/AgoraSdk.d.ts.map +0 -1
- package/types/Decoder/gpu-utils.d.ts.map +0 -1
- package/types/Decoder/index.d.ts.map +0 -1
- package/types/Private/AgoraBase.d.ts +0 -5310
- package/types/Private/AgoraBase.d.ts.map +0 -1
- package/types/Private/AgoraMediaBase.d.ts +0 -1668
- package/types/Private/AgoraMediaBase.d.ts.map +0 -1
- package/types/Private/AgoraMediaPlayerTypes.d.ts +0 -453
- package/types/Private/AgoraMediaPlayerTypes.d.ts.map +0 -1
- package/types/Private/IAgoraH265Transcoder.d.ts.map +0 -1
- package/types/Private/IAgoraLog.d.ts +0 -89
- package/types/Private/IAgoraLog.d.ts.map +0 -1
- package/types/Private/IAgoraMediaEngine.d.ts +0 -250
- package/types/Private/IAgoraMediaEngine.d.ts.map +0 -1
- package/types/Private/IAgoraMediaPlayer.d.ts +0 -648
- package/types/Private/IAgoraMediaPlayer.d.ts.map +0 -1
- package/types/Private/IAgoraMediaPlayerSource.d.ts +0 -109
- package/types/Private/IAgoraMediaPlayerSource.d.ts.map +0 -1
- package/types/Private/IAgoraMediaRecorder.d.ts.map +0 -1
- package/types/Private/IAgoraMediaStreamingSource.d.ts.map +0 -1
- package/types/Private/IAgoraMusicContentCenter.d.ts.map +0 -1
- package/types/Private/IAgoraRhythmPlayer.d.ts +0 -65
- package/types/Private/IAgoraRhythmPlayer.d.ts.map +0 -1
- package/types/Private/IAgoraRtcEngine.d.ts +0 -6103
- package/types/Private/IAgoraRtcEngine.d.ts.map +0 -1
- package/types/Private/IAgoraRtcEngineEx.d.ts +0 -741
- package/types/Private/IAgoraRtcEngineEx.d.ts.map +0 -1
- package/types/Private/IAgoraSpatialAudio.d.ts +0 -196
- package/types/Private/IAgoraSpatialAudio.d.ts.map +0 -1
- package/types/Private/IAudioDeviceManager.d.ts +0 -312
- package/types/Private/IAudioDeviceManager.d.ts.map +0 -1
- package/types/Private/extension/AgoraBaseExtension.d.ts.map +0 -1
- package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +0 -1
- package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraLogExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +0 -1
- package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +0 -1
- package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +0 -1
- package/types/Private/impl/AgoraBaseImpl.d.ts.map +0 -1
- package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +0 -1
- package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +0 -1
- package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +0 -1
- package/types/Private/internal/AgoraH265TranscoderInternal.d.ts.map +0 -1
- package/types/Private/internal/AgoraMediaBaseInternal.d.ts.map +0 -1
- package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +0 -1
- package/types/Private/internal/IrisApiEngine.d.ts.map +0 -1
- package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +0 -1
- package/types/Private/internal/MediaEngineInternal.d.ts.map +0 -1
- package/types/Private/internal/MediaPlayerInternal.d.ts.map +0 -1
- package/types/Private/internal/MediaRecorderInternal.d.ts.map +0 -1
- package/types/Private/internal/MusicContentCenterInternal.d.ts.map +0 -1
- package/types/Private/internal/RtcEngineExInternal.d.ts.map +0 -1
- package/types/Private/ipc/renderer.d.ts.map +0 -1
- package/types/Private/ti/AgoraBase-ti.d.ts.map +0 -1
- package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +0 -1
- package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraLog-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +0 -1
- package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +0 -1
- package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +0 -1
- package/types/Renderer/AgoraView.d.ts.map +0 -1
- package/types/Renderer/CapabilityManager.d.ts.map +0 -1
- package/types/Renderer/IRenderer.d.ts.map +0 -1
- package/types/Renderer/IRendererCache.d.ts.map +0 -1
- package/types/Renderer/RendererCache.d.ts.map +0 -1
- package/types/Renderer/RendererManager.d.ts.map +0 -1
- package/types/Renderer/WebCodecsRenderer/index.d.ts.map +0 -1
- package/types/Renderer/WebCodecsRendererCache.d.ts.map +0 -1
- package/types/Renderer/WebGLRenderer/index.d.ts.map +0 -1
- package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +0 -1
- package/types/Renderer/YUVCanvasRenderer/index.d.ts +0 -9
- package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +0 -1
- package/types/Renderer/index.d.ts.map +0 -1
- package/types/Types.d.ts.map +0 -1
- package/types/Utils.d.ts.map +0 -1
- /package/js/{Decoder → ts/Decoder}/gpu-utils.js +0 -0
- /package/js/{Private → ts/Private}/IAgoraH265Transcoder.js +0 -0
- /package/js/{Private → ts/Private}/IAgoraMediaPlayerSource.js +0 -0
- /package/js/{Private → ts/Private}/IAgoraMediaRecorder.js +0 -0
- /package/js/{Private → ts/Private}/IAgoraMediaStreamingSource.js +0 -0
- /package/js/{Private → ts/Private}/extension/AgoraBaseExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/AgoraMediaBaseExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraLogExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.js +0 -0
- /package/js/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.js +0 -0
- /package/js/{Private → ts/Private}/impl/AgoraBaseImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/AgoraMediaBaseImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.js +0 -0
- /package/js/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.js +0 -0
- /package/js/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/AgoraMediaBaseInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/AudioDeviceManagerInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/MediaEngineInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/MediaPlayerInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/MediaRecorderInternal.js +0 -0
- /package/js/{Private → ts/Private}/internal/MusicContentCenterInternal.js +0 -0
- /package/js/{Private → ts/Private}/ipc/main.js +0 -0
- /package/js/{Private → ts/Private}/ipc/renderer.js +0 -0
- /package/js/{Private → ts/Private}/ti/AgoraBase-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/AgoraMediaBase-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraLog-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.js +0 -0
- /package/js/{Private → ts/Private}/ti/IAudioDeviceManager-ti.js +0 -0
- /package/js/{Renderer → ts/Renderer}/CapabilityManager.js +0 -0
- /package/js/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.js +0 -0
- /package/js/{Renderer → ts/Renderer}/index.js +0 -0
- /package/js/{Types.js → ts/Types.js} +0 -0
- /package/types/{Decoder → ts/Decoder}/gpu-utils.d.ts +0 -0
- /package/types/{Decoder → ts/Decoder}/index.d.ts +0 -0
- /package/types/{Private → ts/Private}/IAgoraH265Transcoder.d.ts +0 -0
- /package/types/{Private → ts/Private}/IAgoraMediaRecorder.d.ts +0 -0
- /package/types/{Private → ts/Private}/IAgoraMediaStreamingSource.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/AgoraBaseExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/AgoraMediaBaseExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraLogExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/AgoraBaseImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/AgoraMediaBaseImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/AgoraMediaBaseInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/AudioDeviceManagerInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/IrisApiEngine.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/MediaEngineInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/MediaPlayerInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/MediaRecorderInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/internal/MusicContentCenterInternal.d.ts +0 -0
- /package/types/{Private → ts/Private}/ipc/main.d.ts +0 -0
- /package/types/{Private → ts/Private}/ipc/renderer.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/AgoraBase-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/AgoraMediaBase-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraLog-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.d.ts +0 -0
- /package/types/{Private → ts/Private}/ti/IAudioDeviceManager-ti.d.ts +0 -0
- /package/types/{Renderer → ts/Renderer}/CapabilityManager.d.ts +0 -0
- /package/types/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.d.ts +0 -0
- /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.
|
|
5
|
-
exports.
|
|
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.
|
|
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
|
-
*
|
|
9
|
+
* Channel scenarios.
|
|
10
10
|
*/
|
|
11
11
|
var ChannelProfileType;
|
|
12
12
|
(function (ChannelProfileType) {
|
|
13
13
|
/**
|
|
14
|
-
* 0: Communication.
|
|
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:
|
|
18
|
+
* 1: (Default) Live broadcasting scenario.
|
|
19
19
|
*/
|
|
20
20
|
ChannelProfileType[ChannelProfileType["ChannelProfileLiveBroadcasting"] = 1] = "ChannelProfileLiveBroadcasting";
|
|
21
21
|
/**
|
|
22
|
-
* 2: Gaming.
|
|
22
|
+
* 2: Gaming scenario. Deprecated: Use ChannelProfileLiveBroadcasting instead.
|
|
23
23
|
*/
|
|
24
24
|
ChannelProfileType[ChannelProfileType["ChannelProfileGame"] = 2] = "ChannelProfileGame";
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
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
|
-
*
|
|
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:
|
|
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
|
|
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
|
|
189
|
-
* The
|
|
190
|
-
*
|
|
191
|
-
* The
|
|
192
|
-
* The
|
|
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
|
|
198
|
-
*
|
|
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:
|
|
203
|
-
* The
|
|
204
|
-
*
|
|
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:
|
|
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:
|
|
219
|
+
* 8: The current state is invalid.
|
|
218
220
|
*/
|
|
219
221
|
ErrorCodeType[ErrorCodeType["ErrInvalidState"] = 8] = "ErrInvalidState";
|
|
220
222
|
/**
|
|
221
|
-
* 9:
|
|
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:
|
|
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:
|
|
246
|
-
* The user is already in the channel.
|
|
247
|
-
*
|
|
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:
|
|
252
|
-
* The user has left the channel before calling
|
|
253
|
-
* The user
|
|
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:
|
|
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
|
|
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:
|
|
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
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
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
|
-
*
|
|
290
|
-
* App
|
|
291
|
-
* The uid used
|
|
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:
|
|
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
|
|
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
|
|
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
|
|
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:
|
|
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:
|
|
321
|
+
* 117: Data stream sending timed out.
|
|
320
322
|
*/
|
|
321
323
|
ErrorCodeType[ErrorCodeType["ErrStreamMessageTimeout"] = 117] = "ErrStreamMessageTimeout";
|
|
322
324
|
/**
|
|
323
|
-
* 119:
|
|
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
|
|
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:
|
|
333
|
+
* 121: Invalid user ID.
|
|
332
334
|
*/
|
|
333
335
|
ErrorCodeType[ErrorCodeType["ErrInvalidUserId"] = 121] = "ErrInvalidUserId";
|
|
334
336
|
/**
|
|
335
|
-
* 122: Data
|
|
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
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
409
|
+
* 200: Unsupported PCM format.
|
|
408
410
|
*/
|
|
409
411
|
ErrorCodeType[ErrorCodeType["ErrPcmsendFormat"] = 200] = "ErrPcmsendFormat";
|
|
410
412
|
/**
|
|
411
|
-
*
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
437
|
+
* 1010: Failed to stop playback device.
|
|
436
438
|
*/
|
|
437
439
|
ErrorCodeType[ErrorCodeType["ErrAdmStopPlayout"] = 1010] = "ErrAdmStopPlayout";
|
|
438
440
|
/**
|
|
439
|
-
* 1011:
|
|
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:
|
|
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:
|
|
449
|
+
* 1013: Failed to stop recording device.
|
|
448
450
|
*/
|
|
449
451
|
ErrorCodeType[ErrorCodeType["ErrAdmStopRecording"] = 1013] = "ErrAdmStopRecording";
|
|
450
452
|
/**
|
|
451
|
-
* 1501:
|
|
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
|
-
*
|
|
488
|
+
* SDK operation permissions for Audio Session.
|
|
487
489
|
*/
|
|
488
490
|
var AudioSessionOperationRestriction;
|
|
489
491
|
(function (AudioSessionOperationRestriction) {
|
|
490
492
|
/**
|
|
491
|
-
* No restriction
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
514
|
+
* Reason for user going offline.
|
|
513
515
|
*/
|
|
514
516
|
var UserOfflineReasonType;
|
|
515
517
|
(function (UserOfflineReasonType) {
|
|
516
518
|
/**
|
|
517
|
-
* 0:
|
|
519
|
+
* 0: User left voluntarily.
|
|
518
520
|
*/
|
|
519
521
|
UserOfflineReasonType[UserOfflineReasonType["UserOfflineQuit"] = 0] = "UserOfflineQuit";
|
|
520
522
|
/**
|
|
521
|
-
* 1:
|
|
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:
|
|
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
|
-
*
|
|
532
|
+
* Interface classes.
|
|
531
533
|
*/
|
|
532
534
|
var InterfaceIdType;
|
|
533
535
|
(function (InterfaceIdType) {
|
|
534
536
|
/**
|
|
535
|
-
* 1:
|
|
537
|
+
* 1: IAudioDeviceManager interface class.
|
|
536
538
|
*/
|
|
537
539
|
InterfaceIdType[InterfaceIdType["AgoraIidAudioDeviceManager"] = 1] = "AgoraIidAudioDeviceManager";
|
|
538
540
|
/**
|
|
539
|
-
* 2:
|
|
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:
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
594
|
+
* Network quality.
|
|
593
595
|
*/
|
|
594
596
|
var QualityType;
|
|
595
597
|
(function (QualityType) {
|
|
596
598
|
/**
|
|
597
|
-
* 0:
|
|
599
|
+
* 0: Network quality unknown.
|
|
598
600
|
*/
|
|
599
601
|
QualityType[QualityType["QualityUnknown"] = 0] = "QualityUnknown";
|
|
600
602
|
/**
|
|
601
|
-
* 1:
|
|
603
|
+
* 1: Excellent network quality.
|
|
602
604
|
*/
|
|
603
605
|
QualityType[QualityType["QualityExcellent"] = 1] = "QualityExcellent";
|
|
604
606
|
/**
|
|
605
|
-
* 2:
|
|
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:
|
|
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:
|
|
615
|
+
* 4: Barely able to communicate, but not smoothly.
|
|
614
616
|
*/
|
|
615
617
|
QualityType[QualityType["QualityBad"] = 4] = "QualityBad";
|
|
616
618
|
/**
|
|
617
|
-
* 5:
|
|
619
|
+
* 5: Very poor network quality, communication is nearly impossible.
|
|
618
620
|
*/
|
|
619
621
|
QualityType[QualityType["QualityVbad"] = 5] = "QualityVbad";
|
|
620
622
|
/**
|
|
621
|
-
* 6:
|
|
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:
|
|
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
|
-
*
|
|
650
|
+
* Clockwise video rotation information.
|
|
649
651
|
*/
|
|
650
652
|
var VideoOrientation;
|
|
651
653
|
(function (VideoOrientation) {
|
|
652
654
|
/**
|
|
653
|
-
* 0: (Default)
|
|
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
|
-
*
|
|
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
|
-
*
|
|
726
|
+
* Video frame type.
|
|
725
727
|
*/
|
|
726
728
|
var VideoFrameType;
|
|
727
729
|
(function (VideoFrameType) {
|
|
728
730
|
/**
|
|
729
|
-
* 0:
|
|
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:
|
|
743
|
+
* 5: B frame.
|
|
742
744
|
*/
|
|
743
745
|
VideoFrameType[VideoFrameType["VideoFrameTypeBFrame"] = 5] = "VideoFrameTypeBFrame";
|
|
744
746
|
/**
|
|
745
|
-
* 6:
|
|
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
|
-
*
|
|
756
|
+
* Orientation mode for video encoding.
|
|
755
757
|
*/
|
|
756
758
|
var OrientationMode;
|
|
757
759
|
(function (OrientationMode) {
|
|
758
760
|
/**
|
|
759
|
-
* 0: (Default)
|
|
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
|
|
776
|
+
* Video encoding degradation preference when bandwidth is limited.
|
|
775
777
|
*/
|
|
776
778
|
var DegradationPreference;
|
|
777
779
|
(function (DegradationPreference) {
|
|
778
780
|
/**
|
|
779
|
-
*
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
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
|
|
856
|
+
* Video codec format.
|
|
855
857
|
*/
|
|
856
858
|
var VideoCodecType;
|
|
857
859
|
(function (VideoCodecType) {
|
|
858
860
|
/**
|
|
859
|
-
* 0: (Default)
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
1036
|
+
* Watermark fit mode.
|
|
1035
1037
|
*/
|
|
1036
1038
|
var WatermarkFitMode;
|
|
1037
1039
|
(function (WatermarkFitMode) {
|
|
1038
1040
|
/**
|
|
1039
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1082
|
+
* Video stream type.
|
|
1081
1083
|
*/
|
|
1082
1084
|
var VideoStreamType;
|
|
1083
1085
|
(function (VideoStreamType) {
|
|
1084
1086
|
/**
|
|
1085
|
-
* 0: High-
|
|
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-
|
|
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
|
|
1120
|
+
* Video subscription settings.
|
|
1119
1121
|
*/
|
|
1120
1122
|
class VideoSubscriptionOptions {
|
|
1121
1123
|
}
|
|
1122
1124
|
exports.VideoSubscriptionOptions = VideoSubscriptionOptions;
|
|
1123
1125
|
/**
|
|
1124
|
-
*
|
|
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
|
|
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)
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
1184
|
+
* Mirror mode type.
|
|
1183
1185
|
*/
|
|
1184
1186
|
var VideoMirrorModeType;
|
|
1185
1187
|
(function (VideoMirrorModeType) {
|
|
1186
1188
|
/**
|
|
1187
|
-
* 0:
|
|
1188
|
-
*
|
|
1189
|
-
*
|
|
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
|
-
*
|
|
1266
|
+
* Bit mask for codec capabilities.
|
|
1265
1267
|
*/
|
|
1266
1268
|
var CodecCapMask;
|
|
1267
1269
|
(function (CodecCapMask) {
|
|
1268
1270
|
/**
|
|
1269
|
-
* (0):
|
|
1271
|
+
* (0): Codec not supported.
|
|
1270
1272
|
*/
|
|
1271
1273
|
CodecCapMask[CodecCapMask["CodecCapMaskNone"] = 0] = "CodecCapMaskNone";
|
|
1272
1274
|
/**
|
|
1273
|
-
* (1 << 0):
|
|
1275
|
+
* (1 << 0): Supports hardware decoding.
|
|
1274
1276
|
*/
|
|
1275
1277
|
CodecCapMask[CodecCapMask["CodecCapMaskHwDec"] = 1] = "CodecCapMaskHwDec";
|
|
1276
1278
|
/**
|
|
1277
|
-
* (1 << 1):
|
|
1279
|
+
* (1 << 1): Supports hardware encoding.
|
|
1278
1280
|
*/
|
|
1279
1281
|
CodecCapMask[CodecCapMask["CodecCapMaskHwEnc"] = 2] = "CodecCapMaskHwEnc";
|
|
1280
1282
|
/**
|
|
1281
|
-
* (1 << 2):
|
|
1283
|
+
* (1 << 2): Supports software decoding.
|
|
1282
1284
|
*/
|
|
1283
1285
|
CodecCapMask[CodecCapMask["CodecCapMaskSwDec"] = 4] = "CodecCapMaskSwDec";
|
|
1284
1286
|
/**
|
|
1285
|
-
* (1 << 3):
|
|
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
|
-
*
|
|
1292
|
+
* Codec capability levels.
|
|
1291
1293
|
*/
|
|
1292
1294
|
class CodecCapLevels {
|
|
1293
1295
|
}
|
|
1294
1296
|
exports.CodecCapLevels = CodecCapLevels;
|
|
1295
1297
|
/**
|
|
1296
|
-
*
|
|
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
|
-
*
|
|
1310
|
+
* Configuration of the video encoder.
|
|
1309
1311
|
*/
|
|
1310
1312
|
class VideoEncoderConfiguration {
|
|
1311
1313
|
}
|
|
1312
1314
|
exports.VideoEncoderConfiguration = VideoEncoderConfiguration;
|
|
1313
1315
|
/**
|
|
1314
|
-
*
|
|
1316
|
+
* Data stream settings.
|
|
1315
1317
|
*
|
|
1316
|
-
* The
|
|
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
|
-
*
|
|
1329
|
+
* Mode for sending video streams.
|
|
1323
1330
|
*/
|
|
1324
1331
|
var SimulcastStreamMode;
|
|
1325
1332
|
(function (SimulcastStreamMode) {
|
|
1326
1333
|
/**
|
|
1327
|
-
* -1: By default,
|
|
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
|
|
1338
|
+
* 0: Never send small streams.
|
|
1332
1339
|
*/
|
|
1333
1340
|
SimulcastStreamMode[SimulcastStreamMode["DisableSimulcastStream"] = 0] = "DisableSimulcastStream";
|
|
1334
1341
|
/**
|
|
1335
|
-
* 1: Always send
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
1409
|
+
* Watermark position and size on screen.
|
|
1403
1410
|
*
|
|
1404
|
-
* The position and size
|
|
1405
|
-
* (xRatio, yRatio)
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1488
|
+
* User roles in live broadcasting scenario.
|
|
1425
1489
|
*/
|
|
1426
1490
|
var ClientRoleType;
|
|
1427
1491
|
(function (ClientRoleType) {
|
|
1428
1492
|
/**
|
|
1429
|
-
* 1:
|
|
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
|
-
*
|
|
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:
|
|
1507
|
+
* 0: No change in local video quality.
|
|
1444
1508
|
*/
|
|
1445
1509
|
QualityAdaptIndication[QualityAdaptIndication["AdaptNone"] = 0] = "AdaptNone";
|
|
1446
1510
|
/**
|
|
1447
|
-
* 1:
|
|
1511
|
+
* 1: Local video quality improves due to increased network bandwidth.
|
|
1448
1512
|
*/
|
|
1449
1513
|
QualityAdaptIndication[QualityAdaptIndication["AdaptUpBandwidth"] = 1] = "AdaptUpBandwidth";
|
|
1450
1514
|
/**
|
|
1451
|
-
* 2:
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
1534
|
+
* User role property settings.
|
|
1471
1535
|
*/
|
|
1472
1536
|
class ClientRoleOptions {
|
|
1473
1537
|
}
|
|
1474
1538
|
exports.ClientRoleOptions = ClientRoleOptions;
|
|
1475
1539
|
/**
|
|
1476
|
-
* The
|
|
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:
|
|
1545
|
+
* 0: Good subjective experience quality.
|
|
1482
1546
|
*/
|
|
1483
1547
|
ExperienceQualityType[ExperienceQualityType["ExperienceQualityGood"] = 0] = "ExperienceQualityGood";
|
|
1484
1548
|
/**
|
|
1485
|
-
* 1:
|
|
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
|
-
*
|
|
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
|
|
1559
|
+
* 0: No reason, indicating good subjective experience quality.
|
|
1496
1560
|
*/
|
|
1497
1561
|
ExperiencePoorReason[ExperiencePoorReason["ExperienceReasonNone"] = 0] = "ExperienceReasonNone";
|
|
1498
1562
|
/**
|
|
1499
|
-
* 1:
|
|
1563
|
+
* 1: Poor network quality of the remote user.
|
|
1500
1564
|
*/
|
|
1501
1565
|
ExperiencePoorReason[ExperiencePoorReason["RemoteNetworkQualityPoor"] = 1] = "RemoteNetworkQualityPoor";
|
|
1502
1566
|
/**
|
|
1503
|
-
* 2:
|
|
1567
|
+
* 2: Poor network quality of the local user.
|
|
1504
1568
|
*/
|
|
1505
1569
|
ExperiencePoorReason[ExperiencePoorReason["LocalNetworkQualityPoor"] = 2] = "LocalNetworkQualityPoor";
|
|
1506
1570
|
/**
|
|
1507
|
-
* 4:
|
|
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:
|
|
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
|
|
1580
|
+
* AI noise reduction mode.
|
|
1517
1581
|
*/
|
|
1518
1582
|
var AudioAinsMode;
|
|
1519
1583
|
(function (AudioAinsMode) {
|
|
1520
1584
|
/**
|
|
1521
|
-
* 0: (Default)
|
|
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.
|
|
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:
|
|
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
|
-
*
|
|
1598
|
+
* Audio encoding properties.
|
|
1535
1599
|
*/
|
|
1536
1600
|
var AudioProfileType;
|
|
1537
1601
|
(function (AudioProfileType) {
|
|
1538
1602
|
/**
|
|
1539
|
-
* 0:
|
|
1540
|
-
*
|
|
1541
|
-
*
|
|
1542
|
-
* Windows:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
1637
|
+
* Enumeration value boundary.
|
|
1571
1638
|
*/
|
|
1572
1639
|
AudioProfileType[AudioProfileType["AudioProfileNum"] = 7] = "AudioProfileNum";
|
|
1573
1640
|
})(AudioProfileType = exports.AudioProfileType || (exports.AudioProfileType = {}));
|
|
1574
1641
|
/**
|
|
1575
|
-
*
|
|
1642
|
+
* Audio scenario.
|
|
1576
1643
|
*/
|
|
1577
1644
|
var AudioScenarioType;
|
|
1578
1645
|
(function (AudioScenarioType) {
|
|
1579
1646
|
/**
|
|
1580
|
-
* 0: (Default) Automatic scenario
|
|
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,
|
|
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
|
|
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:
|
|
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
|
|
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,
|
|
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
|
-
*
|
|
1675
|
+
* Number of enumerations.
|
|
1609
1676
|
*/
|
|
1610
1677
|
AudioScenarioType[AudioScenarioType["AudioScenarioNum"] = 11] = "AudioScenarioNum";
|
|
1611
1678
|
})(AudioScenarioType = exports.AudioScenarioType || (exports.AudioScenarioType = {}));
|
|
1612
1679
|
/**
|
|
1613
|
-
*
|
|
1680
|
+
* Video frame format.
|
|
1614
1681
|
*/
|
|
1615
1682
|
class VideoFormat {
|
|
1616
1683
|
}
|
|
1617
1684
|
exports.VideoFormat = VideoFormat;
|
|
1618
1685
|
/**
|
|
1619
|
-
*
|
|
1686
|
+
* Content type for screen sharing.
|
|
1620
1687
|
*/
|
|
1621
1688
|
var VideoContentHint;
|
|
1622
1689
|
(function (VideoContentHint) {
|
|
1623
1690
|
/**
|
|
1624
|
-
* (Default) No content
|
|
1691
|
+
* (Default) No specified content type.
|
|
1625
1692
|
*/
|
|
1626
1693
|
VideoContentHint[VideoContentHint["ContentHintNone"] = 0] = "ContentHintNone";
|
|
1627
1694
|
/**
|
|
1628
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1704
|
+
* Screen sharing scenario.
|
|
1638
1705
|
*/
|
|
1639
1706
|
var ScreenScenarioType;
|
|
1640
1707
|
(function (ScreenScenarioType) {
|
|
1641
1708
|
/**
|
|
1642
|
-
* 1: (Default) Document. This scenario prioritizes the
|
|
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:
|
|
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
|
|
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
|
|
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
|
-
*
|
|
1726
|
+
* Video application scenario type.
|
|
1660
1727
|
*/
|
|
1661
1728
|
var VideoApplicationScenarioType;
|
|
1662
1729
|
(function (VideoApplicationScenarioType) {
|
|
1663
1730
|
/**
|
|
1664
|
-
* 0: (Default)
|
|
1731
|
+
* 0: (Default) General scenario.
|
|
1665
1732
|
*/
|
|
1666
1733
|
VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
|
|
1667
1734
|
/**
|
|
1668
|
-
*
|
|
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
|
-
*
|
|
1739
|
+
* 2: 1v1 video call
|
|
1686
1740
|
*/
|
|
1687
1741
|
VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenario1v1"] = 2] = "ApplicationScenario1v1";
|
|
1688
1742
|
/**
|
|
1689
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
1822
|
+
* Local audio state.
|
|
1769
1823
|
*/
|
|
1770
1824
|
var LocalAudioStreamState;
|
|
1771
1825
|
(function (LocalAudioStreamState) {
|
|
1772
1826
|
/**
|
|
1773
|
-
* 0:
|
|
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
|
|
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
|
|
1835
|
+
* 2: The first frame of local audio is encoded successfully.
|
|
1782
1836
|
*/
|
|
1783
1837
|
LocalAudioStreamState[LocalAudioStreamState["LocalAudioStreamStateEncoding"] = 2] = "LocalAudioStreamStateEncoding";
|
|
1784
1838
|
/**
|
|
1785
|
-
* 3:
|
|
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
|
-
*
|
|
1844
|
+
* Reason for local audio state change.
|
|
1791
1845
|
*/
|
|
1792
1846
|
var LocalAudioStreamReason;
|
|
1793
1847
|
(function (LocalAudioStreamReason) {
|
|
1794
1848
|
/**
|
|
1795
|
-
* 0:
|
|
1849
|
+
* 0: Local audio state is normal.
|
|
1796
1850
|
*/
|
|
1797
1851
|
LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonOk"] = 0] = "LocalAudioStreamReasonOk";
|
|
1798
1852
|
/**
|
|
1799
|
-
* 1:
|
|
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
|
|
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:
|
|
1865
|
+
* 4: Local audio capture failed.
|
|
1812
1866
|
*/
|
|
1813
1867
|
LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonRecordFailure"] = 4] = "LocalAudioStreamReasonRecordFailure";
|
|
1814
1868
|
/**
|
|
1815
|
-
* 5:
|
|
1869
|
+
* 5: Local audio encoding failed.
|
|
1816
1870
|
*/
|
|
1817
1871
|
LocalAudioStreamReason[LocalAudioStreamReason["LocalAudioStreamReasonEncodeFailure"] = 5] = "LocalAudioStreamReasonEncodeFailure";
|
|
1818
1872
|
/**
|
|
1819
|
-
* 6: No local audio capture device.
|
|
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
|
|
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
|
|
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
|
|
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
|
|
1894
|
+
* Local video state.
|
|
1841
1895
|
*/
|
|
1842
1896
|
var LocalVideoStreamState;
|
|
1843
1897
|
(function (LocalVideoStreamState) {
|
|
1844
1898
|
/**
|
|
1845
|
-
* 0:
|
|
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
|
|
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
|
|
1907
|
+
* 2: The first frame of local video is encoded successfully.
|
|
1854
1908
|
*/
|
|
1855
1909
|
LocalVideoStreamState[LocalVideoStreamState["LocalVideoStreamStateEncoding"] = 2] = "LocalVideoStreamStateEncoding";
|
|
1856
1910
|
/**
|
|
1857
|
-
* 3:
|
|
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
|
-
*
|
|
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:
|
|
1945
|
+
* 0: Local video state is normal.
|
|
1868
1946
|
*/
|
|
1869
1947
|
LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonOk"] = 0] = "LocalVideoStreamReasonOk";
|
|
1870
1948
|
/**
|
|
1871
|
-
* 1:
|
|
1949
|
+
* 1: Unknown error.
|
|
1872
1950
|
*/
|
|
1873
1951
|
LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonFailure"] = 1] = "LocalVideoStreamReasonFailure";
|
|
1874
1952
|
/**
|
|
1875
|
-
* 2: No permission to
|
|
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
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
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
|
|
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
|
|
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:
|
|
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
|
|
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
|
|
1930
|
-
* The local user
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
2058
|
+
* State of the remote audio stream.
|
|
1980
2059
|
*/
|
|
1981
2060
|
var RemoteAudioState;
|
|
1982
2061
|
(function (RemoteAudioState) {
|
|
1983
2062
|
/**
|
|
1984
|
-
* 0: The
|
|
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
|
|
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
|
|
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.
|
|
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:
|
|
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
|
-
*
|
|
2084
|
+
* Reason for remote audio stream state change.
|
|
2006
2085
|
*/
|
|
2007
2086
|
var RemoteAudioStateReason;
|
|
2008
2087
|
(function (RemoteAudioStateReason) {
|
|
2009
2088
|
/**
|
|
2010
|
-
* 0:
|
|
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
|
|
2097
|
+
* 2: Network recovered.
|
|
2019
2098
|
*/
|
|
2020
2099
|
RemoteAudioStateReason[RemoteAudioStateReason["RemoteAudioReasonNetworkRecovery"] = 2] = "RemoteAudioReasonNetworkRecovery";
|
|
2021
2100
|
/**
|
|
2022
|
-
* 3:
|
|
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:
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
2130
|
+
* State of the remote video stream.
|
|
2052
2131
|
*/
|
|
2053
2132
|
var RemoteVideoState;
|
|
2054
2133
|
(function (RemoteVideoState) {
|
|
2055
2134
|
/**
|
|
2056
|
-
* 0: The
|
|
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
|
|
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
|
|
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.
|
|
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:
|
|
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
|
-
*
|
|
2156
|
+
* Reasons for remote video stream state changes.
|
|
2078
2157
|
*/
|
|
2079
2158
|
var RemoteVideoStateReason;
|
|
2080
2159
|
(function (RemoteVideoStateReason) {
|
|
2081
2160
|
/**
|
|
2082
|
-
* 0:
|
|
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
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
2272
|
+
* User volume information.
|
|
2194
2273
|
*/
|
|
2195
2274
|
class AudioVolumeInfo {
|
|
2196
2275
|
}
|
|
2197
2276
|
exports.AudioVolumeInfo = AudioVolumeInfo;
|
|
2198
2277
|
/**
|
|
2199
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
2364
|
+
* RTMP stream publishing state.
|
|
2286
2365
|
*/
|
|
2287
2366
|
var RtmpStreamPublishState;
|
|
2288
2367
|
(function (RtmpStreamPublishState) {
|
|
2289
2368
|
/**
|
|
2290
|
-
* 0:
|
|
2369
|
+
* 0: Stream publishing not started or already ended.
|
|
2291
2370
|
*/
|
|
2292
2371
|
RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateIdle"] = 0] = "RtmpStreamPublishStateIdle";
|
|
2293
2372
|
/**
|
|
2294
|
-
* 1:
|
|
2373
|
+
* 1: Connecting to the streaming server and CDN server.
|
|
2295
2374
|
*/
|
|
2296
2375
|
RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateConnecting"] = 1] = "RtmpStreamPublishStateConnecting";
|
|
2297
2376
|
/**
|
|
2298
|
-
* 2:
|
|
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:
|
|
2303
|
-
* If
|
|
2304
|
-
* If the
|
|
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:
|
|
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
|
|
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
|
-
*
|
|
2396
|
+
* The reason for RTMP stream state change.
|
|
2318
2397
|
*/
|
|
2319
2398
|
var RtmpStreamPublishReason;
|
|
2320
2399
|
(function (RtmpStreamPublishReason) {
|
|
2321
2400
|
/**
|
|
2322
|
-
* 0:
|
|
2401
|
+
* 0: Stream published successfully.
|
|
2323
2402
|
*/
|
|
2324
2403
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonOk"] = 0] = "RtmpStreamPublishReasonOk";
|
|
2325
2404
|
/**
|
|
2326
|
-
* 1: Invalid
|
|
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
|
|
2409
|
+
* 2: The stream is encrypted and cannot be published.
|
|
2331
2410
|
*/
|
|
2332
2411
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonEncryptedStreamNotAllowed"] = 2] = "RtmpStreamPublishReasonEncryptedStreamNotAllowed";
|
|
2333
2412
|
/**
|
|
2334
|
-
* 3:
|
|
2413
|
+
* 3: Stream publishing timed out and failed.
|
|
2335
2414
|
*/
|
|
2336
2415
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonConnectionTimeout"] = 3] = "RtmpStreamPublishReasonConnectionTimeout";
|
|
2337
2416
|
/**
|
|
2338
|
-
* 4:
|
|
2417
|
+
* 4: Error occurred on the streaming server.
|
|
2339
2418
|
*/
|
|
2340
2419
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonInternalServerError"] = 4] = "RtmpStreamPublishReasonInternalServerError";
|
|
2341
2420
|
/**
|
|
2342
|
-
* 5:
|
|
2421
|
+
* 5: Error occurred on the CDN server.
|
|
2343
2422
|
*/
|
|
2344
2423
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonRtmpServerError"] = 5] = "RtmpStreamPublishReasonRtmpServerError";
|
|
2345
2424
|
/**
|
|
2346
|
-
* 6:
|
|
2425
|
+
* 6: Stream publishing requests are too frequent.
|
|
2347
2426
|
*/
|
|
2348
2427
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonTooOften"] = 6] = "RtmpStreamPublishReasonTooOften";
|
|
2349
2428
|
/**
|
|
2350
|
-
* 7: The
|
|
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
|
|
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:
|
|
2437
|
+
* 9: The server did not find the stream.
|
|
2359
2438
|
*/
|
|
2360
2439
|
RtmpStreamPublishReason[RtmpStreamPublishReason["RtmpStreamPublishReasonStreamNotFound"] = 9] = "RtmpStreamPublishReasonStreamNotFound";
|
|
2361
2440
|
/**
|
|
2362
|
-
* 10: The
|
|
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
|
|
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
|
|
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:
|
|
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
|
|
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
|
|
2470
|
+
* Events that occur during RTMP streaming.
|
|
2392
2471
|
*/
|
|
2393
2472
|
var RtmpStreamingEvent;
|
|
2394
2473
|
(function (RtmpStreamingEvent) {
|
|
2395
2474
|
/**
|
|
2396
|
-
* 1:
|
|
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
|
|
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:
|
|
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
|
-
*
|
|
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
|
-
*
|
|
2500
|
+
* Advanced feature configuration for live transcoding.
|
|
2422
2501
|
*
|
|
2423
|
-
*
|
|
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
|
-
*
|
|
2508
|
+
* Network connection state.
|
|
2430
2509
|
*/
|
|
2431
2510
|
var ConnectionStateType;
|
|
2432
2511
|
(function (ConnectionStateType) {
|
|
2433
2512
|
/**
|
|
2434
|
-
* 1:
|
|
2435
|
-
*
|
|
2436
|
-
*
|
|
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:
|
|
2441
|
-
* If the
|
|
2442
|
-
* After the connection is established, the SDK
|
|
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:
|
|
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:
|
|
2451
|
-
* If the SDK
|
|
2452
|
-
* If the SDK fails to rejoin the channel 20 minutes after
|
|
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:
|
|
2457
|
-
*
|
|
2458
|
-
* If the SDK is banned from joining the channel by the
|
|
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
|
-
*
|
|
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
|
|
2548
|
+
* Transcoding properties for RTMP streaming.
|
|
2470
2549
|
*/
|
|
2471
2550
|
class LiveTranscoding {
|
|
2472
2551
|
}
|
|
2473
2552
|
exports.LiveTranscoding = LiveTranscoding;
|
|
2474
2553
|
/**
|
|
2475
|
-
*
|
|
2554
|
+
* Video stream participating in local compositing.
|
|
2476
2555
|
*/
|
|
2477
2556
|
class TranscodingVideoStream {
|
|
2478
2557
|
}
|
|
2479
2558
|
exports.TranscodingVideoStream = TranscodingVideoStream;
|
|
2480
2559
|
/**
|
|
2481
|
-
*
|
|
2560
|
+
* Configuration for local video compositing.
|
|
2482
2561
|
*/
|
|
2483
2562
|
class LocalTranscoderConfiguration {
|
|
2484
2563
|
}
|
|
2485
2564
|
exports.LocalTranscoderConfiguration = LocalTranscoderConfiguration;
|
|
2486
2565
|
/**
|
|
2487
|
-
*
|
|
2566
|
+
* Local composition error codes.
|
|
2488
2567
|
*/
|
|
2489
2568
|
var VideoTranscoderError;
|
|
2490
2569
|
(function (VideoTranscoderError) {
|
|
2491
2570
|
/**
|
|
2492
|
-
* 1: The
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
|
2587
|
+
* 5: The encoded resolution of the composed video is invalid.
|
|
2509
2588
|
*/
|
|
2510
2589
|
VideoTranscoderError[VideoTranscoderError["VtErrInvalidLayout"] = 5] = "VtErrInvalidLayout";
|
|
2511
2590
|
/**
|
|
2512
|
-
* 20:
|
|
2591
|
+
* 20: Internal unknown error.
|
|
2513
2592
|
*/
|
|
2514
2593
|
VideoTranscoderError[VideoTranscoderError["VtErrInternal"] = 20] = "VtErrInternal";
|
|
2515
2594
|
})(VideoTranscoderError = exports.VideoTranscoderError || (exports.VideoTranscoderError = {}));
|
|
2516
2595
|
/**
|
|
2517
|
-
*
|
|
2596
|
+
* An audio source for local audio mixing.
|
|
2518
2597
|
*/
|
|
2519
2598
|
class MixedAudioStream {
|
|
2520
2599
|
}
|
|
2521
2600
|
exports.MixedAudioStream = MixedAudioStream;
|
|
2522
2601
|
/**
|
|
2523
|
-
*
|
|
2602
|
+
* Local audio mixing configuration.
|
|
2524
2603
|
*/
|
|
2525
2604
|
class LocalAudioMixerConfiguration {
|
|
2526
2605
|
}
|
|
2527
2606
|
exports.LocalAudioMixerConfiguration = LocalAudioMixerConfiguration;
|
|
2528
2607
|
/**
|
|
2529
|
-
*
|
|
2608
|
+
* Configuration for last mile network probe.
|
|
2530
2609
|
*/
|
|
2531
2610
|
class LastmileProbeConfig {
|
|
2532
2611
|
}
|
|
2533
2612
|
exports.LastmileProbeConfig = LastmileProbeConfig;
|
|
2534
2613
|
/**
|
|
2535
|
-
*
|
|
2614
|
+
* Status of last mile quality probe result.
|
|
2536
2615
|
*/
|
|
2537
2616
|
var LastmileProbeResultState;
|
|
2538
2617
|
(function (LastmileProbeResultState) {
|
|
2539
2618
|
/**
|
|
2540
|
-
* 1:
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
2644
|
+
* The reason for a change in network connection state.
|
|
2566
2645
|
*/
|
|
2567
2646
|
var ConnectionChangedReasonType;
|
|
2568
2647
|
(function (ConnectionChangedReasonType) {
|
|
2569
2648
|
/**
|
|
2570
|
-
* 0:
|
|
2649
|
+
* 0: Connecting to the network.
|
|
2571
2650
|
*/
|
|
2572
2651
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedConnecting"] = 0] = "ConnectionChangedConnecting";
|
|
2573
2652
|
/**
|
|
2574
|
-
* 1:
|
|
2653
|
+
* 1: Successfully joined the channel.
|
|
2575
2654
|
*/
|
|
2576
2655
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedJoinSuccess"] = 1] = "ConnectionChangedJoinSuccess";
|
|
2577
2656
|
/**
|
|
2578
|
-
* 2:
|
|
2657
|
+
* 2: Network connection interrupted.
|
|
2579
2658
|
*/
|
|
2580
2659
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInterrupted"] = 2] = "ConnectionChangedInterrupted";
|
|
2581
2660
|
/**
|
|
2582
|
-
* 3:
|
|
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:
|
|
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:
|
|
2669
|
+
* 5: Left the channel.
|
|
2591
2670
|
*/
|
|
2592
2671
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedLeaveChannel"] = 5] = "ConnectionChangedLeaveChannel";
|
|
2593
2672
|
/**
|
|
2594
|
-
* 6: The App ID is invalid.
|
|
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:
|
|
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:
|
|
2607
|
-
*
|
|
2608
|
-
* The
|
|
2609
|
-
* The
|
|
2610
|
-
*
|
|
2611
|
-
* The user ID
|
|
2612
|
-
* The
|
|
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
|
-
*
|
|
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:
|
|
2621
|
-
* The user
|
|
2622
|
-
* The user tries to join a channel
|
|
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
|
|
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
|
|
2705
|
+
* 12: The network connection state changed due to a Token renewal.
|
|
2631
2706
|
*/
|
|
2632
2707
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRenewToken"] = 12] = "ConnectionChangedRenewToken";
|
|
2633
2708
|
/**
|
|
2634
|
-
*
|
|
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:
|
|
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:
|
|
2717
|
+
* 15: Successfully rejoined the channel.
|
|
2643
2718
|
*/
|
|
2644
2719
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRejoinSuccess"] = 15] = "ConnectionChangedRejoinSuccess";
|
|
2645
2720
|
/**
|
|
2646
|
-
* 16: The
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
2758
|
+
* Reasons for user role switch failure.
|
|
2684
2759
|
*/
|
|
2685
2760
|
var ClientRoleChangeFailedReason;
|
|
2686
2761
|
(function (ClientRoleChangeFailedReason) {
|
|
2687
2762
|
/**
|
|
2688
|
-
* 1: The number of
|
|
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:
|
|
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:
|
|
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:
|
|
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
|
-
*
|
|
2822
|
+
* Type of network connection.
|
|
2748
2823
|
*/
|
|
2749
2824
|
var NetworkType;
|
|
2750
2825
|
(function (NetworkType) {
|
|
2751
2826
|
/**
|
|
2752
|
-
* -1:
|
|
2827
|
+
* -1: Unknown network connection type.
|
|
2753
2828
|
*/
|
|
2754
2829
|
NetworkType[NetworkType["NetworkTypeUnknown"] = -1] = "NetworkTypeUnknown";
|
|
2755
2830
|
/**
|
|
2756
|
-
* 0:
|
|
2831
|
+
* 0: Network connection is disconnected.
|
|
2757
2832
|
*/
|
|
2758
2833
|
NetworkType[NetworkType["NetworkTypeDisconnected"] = 0] = "NetworkTypeDisconnected";
|
|
2759
2834
|
/**
|
|
2760
|
-
* 1:
|
|
2835
|
+
* 1: Network type is LAN.
|
|
2761
2836
|
*/
|
|
2762
2837
|
NetworkType[NetworkType["NetworkTypeLan"] = 1] = "NetworkTypeLan";
|
|
2763
2838
|
/**
|
|
2764
|
-
* 2:
|
|
2839
|
+
* 2: Network type is Wi-Fi (including hotspot).
|
|
2765
2840
|
*/
|
|
2766
2841
|
NetworkType[NetworkType["NetworkTypeWifi"] = 2] = "NetworkTypeWifi";
|
|
2767
2842
|
/**
|
|
2768
|
-
* 3:
|
|
2843
|
+
* 3: Network type is 2G mobile network.
|
|
2769
2844
|
*/
|
|
2770
2845
|
NetworkType[NetworkType["NetworkTypeMobile2g"] = 3] = "NetworkTypeMobile2g";
|
|
2771
2846
|
/**
|
|
2772
|
-
* 4:
|
|
2847
|
+
* 4: Network type is 3G mobile network.
|
|
2773
2848
|
*/
|
|
2774
2849
|
NetworkType[NetworkType["NetworkTypeMobile3g"] = 4] = "NetworkTypeMobile3g";
|
|
2775
2850
|
/**
|
|
2776
|
-
* 5:
|
|
2851
|
+
* 5: Network type is 4G mobile network.
|
|
2777
2852
|
*/
|
|
2778
2853
|
NetworkType[NetworkType["NetworkTypeMobile4g"] = 5] = "NetworkTypeMobile4g";
|
|
2779
2854
|
/**
|
|
2780
|
-
* 6:
|
|
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
|
-
*
|
|
2860
|
+
* View setup mode.
|
|
2786
2861
|
*/
|
|
2787
2862
|
var VideoViewSetupMode;
|
|
2788
2863
|
(function (VideoViewSetupMode) {
|
|
2789
2864
|
/**
|
|
2790
|
-
* 0: (Default)
|
|
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:
|
|
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
|
-
*
|
|
2878
|
+
* Properties of the video canvas object.
|
|
2804
2879
|
*/
|
|
2805
2880
|
class VideoCanvas {
|
|
2806
2881
|
}
|
|
2807
2882
|
exports.VideoCanvas = VideoCanvas;
|
|
2808
2883
|
/**
|
|
2809
|
-
*
|
|
2884
|
+
* Light contrast level.
|
|
2810
2885
|
*/
|
|
2811
2886
|
var LighteningContrastLevel;
|
|
2812
2887
|
(function (LighteningContrastLevel) {
|
|
2813
2888
|
/**
|
|
2814
|
-
* 0: Low contrast
|
|
2889
|
+
* 0: Low contrast.
|
|
2815
2890
|
*/
|
|
2816
2891
|
LighteningContrastLevel[LighteningContrastLevel["LighteningContrastLow"] = 0] = "LighteningContrastLow";
|
|
2817
2892
|
/**
|
|
2818
|
-
* 1:
|
|
2893
|
+
* 1: Normal contrast.
|
|
2819
2894
|
*/
|
|
2820
2895
|
LighteningContrastLevel[LighteningContrastLevel["LighteningContrastNormal"] = 1] = "LighteningContrastNormal";
|
|
2821
2896
|
/**
|
|
2822
|
-
* 2: High contrast
|
|
2897
|
+
* 2: High contrast.
|
|
2823
2898
|
*/
|
|
2824
2899
|
LighteningContrastLevel[LighteningContrastLevel["LighteningContrastHigh"] = 2] = "LighteningContrastHigh";
|
|
2825
2900
|
})(LighteningContrastLevel = exports.LighteningContrastLevel || (exports.LighteningContrastLevel = {}));
|
|
2826
2901
|
/**
|
|
2827
|
-
*
|
|
2902
|
+
* Beauty effect options.
|
|
2828
2903
|
*/
|
|
2829
2904
|
class BeautyOptions {
|
|
2830
2905
|
}
|
|
2831
2906
|
exports.BeautyOptions = BeautyOptions;
|
|
2832
2907
|
/**
|
|
2833
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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"] =
|
|
2921
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaHeadscale"] = 100] = "FaceShapeAreaHeadscale";
|
|
2845
2922
|
/**
|
|
2846
|
-
*
|
|
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"] =
|
|
2925
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaForehead"] = 101] = "FaceShapeAreaForehead";
|
|
2849
2926
|
/**
|
|
2850
|
-
*
|
|
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"] =
|
|
2929
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaFacecontour"] = 102] = "FaceShapeAreaFacecontour";
|
|
2853
2930
|
/**
|
|
2854
|
-
*
|
|
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"] =
|
|
2933
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaFacelength"] = 103] = "FaceShapeAreaFacelength";
|
|
2857
2934
|
/**
|
|
2858
|
-
*
|
|
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"] =
|
|
2937
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaFacewidth"] = 104] = "FaceShapeAreaFacewidth";
|
|
2861
2938
|
/**
|
|
2862
|
-
*
|
|
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"] =
|
|
2941
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaCheekbone"] = 105] = "FaceShapeAreaCheekbone";
|
|
2865
2942
|
/**
|
|
2866
|
-
*
|
|
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"] =
|
|
2945
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaCheek"] = 106] = "FaceShapeAreaCheek";
|
|
2869
2946
|
/**
|
|
2870
|
-
*
|
|
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["
|
|
2949
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaMandible"] = 107] = "FaceShapeAreaMandible";
|
|
2873
2950
|
/**
|
|
2874
|
-
*
|
|
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["
|
|
2953
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaChin"] = 108] = "FaceShapeAreaChin";
|
|
2877
2954
|
/**
|
|
2878
|
-
*
|
|
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["
|
|
2957
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaEyescale"] = 200] = "FaceShapeAreaEyescale";
|
|
2881
2958
|
/**
|
|
2882
|
-
*
|
|
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["
|
|
2961
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaEyedistance"] = 201] = "FaceShapeAreaEyedistance";
|
|
2885
2962
|
/**
|
|
2886
|
-
*
|
|
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["
|
|
3033
|
+
FaceShapeArea[FaceShapeArea["FaceShapeAreaEyebrowthickness"] = 501] = "FaceShapeAreaEyebrowthickness";
|
|
2889
3034
|
})(FaceShapeArea = exports.FaceShapeArea || (exports.FaceShapeArea = {}));
|
|
2890
3035
|
/**
|
|
2891
|
-
*
|
|
3036
|
+
* Filter effect options.
|
|
2892
3037
|
*/
|
|
2893
3038
|
class FaceShapeAreaOptions {
|
|
2894
3039
|
}
|
|
2895
3040
|
exports.FaceShapeAreaOptions = FaceShapeAreaOptions;
|
|
2896
3041
|
/**
|
|
2897
|
-
*
|
|
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
|
-
*
|
|
3049
|
+
* (0): (Default) Female style beauty effect.
|
|
2903
3050
|
*/
|
|
2904
3051
|
FaceShapeBeautyStyle[FaceShapeBeautyStyle["FaceShapeBeautyStyleFemale"] = 0] = "FaceShapeBeautyStyleFemale";
|
|
2905
3052
|
/**
|
|
2906
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
3074
|
+
* Low-light enhancement mode.
|
|
2924
3075
|
*/
|
|
2925
3076
|
var LowLightEnhanceMode;
|
|
2926
3077
|
(function (LowLightEnhanceMode) {
|
|
2927
3078
|
/**
|
|
2928
|
-
* 0: (Default)
|
|
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.
|
|
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
|
-
*
|
|
3088
|
+
* Low-light enhancement level.
|
|
2938
3089
|
*/
|
|
2939
3090
|
var LowLightEnhanceLevel;
|
|
2940
3091
|
(function (LowLightEnhanceLevel) {
|
|
2941
3092
|
/**
|
|
2942
|
-
* 0: (Default)
|
|
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:
|
|
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
|
-
*
|
|
3102
|
+
* Low-light enhancement options.
|
|
2952
3103
|
*/
|
|
2953
3104
|
class LowlightEnhanceOptions {
|
|
2954
3105
|
}
|
|
2955
3106
|
exports.LowlightEnhanceOptions = LowlightEnhanceOptions;
|
|
2956
3107
|
/**
|
|
2957
|
-
* Video
|
|
3108
|
+
* Video denoising mode.
|
|
2958
3109
|
*/
|
|
2959
3110
|
var VideoDenoiserMode;
|
|
2960
3111
|
(function (VideoDenoiserMode) {
|
|
2961
3112
|
/**
|
|
2962
|
-
* 0: (Default)
|
|
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.
|
|
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
|
|
3122
|
+
* Video denoising level.
|
|
2972
3123
|
*/
|
|
2973
3124
|
var VideoDenoiserLevel;
|
|
2974
3125
|
(function (VideoDenoiserLevel) {
|
|
2975
3126
|
/**
|
|
2976
|
-
* 0: (Default)
|
|
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:
|
|
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
|
|
3136
|
+
* Video denoising options.
|
|
2986
3137
|
*/
|
|
2987
3138
|
class VideoDenoiserOptions {
|
|
2988
3139
|
}
|
|
2989
3140
|
exports.VideoDenoiserOptions = VideoDenoiserOptions;
|
|
2990
3141
|
/**
|
|
2991
|
-
*
|
|
3142
|
+
* Color enhancement options.
|
|
2992
3143
|
*/
|
|
2993
3144
|
class ColorEnhanceOptions {
|
|
2994
3145
|
}
|
|
2995
3146
|
exports.ColorEnhanceOptions = ColorEnhanceOptions;
|
|
2996
3147
|
/**
|
|
2997
|
-
*
|
|
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)
|
|
3157
|
+
* 1: (Default) Solid color background.
|
|
3007
3158
|
*/
|
|
3008
3159
|
BackgroundSourceType[BackgroundSourceType["BackgroundColor"] = 1] = "BackgroundColor";
|
|
3009
3160
|
/**
|
|
3010
|
-
* 2:
|
|
3161
|
+
* 2: Background image in PNG or JPG format.
|
|
3011
3162
|
*/
|
|
3012
3163
|
BackgroundSourceType[BackgroundSourceType["BackgroundImg"] = 2] = "BackgroundImg";
|
|
3013
3164
|
/**
|
|
3014
|
-
* 3:
|
|
3165
|
+
* 3: Background with blur effect.
|
|
3015
3166
|
*/
|
|
3016
3167
|
BackgroundSourceType[BackgroundSourceType["BackgroundBlur"] = 3] = "BackgroundBlur";
|
|
3017
3168
|
/**
|
|
3018
|
-
* 4:
|
|
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
|
-
*
|
|
3174
|
+
* Blur level of custom background image.
|
|
3024
3175
|
*/
|
|
3025
3176
|
var BackgroundBlurDegree;
|
|
3026
3177
|
(function (BackgroundBlurDegree) {
|
|
3027
3178
|
/**
|
|
3028
|
-
* 1:
|
|
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:
|
|
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)
|
|
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
|
-
*
|
|
3192
|
+
* Custom background.
|
|
3042
3193
|
*/
|
|
3043
3194
|
class VirtualBackgroundSource {
|
|
3044
3195
|
}
|
|
3045
3196
|
exports.VirtualBackgroundSource = VirtualBackgroundSource;
|
|
3046
3197
|
/**
|
|
3047
|
-
*
|
|
3198
|
+
* Algorithm for background processing.
|
|
3048
3199
|
*/
|
|
3049
3200
|
var SegModelType;
|
|
3050
3201
|
(function (SegModelType) {
|
|
3051
3202
|
/**
|
|
3052
|
-
* 1: (Default)
|
|
3203
|
+
* 1: (Default) Background processing algorithm suitable for all scenarios.
|
|
3053
3204
|
*/
|
|
3054
3205
|
SegModelType[SegModelType["SegModelAi"] = 1] = "SegModelAi";
|
|
3055
3206
|
/**
|
|
3056
|
-
* 2:
|
|
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
|
-
*
|
|
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
|
|
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:
|
|
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
|
-
*
|
|
3236
|
+
* Configuration options for custom audio tracks.
|
|
3086
3237
|
*/
|
|
3087
3238
|
class AudioTrackConfig {
|
|
3088
3239
|
}
|
|
3089
3240
|
exports.AudioTrackConfig = AudioTrackConfig;
|
|
3090
3241
|
/**
|
|
3091
|
-
*
|
|
3242
|
+
* Preset voice beautifier options.
|
|
3092
3243
|
*/
|
|
3093
3244
|
var VoiceBeautifierPreset;
|
|
3094
3245
|
(function (VoiceBeautifierPreset) {
|
|
3095
3246
|
/**
|
|
3096
|
-
*
|
|
3247
|
+
* Original voice, i.e., disables voice beautifier effects.
|
|
3097
3248
|
*/
|
|
3098
3249
|
VoiceBeautifierPreset[VoiceBeautifierPreset["VoiceBeautifierOff"] = 0] = "VoiceBeautifierOff";
|
|
3099
3250
|
/**
|
|
3100
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
3113
|
-
* If you call setVoiceBeautifierPreset (SingingBeautifier), you can beautify
|
|
3114
|
-
* If you call setVoiceBeautifierParameters (SingingBeautifier, param1, param2), you can beautify
|
|
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
|
-
*
|
|
3269
|
+
* Vigorous.
|
|
3119
3270
|
*/
|
|
3120
3271
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationVigorous"] = 16974080] = "TimbreTransformationVigorous";
|
|
3121
3272
|
/**
|
|
3122
|
-
*
|
|
3273
|
+
* Deep.
|
|
3123
3274
|
*/
|
|
3124
3275
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationDeep"] = 16974336] = "TimbreTransformationDeep";
|
|
3125
3276
|
/**
|
|
3126
|
-
*
|
|
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
|
-
*
|
|
3285
|
+
* Full.
|
|
3135
3286
|
*/
|
|
3136
3287
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationFull"] = 16975104] = "TimbreTransformationFull";
|
|
3137
3288
|
/**
|
|
3138
|
-
*
|
|
3289
|
+
* Clear.
|
|
3139
3290
|
*/
|
|
3140
3291
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationClear"] = 16975360] = "TimbreTransformationClear";
|
|
3141
3292
|
/**
|
|
3142
|
-
*
|
|
3293
|
+
* Resounding.
|
|
3143
3294
|
*/
|
|
3144
3295
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationResounding"] = 16975616] = "TimbreTransformationResounding";
|
|
3145
3296
|
/**
|
|
3146
|
-
*
|
|
3297
|
+
* Ringing.
|
|
3147
3298
|
*/
|
|
3148
3299
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationRinging"] = 16975872] = "TimbreTransformationRinging";
|
|
3149
3300
|
/**
|
|
3150
|
-
*
|
|
3151
|
-
*
|
|
3152
|
-
* If
|
|
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
|
|
3308
|
+
* Preset audio effect options.
|
|
3158
3309
|
*
|
|
3159
|
-
*
|
|
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
|
-
*
|
|
3319
|
+
* Original sound, disables voice effects.
|
|
3165
3320
|
*/
|
|
3166
3321
|
AudioEffectPreset[AudioEffectPreset["AudioEffectOff"] = 0] = "AudioEffectOff";
|
|
3167
3322
|
/**
|
|
3168
|
-
*
|
|
3323
|
+
* KTV.
|
|
3169
3324
|
*/
|
|
3170
3325
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsKtv"] = 33620224] = "RoomAcousticsKtv";
|
|
3171
3326
|
/**
|
|
3172
|
-
*
|
|
3327
|
+
* Concert.
|
|
3173
3328
|
*/
|
|
3174
3329
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsVocalConcert"] = 33620480] = "RoomAcousticsVocalConcert";
|
|
3175
3330
|
/**
|
|
3176
|
-
*
|
|
3331
|
+
* Studio.
|
|
3177
3332
|
*/
|
|
3178
3333
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsStudio"] = 33620736] = "RoomAcousticsStudio";
|
|
3179
3334
|
/**
|
|
3180
|
-
*
|
|
3335
|
+
* Phonograph.
|
|
3181
3336
|
*/
|
|
3182
3337
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsPhonograph"] = 33620992] = "RoomAcousticsPhonograph";
|
|
3183
3338
|
/**
|
|
3184
|
-
*
|
|
3339
|
+
* Virtual stereo, where the SDK renders mono audio into stereo effect.
|
|
3185
3340
|
*/
|
|
3186
3341
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsVirtualStereo"] = 33621248] = "RoomAcousticsVirtualStereo";
|
|
3187
3342
|
/**
|
|
3188
|
-
*
|
|
3343
|
+
* Spacious.
|
|
3189
3344
|
*/
|
|
3190
3345
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsSpacial"] = 33621504] = "RoomAcousticsSpacial";
|
|
3191
3346
|
/**
|
|
3192
|
-
*
|
|
3347
|
+
* Ethereal.
|
|
3193
3348
|
*/
|
|
3194
3349
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsEthereal"] = 33621760] = "RoomAcousticsEthereal";
|
|
3195
3350
|
/**
|
|
3196
|
-
*
|
|
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,
|
|
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
|
-
*
|
|
3359
|
+
* Chorus. Recommended by Agora for chorus scenarios to enhance vocal spatiality.
|
|
3205
3360
|
*/
|
|
3206
3361
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsChorus"] = 33623296] = "RoomAcousticsChorus";
|
|
3207
3362
|
/**
|
|
3208
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
3383
|
+
* Pig King.
|
|
3229
3384
|
*/
|
|
3230
3385
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectPigking"] = 33687040] = "VoiceChangerEffectPigking";
|
|
3231
3386
|
/**
|
|
3232
|
-
*
|
|
3387
|
+
* Hulk.
|
|
3233
3388
|
*/
|
|
3234
3389
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectHulk"] = 33687296] = "VoiceChangerEffectHulk";
|
|
3235
3390
|
/**
|
|
3236
|
-
*
|
|
3391
|
+
* R&B.
|
|
3237
3392
|
*/
|
|
3238
3393
|
AudioEffectPreset[AudioEffectPreset["StyleTransformationRnb"] = 33751296] = "StyleTransformationRnb";
|
|
3239
3394
|
/**
|
|
3240
|
-
*
|
|
3395
|
+
* Pop.
|
|
3241
3396
|
*/
|
|
3242
3397
|
AudioEffectPreset[AudioEffectPreset["StyleTransformationPopular"] = 33751552] = "StyleTransformationPopular";
|
|
3243
3398
|
/**
|
|
3244
|
-
*
|
|
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
|
-
*
|
|
3404
|
+
* Preset voice conversion options.
|
|
3250
3405
|
*/
|
|
3251
3406
|
var VoiceConversionPreset;
|
|
3252
3407
|
(function (VoiceConversionPreset) {
|
|
3253
3408
|
/**
|
|
3254
|
-
*
|
|
3409
|
+
* Original voice, i.e., disables voice conversion effects.
|
|
3255
3410
|
*/
|
|
3256
3411
|
VoiceConversionPreset[VoiceConversionPreset["VoiceConversionOff"] = 0] = "VoiceConversionOff";
|
|
3257
3412
|
/**
|
|
3258
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
3479
|
+
* Turn off headphone equalizer and listen to original audio.
|
|
3325
3480
|
*/
|
|
3326
3481
|
HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerOff"] = 0] = "HeadphoneEqualizerOff";
|
|
3327
3482
|
/**
|
|
3328
|
-
*
|
|
3483
|
+
* Use over-ear headphone equalizer.
|
|
3329
3484
|
*/
|
|
3330
3485
|
HeadphoneEqualizerPreset[HeadphoneEqualizerPreset["HeadphoneEqualizerOverear"] = 67108865] = "HeadphoneEqualizerOverear";
|
|
3331
3486
|
/**
|
|
3332
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
3550
|
+
* Audio recording quality.
|
|
3390
3551
|
*/
|
|
3391
3552
|
var AudioRecordingQualityType;
|
|
3392
3553
|
(function (AudioRecordingQualityType) {
|
|
3393
3554
|
/**
|
|
3394
|
-
* 0: Low quality.
|
|
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.
|
|
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.
|
|
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
|
|
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:
|
|
3577
|
+
* 1: Record only the local user's audio.
|
|
3417
3578
|
*/
|
|
3418
3579
|
AudioFileRecordingType[AudioFileRecordingType["AudioFileRecordingMic"] = 1] = "AudioFileRecordingMic";
|
|
3419
3580
|
/**
|
|
3420
|
-
* 2:
|
|
3581
|
+
* 2: Record only the audio of all remote users.
|
|
3421
3582
|
*/
|
|
3422
3583
|
AudioFileRecordingType[AudioFileRecordingType["AudioFileRecordingPlayback"] = 2] = "AudioFileRecordingPlayback";
|
|
3423
3584
|
/**
|
|
3424
|
-
* 3:
|
|
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
|
|
3590
|
+
* Audio encoding content.
|
|
3430
3591
|
*/
|
|
3431
3592
|
var AudioEncodedFrameObserverPosition;
|
|
3432
3593
|
(function (AudioEncodedFrameObserverPosition) {
|
|
3433
3594
|
/**
|
|
3434
|
-
* 1:
|
|
3595
|
+
* 1: Encode only the local user's audio.
|
|
3435
3596
|
*/
|
|
3436
3597
|
AudioEncodedFrameObserverPosition[AudioEncodedFrameObserverPosition["AudioEncodedFrameObserverPositionRecord"] = 1] = "AudioEncodedFrameObserverPositionRecord";
|
|
3437
3598
|
/**
|
|
3438
|
-
* 2:
|
|
3599
|
+
* 2: Encode only the audio of all remote users.
|
|
3439
3600
|
*/
|
|
3440
3601
|
AudioEncodedFrameObserverPosition[AudioEncodedFrameObserverPosition["AudioEncodedFrameObserverPositionPlayback"] = 2] = "AudioEncodedFrameObserverPositionPlayback";
|
|
3441
3602
|
/**
|
|
3442
|
-
* 3:
|
|
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
|
|
3608
|
+
* Recording configuration.
|
|
3448
3609
|
*/
|
|
3449
3610
|
class AudioRecordingConfiguration {
|
|
3450
3611
|
}
|
|
3451
3612
|
exports.AudioRecordingConfiguration = AudioRecordingConfiguration;
|
|
3452
3613
|
/**
|
|
3453
|
-
* Observer settings for
|
|
3614
|
+
* Observer settings for encoded audio.
|
|
3454
3615
|
*/
|
|
3455
3616
|
class AudioEncodedFrameObserverConfig {
|
|
3456
3617
|
}
|
|
3457
3618
|
exports.AudioEncodedFrameObserverConfig = AudioEncodedFrameObserverConfig;
|
|
3458
3619
|
/**
|
|
3459
|
-
* The region
|
|
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
|
|
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
|
-
*
|
|
3692
|
+
* Error codes for cross-channel media stream relay.
|
|
3532
3693
|
*/
|
|
3533
3694
|
var ChannelMediaRelayError;
|
|
3534
3695
|
(function (ChannelMediaRelayError) {
|
|
3535
3696
|
/**
|
|
3536
|
-
* 0:
|
|
3697
|
+
* 0: Everything is working properly.
|
|
3537
3698
|
*/
|
|
3538
3699
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayOk"] = 0] = "RelayOk";
|
|
3539
3700
|
/**
|
|
3540
|
-
* 1:
|
|
3701
|
+
* 1: Server returned an error.
|
|
3541
3702
|
*/
|
|
3542
3703
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerErrorResponse"] = 1] = "RelayErrorServerErrorResponse";
|
|
3543
3704
|
/**
|
|
3544
|
-
* 2: No
|
|
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
|
|
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:
|
|
3715
|
+
* 4: Failed to initiate cross-channel media stream relay request.
|
|
3553
3716
|
*/
|
|
3554
3717
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedJoinSrc"] = 4] = "RelayErrorFailedJoinSrc";
|
|
3555
3718
|
/**
|
|
3556
|
-
* 5:
|
|
3719
|
+
* 5: Failed to accept cross-channel media stream relay request.
|
|
3557
3720
|
*/
|
|
3558
3721
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedJoinDest"] = 5] = "RelayErrorFailedJoinDest";
|
|
3559
3722
|
/**
|
|
3560
|
-
* 6:
|
|
3723
|
+
* 6: Server failed to receive cross-channel media stream.
|
|
3561
3724
|
*/
|
|
3562
3725
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedPacketReceivedFromSrc"] = 6] = "RelayErrorFailedPacketReceivedFromSrc";
|
|
3563
3726
|
/**
|
|
3564
|
-
* 7:
|
|
3727
|
+
* 7: Server failed to send cross-channel media stream.
|
|
3565
3728
|
*/
|
|
3566
3729
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorFailedPacketSentToDest"] = 7] = "RelayErrorFailedPacketSentToDest";
|
|
3567
3730
|
/**
|
|
3568
|
-
* 8:
|
|
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:
|
|
3735
|
+
* 9: Internal server error.
|
|
3573
3736
|
*/
|
|
3574
3737
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorInternalError"] = 9] = "RelayErrorInternalError";
|
|
3575
3738
|
/**
|
|
3576
|
-
* 10: The token
|
|
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
|
|
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
|
-
*
|
|
3748
|
+
* State codes for cross-channel media stream relay.
|
|
3586
3749
|
*/
|
|
3587
3750
|
var ChannelMediaRelayState;
|
|
3588
3751
|
(function (ChannelMediaRelayState) {
|
|
3589
3752
|
/**
|
|
3590
|
-
* 0:
|
|
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:
|
|
3757
|
+
* 1: SDK is attempting cross-channel relay.
|
|
3595
3758
|
*/
|
|
3596
3759
|
ChannelMediaRelayState[ChannelMediaRelayState["RelayStateConnecting"] = 1] = "RelayStateConnecting";
|
|
3597
3760
|
/**
|
|
3598
|
-
* 2: The
|
|
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
|
|
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
|
-
*
|
|
3776
|
+
* Cross-channel media stream relay configuration.
|
|
3614
3777
|
*/
|
|
3615
3778
|
class ChannelMediaRelayConfiguration {
|
|
3616
3779
|
}
|
|
3617
3780
|
exports.ChannelMediaRelayConfiguration = ChannelMediaRelayConfiguration;
|
|
3618
3781
|
/**
|
|
3619
|
-
*
|
|
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
|
-
*
|
|
3800
|
+
* Built-in encryption modes.
|
|
3638
3801
|
*
|
|
3639
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
3839
|
+
* Enumeration boundary value.
|
|
3677
3840
|
*/
|
|
3678
3841
|
EncryptionMode[EncryptionMode["ModeEnd"] = 9] = "ModeEnd";
|
|
3679
3842
|
})(EncryptionMode = exports.EncryptionMode || (exports.EncryptionMode = {}));
|
|
3680
3843
|
/**
|
|
3681
|
-
*
|
|
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
|
-
*
|
|
3850
|
+
* Error types for built-in encryption.
|
|
3688
3851
|
*/
|
|
3689
3852
|
var EncryptionErrorType;
|
|
3690
3853
|
(function (EncryptionErrorType) {
|
|
3691
3854
|
/**
|
|
3692
|
-
* 0: Internal
|
|
3855
|
+
* 0: Internal error.
|
|
3693
3856
|
*/
|
|
3694
3857
|
EncryptionErrorType[EncryptionErrorType["EncryptionErrorInternalFailure"] = 0] = "EncryptionErrorInternalFailure";
|
|
3695
3858
|
/**
|
|
3696
|
-
* 1: Media stream decryption error.
|
|
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.
|
|
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
|
-
*
|
|
3894
|
+
* Type of device permission.
|
|
3732
3895
|
*/
|
|
3733
3896
|
var PermissionType;
|
|
3734
3897
|
(function (PermissionType) {
|
|
3735
3898
|
/**
|
|
3736
|
-
* 0: Permission for
|
|
3899
|
+
* 0: Permission for audio recording device.
|
|
3737
3900
|
*/
|
|
3738
3901
|
PermissionType[PermissionType["RecordAudio"] = 0] = "RecordAudio";
|
|
3739
3902
|
/**
|
|
3740
|
-
* 1: Permission for
|
|
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
|
-
*
|
|
3912
|
+
* Subscribe state.
|
|
3750
3913
|
*/
|
|
3751
3914
|
var StreamSubscribeState;
|
|
3752
3915
|
(function (StreamSubscribeState) {
|
|
3753
3916
|
/**
|
|
3754
|
-
* 0:
|
|
3917
|
+
* 0: Initial subscribe state after joining the channel.
|
|
3755
3918
|
*/
|
|
3756
3919
|
StreamSubscribeState[StreamSubscribeState["SubStateIdle"] = 0] = "SubStateIdle";
|
|
3757
3920
|
/**
|
|
3758
|
-
* 1:
|
|
3759
|
-
*
|
|
3760
|
-
*
|
|
3761
|
-
*
|
|
3762
|
-
*
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3765
|
-
*
|
|
3766
|
-
*
|
|
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:
|
|
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
|
-
*
|
|
3942
|
+
* Publish state.
|
|
3780
3943
|
*/
|
|
3781
3944
|
var StreamPublishState;
|
|
3782
3945
|
(function (StreamPublishState) {
|
|
3783
3946
|
/**
|
|
3784
|
-
* 0:
|
|
3947
|
+
* 0: Initial publish state after joining the channel.
|
|
3785
3948
|
*/
|
|
3786
3949
|
StreamPublishState[StreamPublishState["PubStateIdle"] = 0] = "PubStateIdle";
|
|
3787
3950
|
/**
|
|
3788
|
-
* 1:
|
|
3789
|
-
* The local user
|
|
3790
|
-
* The local user
|
|
3791
|
-
* The local user
|
|
3792
|
-
* The
|
|
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:
|
|
3963
|
+
* 3: Publish successful.
|
|
3801
3964
|
*/
|
|
3802
3965
|
StreamPublishState[StreamPublishState["PubStatePublished"] = 3] = "PubStatePublished";
|
|
3803
3966
|
})(StreamPublishState = exports.StreamPublishState || (exports.StreamPublishState = {}));
|
|
3804
3967
|
/**
|
|
3805
|
-
*
|
|
3968
|
+
* Configuration for audio and video loop test.
|
|
3806
3969
|
*/
|
|
3807
3970
|
class EchoTestConfiguration {
|
|
3808
3971
|
}
|
|
3809
3972
|
exports.EchoTestConfiguration = EchoTestConfiguration;
|
|
3810
3973
|
/**
|
|
3811
|
-
*
|
|
3974
|
+
* User information.
|
|
3812
3975
|
*/
|
|
3813
3976
|
class UserInfo {
|
|
3814
3977
|
}
|
|
3815
3978
|
exports.UserInfo = UserInfo;
|
|
3816
3979
|
/**
|
|
3817
|
-
*
|
|
3980
|
+
* Ear monitoring audio filter type.
|
|
3818
3981
|
*/
|
|
3819
3982
|
var EarMonitoringFilterType;
|
|
3820
3983
|
(function (EarMonitoringFilterType) {
|
|
3821
3984
|
/**
|
|
3822
|
-
* 1<<0:
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
4044
|
+
* Media frame rendering status.
|
|
3890
4045
|
*/
|
|
3891
4046
|
var MediaTraceEvent;
|
|
3892
4047
|
(function (MediaTraceEvent) {
|
|
3893
4048
|
/**
|
|
3894
|
-
* 0:
|
|
4049
|
+
* 0: Video frame rendered.
|
|
3895
4050
|
*/
|
|
3896
4051
|
MediaTraceEvent[MediaTraceEvent["MediaTraceEventVideoRendered"] = 0] = "MediaTraceEventVideoRendered";
|
|
3897
4052
|
/**
|
|
3898
|
-
* 1:
|
|
4053
|
+
* 1: Video frame decoded.
|
|
3899
4054
|
*/
|
|
3900
4055
|
MediaTraceEvent[MediaTraceEvent["MediaTraceEventVideoDecoded"] = 1] = "MediaTraceEventVideoDecoded";
|
|
3901
4056
|
})(MediaTraceEvent = exports.MediaTraceEvent || (exports.MediaTraceEvent = {}));
|
|
3902
4057
|
/**
|
|
3903
|
-
*
|
|
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
|
-
*
|
|
4092
|
+
* Configuration information of the log server.
|
|
3938
4093
|
*/
|
|
3939
4094
|
class LogUploadServerInfo {
|
|
3940
4095
|
}
|
|
3941
4096
|
exports.LogUploadServerInfo = LogUploadServerInfo;
|
|
3942
4097
|
/**
|
|
3943
|
-
*
|
|
4098
|
+
* Advanced options for Local Access Point.
|
|
3944
4099
|
*/
|
|
3945
4100
|
class AdvancedConfigInfo {
|
|
3946
4101
|
}
|
|
3947
4102
|
exports.AdvancedConfigInfo = AdvancedConfigInfo;
|
|
3948
4103
|
/**
|
|
3949
|
-
*
|
|
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
|
-
*
|
|
4130
|
+
* Spatial audio parameters.
|
|
3976
4131
|
*/
|
|
3977
4132
|
class SpatialAudioParams {
|
|
3978
4133
|
}
|