agora-electron-sdk 4.2.0-dev.4 → 4.2.0-dev.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/js/AgoraSdk.js +4 -2
- package/js/Private/AgoraBase.js +1154 -6
- package/js/Private/AgoraMediaBase.js +308 -0
- package/js/Private/AgoraMediaPlayerTypes.js +112 -0
- package/js/Private/IAgoraLog.js +12 -0
- package/js/Private/IAgoraMediaStreamingSource.js +10 -0
- package/js/Private/IAgoraMusicContentCenter.js +104 -0
- package/js/Private/IAgoraRhythmPlayer.js +8 -0
- package/js/Private/IAgoraRtcEngine.js +843 -0
- package/js/Private/IAgoraRtcEngineEx.js +8 -0
- package/js/Private/IAgoraSpatialAudio.js +44 -0
- package/js/Private/impl/IAgoraMediaPlayerImpl.js +59 -59
- package/js/Private/impl/IAgoraRtcEngineImpl.js +55 -46
- package/js/Private/internal/IrisApiEngine.js +7 -12
- package/js/Private/internal/MediaEngineInternal.js +7 -11
- package/js/Private/internal/MediaPlayerInternal.js +22 -20
- package/js/Private/internal/MediaRecorderInternal.js +4 -4
- package/js/Private/internal/MusicContentCenterInternal.js +7 -9
- package/js/Private/internal/RtcEngineExInternal.js +52 -62
- package/js/Renderer/AgoraView.js +21 -24
- package/js/Renderer/IRenderer.js +6 -13
- package/js/Renderer/IRendererManager.js +9 -0
- package/js/Renderer/RendererManager.js +49 -33
- package/js/Renderer/{GlRenderer → WebGLRenderer}/index.js +39 -45
- package/js/Renderer/YUVCanvasRenderer/index.js +8 -7
- package/js/Renderer/index.js +18 -0
- package/js/Utils.js +6 -8
- package/package.json +5 -4
- package/scripts/buildJS.js +1 -2
- package/scripts/getConfig.js +0 -1
- package/ts/AgoraSdk.ts +5 -2
- package/ts/Private/IAgoraMediaPlayer.ts +45 -45
- package/ts/Private/IAgoraRtcEngine.ts +33 -25
- package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +84 -84
- package/ts/Private/impl/IAgoraRtcEngineImpl.ts +75 -65
- package/ts/Private/internal/IrisApiEngine.ts +0 -2
- package/ts/Private/internal/RtcEngineExInternal.ts +23 -12
- package/ts/Renderer/AgoraView.ts +1 -0
- package/ts/Renderer/IRenderer.ts +8 -14
- package/ts/Renderer/IRendererManager.ts +35 -0
- package/ts/Renderer/RendererManager.ts +9 -9
- package/ts/Renderer/{GlRenderer → WebGLRenderer}/index.ts +26 -45
- package/ts/Renderer/YUVCanvasRenderer/index.ts +8 -10
- package/ts/Renderer/index.ts +2 -0
- package/ts/Types.ts +15 -9
- package/ts/Utils.ts +4 -6
- package/types/AgoraSdk.d.ts +4 -2
- package/types/AgoraSdk.d.ts.map +1 -0
- package/types/Private/AgoraBase.d.ts +1 -0
- package/types/Private/AgoraBase.d.ts.map +1 -0
- package/types/Private/AgoraMediaBase.d.ts +1 -0
- package/types/Private/AgoraMediaBase.d.ts.map +1 -0
- package/types/Private/AgoraMediaPlayerTypes.d.ts +1 -0
- package/types/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
- package/types/Private/IAgoraLog.d.ts +1 -0
- package/types/Private/IAgoraLog.d.ts.map +1 -0
- package/types/Private/IAgoraMediaEngine.d.ts +1 -0
- package/types/Private/IAgoraMediaEngine.d.ts.map +1 -0
- package/types/Private/IAgoraMediaPlayer.d.ts +35 -34
- package/types/Private/IAgoraMediaPlayer.d.ts.map +1 -0
- package/types/Private/IAgoraMediaPlayerSource.d.ts +1 -0
- package/types/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
- package/types/Private/IAgoraMediaRecorder.d.ts +1 -0
- package/types/Private/IAgoraMediaRecorder.d.ts.map +1 -0
- package/types/Private/IAgoraMediaStreamingSource.d.ts +1 -0
- package/types/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
- package/types/Private/IAgoraMusicContentCenter.d.ts +1 -0
- package/types/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
- package/types/Private/IAgoraRhythmPlayer.d.ts +1 -0
- package/types/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
- package/types/Private/IAgoraRtcEngine.d.ts +27 -19
- package/types/Private/IAgoraRtcEngine.d.ts.map +1 -0
- package/types/Private/IAgoraRtcEngineEx.d.ts +1 -0
- package/types/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
- package/types/Private/IAgoraSpatialAudio.d.ts +1 -0
- package/types/Private/IAgoraSpatialAudio.d.ts.map +1 -0
- package/types/Private/IAudioDeviceManager.d.ts +1 -0
- package/types/Private/IAudioDeviceManager.d.ts.map +1 -0
- package/types/Private/extension/AgoraBaseExtension.d.ts +1 -0
- package/types/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
- package/types/Private/extension/AgoraMediaBaseExtension.d.ts +1 -0
- package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
- package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +1 -0
- package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraLogExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraMediaEngineExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraRtcEngineExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
- package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts +1 -0
- package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
- package/types/Private/extension/IAudioDeviceManagerExtension.d.ts +1 -0
- package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
- package/types/Private/impl/AgoraBaseImpl.d.ts +1 -0
- package/types/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
- package/types/Private/impl/AgoraMediaBaseImpl.d.ts +1 -0
- package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraMediaEngineImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts +9 -8
- package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraRtcEngineImpl.d.ts +13 -10
- package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
- package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts +1 -0
- package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
- package/types/Private/impl/IAudioDeviceManagerImpl.d.ts +1 -0
- package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
- package/types/Private/internal/AudioDeviceManagerInternal.d.ts +1 -0
- package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
- package/types/Private/internal/IrisApiEngine.d.ts +8 -7
- package/types/Private/internal/IrisApiEngine.d.ts.map +1 -0
- package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts +1 -0
- package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
- package/types/Private/internal/MediaEngineInternal.d.ts +1 -0
- package/types/Private/internal/MediaEngineInternal.d.ts.map +1 -0
- package/types/Private/internal/MediaPlayerInternal.d.ts +1 -0
- package/types/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
- package/types/Private/internal/MediaRecorderInternal.d.ts +1 -0
- package/types/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
- package/types/Private/internal/MusicContentCenterInternal.d.ts +1 -0
- package/types/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
- package/types/Private/internal/RtcEngineExInternal.d.ts +3 -2
- package/types/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
- package/{js → types}/Private/internal/emitter/EventEmitter.d.ts +1 -0
- package/types/Private/internal/emitter/EventEmitter.d.ts.map +1 -0
- package/types/Private/ti/AgoraBase-ti.d.ts +1 -0
- package/types/Private/ti/AgoraBase-ti.d.ts.map +1 -0
- package/types/Private/ti/AgoraMediaBase-ti.d.ts +1 -0
- package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
- package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts +1 -0
- package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraLog-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMediaEngine-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraRtcEngine-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
- package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts +1 -0
- package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
- package/types/Private/ti/IAudioDeviceManager-ti.d.ts +1 -0
- package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
- package/types/Renderer/AgoraView.d.ts +1 -0
- package/types/Renderer/AgoraView.d.ts.map +1 -0
- package/types/Renderer/IRenderer.d.ts +6 -5
- package/types/Renderer/IRenderer.d.ts.map +1 -0
- package/types/Renderer/IRendererManager.d.ts +18 -0
- package/types/Renderer/IRendererManager.d.ts.map +1 -0
- package/types/Renderer/RendererManager.d.ts +5 -3
- package/types/Renderer/RendererManager.d.ts.map +1 -0
- package/types/Renderer/{GlRenderer → WebGLRenderer}/index.d.ts +9 -19
- package/types/Renderer/WebGLRenderer/index.d.ts.map +1 -0
- package/types/Renderer/WebGLRenderer/webgl-utils.d.ts +1 -0
- package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
- package/types/Renderer/YUVCanvasRenderer/index.d.ts +4 -4
- package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
- package/types/Renderer/index.d.ts +3 -0
- package/types/Renderer/index.d.ts.map +1 -0
- package/types/Types.d.ts +15 -9
- package/types/Types.d.ts.map +1 -0
- package/types/Utils.d.ts +1 -0
- package/types/Utils.d.ts.map +1 -0
- package/js/AgoraSdk.d.ts +0 -36
- package/js/Private/AgoraBase.d.ts +0 -4441
- package/js/Private/AgoraMediaBase.d.ts +0 -1124
- package/js/Private/AgoraMediaPlayerTypes.d.ts +0 -408
- package/js/Private/IAgoraLog.d.ts +0 -80
- package/js/Private/IAgoraMediaEngine.d.ts +0 -183
- package/js/Private/IAgoraMediaPlayer.d.ts +0 -532
- package/js/Private/IAgoraMediaPlayerSource.d.ts +0 -82
- package/js/Private/IAgoraMediaRecorder.d.ts +0 -28
- package/js/Private/IAgoraMediaStreamingSource.d.ts +0 -41
- package/js/Private/IAgoraMusicContentCenter.d.ts +0 -335
- package/js/Private/IAgoraRhythmPlayer.d.ts +0 -64
- package/js/Private/IAgoraRtcEngine.d.ts +0 -4947
- package/js/Private/IAgoraRtcEngineEx.d.ts +0 -553
- package/js/Private/IAgoraSpatialAudio.d.ts +0 -265
- package/js/Private/IAudioDeviceManager.d.ts +0 -254
- package/js/Private/extension/AgoraBaseExtension.d.ts +0 -1
- package/js/Private/extension/AgoraMediaBaseExtension.d.ts +0 -1
- package/js/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -1
- package/js/Private/extension/IAgoraLogExtension.d.ts +0 -1
- package/js/Private/extension/IAgoraMediaEngineExtension.d.ts +0 -40
- package/js/Private/extension/IAgoraMediaPlayerExtension.d.ts +0 -46
- package/js/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -1
- package/js/Private/extension/IAgoraMediaRecorderExtension.d.ts +0 -44
- package/js/Private/extension/IAgoraMusicContentCenterExtension.d.ts +0 -20
- package/js/Private/extension/IAgoraRhythmPlayerExtension.d.ts +0 -1
- package/js/Private/extension/IAgoraRtcEngineExExtension.d.ts +0 -1
- package/js/Private/extension/IAgoraRtcEngineExtension.d.ts +0 -42
- package/js/Private/extension/IAgoraSpatialAudioExtension.d.ts +0 -1
- package/js/Private/extension/IAudioDeviceManagerExtension.d.ts +0 -1
- package/js/Private/impl/AgoraBaseImpl.d.ts +0 -2
- package/js/Private/impl/AgoraMediaBaseImpl.d.ts +0 -8
- package/js/Private/impl/IAgoraMediaEngineImpl.d.ts +0 -39
- package/js/Private/impl/IAgoraMediaPlayerImpl.d.ts +0 -140
- package/js/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -2
- package/js/Private/impl/IAgoraMediaRecorderImpl.d.ts +0 -10
- package/js/Private/impl/IAgoraMusicContentCenterImpl.d.ts +0 -58
- package/js/Private/impl/IAgoraRtcEngineExImpl.d.ts +0 -105
- package/js/Private/impl/IAgoraRtcEngineImpl.d.ts +0 -570
- package/js/Private/impl/IAgoraSpatialAudioImpl.d.ts +0 -48
- package/js/Private/impl/IAudioDeviceManagerImpl.d.ts +0 -64
- package/js/Private/internal/AudioDeviceManagerInternal.d.ts +0 -8
- package/js/Private/internal/IrisApiEngine.d.ts +0 -147
- package/js/Private/internal/LocalSpatialAudioEngineInternal.d.ts +0 -18
- package/js/Private/internal/MediaEngineInternal.d.ts +0 -21
- package/js/Private/internal/MediaPlayerInternal.d.ts +0 -33
- package/js/Private/internal/MediaRecorderInternal.d.ts +0 -17
- package/js/Private/internal/MusicContentCenterInternal.d.ts +0 -39
- package/js/Private/internal/RtcEngineExInternal.d.ts +0 -80
- package/js/Private/ti/AgoraBase-ti.d.ts +0 -7
- package/js/Private/ti/AgoraMediaBase-ti.d.ts +0 -13
- package/js/Private/ti/AgoraMediaPlayerTypes-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraLog-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraMediaEngine-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraMediaPlayer-ti.d.ts +0 -7
- package/js/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -7
- package/js/Private/ti/IAgoraMediaRecorder-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraMediaStreamingSource-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraMusicContentCenter-ti.d.ts +0 -7
- package/js/Private/ti/IAgoraRhythmPlayer-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraRtcEngine-ti.d.ts +0 -9
- package/js/Private/ti/IAgoraRtcEngineEx-ti.d.ts +0 -6
- package/js/Private/ti/IAgoraSpatialAudio-ti.d.ts +0 -6
- package/js/Private/ti/IAudioDeviceManager-ti.d.ts +0 -6
- package/js/Renderer/AgoraView.d.ts +0 -69
- package/js/Renderer/GlRenderer/index.d.ts +0 -59
- package/js/Renderer/GlRenderer/webgl-utils.d.ts +0 -0
- package/js/Renderer/IRenderer.d.ts +0 -21
- package/js/Renderer/RendererManager.d.ts +0 -152
- package/js/Renderer/YUVCanvasRenderer/index.d.ts +0 -16
- package/js/Types.d.ts +0 -271
- package/js/Utils.d.ts +0 -58
- /package/js/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +0 -0
- /package/ts/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +0 -0
package/js/Private/AgoraBase.js
CHANGED
|
@@ -778,6 +778,14 @@ var DegradationPreference;
|
|
|
778
778
|
* The video dimension.
|
|
779
779
|
*/
|
|
780
780
|
class VideoDimensions {
|
|
781
|
+
/**
|
|
782
|
+
* The width (pixels) of the video.
|
|
783
|
+
*/
|
|
784
|
+
width;
|
|
785
|
+
/**
|
|
786
|
+
* The height (pixels) of the video.
|
|
787
|
+
*/
|
|
788
|
+
height;
|
|
781
789
|
}
|
|
782
790
|
exports.VideoDimensions = VideoDimensions;
|
|
783
791
|
/**
|
|
@@ -858,6 +866,18 @@ var TCcMode;
|
|
|
858
866
|
* @ignore
|
|
859
867
|
*/
|
|
860
868
|
class SenderOptions {
|
|
869
|
+
/**
|
|
870
|
+
* @ignore
|
|
871
|
+
*/
|
|
872
|
+
ccMode;
|
|
873
|
+
/**
|
|
874
|
+
* @ignore
|
|
875
|
+
*/
|
|
876
|
+
codecType;
|
|
877
|
+
/**
|
|
878
|
+
* @ignore
|
|
879
|
+
*/
|
|
880
|
+
targetBitrate;
|
|
861
881
|
}
|
|
862
882
|
exports.SenderOptions = SenderOptions;
|
|
863
883
|
/**
|
|
@@ -970,18 +990,70 @@ var WatermarkFitMode;
|
|
|
970
990
|
* @ignore
|
|
971
991
|
*/
|
|
972
992
|
class EncodedAudioFrameAdvancedSettings {
|
|
993
|
+
/**
|
|
994
|
+
* @ignore
|
|
995
|
+
*/
|
|
996
|
+
speech;
|
|
997
|
+
/**
|
|
998
|
+
* @ignore
|
|
999
|
+
*/
|
|
1000
|
+
sendEvenIfEmpty;
|
|
973
1001
|
}
|
|
974
1002
|
exports.EncodedAudioFrameAdvancedSettings = EncodedAudioFrameAdvancedSettings;
|
|
975
1003
|
/**
|
|
976
1004
|
* Audio information after encoding.
|
|
977
1005
|
*/
|
|
978
1006
|
class EncodedAudioFrameInfo {
|
|
1007
|
+
/**
|
|
1008
|
+
* Audio Codec type: AudioCodecType
|
|
1009
|
+
*/
|
|
1010
|
+
codec;
|
|
1011
|
+
/**
|
|
1012
|
+
* Audio sample rate (Hz).
|
|
1013
|
+
*/
|
|
1014
|
+
sampleRateHz;
|
|
1015
|
+
/**
|
|
1016
|
+
* The number of audio samples per channel.
|
|
1017
|
+
*/
|
|
1018
|
+
samplesPerChannel;
|
|
1019
|
+
/**
|
|
1020
|
+
* The number of audio channels.
|
|
1021
|
+
*/
|
|
1022
|
+
numberOfChannels;
|
|
1023
|
+
/**
|
|
1024
|
+
* This function is currently not supported.
|
|
1025
|
+
*/
|
|
1026
|
+
advancedSettings;
|
|
1027
|
+
/**
|
|
1028
|
+
* The Unix timestamp (ms) for capturing the external encoded video frames.
|
|
1029
|
+
*/
|
|
1030
|
+
captureTimeMs;
|
|
979
1031
|
}
|
|
980
1032
|
exports.EncodedAudioFrameInfo = EncodedAudioFrameInfo;
|
|
981
1033
|
/**
|
|
982
1034
|
* @ignore
|
|
983
1035
|
*/
|
|
984
1036
|
class AudioPcmDataInfo {
|
|
1037
|
+
/**
|
|
1038
|
+
* @ignore
|
|
1039
|
+
*/
|
|
1040
|
+
samplesPerChannel;
|
|
1041
|
+
/**
|
|
1042
|
+
* @ignore
|
|
1043
|
+
*/
|
|
1044
|
+
channelNum;
|
|
1045
|
+
/**
|
|
1046
|
+
* @ignore
|
|
1047
|
+
*/
|
|
1048
|
+
samplesOut;
|
|
1049
|
+
/**
|
|
1050
|
+
* @ignore
|
|
1051
|
+
*/
|
|
1052
|
+
elapsedTimeMs;
|
|
1053
|
+
/**
|
|
1054
|
+
* @ignore
|
|
1055
|
+
*/
|
|
1056
|
+
ntpTimeMs;
|
|
985
1057
|
}
|
|
986
1058
|
exports.AudioPcmDataInfo = AudioPcmDataInfo;
|
|
987
1059
|
/**
|
|
@@ -1016,12 +1088,64 @@ var VideoStreamType;
|
|
|
1016
1088
|
* Video subscription options.
|
|
1017
1089
|
*/
|
|
1018
1090
|
class VideoSubscriptionOptions {
|
|
1091
|
+
/**
|
|
1092
|
+
* @ignore
|
|
1093
|
+
*/
|
|
1094
|
+
type;
|
|
1095
|
+
/**
|
|
1096
|
+
* Whether to subscribe to encoded video frames only:true: Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.false: (Default) Subscribe to both raw video data and encoded video data.
|
|
1097
|
+
*/
|
|
1098
|
+
encodedFrameOnly;
|
|
1019
1099
|
}
|
|
1020
1100
|
exports.VideoSubscriptionOptions = VideoSubscriptionOptions;
|
|
1021
1101
|
/**
|
|
1022
1102
|
* Information about externally encoded video frames.
|
|
1023
1103
|
*/
|
|
1024
1104
|
class EncodedVideoFrameInfo {
|
|
1105
|
+
/**
|
|
1106
|
+
* The codec type of the local video stream. See VideoCodecType . The default value is VideoCodecH264 (2).
|
|
1107
|
+
*/
|
|
1108
|
+
codecType;
|
|
1109
|
+
/**
|
|
1110
|
+
* Width (pixel) of the video frame.
|
|
1111
|
+
*/
|
|
1112
|
+
width;
|
|
1113
|
+
/**
|
|
1114
|
+
* Height (pixel) of the video frame.
|
|
1115
|
+
*/
|
|
1116
|
+
height;
|
|
1117
|
+
/**
|
|
1118
|
+
* The number of video frames per second.When this parameter is not 0, you can use it to calculate the Unix timestamp of externally encoded video frames.
|
|
1119
|
+
*/
|
|
1120
|
+
framesPerSecond;
|
|
1121
|
+
/**
|
|
1122
|
+
* The video frame type. See VideoFrameType .
|
|
1123
|
+
*/
|
|
1124
|
+
frameType;
|
|
1125
|
+
/**
|
|
1126
|
+
* The rotation information of the video frame. See VideoOrientation .
|
|
1127
|
+
*/
|
|
1128
|
+
rotation;
|
|
1129
|
+
/**
|
|
1130
|
+
* Reserved for future use.
|
|
1131
|
+
*/
|
|
1132
|
+
trackId;
|
|
1133
|
+
/**
|
|
1134
|
+
* The Unix timestamp (ms) for capturing the external encoded video frames.
|
|
1135
|
+
*/
|
|
1136
|
+
captureTimeMs;
|
|
1137
|
+
/**
|
|
1138
|
+
* @ignore
|
|
1139
|
+
*/
|
|
1140
|
+
decodeTimeMs;
|
|
1141
|
+
/**
|
|
1142
|
+
* The user ID to push the externally encoded video frame.
|
|
1143
|
+
*/
|
|
1144
|
+
uid;
|
|
1145
|
+
/**
|
|
1146
|
+
* The type of video streams. See VideoStreamType .
|
|
1147
|
+
*/
|
|
1148
|
+
streamType;
|
|
1025
1149
|
}
|
|
1026
1150
|
exports.EncodedVideoFrameInfo = EncodedVideoFrameInfo;
|
|
1027
1151
|
/**
|
|
@@ -1061,6 +1185,14 @@ var EncodingPreference;
|
|
|
1061
1185
|
* Advanced options for video encoding.
|
|
1062
1186
|
*/
|
|
1063
1187
|
class AdvanceOptions {
|
|
1188
|
+
/**
|
|
1189
|
+
* Video encoder preference. See EncodingPreference .
|
|
1190
|
+
*/
|
|
1191
|
+
encodingPreference;
|
|
1192
|
+
/**
|
|
1193
|
+
* Compression preference for video encoding. See CompressionPreference .
|
|
1194
|
+
*/
|
|
1195
|
+
compressionPreference;
|
|
1064
1196
|
}
|
|
1065
1197
|
exports.AdvanceOptions = AdvanceOptions;
|
|
1066
1198
|
/**
|
|
@@ -1111,12 +1243,56 @@ var CodecCapMask;
|
|
|
1111
1243
|
* @ignore
|
|
1112
1244
|
*/
|
|
1113
1245
|
class CodecCapInfo {
|
|
1246
|
+
/**
|
|
1247
|
+
* @ignore
|
|
1248
|
+
*/
|
|
1249
|
+
codecType;
|
|
1250
|
+
/**
|
|
1251
|
+
* @ignore
|
|
1252
|
+
*/
|
|
1253
|
+
codecCapMask;
|
|
1114
1254
|
}
|
|
1115
1255
|
exports.CodecCapInfo = CodecCapInfo;
|
|
1116
1256
|
/**
|
|
1117
1257
|
* Video encoder configurations.
|
|
1118
1258
|
*/
|
|
1119
1259
|
class VideoEncoderConfiguration {
|
|
1260
|
+
/**
|
|
1261
|
+
* The codec type of the local video stream. See VideoCodecType .
|
|
1262
|
+
*/
|
|
1263
|
+
codecType;
|
|
1264
|
+
/**
|
|
1265
|
+
* The dimensions of the encoded video (px). See VideoDimensions . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.
|
|
1266
|
+
*/
|
|
1267
|
+
dimensions;
|
|
1268
|
+
/**
|
|
1269
|
+
* The frame rate (fps) of the encoding video frame. The default value is 15. See FrameRate .
|
|
1270
|
+
*/
|
|
1271
|
+
frameRate;
|
|
1272
|
+
/**
|
|
1273
|
+
* The encoding bitrate (Kbps) of the video.
|
|
1274
|
+
*/
|
|
1275
|
+
bitrate;
|
|
1276
|
+
/**
|
|
1277
|
+
* The minimum encoding bitrate (Kbps) of the video.The SDK automatically adjusts the encoding bitrate to adapt to the network conditions. Using a value greater than the default value forces the video encoder to output high-quality images but may cause more packet loss and sacrifice the smoothness of the video transmission. Unless you have special requirements for image quality, Agora does not recommend changing this value.This parameter only applies to the interactive streaming profile.
|
|
1278
|
+
*/
|
|
1279
|
+
minBitrate;
|
|
1280
|
+
/**
|
|
1281
|
+
* The orientation mode of the encoded video. See OrientationMode .
|
|
1282
|
+
*/
|
|
1283
|
+
orientationMode;
|
|
1284
|
+
/**
|
|
1285
|
+
* Video degradation preference under limited bandwidth. See DegradationPreference .
|
|
1286
|
+
*/
|
|
1287
|
+
degradationPreference;
|
|
1288
|
+
/**
|
|
1289
|
+
* By default, the video is not mirrored.
|
|
1290
|
+
*/
|
|
1291
|
+
mirrorMode;
|
|
1292
|
+
/**
|
|
1293
|
+
* Advanced options for video encoding. See AdvanceOptions .
|
|
1294
|
+
*/
|
|
1295
|
+
advanceOptions;
|
|
1120
1296
|
}
|
|
1121
1297
|
exports.VideoEncoderConfiguration = VideoEncoderConfiguration;
|
|
1122
1298
|
/**
|
|
@@ -1124,6 +1300,14 @@ exports.VideoEncoderConfiguration = VideoEncoderConfiguration;
|
|
|
1124
1300
|
* The following table shows the SDK behaviors under different parameter settings:
|
|
1125
1301
|
*/
|
|
1126
1302
|
class DataStreamConfig {
|
|
1303
|
+
/**
|
|
1304
|
+
* Whether to synchronize the data packet with the published audio packet.true: Synchronize the data packet with the audio packet.false: Do not synchronize the data packet with the audio packet.When you set the data packet to synchronize with the audio, then if the data packet delay is within the audio delay, the SDK triggers the onStreamMessage callback when the synchronized audio packet is played out. Do not set this parameter as true if you need the receiver to receive the data packet immediately. Agora recommends that you set this parameter to true only when you need to implement specific functions, for example, lyric synchronization.
|
|
1305
|
+
*/
|
|
1306
|
+
syncWithAudio;
|
|
1307
|
+
/**
|
|
1308
|
+
* Whether the SDK guarantees that the receiver receives the data in the sent order.true: Guarantee that the receiver receives the data in the sent order.false: Do not guarantee that the receiver receives the data in the sent order.Do not set this parameter as true if you need the receiver to receive the data packet immediately.
|
|
1309
|
+
*/
|
|
1310
|
+
ordered;
|
|
1127
1311
|
}
|
|
1128
1312
|
exports.DataStreamConfig = DataStreamConfig;
|
|
1129
1313
|
/**
|
|
@@ -1148,12 +1332,40 @@ var SimulcastStreamMode;
|
|
|
1148
1332
|
* The configuration of the low-quality video stream.
|
|
1149
1333
|
*/
|
|
1150
1334
|
class SimulcastStreamConfig {
|
|
1335
|
+
/**
|
|
1336
|
+
* The video dimension. See VideoDimensions . The default value is 160 × 120.
|
|
1337
|
+
*/
|
|
1338
|
+
dimensions;
|
|
1339
|
+
/**
|
|
1340
|
+
* @ignore
|
|
1341
|
+
*/
|
|
1342
|
+
kBitrate;
|
|
1343
|
+
/**
|
|
1344
|
+
* The capture frame rate (fps) of the local video. The default value is 5.
|
|
1345
|
+
*/
|
|
1346
|
+
framerate;
|
|
1151
1347
|
}
|
|
1152
1348
|
exports.SimulcastStreamConfig = SimulcastStreamConfig;
|
|
1153
1349
|
/**
|
|
1154
1350
|
* The location of the target area relative to the screen or window. If you do not set this parameter, the SDK selects the whole screen or window.
|
|
1155
1351
|
*/
|
|
1156
1352
|
class Rectangle {
|
|
1353
|
+
/**
|
|
1354
|
+
* The horizontal offset from the top-left corner.
|
|
1355
|
+
*/
|
|
1356
|
+
x;
|
|
1357
|
+
/**
|
|
1358
|
+
* The vertical offset from the top-left corner.
|
|
1359
|
+
*/
|
|
1360
|
+
y;
|
|
1361
|
+
/**
|
|
1362
|
+
* The width of the target area.
|
|
1363
|
+
*/
|
|
1364
|
+
width;
|
|
1365
|
+
/**
|
|
1366
|
+
* The height of the target area.
|
|
1367
|
+
*/
|
|
1368
|
+
height;
|
|
1157
1369
|
}
|
|
1158
1370
|
exports.Rectangle = Rectangle;
|
|
1159
1371
|
/**
|
|
@@ -1161,18 +1373,182 @@ exports.Rectangle = Rectangle;
|
|
|
1161
1373
|
* The position and size of the watermark on the screen are determined by xRatio, yRatio, and widthRatio:(xRatio, yRatio) refers to the coordinates of the upper left corner of the watermark, which determines the distance from the upper left corner of the watermark to the upper left corner of the screen.The widthRatio determines the width of the watermark.
|
|
1162
1374
|
*/
|
|
1163
1375
|
class WatermarkRatio {
|
|
1376
|
+
/**
|
|
1377
|
+
* The x-coordinate of the upper left corner of the watermark. The horizontal position relative to the origin, where the upper left corner of the screen is the origin, and the x-coordinate is the upper left corner of the watermark. The value range is [0.0,1.0], and the default value is 0.
|
|
1378
|
+
*/
|
|
1379
|
+
xRatio;
|
|
1380
|
+
/**
|
|
1381
|
+
* The y-coordinate of the upper left corner of the watermark. The vertical position relative to the origin, where the upper left corner of the screen is the origin, and the y-coordinate is the upper left corner of the screen. The value range is [0.0,1.0], and the default value is 0.
|
|
1382
|
+
*/
|
|
1383
|
+
yRatio;
|
|
1384
|
+
/**
|
|
1385
|
+
* The width of the watermark. The SDK calculates the height of the watermark proportionally according to this parameter value to ensure that the enlarged or reduced watermark image is not distorted. The value range is [0,1], and the default value is 0, which means no watermark is displayed.
|
|
1386
|
+
*/
|
|
1387
|
+
widthRatio;
|
|
1164
1388
|
}
|
|
1165
1389
|
exports.WatermarkRatio = WatermarkRatio;
|
|
1166
1390
|
/**
|
|
1167
1391
|
* Configurations of the watermark image.
|
|
1168
1392
|
*/
|
|
1169
1393
|
class WatermarkOptions {
|
|
1394
|
+
/**
|
|
1395
|
+
* Reserved for future use.
|
|
1396
|
+
*/
|
|
1397
|
+
visibleInPreview;
|
|
1398
|
+
/**
|
|
1399
|
+
* When the adaptation mode of the watermark is FitModeCoverPosition, it is used to set the area of the watermark image in landscape mode. See FitModeCoverPosition for details.
|
|
1400
|
+
*/
|
|
1401
|
+
positionInLandscapeMode;
|
|
1402
|
+
/**
|
|
1403
|
+
* When the adaptation mode of the watermark is FitModeCoverPosition, it is used to set the area of the watermark image in portrait mode. See FitModeCoverPosition for details.
|
|
1404
|
+
*/
|
|
1405
|
+
positionInPortraitMode;
|
|
1406
|
+
/**
|
|
1407
|
+
* When the watermark adaptation mode is FitModeUseImageRatio, this parameter is used to set the watermark coordinates. See WatermarkRatio .
|
|
1408
|
+
*/
|
|
1409
|
+
watermarkRatio;
|
|
1410
|
+
/**
|
|
1411
|
+
* The adaptation mode of the watermark. See WatermarkFitMode .
|
|
1412
|
+
*/
|
|
1413
|
+
mode;
|
|
1170
1414
|
}
|
|
1171
1415
|
exports.WatermarkOptions = WatermarkOptions;
|
|
1172
1416
|
/**
|
|
1173
1417
|
* Statistics of the channel.
|
|
1174
1418
|
*/
|
|
1175
1419
|
class RtcStats {
|
|
1420
|
+
/**
|
|
1421
|
+
* Call duration of the local user in seconds, represented by an aggregate value.
|
|
1422
|
+
*/
|
|
1423
|
+
duration;
|
|
1424
|
+
/**
|
|
1425
|
+
* Total number of bytes transmitted, represented by an aggregate value.
|
|
1426
|
+
*/
|
|
1427
|
+
txBytes;
|
|
1428
|
+
/**
|
|
1429
|
+
* Total number of bytes received, represented by an aggregate value.
|
|
1430
|
+
*/
|
|
1431
|
+
rxBytes;
|
|
1432
|
+
/**
|
|
1433
|
+
* Total number of audio bytes sent, represented by an aggregate value.
|
|
1434
|
+
*/
|
|
1435
|
+
txAudioBytes;
|
|
1436
|
+
/**
|
|
1437
|
+
* The total number of video bytes sent, represented by an aggregate value.
|
|
1438
|
+
*/
|
|
1439
|
+
txVideoBytes;
|
|
1440
|
+
/**
|
|
1441
|
+
* The total number of audio bytes received, represented by an aggregate value.
|
|
1442
|
+
*/
|
|
1443
|
+
rxAudioBytes;
|
|
1444
|
+
/**
|
|
1445
|
+
* The total number of video bytes received, represented by an aggregate value.
|
|
1446
|
+
*/
|
|
1447
|
+
rxVideoBytes;
|
|
1448
|
+
/**
|
|
1449
|
+
* Video transmission bitrate (Kbps), represented by an instantaneous value.
|
|
1450
|
+
*/
|
|
1451
|
+
txKBitRate;
|
|
1452
|
+
/**
|
|
1453
|
+
* The receiving bitrate (Kbps), represented by an instantaneous value.
|
|
1454
|
+
*/
|
|
1455
|
+
rxKBitRate;
|
|
1456
|
+
/**
|
|
1457
|
+
* Audio receive bitrate (Kbps), represented by an instantaneous value.
|
|
1458
|
+
*/
|
|
1459
|
+
rxAudioKBitRate;
|
|
1460
|
+
/**
|
|
1461
|
+
* The bitrate (Kbps) of sending the audio packet.
|
|
1462
|
+
*/
|
|
1463
|
+
txAudioKBitRate;
|
|
1464
|
+
/**
|
|
1465
|
+
* Video receive bitrate (Kbps), represented by an instantaneous value.
|
|
1466
|
+
*/
|
|
1467
|
+
rxVideoKBitRate;
|
|
1468
|
+
/**
|
|
1469
|
+
* The bitrate (Kbps) of sending the video.
|
|
1470
|
+
*/
|
|
1471
|
+
txVideoKBitRate;
|
|
1472
|
+
/**
|
|
1473
|
+
* The client-to-server delay (ms).
|
|
1474
|
+
*/
|
|
1475
|
+
lastmileDelay;
|
|
1476
|
+
/**
|
|
1477
|
+
* The number of users in the channel.
|
|
1478
|
+
*/
|
|
1479
|
+
userCount;
|
|
1480
|
+
/**
|
|
1481
|
+
* Application CPU usage (%).The value of cpuTotalUsage is always reported as 0 in the onLeaveChannel callback.
|
|
1482
|
+
*/
|
|
1483
|
+
cpuAppUsage;
|
|
1484
|
+
/**
|
|
1485
|
+
* The system CPU usage (%).For Windows, in the multi-kernel environment, this member represents the average CPU usage. The value = (100 - System Idle Progress in Task Manager)/100.The value of cpuTotalUsage is always reported as 0 in the onLeaveChannel callback.
|
|
1486
|
+
*/
|
|
1487
|
+
cpuTotalUsage;
|
|
1488
|
+
/**
|
|
1489
|
+
* The round-trip time delay (ms) from the client to the local router.
|
|
1490
|
+
*/
|
|
1491
|
+
gatewayRtt;
|
|
1492
|
+
/**
|
|
1493
|
+
* The memory ratio occupied by the app (%).This value is for reference only. Due to system limitations, you may not get this value.
|
|
1494
|
+
*/
|
|
1495
|
+
memoryAppUsageRatio;
|
|
1496
|
+
/**
|
|
1497
|
+
* The memory occupied by the system (%).This value is for reference only. Due to system limitations, you may not get this value.
|
|
1498
|
+
*/
|
|
1499
|
+
memoryTotalUsageRatio;
|
|
1500
|
+
/**
|
|
1501
|
+
* The memory size occupied by the app (KB).This value is for reference only. Due to system limitations, you may not get this value.
|
|
1502
|
+
*/
|
|
1503
|
+
memoryAppUsageInKbytes;
|
|
1504
|
+
/**
|
|
1505
|
+
* The duration (ms) between the SDK starts connecting and the connection is established. If the value reported is 0, it means invalid.
|
|
1506
|
+
*/
|
|
1507
|
+
connectTimeMs;
|
|
1508
|
+
/**
|
|
1509
|
+
* @ignore
|
|
1510
|
+
*/
|
|
1511
|
+
firstAudioPacketDuration;
|
|
1512
|
+
/**
|
|
1513
|
+
* @ignore
|
|
1514
|
+
*/
|
|
1515
|
+
firstVideoPacketDuration;
|
|
1516
|
+
/**
|
|
1517
|
+
* @ignore
|
|
1518
|
+
*/
|
|
1519
|
+
firstVideoKeyFramePacketDuration;
|
|
1520
|
+
/**
|
|
1521
|
+
* @ignore
|
|
1522
|
+
*/
|
|
1523
|
+
packetsBeforeFirstKeyFramePacket;
|
|
1524
|
+
/**
|
|
1525
|
+
* @ignore
|
|
1526
|
+
*/
|
|
1527
|
+
firstAudioPacketDurationAfterUnmute;
|
|
1528
|
+
/**
|
|
1529
|
+
* @ignore
|
|
1530
|
+
*/
|
|
1531
|
+
firstVideoPacketDurationAfterUnmute;
|
|
1532
|
+
/**
|
|
1533
|
+
* @ignore
|
|
1534
|
+
*/
|
|
1535
|
+
firstVideoKeyFramePacketDurationAfterUnmute;
|
|
1536
|
+
/**
|
|
1537
|
+
* @ignore
|
|
1538
|
+
*/
|
|
1539
|
+
firstVideoKeyFrameDecodedDurationAfterUnmute;
|
|
1540
|
+
/**
|
|
1541
|
+
* @ignore
|
|
1542
|
+
*/
|
|
1543
|
+
firstVideoKeyFrameRenderedDurationAfterUnmute;
|
|
1544
|
+
/**
|
|
1545
|
+
* The packet loss rate (%) from the client to the Agora server before applying the anti-packet-loss algorithm.
|
|
1546
|
+
*/
|
|
1547
|
+
txPacketLossRate;
|
|
1548
|
+
/**
|
|
1549
|
+
* The packet loss rate (%) from the Agora server to the client before using the anti-packet-loss method.
|
|
1550
|
+
*/
|
|
1551
|
+
rxPacketLossRate;
|
|
1176
1552
|
}
|
|
1177
1553
|
exports.RtcStats = RtcStats;
|
|
1178
1554
|
/**
|
|
@@ -1225,6 +1601,10 @@ var AudienceLatencyLevelType;
|
|
|
1225
1601
|
* The detailed options of a user.
|
|
1226
1602
|
*/
|
|
1227
1603
|
class ClientRoleOptions {
|
|
1604
|
+
/**
|
|
1605
|
+
* The latency level of an audience member in interactive live streaming. See AudienceLatencyLevelType .
|
|
1606
|
+
*/
|
|
1607
|
+
audienceLatencyLevel;
|
|
1228
1608
|
}
|
|
1229
1609
|
exports.ClientRoleOptions = ClientRoleOptions;
|
|
1230
1610
|
/**
|
|
@@ -1357,6 +1737,18 @@ var AudioScenarioType;
|
|
|
1357
1737
|
* The format of the video frame.
|
|
1358
1738
|
*/
|
|
1359
1739
|
class VideoFormat {
|
|
1740
|
+
/**
|
|
1741
|
+
* The width (px) of the video frame.
|
|
1742
|
+
*/
|
|
1743
|
+
width;
|
|
1744
|
+
/**
|
|
1745
|
+
* The height (px) of the video frame.
|
|
1746
|
+
*/
|
|
1747
|
+
height;
|
|
1748
|
+
/**
|
|
1749
|
+
* The video frame rate (fps).
|
|
1750
|
+
*/
|
|
1751
|
+
fps;
|
|
1360
1752
|
}
|
|
1361
1753
|
exports.VideoFormat = VideoFormat;
|
|
1362
1754
|
/**
|
|
@@ -1785,6 +2177,42 @@ var RemoteUserState;
|
|
|
1785
2177
|
* @ignore
|
|
1786
2178
|
*/
|
|
1787
2179
|
class VideoTrackInfo {
|
|
2180
|
+
/**
|
|
2181
|
+
* @ignore
|
|
2182
|
+
*/
|
|
2183
|
+
isLocal;
|
|
2184
|
+
/**
|
|
2185
|
+
* @ignore
|
|
2186
|
+
*/
|
|
2187
|
+
ownerUid;
|
|
2188
|
+
/**
|
|
2189
|
+
* @ignore
|
|
2190
|
+
*/
|
|
2191
|
+
trackId;
|
|
2192
|
+
/**
|
|
2193
|
+
* @ignore
|
|
2194
|
+
*/
|
|
2195
|
+
channelId;
|
|
2196
|
+
/**
|
|
2197
|
+
* @ignore
|
|
2198
|
+
*/
|
|
2199
|
+
streamType;
|
|
2200
|
+
/**
|
|
2201
|
+
* @ignore
|
|
2202
|
+
*/
|
|
2203
|
+
codecType;
|
|
2204
|
+
/**
|
|
2205
|
+
* @ignore
|
|
2206
|
+
*/
|
|
2207
|
+
encodedFrameOnly;
|
|
2208
|
+
/**
|
|
2209
|
+
* @ignore
|
|
2210
|
+
*/
|
|
2211
|
+
sourceType;
|
|
2212
|
+
/**
|
|
2213
|
+
* @ignore
|
|
2214
|
+
*/
|
|
2215
|
+
observationPosition;
|
|
1788
2216
|
}
|
|
1789
2217
|
exports.VideoTrackInfo = VideoTrackInfo;
|
|
1790
2218
|
/**
|
|
@@ -1817,18 +2245,46 @@ var RemoteVideoDownscaleLevel;
|
|
|
1817
2245
|
* The volume information of users.
|
|
1818
2246
|
*/
|
|
1819
2247
|
class AudioVolumeInfo {
|
|
2248
|
+
/**
|
|
2249
|
+
* The user ID.In the local user's callback, uid = 0.In the remote users' callback, uid is the user ID of a remote user whose instantaneous volume is one of the three highest.
|
|
2250
|
+
*/
|
|
2251
|
+
uid;
|
|
2252
|
+
/**
|
|
2253
|
+
* The volume of the user. The value ranges between 0 (lowest volume) and 255 (highest volume).
|
|
2254
|
+
*/
|
|
2255
|
+
volume;
|
|
2256
|
+
/**
|
|
2257
|
+
* Voice activity status of the local user.0: The local user is not speaking.1: The local user is speaking.The vad parameter does not report the voice activity status of remote users. In a remote user's callback, the value of vad is always 1.To use this parameter, you must set reportVad to true when calling enableAudioVolumeIndication .
|
|
2258
|
+
*/
|
|
2259
|
+
vad;
|
|
2260
|
+
/**
|
|
2261
|
+
* The voice pitch of the local user. The value ranges between 0.0 and 4000.0.The voicePitch parameter does not report the voice pitch of remote users. In the remote users' callback, the value of voicePitch is always 0.0.
|
|
2262
|
+
*/
|
|
2263
|
+
voicePitch;
|
|
1820
2264
|
}
|
|
1821
2265
|
exports.AudioVolumeInfo = AudioVolumeInfo;
|
|
1822
2266
|
/**
|
|
1823
2267
|
* The audio device information.
|
|
1824
2268
|
*/
|
|
1825
2269
|
class DeviceInfo {
|
|
2270
|
+
/**
|
|
2271
|
+
* @ignore
|
|
2272
|
+
*/
|
|
2273
|
+
isLowLatencyAudioSupported;
|
|
1826
2274
|
}
|
|
1827
2275
|
exports.DeviceInfo = DeviceInfo;
|
|
1828
2276
|
/**
|
|
1829
2277
|
* @ignore
|
|
1830
2278
|
*/
|
|
1831
2279
|
class Packet {
|
|
2280
|
+
/**
|
|
2281
|
+
* @ignore
|
|
2282
|
+
*/
|
|
2283
|
+
buffer;
|
|
2284
|
+
/**
|
|
2285
|
+
* @ignore
|
|
2286
|
+
*/
|
|
2287
|
+
size;
|
|
1832
2288
|
}
|
|
1833
2289
|
exports.Packet = Packet;
|
|
1834
2290
|
/**
|
|
@@ -1903,6 +2359,30 @@ var AudioCodecProfileType;
|
|
|
1903
2359
|
* Local audio statistics.
|
|
1904
2360
|
*/
|
|
1905
2361
|
class LocalAudioStats {
|
|
2362
|
+
/**
|
|
2363
|
+
* The number of audio channels.
|
|
2364
|
+
*/
|
|
2365
|
+
numChannels;
|
|
2366
|
+
/**
|
|
2367
|
+
* The sampling rate (Hz) of sending the local user's audio stream.
|
|
2368
|
+
*/
|
|
2369
|
+
sentSampleRate;
|
|
2370
|
+
/**
|
|
2371
|
+
* The average bitrate (Kbps) of sending the local user's audio stream.
|
|
2372
|
+
*/
|
|
2373
|
+
sentBitrate;
|
|
2374
|
+
/**
|
|
2375
|
+
* The internal payload codec.
|
|
2376
|
+
*/
|
|
2377
|
+
internalCodec;
|
|
2378
|
+
/**
|
|
2379
|
+
* The packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
|
|
2380
|
+
*/
|
|
2381
|
+
txPacketLossRate;
|
|
2382
|
+
/**
|
|
2383
|
+
* The delay of the audio device module when playing or recording audio.
|
|
2384
|
+
*/
|
|
2385
|
+
audioDeviceDelay;
|
|
1906
2386
|
}
|
|
1907
2387
|
exports.LocalAudioStats = LocalAudioStats;
|
|
1908
2388
|
/**
|
|
@@ -2037,6 +2517,34 @@ var RtmpStreamingEvent;
|
|
|
2037
2517
|
* This class sets the properties of the watermark and background images in the live video.
|
|
2038
2518
|
*/
|
|
2039
2519
|
class RtcImage {
|
|
2520
|
+
/**
|
|
2521
|
+
* The HTTP/HTTPS URL address of the image in the live video. The maximum length of this parameter is 1024 bytes.
|
|
2522
|
+
*/
|
|
2523
|
+
url;
|
|
2524
|
+
/**
|
|
2525
|
+
* The x coordinate (pixel) of the image on the video frame (taking the upper left corner of the video frame as the origin).
|
|
2526
|
+
*/
|
|
2527
|
+
x;
|
|
2528
|
+
/**
|
|
2529
|
+
* The y coordinate (pixel) of the image on the video frame (taking the upper left corner of the video frame as the origin).
|
|
2530
|
+
*/
|
|
2531
|
+
y;
|
|
2532
|
+
/**
|
|
2533
|
+
* The width (pixel) of the image on the video frame.
|
|
2534
|
+
*/
|
|
2535
|
+
width;
|
|
2536
|
+
/**
|
|
2537
|
+
* The height (pixel) of the image on the video frame.
|
|
2538
|
+
*/
|
|
2539
|
+
height;
|
|
2540
|
+
/**
|
|
2541
|
+
* The layer index of the watermark or background image. When you use the watermark array to add a watermark or multiple watermarks, you must pass a value to zOrder in the range [1,255]; otherwise, the SDK reports an error. In other cases, zOrder can optionally be passed in the range [0,255], with 0 being the default value. 0 means the bottom layer and 255 means the top layer.
|
|
2542
|
+
*/
|
|
2543
|
+
zOrder;
|
|
2544
|
+
/**
|
|
2545
|
+
* The transparency of the watermark or background image. The value ranges between 0.0 and 1.0:0.0: Completely transparent.1.0: (Default) Opaque.
|
|
2546
|
+
*/
|
|
2547
|
+
alpha;
|
|
2040
2548
|
}
|
|
2041
2549
|
exports.RtcImage = RtcImage;
|
|
2042
2550
|
/**
|
|
@@ -2044,6 +2552,14 @@ exports.RtcImage = RtcImage;
|
|
|
2044
2552
|
* If you want to enable the advanced features of streaming with transcoding, contact .
|
|
2045
2553
|
*/
|
|
2046
2554
|
class LiveStreamAdvancedFeature {
|
|
2555
|
+
/**
|
|
2556
|
+
* The feature names, including LBHQ (high-quality video with a lower bitrate) and VEO (optimized video encoder).
|
|
2557
|
+
*/
|
|
2558
|
+
featureName;
|
|
2559
|
+
/**
|
|
2560
|
+
* Whether to enable the advanced features of streaming with transcoding:true: Enable the advanced features.false: (Default) Do not enable the advanced features.
|
|
2561
|
+
*/
|
|
2562
|
+
opened;
|
|
2047
2563
|
}
|
|
2048
2564
|
exports.LiveStreamAdvancedFeature = LiveStreamAdvancedFeature;
|
|
2049
2565
|
/**
|
|
@@ -2076,24 +2592,208 @@ var ConnectionStateType;
|
|
|
2076
2592
|
* Transcoding configurations of each host.
|
|
2077
2593
|
*/
|
|
2078
2594
|
class TranscodingUser {
|
|
2595
|
+
/**
|
|
2596
|
+
* The user ID of the host.
|
|
2597
|
+
*/
|
|
2598
|
+
uid;
|
|
2599
|
+
/**
|
|
2600
|
+
* The x coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is [0, width], where width is the width set in LiveTranscoding .
|
|
2601
|
+
*/
|
|
2602
|
+
x;
|
|
2603
|
+
/**
|
|
2604
|
+
* The y coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is [0, height], where height is the height set in LiveTranscoding .
|
|
2605
|
+
*/
|
|
2606
|
+
y;
|
|
2607
|
+
/**
|
|
2608
|
+
* The width (pixel) of the host's video.
|
|
2609
|
+
*/
|
|
2610
|
+
width;
|
|
2611
|
+
/**
|
|
2612
|
+
* The height (pixel) of the host's video.
|
|
2613
|
+
*/
|
|
2614
|
+
height;
|
|
2615
|
+
/**
|
|
2616
|
+
* The layer index number of the host's video. The value range is [0, 100].0: (Default) The host's video is the bottom layer.100: The host's video is the top layer.If the value is less than 0 or greater than 100, ErrInvalidArgument error is returned.Setting zOrder to 0 is supported.
|
|
2617
|
+
*/
|
|
2618
|
+
zOrder;
|
|
2619
|
+
/**
|
|
2620
|
+
* The transparency of the host's video. The value range is [0.0,1.0].0.0: Completely transparent.1.0: (Default) Opaque.
|
|
2621
|
+
*/
|
|
2622
|
+
alpha;
|
|
2623
|
+
/**
|
|
2624
|
+
* The audio channel used by the host's audio in the output audio. The default value is 0, and the value range is [0, 5].0: (Recommended) The defaut setting, which supports dual channels at most and depends on the upstream of the host.1: The host's audio uses the FL audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first.2: The host's audio uses the FC audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first.3: The host's audio uses the FR audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first.4: The host's audio uses the BL audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first.5: The host's audio uses the BR audio channel. If the host's upstream uses multiple audio channels, the Agora server mixes them into mono first.0xFF or a value greater than 5: The host's audio is muted, and the Agora server removes the host's audio.If the value is not 0, a special player is required.
|
|
2625
|
+
*/
|
|
2626
|
+
audioChannel;
|
|
2079
2627
|
}
|
|
2080
2628
|
exports.TranscodingUser = TranscodingUser;
|
|
2081
2629
|
/**
|
|
2082
2630
|
* Transcoding configurations for Media Push.
|
|
2083
2631
|
*/
|
|
2084
2632
|
class LiveTranscoding {
|
|
2633
|
+
/**
|
|
2634
|
+
* The width of the video in pixels. The default value is 360.When pushing video streams to the CDN, the value range of width is [64,1920]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1920, Agora server automatically adjusts it to 1920.When pushing audio streams to the CDN, set width and height as 0.
|
|
2635
|
+
*/
|
|
2636
|
+
width;
|
|
2637
|
+
/**
|
|
2638
|
+
* The height of the video in pixels. The default value is 640.When pushing video streams to the CDN, the value range of height is [64,1080]. If the value is less than 64, Agora server automatically adjusts it to 64; if the value is greater than 1080, Agora server automatically adjusts it to 1080.When pushing audio streams to the CDN, set width and height as 0.
|
|
2639
|
+
*/
|
|
2640
|
+
height;
|
|
2641
|
+
/**
|
|
2642
|
+
* Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps.
|
|
2643
|
+
*/
|
|
2644
|
+
videoBitrate;
|
|
2645
|
+
/**
|
|
2646
|
+
* Frame rate (fps) of the output video stream set for Media Push. The default value is 15. The value range is (0,30].The Agora server adjusts any value over 30 to 30.
|
|
2647
|
+
*/
|
|
2648
|
+
videoFramerate;
|
|
2649
|
+
/**
|
|
2650
|
+
* DeprecatedThis member is deprecated.Latency mode:true: Low latency with unassured quality.false: (Default) High latency with assured quality.
|
|
2651
|
+
*/
|
|
2652
|
+
lowLatency;
|
|
2653
|
+
/**
|
|
2654
|
+
* GOP (Group of Pictures) in fps of the video frames for Media Push. The default value is 30.
|
|
2655
|
+
*/
|
|
2656
|
+
videoGop;
|
|
2657
|
+
/**
|
|
2658
|
+
* Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See VideoCodecProfileType for details.If you set this parameter to any other value, Agora adjusts it to the default value.
|
|
2659
|
+
*/
|
|
2660
|
+
videoCodecProfile;
|
|
2661
|
+
/**
|
|
2662
|
+
* The background color in RGB hex value. Value only. Do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black).
|
|
2663
|
+
*/
|
|
2664
|
+
backgroundColor;
|
|
2665
|
+
/**
|
|
2666
|
+
* Video codec profile types for Media Push. See VideoCodecTypeForStream .
|
|
2667
|
+
*/
|
|
2668
|
+
videoCodecType;
|
|
2669
|
+
/**
|
|
2670
|
+
* The number of users in the Media Push. The value range is [0,17].
|
|
2671
|
+
*/
|
|
2672
|
+
userCount;
|
|
2673
|
+
/**
|
|
2674
|
+
* Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See TranscodingUser .
|
|
2675
|
+
*/
|
|
2676
|
+
transcodingUsers;
|
|
2677
|
+
/**
|
|
2678
|
+
* Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 bytes. For more information on SEI, see SEI-related questions.
|
|
2679
|
+
*/
|
|
2680
|
+
transcodingExtraInfo;
|
|
2681
|
+
/**
|
|
2682
|
+
* DeprecatedObsolete and not recommended for use.The metadata sent to the CDN client.
|
|
2683
|
+
*/
|
|
2684
|
+
metadata;
|
|
2685
|
+
/**
|
|
2686
|
+
* The watermark on the live video. The image format needs to be PNG. See RtcImage .You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.
|
|
2687
|
+
*/
|
|
2688
|
+
watermark;
|
|
2689
|
+
/**
|
|
2690
|
+
* The number of watermarks on the live video. The total number of watermarks and background images can range from 0 to 10. This parameter is used with watermark.
|
|
2691
|
+
*/
|
|
2692
|
+
watermarkCount;
|
|
2693
|
+
/**
|
|
2694
|
+
* The number of background images on the live video. The image format needs to be PNG. See RtcImage .You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.
|
|
2695
|
+
*/
|
|
2696
|
+
backgroundImage;
|
|
2697
|
+
/**
|
|
2698
|
+
* The number of background images on the live video. The total number of watermarks and background images can range from 0 to 10. This parameter is used with backgroundImage.
|
|
2699
|
+
*/
|
|
2700
|
+
backgroundImageCount;
|
|
2701
|
+
/**
|
|
2702
|
+
* The audio sampling rate (Hz) of the output media stream. See AudioSampleRateType .
|
|
2703
|
+
*/
|
|
2704
|
+
audioSampleRate;
|
|
2705
|
+
/**
|
|
2706
|
+
* Bitrate (Kbps) of the audio output stream for Media Push. The default value is 48, and the highest value is 128.
|
|
2707
|
+
*/
|
|
2708
|
+
audioBitrate;
|
|
2709
|
+
/**
|
|
2710
|
+
* The number of audio channels for Media Push. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5.1: (Default) Mono2: Stereo.3: Three audio channels.4: Four audio channels.5: Five audio channels.
|
|
2711
|
+
*/
|
|
2712
|
+
audioChannels;
|
|
2713
|
+
/**
|
|
2714
|
+
* Audio codec profile type for Media Push. See AudioCodecProfileType .
|
|
2715
|
+
*/
|
|
2716
|
+
audioCodecProfile;
|
|
2717
|
+
/**
|
|
2718
|
+
* Advanced features of the Media Push with transcoding. See LiveStreamAdvancedFeature .
|
|
2719
|
+
*/
|
|
2720
|
+
advancedFeatures;
|
|
2721
|
+
/**
|
|
2722
|
+
* The number of enabled advanced features. The default value is 0.
|
|
2723
|
+
*/
|
|
2724
|
+
advancedFeatureCount;
|
|
2085
2725
|
}
|
|
2086
2726
|
exports.LiveTranscoding = LiveTranscoding;
|
|
2087
2727
|
/**
|
|
2088
2728
|
* The video streams for the video mixing on the local client.
|
|
2089
2729
|
*/
|
|
2090
2730
|
class TranscodingVideoStream {
|
|
2731
|
+
/**
|
|
2732
|
+
* The source type of video for the video mixing on the local client. See VideoSourceType .
|
|
2733
|
+
*/
|
|
2734
|
+
sourceType;
|
|
2735
|
+
/**
|
|
2736
|
+
* The ID of the remote user.Use this parameter only when the source type of the video for the video mixing on the local client is VideoSourceRemote.
|
|
2737
|
+
*/
|
|
2738
|
+
remoteUserUid;
|
|
2739
|
+
/**
|
|
2740
|
+
* The URL of the image.
|
|
2741
|
+
*/
|
|
2742
|
+
imageUrl;
|
|
2743
|
+
/**
|
|
2744
|
+
* @ignore
|
|
2745
|
+
*/
|
|
2746
|
+
mediaPlayerId;
|
|
2747
|
+
/**
|
|
2748
|
+
* The horizontal displacement of the top-left corner of the video for the video mixing on the client relative to the top-left corner (origin) of the canvas for this video mixing.
|
|
2749
|
+
*/
|
|
2750
|
+
x;
|
|
2751
|
+
/**
|
|
2752
|
+
* The vertical displacement of the top-left corner of the video for the video mixing on the client relative to the top-left corner (origin) of the canvas for this video mixing.
|
|
2753
|
+
*/
|
|
2754
|
+
y;
|
|
2755
|
+
/**
|
|
2756
|
+
* The width (px) of the video for the video mixing on the local client.
|
|
2757
|
+
*/
|
|
2758
|
+
width;
|
|
2759
|
+
/**
|
|
2760
|
+
* The height (px) of the video for the video mixing on the local client.
|
|
2761
|
+
*/
|
|
2762
|
+
height;
|
|
2763
|
+
/**
|
|
2764
|
+
* The number of the layer to which the video for the video mixing on the local client belongs. The value range is [0,100].0: (Default) The layer is at the bottom.100: The layer is at the top.
|
|
2765
|
+
*/
|
|
2766
|
+
zOrder;
|
|
2767
|
+
/**
|
|
2768
|
+
* The transparency of the video for the video mixing on the local client. The value range is [0.0,1.0]. 0.0 means the transparency is completely transparent. 1.0 means the transparency is opaque.
|
|
2769
|
+
*/
|
|
2770
|
+
alpha;
|
|
2771
|
+
/**
|
|
2772
|
+
* Whether to mirror the video for the video mixing on the local client.true: Mirror the captured video.false: (Default) Do not mirror the captured video.The paramter only works for videos with the source type
|
|
2773
|
+
*/
|
|
2774
|
+
mirror;
|
|
2091
2775
|
}
|
|
2092
2776
|
exports.TranscodingVideoStream = TranscodingVideoStream;
|
|
2093
2777
|
/**
|
|
2094
2778
|
* The configuration of the video mixing on the local client.
|
|
2095
2779
|
*/
|
|
2096
2780
|
class LocalTranscoderConfiguration {
|
|
2781
|
+
/**
|
|
2782
|
+
* The number of the video streams for the video mixing on the local client.
|
|
2783
|
+
*/
|
|
2784
|
+
streamCount;
|
|
2785
|
+
/**
|
|
2786
|
+
* The video streams for the video mixing on the local client. See TranscodingVideoStream .
|
|
2787
|
+
*/
|
|
2788
|
+
videoInputStreams;
|
|
2789
|
+
/**
|
|
2790
|
+
* The encoding configuration of the mixed video stream after the video mixing on the local client. See VideoEncoderConfiguration .
|
|
2791
|
+
*/
|
|
2792
|
+
videoOutputConfiguration;
|
|
2793
|
+
/**
|
|
2794
|
+
* @ignore
|
|
2795
|
+
*/
|
|
2796
|
+
syncWithPrimaryCamera;
|
|
2097
2797
|
}
|
|
2098
2798
|
exports.LocalTranscoderConfiguration = LocalTranscoderConfiguration;
|
|
2099
2799
|
/**
|
|
@@ -2128,12 +2828,28 @@ var VideoTranscoderError;
|
|
|
2128
2828
|
/**
|
|
2129
2829
|
* @ignore
|
|
2130
2830
|
*/
|
|
2131
|
-
VideoTranscoderError[VideoTranscoderError["VtErrInternal"] = 20] = "VtErrInternal";
|
|
2132
|
-
})(VideoTranscoderError = exports.VideoTranscoderError || (exports.VideoTranscoderError = {}));
|
|
2133
|
-
/**
|
|
2134
|
-
* Configurations of the last-mile network test.
|
|
2135
|
-
*/
|
|
2136
|
-
class LastmileProbeConfig {
|
|
2831
|
+
VideoTranscoderError[VideoTranscoderError["VtErrInternal"] = 20] = "VtErrInternal";
|
|
2832
|
+
})(VideoTranscoderError = exports.VideoTranscoderError || (exports.VideoTranscoderError = {}));
|
|
2833
|
+
/**
|
|
2834
|
+
* Configurations of the last-mile network test.
|
|
2835
|
+
*/
|
|
2836
|
+
class LastmileProbeConfig {
|
|
2837
|
+
/**
|
|
2838
|
+
* Sets whether to test the uplink network. Some users, for example, the audience members in a LIVE_BROADCASTING channel, do not need such a test.true: Test the uplink network.false: Do not test the uplink network.
|
|
2839
|
+
*/
|
|
2840
|
+
probeUplink;
|
|
2841
|
+
/**
|
|
2842
|
+
* Sets whether to test the downlink network:true: Test the downlink network.false: Do not test the downlink network.
|
|
2843
|
+
*/
|
|
2844
|
+
probeDownlink;
|
|
2845
|
+
/**
|
|
2846
|
+
* The expected maximum uplink bitrate (bps) of the local user. The value range is [100000, 5000000]. Agora recommends referring to setVideoEncoderConfiguration to set the value.
|
|
2847
|
+
*/
|
|
2848
|
+
expectedUplinkBitrate;
|
|
2849
|
+
/**
|
|
2850
|
+
* The expected maximum downlink bitrate (bps) of the local user. The value range is [100000,5000000].
|
|
2851
|
+
*/
|
|
2852
|
+
expectedDownlinkBitrate;
|
|
2137
2853
|
}
|
|
2138
2854
|
exports.LastmileProbeConfig = LastmileProbeConfig;
|
|
2139
2855
|
/**
|
|
@@ -2158,12 +2874,40 @@ var LastmileProbeResultState;
|
|
|
2158
2874
|
* Results of the uplink or downlink last-mile network test.
|
|
2159
2875
|
*/
|
|
2160
2876
|
class LastmileProbeOneWayResult {
|
|
2877
|
+
/**
|
|
2878
|
+
* The packet loss rate (%).
|
|
2879
|
+
*/
|
|
2880
|
+
packetLossRate;
|
|
2881
|
+
/**
|
|
2882
|
+
* The network jitter (ms).
|
|
2883
|
+
*/
|
|
2884
|
+
jitter;
|
|
2885
|
+
/**
|
|
2886
|
+
* The estimated available bandwidth (bps).
|
|
2887
|
+
*/
|
|
2888
|
+
availableBandwidth;
|
|
2161
2889
|
}
|
|
2162
2890
|
exports.LastmileProbeOneWayResult = LastmileProbeOneWayResult;
|
|
2163
2891
|
/**
|
|
2164
2892
|
* Results of the uplink and downlink last-mile network tests.
|
|
2165
2893
|
*/
|
|
2166
2894
|
class LastmileProbeResult {
|
|
2895
|
+
/**
|
|
2896
|
+
* The status of the last-mile probe test. See LastmileProbeResultState .
|
|
2897
|
+
*/
|
|
2898
|
+
state;
|
|
2899
|
+
/**
|
|
2900
|
+
* Results of the uplink last-mile network test. See LastmileProbeOneWayResult .
|
|
2901
|
+
*/
|
|
2902
|
+
uplinkReport;
|
|
2903
|
+
/**
|
|
2904
|
+
* Results of the downlink last-mile network test. See LastmileProbeOneWayResult .
|
|
2905
|
+
*/
|
|
2906
|
+
downlinkReport;
|
|
2907
|
+
/**
|
|
2908
|
+
* The round-trip time (ms).
|
|
2909
|
+
*/
|
|
2910
|
+
rtt;
|
|
2167
2911
|
}
|
|
2168
2912
|
exports.LastmileProbeResult = LastmileProbeResult;
|
|
2169
2913
|
/**
|
|
@@ -2322,6 +3066,18 @@ var WlaccSuggestAction;
|
|
|
2322
3066
|
* @ignore
|
|
2323
3067
|
*/
|
|
2324
3068
|
class WlAccStats {
|
|
3069
|
+
/**
|
|
3070
|
+
* @ignore
|
|
3071
|
+
*/
|
|
3072
|
+
e2eDelayPercent;
|
|
3073
|
+
/**
|
|
3074
|
+
* @ignore
|
|
3075
|
+
*/
|
|
3076
|
+
frozenRatioPercent;
|
|
3077
|
+
/**
|
|
3078
|
+
* @ignore
|
|
3079
|
+
*/
|
|
3080
|
+
lossRatePercent;
|
|
2325
3081
|
}
|
|
2326
3082
|
exports.WlAccStats = WlAccStats;
|
|
2327
3083
|
/**
|
|
@@ -2380,6 +3136,42 @@ var VideoViewSetupMode;
|
|
|
2380
3136
|
* Attributes of video canvas object.
|
|
2381
3137
|
*/
|
|
2382
3138
|
class VideoCanvas {
|
|
3139
|
+
/**
|
|
3140
|
+
* Video display window.
|
|
3141
|
+
*/
|
|
3142
|
+
view;
|
|
3143
|
+
/**
|
|
3144
|
+
* The user ID.
|
|
3145
|
+
*/
|
|
3146
|
+
uid;
|
|
3147
|
+
/**
|
|
3148
|
+
* The rendering mode of the video. See RenderModeType .
|
|
3149
|
+
*/
|
|
3150
|
+
renderMode;
|
|
3151
|
+
/**
|
|
3152
|
+
* The mirror mode of the view. See VideoMirrorModeType .For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.For the remote user: The mirror mode is disabled by default.
|
|
3153
|
+
*/
|
|
3154
|
+
mirrorMode;
|
|
3155
|
+
/**
|
|
3156
|
+
* @ignore
|
|
3157
|
+
*/
|
|
3158
|
+
setupMode;
|
|
3159
|
+
/**
|
|
3160
|
+
* The type of the video frame, see VideoSourceType .
|
|
3161
|
+
*/
|
|
3162
|
+
sourceType;
|
|
3163
|
+
/**
|
|
3164
|
+
* The ID of the media player. You can get the Device ID by calling getMediaPlayerId .
|
|
3165
|
+
*/
|
|
3166
|
+
mediaPlayerId;
|
|
3167
|
+
/**
|
|
3168
|
+
* @ignore
|
|
3169
|
+
*/
|
|
3170
|
+
cropArea;
|
|
3171
|
+
/**
|
|
3172
|
+
* @ignore
|
|
3173
|
+
*/
|
|
3174
|
+
enableAlphaMask;
|
|
2383
3175
|
}
|
|
2384
3176
|
exports.VideoCanvas = VideoCanvas;
|
|
2385
3177
|
/**
|
|
@@ -2404,6 +3196,26 @@ var LighteningContrastLevel;
|
|
|
2404
3196
|
* Image enhancement options.
|
|
2405
3197
|
*/
|
|
2406
3198
|
class BeautyOptions {
|
|
3199
|
+
/**
|
|
3200
|
+
* The contrast level, used with the lighteningLevel parameter. The larger the value, the greater the contrast between light and dark.
|
|
3201
|
+
*/
|
|
3202
|
+
lighteningContrastLevel;
|
|
3203
|
+
/**
|
|
3204
|
+
* The brightening level, in the range [0.0,1.0], where 0.0 means the original brightening. The default value is
|
|
3205
|
+
*/
|
|
3206
|
+
lighteningLevel;
|
|
3207
|
+
/**
|
|
3208
|
+
* The smoothness level, in the range [0.0,1.0], where 0.0 means the original smoothness. The default value is
|
|
3209
|
+
*/
|
|
3210
|
+
smoothnessLevel;
|
|
3211
|
+
/**
|
|
3212
|
+
* The redness level, in the range [0.0,1.0], where 0.0 means the original redness. The default value is
|
|
3213
|
+
*/
|
|
3214
|
+
rednessLevel;
|
|
3215
|
+
/**
|
|
3216
|
+
* The sharpness level, in the range [0.0,1.0], where 0.0 means the original sharpness. The default value is
|
|
3217
|
+
*/
|
|
3218
|
+
sharpnessLevel;
|
|
2407
3219
|
}
|
|
2408
3220
|
exports.BeautyOptions = BeautyOptions;
|
|
2409
3221
|
/**
|
|
@@ -2438,6 +3250,14 @@ var LowLightEnhanceLevel;
|
|
|
2438
3250
|
* The low-light enhancement options.
|
|
2439
3251
|
*/
|
|
2440
3252
|
class LowlightEnhanceOptions {
|
|
3253
|
+
/**
|
|
3254
|
+
* The low-light enhancement mode. See LowLightEnhanceMode .
|
|
3255
|
+
*/
|
|
3256
|
+
mode;
|
|
3257
|
+
/**
|
|
3258
|
+
* The low-light enhancement level. See LowLightEnhanceLevel .
|
|
3259
|
+
*/
|
|
3260
|
+
level;
|
|
2441
3261
|
}
|
|
2442
3262
|
exports.LowlightEnhanceOptions = LowlightEnhanceOptions;
|
|
2443
3263
|
/**
|
|
@@ -2476,12 +3296,28 @@ var VideoDenoiserLevel;
|
|
|
2476
3296
|
* Video noise reduction options.
|
|
2477
3297
|
*/
|
|
2478
3298
|
class VideoDenoiserOptions {
|
|
3299
|
+
/**
|
|
3300
|
+
* Video noise reduction mode.
|
|
3301
|
+
*/
|
|
3302
|
+
mode;
|
|
3303
|
+
/**
|
|
3304
|
+
* Video noise reduction level.
|
|
3305
|
+
*/
|
|
3306
|
+
level;
|
|
2479
3307
|
}
|
|
2480
3308
|
exports.VideoDenoiserOptions = VideoDenoiserOptions;
|
|
2481
3309
|
/**
|
|
2482
3310
|
* The color enhancement options.
|
|
2483
3311
|
*/
|
|
2484
3312
|
class ColorEnhanceOptions {
|
|
3313
|
+
/**
|
|
3314
|
+
* The level of color enhancement. The value range is [0.0, 1.0]. 0.0 is the default value, which means no color enhancement is applied to the video. The higher the value, the higher the level of color enhancement. The default value is 0.5.
|
|
3315
|
+
*/
|
|
3316
|
+
strengthLevel;
|
|
3317
|
+
/**
|
|
3318
|
+
* The level of skin tone protection. The value range is [0.0, 1.0]. 0.0 means no skin tone protection. The higher the value, the higher the level of skin tone protection. The default value is 1.0.When the level of color enhancement is higher, the portrait skin tone can be significantly distorted, so you need to set the level of skin tone protection.When the level of skin tone protection is higher, the color enhancement effect can be slightly reduced.Therefore, to get the best color enhancement effect, Agora recommends that you adjust strengthLevel and skinProtectLevel to get the most appropriate values.
|
|
3319
|
+
*/
|
|
3320
|
+
skinProtectLevel;
|
|
2485
3321
|
}
|
|
2486
3322
|
exports.ColorEnhanceOptions = ColorEnhanceOptions;
|
|
2487
3323
|
/**
|
|
@@ -2532,6 +3368,22 @@ var BackgroundBlurDegree;
|
|
|
2532
3368
|
* The custom background image.
|
|
2533
3369
|
*/
|
|
2534
3370
|
class VirtualBackgroundSource {
|
|
3371
|
+
/**
|
|
3372
|
+
* @ignore
|
|
3373
|
+
*/
|
|
3374
|
+
background_source_type;
|
|
3375
|
+
/**
|
|
3376
|
+
* The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image is BackgroundColor.
|
|
3377
|
+
*/
|
|
3378
|
+
color;
|
|
3379
|
+
/**
|
|
3380
|
+
* The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image is BackgroundImg.
|
|
3381
|
+
*/
|
|
3382
|
+
source;
|
|
3383
|
+
/**
|
|
3384
|
+
* The degree of blurring applied to the custom background image. This parameter takes effect only when the type of the custom background image is BackgroundBlur.
|
|
3385
|
+
*/
|
|
3386
|
+
blur_degree;
|
|
2535
3387
|
}
|
|
2536
3388
|
exports.VirtualBackgroundSource = VirtualBackgroundSource;
|
|
2537
3389
|
/**
|
|
@@ -2552,6 +3404,14 @@ var SegModelType;
|
|
|
2552
3404
|
* Processing properties for background images.
|
|
2553
3405
|
*/
|
|
2554
3406
|
class SegmentationProperty {
|
|
3407
|
+
/**
|
|
3408
|
+
* The type of algorithms to user for background processing. See SegModelType .
|
|
3409
|
+
*/
|
|
3410
|
+
modelType;
|
|
3411
|
+
/**
|
|
3412
|
+
* The range of accuracy for identifying green colors (different shades of green) in the view. The value range is [0,1], and the default value is 0.5. The larger the value, the wider the range of identifiable shades of green. When the value of this parameter is too large, the edge of the portrait and the green color in the portrait range are also detected. Agora recommends that you dynamically adjust the value of this parameter according to the actual effect.This parameter only takes effect when modelType is set to SegModelGreen.
|
|
3413
|
+
*/
|
|
3414
|
+
greenCapacity;
|
|
2555
3415
|
}
|
|
2556
3416
|
exports.SegmentationProperty = SegmentationProperty;
|
|
2557
3417
|
/**
|
|
@@ -2576,6 +3436,10 @@ var AudioTrackType;
|
|
|
2576
3436
|
* @ignore
|
|
2577
3437
|
*/
|
|
2578
3438
|
class AudioTrackConfig {
|
|
3439
|
+
/**
|
|
3440
|
+
* @ignore
|
|
3441
|
+
*/
|
|
3442
|
+
enableLocalPlayback;
|
|
2579
3443
|
}
|
|
2580
3444
|
exports.AudioTrackConfig = AudioTrackConfig;
|
|
2581
3445
|
/**
|
|
@@ -2819,6 +3683,46 @@ var HeadphoneEqualizerPreset;
|
|
|
2819
3683
|
* Screen sharing configurations.
|
|
2820
3684
|
*/
|
|
2821
3685
|
class ScreenCaptureParameters {
|
|
3686
|
+
/**
|
|
3687
|
+
* On Windows and macOS, this represents the video encoding resolution of the shared screen stream. See VideoDimensions . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under
|
|
3688
|
+
*/
|
|
3689
|
+
dimensions;
|
|
3690
|
+
/**
|
|
3691
|
+
* On Windows and macOS, this represents the video encoding frame rate (fps) of the shared screen stream. The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting this to a value greater than 15.
|
|
3692
|
+
*/
|
|
3693
|
+
frameRate;
|
|
3694
|
+
/**
|
|
3695
|
+
* On Windows and macOS, this represents the video encoding bitrate of the shared screen stream. The bitrate (Kbps) of the shared region. The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen).
|
|
3696
|
+
*/
|
|
3697
|
+
bitrate;
|
|
3698
|
+
/**
|
|
3699
|
+
* Whether to capture the mouse in screen sharing:true: (Default) Capture the mouse.false: Do not capture the mouse.
|
|
3700
|
+
*/
|
|
3701
|
+
captureMouseCursor;
|
|
3702
|
+
/**
|
|
3703
|
+
* Whether to bring the window to the front when calling the startScreenCaptureByWindowId method to share it:true: Bring the window to the front.false: (Default) Do not bring the window to the front.
|
|
3704
|
+
*/
|
|
3705
|
+
windowFocus;
|
|
3706
|
+
/**
|
|
3707
|
+
* The ID list of the windows to be blocked. When calling startScreenCaptureByDisplayId to start screen sharing, you can use this parameter to block a specified window. When calling updateScreenCaptureParameters to update screen sharing configurations, you can use this parameter to dynamically block a specified window.
|
|
3708
|
+
*/
|
|
3709
|
+
excludeWindowList;
|
|
3710
|
+
/**
|
|
3711
|
+
* The number of windows to be excluded.On the Windows platform, the maximum value of this parameter is 24; if this value is exceeded, excluding the window fails.
|
|
3712
|
+
*/
|
|
3713
|
+
excludeWindowCount;
|
|
3714
|
+
/**
|
|
3715
|
+
* The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to true.
|
|
3716
|
+
*/
|
|
3717
|
+
highLightWidth;
|
|
3718
|
+
/**
|
|
3719
|
+
* On macOS, COLOR_CLASS refers to NSColor.
|
|
3720
|
+
*/
|
|
3721
|
+
highLightColor;
|
|
3722
|
+
/**
|
|
3723
|
+
* Whether to place a border around the shared window or screen:true: Place a border.false: (Default) Do not place a border.When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to true.
|
|
3724
|
+
*/
|
|
3725
|
+
enableHighLight;
|
|
2822
3726
|
}
|
|
2823
3727
|
exports.ScreenCaptureParameters = ScreenCaptureParameters;
|
|
2824
3728
|
/**
|
|
@@ -2883,12 +3787,44 @@ var AudioEncodedFrameObserverPosition;
|
|
|
2883
3787
|
* Recording configurations.
|
|
2884
3788
|
*/
|
|
2885
3789
|
class AudioRecordingConfiguration {
|
|
3790
|
+
/**
|
|
3791
|
+
* The absolute path (including the filename extensions) of the recording file. For example: C:\music\audio.mp4.Ensure that the directory for the log files exists and is writable.
|
|
3792
|
+
*/
|
|
3793
|
+
filePath;
|
|
3794
|
+
/**
|
|
3795
|
+
* @ignore
|
|
3796
|
+
*/
|
|
3797
|
+
encode;
|
|
3798
|
+
/**
|
|
3799
|
+
* Recording sample rate (Hz).16000(Default) 320004410048000If you set this parameter to 44100 or 48000, Agora recommends recording WAV files, or AAC files with quality set as AudioRecordingQualityMedium or AudioRecordingQualityHigh for better recording quality.
|
|
3800
|
+
*/
|
|
3801
|
+
sampleRate;
|
|
3802
|
+
/**
|
|
3803
|
+
* The recording content. See AudioFileRecordingType .
|
|
3804
|
+
*/
|
|
3805
|
+
fileRecordingType;
|
|
3806
|
+
/**
|
|
3807
|
+
* Recording quality. See AudioRecordingQualityType .Note: This parameter applies to AAC files only.
|
|
3808
|
+
*/
|
|
3809
|
+
quality;
|
|
3810
|
+
/**
|
|
3811
|
+
* The audio channel of recording: The parameter supports the following values:1: (Default) Mono.2: Stereo.The actual recorded audio channel is related to the audio channel that you capture.If the captured audio is mono and recordingChannel is 2, the recorded audio is the dual-channel data that is copied from mono data, not stereo.If the captured audio is dual channel and recordingChannel is 1, the recorded audio is the mono data that is mixed by dual-channel data.The integration scheme also affects the final recorded audio channel. If you need to record in stereo, contact .
|
|
3812
|
+
*/
|
|
3813
|
+
recordingChannel;
|
|
2886
3814
|
}
|
|
2887
3815
|
exports.AudioRecordingConfiguration = AudioRecordingConfiguration;
|
|
2888
3816
|
/**
|
|
2889
3817
|
* Observer settings for encoded audio.
|
|
2890
3818
|
*/
|
|
2891
3819
|
class AudioEncodedFrameObserverConfig {
|
|
3820
|
+
/**
|
|
3821
|
+
* Audio profile. See AudioEncodedFrameObserverPosition .
|
|
3822
|
+
*/
|
|
3823
|
+
postionType;
|
|
3824
|
+
/**
|
|
3825
|
+
* Audio encoding type. See AudioEncodingType .
|
|
3826
|
+
*/
|
|
3827
|
+
encodingType;
|
|
2892
3828
|
}
|
|
2893
3829
|
exports.AudioEncodedFrameObserverConfig = AudioEncodedFrameObserverConfig;
|
|
2894
3830
|
/**
|
|
@@ -3109,30 +4045,94 @@ var ChannelMediaRelayState;
|
|
|
3109
4045
|
* Channel media information.
|
|
3110
4046
|
*/
|
|
3111
4047
|
class ChannelMediaInfo {
|
|
4048
|
+
/**
|
|
4049
|
+
* The channel name.
|
|
4050
|
+
*/
|
|
4051
|
+
channelName;
|
|
4052
|
+
/**
|
|
4053
|
+
* The token that enables the user to join the channel.
|
|
4054
|
+
*/
|
|
4055
|
+
token;
|
|
4056
|
+
/**
|
|
4057
|
+
* The user ID.
|
|
4058
|
+
*/
|
|
4059
|
+
uid;
|
|
3112
4060
|
}
|
|
3113
4061
|
exports.ChannelMediaInfo = ChannelMediaInfo;
|
|
3114
4062
|
/**
|
|
3115
4063
|
* Configuration of cross channel media relay.
|
|
3116
4064
|
*/
|
|
3117
4065
|
class ChannelMediaRelayConfiguration {
|
|
4066
|
+
/**
|
|
4067
|
+
* @ignore
|
|
4068
|
+
*/
|
|
4069
|
+
srcInfo;
|
|
4070
|
+
/**
|
|
4071
|
+
* @ignore
|
|
4072
|
+
*/
|
|
4073
|
+
destInfos;
|
|
4074
|
+
/**
|
|
4075
|
+
* @ignore
|
|
4076
|
+
*/
|
|
4077
|
+
destCount;
|
|
3118
4078
|
}
|
|
3119
4079
|
exports.ChannelMediaRelayConfiguration = ChannelMediaRelayConfiguration;
|
|
3120
4080
|
/**
|
|
3121
4081
|
* The uplink network information.
|
|
3122
4082
|
*/
|
|
3123
4083
|
class UplinkNetworkInfo {
|
|
4084
|
+
/**
|
|
4085
|
+
* The target video encoder bitrate (bps).
|
|
4086
|
+
*/
|
|
4087
|
+
video_encoder_target_bitrate_bps;
|
|
3124
4088
|
}
|
|
3125
4089
|
exports.UplinkNetworkInfo = UplinkNetworkInfo;
|
|
3126
4090
|
/**
|
|
3127
4091
|
* @ignore
|
|
3128
4092
|
*/
|
|
3129
4093
|
class PeerDownlinkInfo {
|
|
4094
|
+
/**
|
|
4095
|
+
* @ignore
|
|
4096
|
+
*/
|
|
4097
|
+
uid;
|
|
4098
|
+
/**
|
|
4099
|
+
* @ignore
|
|
4100
|
+
*/
|
|
4101
|
+
stream_type;
|
|
4102
|
+
/**
|
|
4103
|
+
* @ignore
|
|
4104
|
+
*/
|
|
4105
|
+
current_downscale_level;
|
|
4106
|
+
/**
|
|
4107
|
+
* @ignore
|
|
4108
|
+
*/
|
|
4109
|
+
expected_bitrate_bps;
|
|
3130
4110
|
}
|
|
3131
4111
|
exports.PeerDownlinkInfo = PeerDownlinkInfo;
|
|
3132
4112
|
/**
|
|
3133
4113
|
* @ignore
|
|
3134
4114
|
*/
|
|
3135
4115
|
class DownlinkNetworkInfo {
|
|
4116
|
+
/**
|
|
4117
|
+
* @ignore
|
|
4118
|
+
*/
|
|
4119
|
+
lastmile_buffer_delay_time_ms;
|
|
4120
|
+
/**
|
|
4121
|
+
* @ignore
|
|
4122
|
+
*/
|
|
4123
|
+
bandwidth_estimation_bps;
|
|
4124
|
+
/**
|
|
4125
|
+
* @ignore
|
|
4126
|
+
*/
|
|
4127
|
+
total_downscale_level_count;
|
|
4128
|
+
/**
|
|
4129
|
+
* @ignore
|
|
4130
|
+
*/
|
|
4131
|
+
peer_downlink_info;
|
|
4132
|
+
/**
|
|
4133
|
+
* @ignore
|
|
4134
|
+
*/
|
|
4135
|
+
total_received_video_count;
|
|
3136
4136
|
}
|
|
3137
4137
|
exports.DownlinkNetworkInfo = DownlinkNetworkInfo;
|
|
3138
4138
|
/**
|
|
@@ -3182,6 +4182,18 @@ var EncryptionMode;
|
|
|
3182
4182
|
* Built-in encryption configurations.
|
|
3183
4183
|
*/
|
|
3184
4184
|
class EncryptionConfig {
|
|
4185
|
+
/**
|
|
4186
|
+
* The built-in encryption mode. See EncryptionMode . Agora recommends using Aes128Gcm2 or Aes256Gcm2 encrypted mode. These two modes support the use of salt for higher security.
|
|
4187
|
+
*/
|
|
4188
|
+
encryptionMode;
|
|
4189
|
+
/**
|
|
4190
|
+
* Encryption key in string type with unlimited length. Agora recommends using a 32-byte key.If you do not set an encryption key or set it as NULL, you cannot use the built-in encryption, and the SDK returns -2.
|
|
4191
|
+
*/
|
|
4192
|
+
encryptionKey;
|
|
4193
|
+
/**
|
|
4194
|
+
* Salt, 32 bytes in length. Agora recommends that you use OpenSSL to generate salt on the server side. See Media Stream Encryption for details. This parameter takes effect only in Aes128Gcm2 or Aes256Gcm2 encrypted mode. In this case, ensure that this parameter is not 0.
|
|
4195
|
+
*/
|
|
4196
|
+
encryptionKdfSalt;
|
|
3185
4197
|
}
|
|
3186
4198
|
exports.EncryptionConfig = EncryptionConfig;
|
|
3187
4199
|
/**
|
|
@@ -3296,12 +4308,44 @@ var StreamPublishState;
|
|
|
3296
4308
|
* The configuration of the audio and video call loop test.
|
|
3297
4309
|
*/
|
|
3298
4310
|
class EchoTestConfiguration {
|
|
4311
|
+
/**
|
|
4312
|
+
* The view used to render the local user's video. This parameter is only applicable to scenarios testing video devices, that is, when enableVideo is true.
|
|
4313
|
+
*/
|
|
4314
|
+
view;
|
|
4315
|
+
/**
|
|
4316
|
+
* Whether to enable the audio device for the loop test:true: (Default) Enable the audio device. To test the audio device, set this parameter as true.false: Disable the audio device.
|
|
4317
|
+
*/
|
|
4318
|
+
enableAudio;
|
|
4319
|
+
/**
|
|
4320
|
+
* Whether to enable the video device for the loop test:true: (Default) Enable the video device. To test the video device, set this parameter as true.false: Disable the video device.
|
|
4321
|
+
*/
|
|
4322
|
+
enableVideo;
|
|
4323
|
+
/**
|
|
4324
|
+
* @ignore
|
|
4325
|
+
*/
|
|
4326
|
+
token;
|
|
4327
|
+
/**
|
|
4328
|
+
* The channel name that identifies each audio and video call loop. To ensure proper loop test functionality, the channel name passed in to identify each loop test cannot be the same when users of the same project (App ID) perform audio and video call loop tests on different devices.
|
|
4329
|
+
*/
|
|
4330
|
+
channelId;
|
|
4331
|
+
/**
|
|
4332
|
+
* @ignore
|
|
4333
|
+
*/
|
|
4334
|
+
intervalInSeconds;
|
|
3299
4335
|
}
|
|
3300
4336
|
exports.EchoTestConfiguration = EchoTestConfiguration;
|
|
3301
4337
|
/**
|
|
3302
4338
|
* The information of the user.
|
|
3303
4339
|
*/
|
|
3304
4340
|
class UserInfo {
|
|
4341
|
+
/**
|
|
4342
|
+
* The user ID.
|
|
4343
|
+
*/
|
|
4344
|
+
uid;
|
|
4345
|
+
/**
|
|
4346
|
+
* User account. The maximum data length is MaxUserAccountLengthType .
|
|
4347
|
+
*/
|
|
4348
|
+
userAccount;
|
|
3305
4349
|
}
|
|
3306
4350
|
exports.UserInfo = UserInfo;
|
|
3307
4351
|
/**
|
|
@@ -3356,6 +4400,22 @@ var ThreadPriorityType;
|
|
|
3356
4400
|
* The video configuration for the shared screen stream.
|
|
3357
4401
|
*/
|
|
3358
4402
|
class ScreenVideoParameters {
|
|
4403
|
+
/**
|
|
4404
|
+
* The video encoding dimension. The default value is 1280 × 720.
|
|
4405
|
+
*/
|
|
4406
|
+
dimensions;
|
|
4407
|
+
/**
|
|
4408
|
+
* The video encoding frame rate (fps). The default value is 15.
|
|
4409
|
+
*/
|
|
4410
|
+
frameRate;
|
|
4411
|
+
/**
|
|
4412
|
+
* The video encoding bitrate (Kbps).
|
|
4413
|
+
*/
|
|
4414
|
+
bitrate;
|
|
4415
|
+
/**
|
|
4416
|
+
* The content hint for screen sharing.
|
|
4417
|
+
*/
|
|
4418
|
+
contentHint;
|
|
3359
4419
|
}
|
|
3360
4420
|
exports.ScreenVideoParameters = ScreenVideoParameters;
|
|
3361
4421
|
/**
|
|
@@ -3363,12 +4423,40 @@ exports.ScreenVideoParameters = ScreenVideoParameters;
|
|
|
3363
4423
|
* Only available where captureAudio is true.
|
|
3364
4424
|
*/
|
|
3365
4425
|
class ScreenAudioParameters {
|
|
4426
|
+
/**
|
|
4427
|
+
* Audio sample rate (Hz). The default value is 16000.
|
|
4428
|
+
*/
|
|
4429
|
+
sampleRate;
|
|
4430
|
+
/**
|
|
4431
|
+
* The number of audio channels. The default value is 2, which means stereo.
|
|
4432
|
+
*/
|
|
4433
|
+
channels;
|
|
4434
|
+
/**
|
|
4435
|
+
* The volume of the captured system audio. The value range is [0, 100]. The default value is 100.
|
|
4436
|
+
*/
|
|
4437
|
+
captureSignalVolume;
|
|
3366
4438
|
}
|
|
3367
4439
|
exports.ScreenAudioParameters = ScreenAudioParameters;
|
|
3368
4440
|
/**
|
|
3369
4441
|
* @ignore
|
|
3370
4442
|
*/
|
|
3371
4443
|
class ScreenCaptureParameters2 {
|
|
4444
|
+
/**
|
|
4445
|
+
* @ignore
|
|
4446
|
+
*/
|
|
4447
|
+
captureAudio;
|
|
4448
|
+
/**
|
|
4449
|
+
* @ignore
|
|
4450
|
+
*/
|
|
4451
|
+
audioParams;
|
|
4452
|
+
/**
|
|
4453
|
+
* @ignore
|
|
4454
|
+
*/
|
|
4455
|
+
captureVideo;
|
|
4456
|
+
/**
|
|
4457
|
+
* @ignore
|
|
4458
|
+
*/
|
|
4459
|
+
videoParams;
|
|
3372
4460
|
}
|
|
3373
4461
|
exports.ScreenCaptureParameters2 = ScreenCaptureParameters2;
|
|
3374
4462
|
/**
|
|
@@ -3389,6 +4477,34 @@ var MediaTraceEvent;
|
|
|
3389
4477
|
* @ignore
|
|
3390
4478
|
*/
|
|
3391
4479
|
class VideoRenderingTracingInfo {
|
|
4480
|
+
/**
|
|
4481
|
+
* @ignore
|
|
4482
|
+
*/
|
|
4483
|
+
elapsedTime;
|
|
4484
|
+
/**
|
|
4485
|
+
* @ignore
|
|
4486
|
+
*/
|
|
4487
|
+
start2JoinChannel;
|
|
4488
|
+
/**
|
|
4489
|
+
* @ignore
|
|
4490
|
+
*/
|
|
4491
|
+
join2JoinSuccess;
|
|
4492
|
+
/**
|
|
4493
|
+
* @ignore
|
|
4494
|
+
*/
|
|
4495
|
+
joinSuccess2RemoteJoined;
|
|
4496
|
+
/**
|
|
4497
|
+
* @ignore
|
|
4498
|
+
*/
|
|
4499
|
+
remoteJoined2SetView;
|
|
4500
|
+
/**
|
|
4501
|
+
* @ignore
|
|
4502
|
+
*/
|
|
4503
|
+
remoteJoined2UnmuteVideo;
|
|
4504
|
+
/**
|
|
4505
|
+
* @ignore
|
|
4506
|
+
*/
|
|
4507
|
+
remoteJoined2PacketReceived;
|
|
3392
4508
|
}
|
|
3393
4509
|
exports.VideoRenderingTracingInfo = VideoRenderingTracingInfo;
|
|
3394
4510
|
/**
|
|
@@ -3409,5 +4525,37 @@ var ConfigFetchType;
|
|
|
3409
4525
|
* The spatial audio parameters.
|
|
3410
4526
|
*/
|
|
3411
4527
|
class SpatialAudioParams {
|
|
4528
|
+
/**
|
|
4529
|
+
* The azimuth angle of the remote user or media player relative to the local user. The value range is [0,360], and the unit is degrees, The values are as follows:0: (Default) 0 degrees, which means directly in front on the horizontal plane.90: 90 degrees, which means directly to the left on the horizontal plane.180: 180 degrees, which means directly behind on the horizontal plane.270: 270 degrees, which means directly to the right on the horizontal plane.360: 360 degrees, which means directly in front on the horizontal plane.
|
|
4530
|
+
*/
|
|
4531
|
+
speaker_azimuth;
|
|
4532
|
+
/**
|
|
4533
|
+
* The elevation angle of the remote user or media player relative to the local user. The value range is [-90,90], and the unit is degrees, The values are as follows:0: (Default) 0 degrees, which means that the horizontal plane is not rotated.-90: -90 degrees, which means that the horizontal plane is rotated 90 degrees downwards.90: 90 degrees, which means that the horizontal plane is rotated 90 degrees upwards.
|
|
4534
|
+
*/
|
|
4535
|
+
speaker_elevation;
|
|
4536
|
+
/**
|
|
4537
|
+
* The distance of the remote user or media player relative to the local user. The value range is [1,50], and the unit is meters. The default value is 1 meter.
|
|
4538
|
+
*/
|
|
4539
|
+
speaker_distance;
|
|
4540
|
+
/**
|
|
4541
|
+
* The orientation of the remote user or media player relative to the local user. The value range is [0,180], and the unit is degrees, The values are as follows:0: (Default) 0 degrees, which means that the sound source and listener face the same direction.180: 180 degrees, which means that the sound source and listener face each other.
|
|
4542
|
+
*/
|
|
4543
|
+
speaker_orientation;
|
|
4544
|
+
/**
|
|
4545
|
+
* Whether to enable audio blurring:true: Enable audio blurring.false: (Default) Disable audio blurring.
|
|
4546
|
+
*/
|
|
4547
|
+
enable_blur;
|
|
4548
|
+
/**
|
|
4549
|
+
* Whether to enable air absorption, that is, to simulate the sound attenuation effect of sound transmitting in the air; under a certain transmission distance, the attenuation speed of high-frequency sound is fast, and the attenuation speed of low-frequency sound is slow.true: (Default) Enable air absorption. Make sure that the value of speaker_attenuation is not 0; otherwise, this setting does not take effect.false: Disable air absorption.
|
|
4550
|
+
*/
|
|
4551
|
+
enable_air_absorb;
|
|
4552
|
+
/**
|
|
4553
|
+
* The sound attenuation coefficient of the remote user or media player. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, where the volume and timbre only have a weak attenuation during the propagation, and the sound can travel farther than that in a real environment. enable_air_absorb needs to be enabled at the same time. 0.5: (Default) Simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.(0.5,1]: Strong attenuation mode, where volume and timbre attenuate rapidly during the propagation. enable_air_absorb needs to be enabled at the same time.
|
|
4554
|
+
*/
|
|
4555
|
+
speaker_attenuation;
|
|
4556
|
+
/**
|
|
4557
|
+
* Whether to enable the Doppler effect: When there is a relative displacement between the sound source and the receiver of the sound source, the tone heard by the receiver changes.true: Enable the Doppler effect.false: (Default) Disable the Doppler effect.This parameter is suitable for scenarios where the sound source is moving at high speed (for example, racing games). It is not recommended for common audio and video interactive scenarios (for example, voice chat, cohosting, or online KTV).When this parameter is enabled, Agora recommends that you set a regular period (such as 30 ms), and then call the updatePlayerPositionInfo , updateSelfPosition , and updateRemotePosition methods to continuously update the relative distance between the sound source and the receiver. The following factors can cause the Doppler effect to be unpredictable or the sound to be jittery: the period of updating the distance is too long, the updating period is irregular, or the distance information is lost due to network packet loss or delay.
|
|
4558
|
+
*/
|
|
4559
|
+
enable_doppler;
|
|
3412
4560
|
}
|
|
3413
4561
|
exports.SpatialAudioParams = SpatialAudioParams;
|