agora-electron-sdk 4.2.1 → 4.2.2-dev.6
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 +15 -0
- package/js/AgoraSdk.js +3 -1
- package/js/Private/AgoraBase.js +215 -61
- package/js/Private/AgoraMediaBase.js +13 -9
- package/js/Private/IAgoraRtcEngine.js +19 -56
- package/js/Private/IAgoraRtcEngineEx.js +2 -1
- package/js/Private/IAgoraSpatialAudio.js +3 -1
- package/js/Private/impl/IAgoraMediaEngineImpl.js +12 -6
- package/js/Private/impl/IAgoraMusicContentCenterImpl.js +55 -16
- package/js/Private/impl/IAgoraRtcEngineImpl.js +105 -14
- package/js/Private/internal/MusicContentCenterInternal.js +3 -0
- package/js/Private/internal/RtcEngineExInternal.js +26 -6
- package/js/Private/ti/AgoraMediaBase-ti.js +13 -13
- package/js/Private/ti/IAgoraMusicContentCenter-ti.js +3 -2
- package/js/Private/ti/IAgoraRtcEngine-ti.js +2 -2
- package/js/Renderer/WebGLRenderer/index.js +19 -19
- package/js/Renderer/YUVCanvasRenderer/index.js +1 -1
- package/package.json +3 -3
- package/scripts/zipBuild.js +3 -1
- package/ts/AgoraSdk.ts +3 -1
- package/ts/Private/AgoraBase.ts +473 -185
- package/ts/Private/AgoraMediaBase.ts +104 -71
- package/ts/Private/AgoraMediaPlayerTypes.ts +10 -7
- package/ts/Private/IAgoraLog.ts +7 -3
- package/ts/Private/IAgoraMediaEngine.ts +88 -43
- package/ts/Private/IAgoraMediaPlayer.ts +173 -80
- package/ts/Private/IAgoraMediaPlayerSource.ts +17 -8
- package/ts/Private/IAgoraMusicContentCenter.ts +25 -4
- package/ts/Private/IAgoraRtcEngine.ts +1846 -854
- package/ts/Private/IAgoraRtcEngineEx.ts +311 -152
- package/ts/Private/IAgoraSpatialAudio.ts +97 -39
- package/ts/Private/IAudioDeviceManager.ts +75 -31
- package/ts/Private/impl/IAgoraMediaEngineImpl.ts +12 -6
- package/ts/Private/impl/IAgoraMusicContentCenterImpl.ts +72 -21
- package/ts/Private/impl/IAgoraRtcEngineImpl.ts +134 -15
- package/ts/Private/internal/MusicContentCenterInternal.ts +4 -0
- package/ts/Private/internal/RtcEngineExInternal.ts +43 -13
- package/ts/Private/ti/AgoraMediaBase-ti.ts +13 -13
- package/ts/Private/ti/IAgoraMusicContentCenter-ti.ts +3 -2
- package/ts/Private/ti/IAgoraRtcEngine-ti.ts +2 -2
- package/ts/Renderer/WebGLRenderer/index.ts +26 -21
- package/ts/Renderer/YUVCanvasRenderer/index.ts +1 -1
- package/types/AgoraSdk.d.ts +3 -1
- package/types/AgoraSdk.d.ts.map +1 -1
- package/types/Private/AgoraBase.d.ts +467 -185
- package/types/Private/AgoraBase.d.ts.map +1 -1
- package/types/Private/AgoraMediaBase.d.ts +104 -68
- package/types/Private/AgoraMediaBase.d.ts.map +1 -1
- package/types/Private/AgoraMediaPlayerTypes.d.ts +10 -7
- package/types/Private/AgoraMediaPlayerTypes.d.ts.map +1 -1
- package/types/Private/IAgoraLog.d.ts +7 -3
- package/types/Private/IAgoraLog.d.ts.map +1 -1
- package/types/Private/IAgoraMediaEngine.d.ts +88 -43
- package/types/Private/IAgoraMediaEngine.d.ts.map +1 -1
- package/types/Private/IAgoraMediaPlayer.d.ts +173 -80
- package/types/Private/IAgoraMediaPlayer.d.ts.map +1 -1
- package/types/Private/IAgoraMediaPlayerSource.d.ts +17 -8
- package/types/Private/IAgoraMediaPlayerSource.d.ts.map +1 -1
- package/types/Private/IAgoraMusicContentCenter.d.ts +17 -5
- package/types/Private/IAgoraMusicContentCenter.d.ts.map +1 -1
- package/types/Private/IAgoraRtcEngine.d.ts +1832 -851
- package/types/Private/IAgoraRtcEngine.d.ts.map +1 -1
- package/types/Private/IAgoraRtcEngineEx.d.ts +311 -152
- package/types/Private/IAgoraRtcEngineEx.d.ts.map +1 -1
- package/types/Private/IAgoraSpatialAudio.d.ts +97 -39
- package/types/Private/IAgoraSpatialAudio.d.ts.map +1 -1
- package/types/Private/IAudioDeviceManager.d.ts +75 -31
- package/types/Private/IAudioDeviceManager.d.ts.map +1 -1
- package/types/Private/impl/IAgoraMediaEngineImpl.d.ts +2 -2
- package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -1
- package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts +9 -5
- package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -1
- package/types/Private/impl/IAgoraRtcEngineImpl.d.ts +16 -4
- package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -1
- package/types/Private/internal/MusicContentCenterInternal.d.ts +1 -0
- package/types/Private/internal/MusicContentCenterInternal.d.ts.map +1 -1
- package/types/Private/internal/RtcEngineExInternal.d.ts +1 -0
- package/types/Private/internal/RtcEngineExInternal.d.ts.map +1 -1
- package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -1
- package/types/Renderer/WebGLRenderer/index.d.ts +1 -1
- package/types/Renderer/WebGLRenderer/index.d.ts.map +1 -1
package/js/Private/AgoraBase.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.
|
|
5
|
-
exports.
|
|
6
|
-
exports.SpatialAudioParams = exports.RecorderStreamInfo = exports.ConfigFetchType = exports.VideoRenderingTracingInfo = exports.MediaTraceEvent = exports.ScreenCaptureParameters2 = exports.ScreenAudioParameters = void 0;
|
|
3
|
+
exports.AudienceLatencyLevelType = exports.QualityAdaptIndication = exports.ClientRoleType = exports.RtcStats = exports.WatermarkOptions = exports.WatermarkRatio = exports.Rectangle = exports.SimulcastStreamConfig = exports.SimulcastStreamMode = exports.DataStreamConfig = exports.VideoEncoderConfiguration = exports.CodecCapInfo = exports.CodecCapLevels = exports.CodecCapMask = exports.VideoMirrorModeType = exports.AdvanceOptions = exports.EncodingPreference = exports.CompressionPreference = exports.EncodedVideoFrameInfo = exports.VideoSubscriptionOptions = exports.VideoStreamType = exports.H264PacketizeMode = exports.AudioPcmDataInfo = exports.EncodedAudioFrameInfo = exports.EncodedAudioFrameAdvancedSettings = exports.WatermarkFitMode = exports.AudioEncodingType = exports.AudioCodecType = exports.SenderOptions = exports.TCcMode = 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.WlAccStats = exports.WlaccSuggestAction = exports.WlaccMessageReason = exports.ClientRoleChangeFailedReason = exports.ConnectionChangedReasonType = exports.LastmileProbeResult = exports.LastmileProbeOneWayResult = exports.LastmileProbeResultState = exports.LastmileProbeConfig = exports.VideoTranscoderError = exports.LocalTranscoderConfiguration = exports.TranscodingVideoStream = exports.LiveTranscoding = exports.TranscodingUser = exports.ConnectionStateType = exports.LiveStreamAdvancedFeature = exports.RtcImage = exports.RtmpStreamingEvent = exports.RtmpStreamPublishErrorType = 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.LocalVideoStreamError = exports.LocalVideoStreamState = exports.LocalAudioStreamError = exports.LocalAudioStreamState = exports.CaptureBrightnessLevelType = exports.VideoApplicationScenarioType = exports.ScreenScenarioType = exports.VideoContentHint = exports.VideoFormat = exports.AudioScenarioType = exports.AudioProfileType = exports.AudioAinsMode = exports.ExperiencePoorReason = exports.ExperienceQualityType = exports.ClientRoleOptions = void 0;
|
|
5
|
+
exports.EarMonitoringFilterType = exports.UserInfo = exports.EchoTestConfiguration = exports.StreamPublishState = exports.StreamSubscribeState = exports.MaxUserAccountLengthType = exports.PermissionType = exports.UploadErrorReason = exports.EncryptionErrorType = exports.EncryptionConfig = exports.EncryptionMode = exports.DownlinkNetworkInfo = exports.PeerDownlinkInfo = exports.UplinkNetworkInfo = exports.ChannelMediaRelayConfiguration = exports.ChannelMediaInfo = exports.ChannelMediaRelayState = exports.ChannelMediaRelayEvent = exports.ChannelMediaRelayError = exports.AreaCodeEx = exports.AreaCode = exports.AudioEncodedFrameObserverConfig = exports.AudioRecordingConfiguration = exports.AudioEncodedFrameObserverPosition = exports.AudioFileRecordingType = exports.AudioRecordingQualityType = exports.ScreenCaptureParameters = 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.BeautyOptions = exports.LighteningContrastLevel = exports.VideoCanvas = exports.VideoViewSetupMode = exports.NetworkType = void 0;
|
|
6
|
+
exports.SpatialAudioParams = exports.LocalAccessPointConfiguration = exports.AdvancedConfigInfo = exports.LogUploadServerInfo = exports.LocalProxyMode = exports.RecorderStreamInfo = exports.ConfigFetchType = exports.VideoRenderingTracingInfo = exports.MediaTraceEvent = exports.ScreenCaptureParameters2 = exports.ScreenAudioParameters = exports.ScreenVideoParameters = exports.ThreadPriorityType = void 0;
|
|
7
7
|
require("./extension/AgoraBaseExtension");
|
|
8
8
|
/**
|
|
9
9
|
* The channel profile.
|
|
@@ -163,6 +163,7 @@ var WarnCodeType;
|
|
|
163
163
|
})(WarnCodeType = exports.WarnCodeType || (exports.WarnCodeType = {}));
|
|
164
164
|
/**
|
|
165
165
|
* Error codes.
|
|
166
|
+
*
|
|
166
167
|
* An error code indicates that the SDK encountered an unrecoverable error that requires application intervention. For example, an error is returned when the camera fails to open, and the app needs to inform the user that the camera cannot be used.
|
|
167
168
|
*/
|
|
168
169
|
var ErrorCodeType;
|
|
@@ -180,15 +181,24 @@ var ErrorCodeType;
|
|
|
180
181
|
*/
|
|
181
182
|
ErrorCodeType[ErrorCodeType["ErrInvalidArgument"] = 2] = "ErrInvalidArgument";
|
|
182
183
|
/**
|
|
183
|
-
* 3: The SDK is not ready. Possible reasons include the following:
|
|
184
|
+
* 3: The SDK is not ready. Possible reasons include the following:
|
|
185
|
+
* The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
|
|
186
|
+
* No user has joined the channel when the method is called. Check the code logic.
|
|
187
|
+
* The user has not left the channel when the rate or complain method is called. Check the code logic.
|
|
188
|
+
* The audio module is disabled.
|
|
189
|
+
* The program is not complete.
|
|
184
190
|
*/
|
|
185
191
|
ErrorCodeType[ErrorCodeType["ErrNotReady"] = 3] = "ErrNotReady";
|
|
186
192
|
/**
|
|
187
|
-
* 4: The IRtcEngine does not support the request. Possible reasons include the following:
|
|
193
|
+
* 4: The IRtcEngine does not support the request. Possible reasons include the following:
|
|
194
|
+
* The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.
|
|
188
195
|
*/
|
|
189
196
|
ErrorCodeType[ErrorCodeType["ErrNotSupported"] = 4] = "ErrNotSupported";
|
|
190
197
|
/**
|
|
191
|
-
* 5: The request is rejected. Possible reasons include the following:
|
|
198
|
+
* 5: The request is rejected. Possible reasons include the following:
|
|
199
|
+
* The IRtcEngine initialization fails. Reinitialize the IRtcEngine.
|
|
200
|
+
* The channel name is set as the empty string "" when joining the channel. Reset the channel name.
|
|
201
|
+
* When the joinChannelEx method is called to join multiple channels, the specified channel name is already in use. Reset the channel name.
|
|
192
202
|
*/
|
|
193
203
|
ErrorCodeType[ErrorCodeType["ErrRefused"] = 5] = "ErrRefused";
|
|
194
204
|
/**
|
|
@@ -228,11 +238,15 @@ var ErrorCodeType;
|
|
|
228
238
|
*/
|
|
229
239
|
ErrorCodeType[ErrorCodeType["ErrNetDown"] = 14] = "ErrNetDown";
|
|
230
240
|
/**
|
|
231
|
-
* 17: The request to join the channel is rejected. Possible reasons include the following:
|
|
241
|
+
* 17: The request to join the channel is rejected. Possible reasons include the following:
|
|
242
|
+
* The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
|
|
243
|
+
* After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
|
|
232
244
|
*/
|
|
233
245
|
ErrorCodeType[ErrorCodeType["ErrJoinChannelRejected"] = 17] = "ErrJoinChannelRejected";
|
|
234
246
|
/**
|
|
235
|
-
* 18: Fails to leave the channel. Possible reasons include the following:
|
|
247
|
+
* 18: Fails to leave the channel. Possible reasons include the following:
|
|
248
|
+
* The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error.
|
|
249
|
+
* The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.
|
|
236
250
|
*/
|
|
237
251
|
ErrorCodeType[ErrorCodeType["ErrLeaveChannelRejected"] = 18] = "ErrLeaveChannelRejected";
|
|
238
252
|
/**
|
|
@@ -264,11 +278,13 @@ var ErrorCodeType;
|
|
|
264
278
|
*/
|
|
265
279
|
ErrorCodeType[ErrorCodeType["ErrNoServerResources"] = 103] = "ErrNoServerResources";
|
|
266
280
|
/**
|
|
267
|
-
* 109: The current token has expired. Apply for a new token on the server and call renewToken
|
|
281
|
+
* 109: The current token has expired. Apply for a new token on the server and call renewToken. Deprecated: This enumerator is deprecated. Use ConnectionChangedTokenExpired (9) in the onConnectionStateChanged callback instead.
|
|
268
282
|
*/
|
|
269
283
|
ErrorCodeType[ErrorCodeType["ErrTokenExpired"] = 109] = "ErrTokenExpired";
|
|
270
284
|
/**
|
|
271
|
-
* 110: Invalid token. Typical reasons include the following:
|
|
285
|
+
* 110: Invalid token. Typical reasons include the following:
|
|
286
|
+
* App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication.
|
|
287
|
+
* The uid used to generate the token is not the same as the uid used to join the channel. Deprecated: This enumerator is deprecated. Use ConnectionChangedInvalidToken (8) in the onConnectionStateChanged callback instead.
|
|
272
288
|
*/
|
|
273
289
|
ErrorCodeType[ErrorCodeType["ErrInvalidToken"] = 110] = "ErrInvalidToken";
|
|
274
290
|
/**
|
|
@@ -494,7 +510,7 @@ var UserOfflineReasonType;
|
|
|
494
510
|
*/
|
|
495
511
|
UserOfflineReasonType[UserOfflineReasonType["UserOfflineQuit"] = 0] = "UserOfflineQuit";
|
|
496
512
|
/**
|
|
497
|
-
* 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time.If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
|
|
513
|
+
* 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline.
|
|
498
514
|
*/
|
|
499
515
|
UserOfflineReasonType[UserOfflineReasonType["UserOfflineDropped"] = 1] = "UserOfflineDropped";
|
|
500
516
|
/**
|
|
@@ -536,7 +552,7 @@ var InterfaceIdType;
|
|
|
536
552
|
*/
|
|
537
553
|
InterfaceIdType[InterfaceIdType["AgoraIidRtcConnection"] = 7] = "AgoraIidRtcConnection";
|
|
538
554
|
/**
|
|
539
|
-
*
|
|
555
|
+
* @ignore
|
|
540
556
|
*/
|
|
541
557
|
InterfaceIdType[InterfaceIdType["AgoraIidSignalingEngine"] = 8] = "AgoraIidSignalingEngine";
|
|
542
558
|
/**
|
|
@@ -736,7 +752,9 @@ var VideoFrameType;
|
|
|
736
752
|
var OrientationMode;
|
|
737
753
|
(function (OrientationMode) {
|
|
738
754
|
/**
|
|
739
|
-
* 0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver.
|
|
755
|
+
* 0: (Default) The output video always follows the orientation of the captured video. The receiver takes the rotational information passed on from the video encoder. This mode applies to scenarios where video orientation can be adjusted on the receiver.
|
|
756
|
+
* If the captured video is in landscape mode, the output video is in landscape mode.
|
|
757
|
+
* If the captured video is in portrait mode, the output video is in portrait mode.
|
|
740
758
|
*/
|
|
741
759
|
OrientationMode[OrientationMode["OrientationModeAdaptive"] = 0] = "OrientationModeAdaptive";
|
|
742
760
|
/**
|
|
@@ -762,7 +780,7 @@ var DegradationPreference;
|
|
|
762
780
|
*/
|
|
763
781
|
DegradationPreference[DegradationPreference["MaintainFramerate"] = 1] = "MaintainFramerate";
|
|
764
782
|
/**
|
|
765
|
-
* 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The MaintainBalanced has a lower reduction than MaintainQuality and MaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority.The resolution of the video sent may change, so remote users need to handle this issue. See onVideoSizeChanged
|
|
783
|
+
* 2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth. The MaintainBalanced has a lower reduction than MaintainQuality and MaintainFramerate, and this preference is suitable for scenarios where both smoothness and video quality are a priority. The resolution of the video sent may change, so remote users need to handle this issue. See onVideoSizeChanged.
|
|
766
784
|
*/
|
|
767
785
|
DegradationPreference[DegradationPreference["MaintainBalanced"] = 2] = "MaintainBalanced";
|
|
768
786
|
/**
|
|
@@ -801,6 +819,32 @@ var ScreenCaptureFramerateCapability;
|
|
|
801
819
|
*/
|
|
802
820
|
ScreenCaptureFramerateCapability[ScreenCaptureFramerateCapability["ScreenCaptureFramerateCapability60Fps"] = 2] = "ScreenCaptureFramerateCapability60Fps";
|
|
803
821
|
})(ScreenCaptureFramerateCapability = exports.ScreenCaptureFramerateCapability || (exports.ScreenCaptureFramerateCapability = {}));
|
|
822
|
+
/**
|
|
823
|
+
* @ignore
|
|
824
|
+
*/
|
|
825
|
+
var VideoCodecCapabilityLevel;
|
|
826
|
+
(function (VideoCodecCapabilityLevel) {
|
|
827
|
+
/**
|
|
828
|
+
* @ignore
|
|
829
|
+
*/
|
|
830
|
+
VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevelUnspecified"] = -1] = "CodecCapabilityLevelUnspecified";
|
|
831
|
+
/**
|
|
832
|
+
* @ignore
|
|
833
|
+
*/
|
|
834
|
+
VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevelBasicSupport"] = 5] = "CodecCapabilityLevelBasicSupport";
|
|
835
|
+
/**
|
|
836
|
+
* @ignore
|
|
837
|
+
*/
|
|
838
|
+
VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevel1080p30fps"] = 10] = "CodecCapabilityLevel1080p30fps";
|
|
839
|
+
/**
|
|
840
|
+
* @ignore
|
|
841
|
+
*/
|
|
842
|
+
VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevel1080p60fps"] = 20] = "CodecCapabilityLevel1080p60fps";
|
|
843
|
+
/**
|
|
844
|
+
* @ignore
|
|
845
|
+
*/
|
|
846
|
+
VideoCodecCapabilityLevel[VideoCodecCapabilityLevel["CodecCapabilityLevel4k60fps"] = 30] = "CodecCapabilityLevel4k60fps";
|
|
847
|
+
})(VideoCodecCapabilityLevel = exports.VideoCodecCapabilityLevel || (exports.VideoCodecCapabilityLevel = {}));
|
|
804
848
|
/**
|
|
805
849
|
* Video codec types.
|
|
806
850
|
*/
|
|
@@ -823,7 +867,7 @@ var VideoCodecType;
|
|
|
823
867
|
*/
|
|
824
868
|
VideoCodecType[VideoCodecType["VideoCodecH265"] = 3] = "VideoCodecH265";
|
|
825
869
|
/**
|
|
826
|
-
* 6: Generic.This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
|
|
870
|
+
* 6: Generic. This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.
|
|
827
871
|
*/
|
|
828
872
|
VideoCodecType[VideoCodecType["VideoCodecGeneric"] = 6] = "VideoCodecGeneric";
|
|
829
873
|
/**
|
|
@@ -839,7 +883,7 @@ var VideoCodecType;
|
|
|
839
883
|
*/
|
|
840
884
|
VideoCodecType[VideoCodecType["VideoCodecVp9"] = 13] = "VideoCodecVp9";
|
|
841
885
|
/**
|
|
842
|
-
* 20: Generic JPEG.This type consumes minimum computing resources and applies to IoT devices.
|
|
886
|
+
* 20: Generic JPEG. This type consumes minimum computing resources and applies to IoT devices.
|
|
843
887
|
*/
|
|
844
888
|
VideoCodecType[VideoCodecType["VideoCodecGenericJpeg"] = 20] = "VideoCodecGenericJpeg";
|
|
845
889
|
})(VideoCodecType = exports.VideoCodecType || (exports.VideoCodecType = {}));
|
|
@@ -964,11 +1008,11 @@ var AudioEncodingType;
|
|
|
964
1008
|
var WatermarkFitMode;
|
|
965
1009
|
(function (WatermarkFitMode) {
|
|
966
1010
|
/**
|
|
967
|
-
* Use the positionInLandscapeMode and positionInPortraitMode values you set in WatermarkOptions
|
|
1011
|
+
* Use the positionInLandscapeMode and positionInPortraitMode values you set in WatermarkOptions. The settings in WatermarkRatio are invalid.
|
|
968
1012
|
*/
|
|
969
1013
|
WatermarkFitMode[WatermarkFitMode["FitModeCoverPosition"] = 0] = "FitModeCoverPosition";
|
|
970
1014
|
/**
|
|
971
|
-
* Use the value you set in WatermarkRatio
|
|
1015
|
+
* Use the value you set in WatermarkRatio. The settings in positionInLandscapeMode and positionInPortraitMode in WatermarkOptions are invalid.
|
|
972
1016
|
*/
|
|
973
1017
|
WatermarkFitMode[WatermarkFitMode["FitModeUseImageRatio"] = 1] = "FitModeUseImageRatio";
|
|
974
1018
|
})(WatermarkFitMode = exports.WatermarkFitMode || (exports.WatermarkFitMode = {}));
|
|
@@ -1092,7 +1136,9 @@ exports.AdvanceOptions = AdvanceOptions;
|
|
|
1092
1136
|
var VideoMirrorModeType;
|
|
1093
1137
|
(function (VideoMirrorModeType) {
|
|
1094
1138
|
/**
|
|
1095
|
-
* 0: The SDK determines the mirror mode.
|
|
1139
|
+
* 0: The SDK determines the mirror mode.
|
|
1140
|
+
* 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.
|
|
1141
|
+
* For the remote user: The mirror mode is disabled by default.
|
|
1096
1142
|
*/
|
|
1097
1143
|
VideoMirrorModeType[VideoMirrorModeType["VideoMirrorModeAuto"] = 0] = "VideoMirrorModeAuto";
|
|
1098
1144
|
/**
|
|
@@ -1130,6 +1176,15 @@ var CodecCapMask;
|
|
|
1130
1176
|
*/
|
|
1131
1177
|
CodecCapMask[CodecCapMask["CodecCapMaskSwEnc"] = 8] = "CodecCapMaskSwEnc";
|
|
1132
1178
|
})(CodecCapMask = exports.CodecCapMask || (exports.CodecCapMask = {}));
|
|
1179
|
+
/**
|
|
1180
|
+
* The level of the codec capability.
|
|
1181
|
+
*/
|
|
1182
|
+
var CodecCapLevels = /** @class */ (function () {
|
|
1183
|
+
function CodecCapLevels() {
|
|
1184
|
+
}
|
|
1185
|
+
return CodecCapLevels;
|
|
1186
|
+
}());
|
|
1187
|
+
exports.CodecCapLevels = CodecCapLevels;
|
|
1133
1188
|
/**
|
|
1134
1189
|
* The codec capability of the device.
|
|
1135
1190
|
*/
|
|
@@ -1150,6 +1205,7 @@ var VideoEncoderConfiguration = /** @class */ (function () {
|
|
|
1150
1205
|
exports.VideoEncoderConfiguration = VideoEncoderConfiguration;
|
|
1151
1206
|
/**
|
|
1152
1207
|
* The configurations for the data stream.
|
|
1208
|
+
*
|
|
1153
1209
|
* The following table shows the SDK behaviors under different parameter settings:
|
|
1154
1210
|
*/
|
|
1155
1211
|
var DataStreamConfig = /** @class */ (function () {
|
|
@@ -1196,7 +1252,10 @@ var Rectangle = /** @class */ (function () {
|
|
|
1196
1252
|
exports.Rectangle = Rectangle;
|
|
1197
1253
|
/**
|
|
1198
1254
|
* The position and size of the watermark on the screen.
|
|
1199
|
-
*
|
|
1255
|
+
*
|
|
1256
|
+
* The position and size of the watermark on the screen are determined by xRatio, yRatio, and widthRatio :
|
|
1257
|
+
* (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.
|
|
1258
|
+
* The widthRatio determines the width of the watermark.
|
|
1200
1259
|
*/
|
|
1201
1260
|
var WatermarkRatio = /** @class */ (function () {
|
|
1202
1261
|
function WatermarkRatio() {
|
|
@@ -1318,20 +1377,20 @@ var ExperiencePoorReason;
|
|
|
1318
1377
|
ExperiencePoorReason[ExperiencePoorReason["WifiBluetoothCoexist"] = 8] = "WifiBluetoothCoexist";
|
|
1319
1378
|
})(ExperiencePoorReason = exports.ExperiencePoorReason || (exports.ExperiencePoorReason = {}));
|
|
1320
1379
|
/**
|
|
1321
|
-
* AI noise
|
|
1380
|
+
* AI noise suppression modes.
|
|
1322
1381
|
*/
|
|
1323
1382
|
var AudioAinsMode;
|
|
1324
1383
|
(function (AudioAinsMode) {
|
|
1325
1384
|
/**
|
|
1326
|
-
* 0: (Default) Balance mode. This mode allows for a balanced performance on noice
|
|
1385
|
+
* 0: (Default) Balance mode. This mode allows for a balanced performance on noice suppression and time delay.
|
|
1327
1386
|
*/
|
|
1328
1387
|
AudioAinsMode[AudioAinsMode["AinsModeBalanced"] = 0] = "AinsModeBalanced";
|
|
1329
1388
|
/**
|
|
1330
|
-
* 1: Aggressive mode. In scenarios where high performance on noise
|
|
1389
|
+
* 1: Aggressive mode. In scenarios where high performance on noise suppression is required, such as live streaming outdoor events, this mode reduces nosie more dramatically, but may sometimes affect the original character of the audio.
|
|
1331
1390
|
*/
|
|
1332
1391
|
AudioAinsMode[AudioAinsMode["AinsModeAggressive"] = 1] = "AinsModeAggressive";
|
|
1333
1392
|
/**
|
|
1334
|
-
* 2: Aggressive mode with low latency. The noise
|
|
1393
|
+
* 2: Aggressive mode with low latency. The noise suppression delay of this mode is about only half of that of the balance and aggressive modes. It is suitable for scenarios that have high requirements on noise suppression with low latency, such as sing together online in real time.
|
|
1335
1394
|
*/
|
|
1336
1395
|
AudioAinsMode[AudioAinsMode["AinsModeUltralowlatency"] = 2] = "AinsModeUltralowlatency";
|
|
1337
1396
|
})(AudioAinsMode = exports.AudioAinsMode || (exports.AudioAinsMode = {}));
|
|
@@ -1341,7 +1400,10 @@ var AudioAinsMode;
|
|
|
1341
1400
|
var AudioProfileType;
|
|
1342
1401
|
(function (AudioProfileType) {
|
|
1343
1402
|
/**
|
|
1344
|
-
* 0: The default audio profile.
|
|
1403
|
+
* 0: The default audio profile.
|
|
1404
|
+
* For the interactive streaming profile: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
|
|
1405
|
+
* For the communication profile:
|
|
1406
|
+
* Windows: A sample rate of 16 kHz, audio encoding, mono, and a bitrate of up to 16 Kbps. macOS: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
|
|
1345
1407
|
*/
|
|
1346
1408
|
AudioProfileType[AudioProfileType["AudioProfileDefault"] = 0] = "AudioProfileDefault";
|
|
1347
1409
|
/**
|
|
@@ -1353,7 +1415,7 @@ var AudioProfileType;
|
|
|
1353
1415
|
*/
|
|
1354
1416
|
AudioProfileType[AudioProfileType["AudioProfileMusicStandard"] = 2] = "AudioProfileMusicStandard";
|
|
1355
1417
|
/**
|
|
1356
|
-
* 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
|
|
1418
|
+
* 3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
|
|
1357
1419
|
*/
|
|
1358
1420
|
AudioProfileType[AudioProfileType["AudioProfileMusicStandardStereo"] = 3] = "AudioProfileMusicStandardStereo";
|
|
1359
1421
|
/**
|
|
@@ -1361,7 +1423,7 @@ var AudioProfileType;
|
|
|
1361
1423
|
*/
|
|
1362
1424
|
AudioProfileType[AudioProfileType["AudioProfileMusicHighQuality"] = 4] = "AudioProfileMusicHighQuality";
|
|
1363
1425
|
/**
|
|
1364
|
-
* 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
|
|
1426
|
+
* 5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps. To implement stereo audio, you also need to call setAdvancedAudioOptions and set audioProcessingChannels to AudioProcessingStereo in AdvancedAudioOptions.
|
|
1365
1427
|
*/
|
|
1366
1428
|
AudioProfileType[AudioProfileType["AudioProfileMusicHighQualityStereo"] = 5] = "AudioProfileMusicHighQualityStereo";
|
|
1367
1429
|
/**
|
|
@@ -1462,7 +1524,20 @@ var VideoApplicationScenarioType;
|
|
|
1462
1524
|
*/
|
|
1463
1525
|
VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
|
|
1464
1526
|
/**
|
|
1465
|
-
* If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
|
|
1527
|
+
* If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
|
|
1528
|
+
* 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.
|
|
1529
|
+
* 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.
|
|
1530
|
+
* If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
|
|
1531
|
+
* 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:
|
|
1532
|
+
* Resolution: 1280 × 720
|
|
1533
|
+
* Frame rate: 15 fps
|
|
1534
|
+
* Bitrate: 1600 Kbps
|
|
1535
|
+
* 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.
|
|
1536
|
+
* If nobody subscribes to the low-quality stream, the SDK automatically disables it to save upstream bandwidth.
|
|
1537
|
+
* 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:
|
|
1538
|
+
* Resolution: 480 × 272
|
|
1539
|
+
* Frame rate: 15 fps
|
|
1540
|
+
* Bitrate: 500 Kbps 1: The meeting scenario.
|
|
1466
1541
|
*/
|
|
1467
1542
|
VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioMeeting"] = 1] = "ApplicationScenarioMeeting";
|
|
1468
1543
|
})(VideoApplicationScenarioType = exports.VideoApplicationScenarioType || (exports.VideoApplicationScenarioType = {}));
|
|
@@ -1524,7 +1599,7 @@ var LocalAudioStreamError;
|
|
|
1524
1599
|
*/
|
|
1525
1600
|
LocalAudioStreamError[LocalAudioStreamError["LocalAudioStreamErrorFailure"] = 1] = "LocalAudioStreamErrorFailure";
|
|
1526
1601
|
/**
|
|
1527
|
-
* 2: No permission to use the local audio capturing device. Remind your users to grant permission.Deprecated:This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
|
|
1602
|
+
* 2: No permission to use the local audio capturing device. Remind your users to grant permission. Deprecated: This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
|
|
1528
1603
|
*/
|
|
1529
1604
|
LocalAudioStreamError[LocalAudioStreamError["LocalAudioStreamErrorDeviceNoPermission"] = 2] = "LocalAudioStreamErrorDeviceNoPermission";
|
|
1530
1605
|
/**
|
|
@@ -1596,7 +1671,7 @@ var LocalVideoStreamError;
|
|
|
1596
1671
|
*/
|
|
1597
1672
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorFailure"] = 1] = "LocalVideoStreamErrorFailure";
|
|
1598
1673
|
/**
|
|
1599
|
-
* 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel.Deprecated:This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
|
|
1674
|
+
* 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel. Deprecated: This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
|
|
1600
1675
|
*/
|
|
1601
1676
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceNoPermission"] = 2] = "LocalVideoStreamErrorDeviceNoPermission";
|
|
1602
1677
|
/**
|
|
@@ -1624,7 +1699,7 @@ var LocalVideoStreamError;
|
|
|
1624
1699
|
*/
|
|
1625
1700
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceNotFound"] = 8] = "LocalVideoStreamErrorDeviceNotFound";
|
|
1626
1701
|
/**
|
|
1627
|
-
* 9:(For macOS only) The video capture device currently in use is disconnected (such as being unplugged).
|
|
1702
|
+
* 9: (For macOS only) The video capture device currently in use is disconnected (such as being unplugged).
|
|
1628
1703
|
*/
|
|
1629
1704
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorDeviceDisconnected"] = 9] = "LocalVideoStreamErrorDeviceDisconnected";
|
|
1630
1705
|
/**
|
|
@@ -1640,7 +1715,10 @@ var LocalVideoStreamError;
|
|
|
1640
1715
|
*/
|
|
1641
1716
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureWindowMinimized"] = 11] = "LocalVideoStreamErrorScreenCaptureWindowMinimized";
|
|
1642
1717
|
/**
|
|
1643
|
-
* 12: (For macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing.Common scenarios for reporting this error code:
|
|
1718
|
+
* 12: (For macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios for reporting this error code:
|
|
1719
|
+
* When the local user closes the shared window, the SDK reports this error code.
|
|
1720
|
+
* The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
|
|
1721
|
+
* The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
|
|
1644
1722
|
*/
|
|
1645
1723
|
LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureWindowClosed"] = 12] = "LocalVideoStreamErrorScreenCaptureWindowClosed";
|
|
1646
1724
|
/**
|
|
@@ -1808,7 +1886,7 @@ var RemoteVideoStateReason;
|
|
|
1808
1886
|
*/
|
|
1809
1887
|
RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonSdkInBackground"] = 12] = "RemoteVideoStateReasonSdkInBackground";
|
|
1810
1888
|
/**
|
|
1811
|
-
*
|
|
1889
|
+
* 13: The local video decoder does not support decoding the remote video stream.
|
|
1812
1890
|
*/
|
|
1813
1891
|
RemoteVideoStateReason[RemoteVideoStateReason["RemoteVideoStateReasonCodecNotSupport"] = 13] = "RemoteVideoStateReasonCodecNotSupport";
|
|
1814
1892
|
})(RemoteVideoStateReason = exports.RemoteVideoStateReason || (exports.RemoteVideoStateReason = {}));
|
|
@@ -1991,7 +2069,9 @@ var RtmpStreamPublishState;
|
|
|
1991
2069
|
*/
|
|
1992
2070
|
RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRunning"] = 2] = "RtmpStreamPublishStateRunning";
|
|
1993
2071
|
/**
|
|
1994
|
-
* 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.
|
|
2072
|
+
* 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state.
|
|
2073
|
+
* If the SDK successfully resumes the streaming, RtmpStreamPublishStateRunning (2) returns.
|
|
2074
|
+
* If the streaming does not resume within 60 seconds or server errors occur, RtmpStreamPublishStateFailure (4) returns. If you feel that 60 seconds is too long, you can also actively try to reconnect.
|
|
1995
2075
|
*/
|
|
1996
2076
|
RtmpStreamPublishState[RtmpStreamPublishState["RtmpStreamPublishStateRecovering"] = 3] = "RtmpStreamPublishStateRecovering";
|
|
1997
2077
|
/**
|
|
@@ -2101,6 +2181,7 @@ var RtmpStreamingEvent;
|
|
|
2101
2181
|
})(RtmpStreamingEvent = exports.RtmpStreamingEvent || (exports.RtmpStreamingEvent = {}));
|
|
2102
2182
|
/**
|
|
2103
2183
|
* Image properties.
|
|
2184
|
+
*
|
|
2104
2185
|
* This class sets the properties of the watermark and background images in the live video.
|
|
2105
2186
|
*/
|
|
2106
2187
|
var RtcImage = /** @class */ (function () {
|
|
@@ -2111,7 +2192,8 @@ var RtcImage = /** @class */ (function () {
|
|
|
2111
2192
|
exports.RtcImage = RtcImage;
|
|
2112
2193
|
/**
|
|
2113
2194
|
* The configuration for advanced features of the RTMP or RTMPS streaming with transcoding.
|
|
2114
|
-
*
|
|
2195
|
+
*
|
|
2196
|
+
* If you want to enable the advanced features of streaming with transcoding, contact.
|
|
2115
2197
|
*/
|
|
2116
2198
|
var LiveStreamAdvancedFeature = /** @class */ (function () {
|
|
2117
2199
|
function LiveStreamAdvancedFeature() {
|
|
@@ -2125,11 +2207,15 @@ exports.LiveStreamAdvancedFeature = LiveStreamAdvancedFeature;
|
|
|
2125
2207
|
var ConnectionStateType;
|
|
2126
2208
|
(function (ConnectionStateType) {
|
|
2127
2209
|
/**
|
|
2128
|
-
* 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases:
|
|
2210
|
+
* 1: The SDK is disconnected from the Agora edge server. The state indicates the SDK is in one of the following phases:
|
|
2211
|
+
* Theinitial state before calling the joinChannel method.
|
|
2212
|
+
* The app calls the leaveChannel method.
|
|
2129
2213
|
*/
|
|
2130
2214
|
ConnectionStateType[ConnectionStateType["ConnectionStateDisconnected"] = 1] = "ConnectionStateDisconnected";
|
|
2131
2215
|
/**
|
|
2132
|
-
* 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls joinChannel.
|
|
2216
|
+
* 2: The SDK is connecting to the Agora edge server. This state indicates that the SDK is establishing a connection with the specified channel after the app calls joinChannel.
|
|
2217
|
+
* If the SDK successfully joins the channel, it triggers the onConnectionStateChanged callback and the connection state switches to ConnectionStateConnected.
|
|
2218
|
+
* After the connection is established, the SDK also initializes the media and triggers onJoinChannelSuccess when everything is ready.
|
|
2133
2219
|
*/
|
|
2134
2220
|
ConnectionStateType[ConnectionStateType["ConnectionStateConnecting"] = 2] = "ConnectionStateConnecting";
|
|
2135
2221
|
/**
|
|
@@ -2137,11 +2223,15 @@ var ConnectionStateType;
|
|
|
2137
2223
|
*/
|
|
2138
2224
|
ConnectionStateType[ConnectionStateType["ConnectionStateConnected"] = 3] = "ConnectionStateConnected";
|
|
2139
2225
|
/**
|
|
2140
|
-
* 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
|
|
2226
|
+
* 4: The SDK keeps reconnecting to the Agora edge server. The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
|
|
2227
|
+
* If the SDK cannot rejoin the channel within 10 seconds, it triggers onConnectionLost, stays in the ConnectionStateReconnecting state, and keeps rejoining the channel.
|
|
2228
|
+
* If the SDK fails to rejoin the channel 20 minutes after being disconnected from the Agora edge server, the SDK triggers the onConnectionStateChanged callback, switches to the ConnectionStateFailed state, and stops rejoining the channel.
|
|
2141
2229
|
*/
|
|
2142
2230
|
ConnectionStateType[ConnectionStateType["ConnectionStateReconnecting"] = 4] = "ConnectionStateReconnecting";
|
|
2143
2231
|
/**
|
|
2144
|
-
* 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call leaveChannel to leave the channel.
|
|
2232
|
+
* 5: The SDK fails to connect to the Agora edge server or join the channel. This state indicates that the SDK stops trying to rejoin the channel. You must call leaveChannel to leave the channel.
|
|
2233
|
+
* You can call joinChannel to rejoin the channel.
|
|
2234
|
+
* If the SDK is banned from joining the channel by the Agora edge server through the RESTful API, the SDK triggers the onConnectionStateChanged callback.
|
|
2145
2235
|
*/
|
|
2146
2236
|
ConnectionStateType[ConnectionStateType["ConnectionStateFailed"] = 5] = "ConnectionStateFailed";
|
|
2147
2237
|
})(ConnectionStateType = exports.ConnectionStateType || (exports.ConnectionStateType = {}));
|
|
@@ -2298,7 +2388,9 @@ var ConnectionChangedReasonType;
|
|
|
2298
2388
|
*/
|
|
2299
2389
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidChannelName"] = 7] = "ConnectionChangedInvalidChannelName";
|
|
2300
2390
|
/**
|
|
2301
|
-
* 8: The connection failed because the token is not valid. Possible reasons are as follows:
|
|
2391
|
+
* 8: The connection failed because the token is not valid. Possible reasons are as follows:
|
|
2392
|
+
* The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
|
|
2393
|
+
* The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
|
|
2302
2394
|
*/
|
|
2303
2395
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidToken"] = 8] = "ConnectionChangedInvalidToken";
|
|
2304
2396
|
/**
|
|
@@ -2306,7 +2398,9 @@ var ConnectionChangedReasonType;
|
|
|
2306
2398
|
*/
|
|
2307
2399
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedTokenExpired"] = 9] = "ConnectionChangedTokenExpired";
|
|
2308
2400
|
/**
|
|
2309
|
-
* 10: The connection is rejected by server. Possible reasons are as follows:
|
|
2401
|
+
* 10: The connection is rejected by server. Possible reasons are as follows:
|
|
2402
|
+
* The user is already in the channel and still calls a method, for example, joinChannel, to join the channel. Stop calling this method to clear this error.
|
|
2403
|
+
* The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
|
|
2310
2404
|
*/
|
|
2311
2405
|
ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRejectedByServer"] = 10] = "ConnectionChangedRejectedByServer";
|
|
2312
2406
|
/**
|
|
@@ -2360,7 +2454,7 @@ var ConnectionChangedReasonType;
|
|
|
2360
2454
|
var ClientRoleChangeFailedReason;
|
|
2361
2455
|
(function (ClientRoleChangeFailedReason) {
|
|
2362
2456
|
/**
|
|
2363
|
-
* 1: The number of hosts in the channel is already at the upper limit.This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
|
|
2457
|
+
* 1: The number of hosts in the channel is already at the upper limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
|
|
2364
2458
|
*/
|
|
2365
2459
|
ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedTooManyBroadcasters"] = 1] = "ClientRoleChangeFailedTooManyBroadcasters";
|
|
2366
2460
|
/**
|
|
@@ -2709,19 +2803,21 @@ var VoiceBeautifierPreset;
|
|
|
2709
2803
|
*/
|
|
2710
2804
|
VoiceBeautifierPreset[VoiceBeautifierPreset["VoiceBeautifierOff"] = 0] = "VoiceBeautifierOff";
|
|
2711
2805
|
/**
|
|
2712
|
-
* A more magnetic voice.Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
|
|
2806
|
+
* A more magnetic voice. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.
|
|
2713
2807
|
*/
|
|
2714
2808
|
VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierMagnetic"] = 16843008] = "ChatBeautifierMagnetic";
|
|
2715
2809
|
/**
|
|
2716
|
-
* A fresher voice.Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
|
|
2810
|
+
* A fresher voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
|
|
2717
2811
|
*/
|
|
2718
2812
|
VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierFresh"] = 16843264] = "ChatBeautifierFresh";
|
|
2719
2813
|
/**
|
|
2720
|
-
* A more vital voice.Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
|
|
2814
|
+
* A more vital voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.
|
|
2721
2815
|
*/
|
|
2722
2816
|
VoiceBeautifierPreset[VoiceBeautifierPreset["ChatBeautifierVitality"] = 16843520] = "ChatBeautifierVitality";
|
|
2723
2817
|
/**
|
|
2724
|
-
* Singing beautifier effect.
|
|
2818
|
+
* Singing beautifier effect.
|
|
2819
|
+
* If you call setVoiceBeautifierPreset (SingingBeautifier), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion.
|
|
2820
|
+
* If you call setVoiceBeautifierParameters (SingingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect.
|
|
2725
2821
|
*/
|
|
2726
2822
|
VoiceBeautifierPreset[VoiceBeautifierPreset["SingingBeautifier"] = 16908544] = "SingingBeautifier";
|
|
2727
2823
|
/**
|
|
@@ -2757,12 +2853,15 @@ var VoiceBeautifierPreset;
|
|
|
2757
2853
|
*/
|
|
2758
2854
|
VoiceBeautifierPreset[VoiceBeautifierPreset["TimbreTransformationRinging"] = 16975872] = "TimbreTransformationRinging";
|
|
2759
2855
|
/**
|
|
2760
|
-
* A ultra-high quality voice, which makes the audio clearer and restores more details.
|
|
2856
|
+
* A ultra-high quality voice, which makes the audio clearer and restores more details.
|
|
2857
|
+
* To achieve better audio effect quality, Agora recommends that you set the profile of to AudioProfileMusicHighQuality (4) or AudioProfileMusicHighQualityStereo (5) and scenario to AudioScenarioGameStreaming (3) before calling setVoiceBeautifierPreset.
|
|
2858
|
+
* If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.
|
|
2761
2859
|
*/
|
|
2762
2860
|
VoiceBeautifierPreset[VoiceBeautifierPreset["UltraHighQualityVoice"] = 17039616] = "UltraHighQualityVoice";
|
|
2763
2861
|
})(VoiceBeautifierPreset = exports.VoiceBeautifierPreset || (exports.VoiceBeautifierPreset = {}));
|
|
2764
2862
|
/**
|
|
2765
2863
|
* Preset audio effects.
|
|
2864
|
+
*
|
|
2766
2865
|
* To get better audio effects, Agora recommends calling setAudioProfile and setting the profile parameter as recommended below before using the preset audio effects.
|
|
2767
2866
|
*/
|
|
2768
2867
|
var AudioEffectPreset;
|
|
@@ -2800,31 +2899,31 @@ var AudioEffectPreset;
|
|
|
2800
2899
|
*/
|
|
2801
2900
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsEthereal"] = 33621760] = "RoomAcousticsEthereal";
|
|
2802
2901
|
/**
|
|
2803
|
-
* A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period.If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
|
|
2902
|
+
* A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period. If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
|
|
2804
2903
|
*/
|
|
2805
2904
|
AudioEffectPreset[AudioEffectPreset["RoomAcoustics3dVoice"] = 33622016] = "RoomAcoustics3dVoice";
|
|
2806
2905
|
/**
|
|
2807
|
-
* Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect.If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
|
|
2906
|
+
* Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect. If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
|
|
2808
2907
|
*/
|
|
2809
2908
|
AudioEffectPreset[AudioEffectPreset["RoomAcousticsVirtualSurroundSound"] = 33622272] = "RoomAcousticsVirtualSurroundSound";
|
|
2810
2909
|
/**
|
|
2811
|
-
* A middle-aged man's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2910
|
+
* A middle-aged man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2812
2911
|
*/
|
|
2813
2912
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectUncle"] = 33685760] = "VoiceChangerEffectUncle";
|
|
2814
2913
|
/**
|
|
2815
|
-
* An older man's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2914
|
+
* An older man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2816
2915
|
*/
|
|
2817
2916
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectOldman"] = 33686016] = "VoiceChangerEffectOldman";
|
|
2818
2917
|
/**
|
|
2819
|
-
* A boy's voice.Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2918
|
+
* A boy's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2820
2919
|
*/
|
|
2821
2920
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectBoy"] = 33686272] = "VoiceChangerEffectBoy";
|
|
2822
2921
|
/**
|
|
2823
|
-
* A young woman's voice.Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2922
|
+
* A young woman's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2824
2923
|
*/
|
|
2825
2924
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectSister"] = 33686528] = "VoiceChangerEffectSister";
|
|
2826
2925
|
/**
|
|
2827
|
-
* A girl's voice.Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2926
|
+
* A girl's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
|
|
2828
2927
|
*/
|
|
2829
2928
|
AudioEffectPreset[AudioEffectPreset["VoiceChangerEffectGirl"] = 33686784] = "VoiceChangerEffectGirl";
|
|
2830
2929
|
/**
|
|
@@ -2968,7 +3067,7 @@ var AudioRecordingQualityType;
|
|
|
2968
3067
|
AudioRecordingQualityType[AudioRecordingQualityType["AudioRecordingQualityUltraHigh"] = 3] = "AudioRecordingQualityUltraHigh";
|
|
2969
3068
|
})(AudioRecordingQualityType = exports.AudioRecordingQualityType || (exports.AudioRecordingQualityType = {}));
|
|
2970
3069
|
/**
|
|
2971
|
-
* Recording content. Set in startAudioRecording
|
|
3070
|
+
* Recording content. Set in startAudioRecording.
|
|
2972
3071
|
*/
|
|
2973
3072
|
var AudioFileRecordingType;
|
|
2974
3073
|
(function (AudioFileRecordingType) {
|
|
@@ -3103,7 +3202,7 @@ var ChannelMediaRelayError;
|
|
|
3103
3202
|
*/
|
|
3104
3203
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerErrorResponse"] = 1] = "RelayErrorServerErrorResponse";
|
|
3105
3204
|
/**
|
|
3106
|
-
* 2: No server response.You can call leaveChannel to leave the channel.This error can also occur if your project has not enabled co-host token authentication. You can to enable the service for cohosting across channels before starting a channel media relay.
|
|
3205
|
+
* 2: No server response. You can call leaveChannel to leave the channel. This error can also occur if your project has not enabled co-host token authentication. You can to enable the service for cohosting across channels before starting a channel media relay.
|
|
3107
3206
|
*/
|
|
3108
3207
|
ChannelMediaRelayError[ChannelMediaRelayError["RelayErrorServerNoResponse"] = 2] = "RelayErrorServerNoResponse";
|
|
3109
3208
|
/**
|
|
@@ -3219,7 +3318,7 @@ var ChannelMediaRelayEvent;
|
|
|
3219
3318
|
var ChannelMediaRelayState;
|
|
3220
3319
|
(function (ChannelMediaRelayState) {
|
|
3221
3320
|
/**
|
|
3222
|
-
* 0: The initial state. After you successfully stop the channel media relay by calling stopChannelMediaRelay
|
|
3321
|
+
* 0: The initial state. After you successfully stop the channel media relay by calling stopChannelMediaRelay, the onChannelMediaRelayStateChanged callback returns this state.
|
|
3223
3322
|
*/
|
|
3224
3323
|
ChannelMediaRelayState[ChannelMediaRelayState["RelayStateIdle"] = 0] = "RelayStateIdle";
|
|
3225
3324
|
/**
|
|
@@ -3282,6 +3381,7 @@ var DownlinkNetworkInfo = /** @class */ (function () {
|
|
|
3282
3381
|
exports.DownlinkNetworkInfo = DownlinkNetworkInfo;
|
|
3283
3382
|
/**
|
|
3284
3383
|
* The built-in encryption mode.
|
|
3384
|
+
*
|
|
3285
3385
|
* Agora recommends using Aes128Gcm2 or Aes256Gcm2 encrypted mode. These two modes support the use of salt for higher security.
|
|
3286
3386
|
*/
|
|
3287
3387
|
var EncryptionMode;
|
|
@@ -3406,7 +3506,15 @@ var StreamSubscribeState;
|
|
|
3406
3506
|
*/
|
|
3407
3507
|
StreamSubscribeState[StreamSubscribeState["SubStateIdle"] = 0] = "SubStateIdle";
|
|
3408
3508
|
/**
|
|
3409
|
-
* 1: Fails to subscribe to the remote stream. Possible reasons:
|
|
3509
|
+
* 1: Fails to subscribe to the remote stream. Possible reasons:
|
|
3510
|
+
* The remote user:
|
|
3511
|
+
* Calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media stream.
|
|
3512
|
+
* Calls disableAudio or disableVideo to disable the local audio or video module.
|
|
3513
|
+
* Calls enableLocalAudio (false) or enableLocalVideo (false) to disable local audio or video capture.
|
|
3514
|
+
* The role of the remote user is audience.
|
|
3515
|
+
* The local user calls the following methods to stop receiving remote streams:
|
|
3516
|
+
* Call muteRemoteAudioStream (true) or muteAllRemoteAudioStreams (true) to stop receiving the remote audio stream.
|
|
3517
|
+
* Call muteRemoteVideoStream (true) or muteAllRemoteVideoStreams (true) to stop receiving the remote video stream.
|
|
3410
3518
|
*/
|
|
3411
3519
|
StreamSubscribeState[StreamSubscribeState["SubStateNoSubscribed"] = 1] = "SubStateNoSubscribed";
|
|
3412
3520
|
/**
|
|
@@ -3428,7 +3536,11 @@ var StreamPublishState;
|
|
|
3428
3536
|
*/
|
|
3429
3537
|
StreamPublishState[StreamPublishState["PubStateIdle"] = 0] = "PubStateIdle";
|
|
3430
3538
|
/**
|
|
3431
|
-
* 1: Fails to publish the local stream. Possible reasons:
|
|
3539
|
+
* 1: Fails to publish the local stream. Possible reasons:
|
|
3540
|
+
* The local user calls muteLocalAudioStream (true) or muteLocalVideoStream (true) to stop sending local media streams.
|
|
3541
|
+
* The local user calls disableAudio or disableVideo to disable the local audio or video module.
|
|
3542
|
+
* The local user calls enableLocalAudio (false) or enableLocalVideo (false) to disable the local audio or video capture.
|
|
3543
|
+
* The role of the local user is audience.
|
|
3432
3544
|
*/
|
|
3433
3545
|
StreamPublishState[StreamPublishState["PubStateNoPublished"] = 1] = "PubStateNoPublished";
|
|
3434
3546
|
/**
|
|
@@ -3517,6 +3629,7 @@ var ScreenVideoParameters = /** @class */ (function () {
|
|
|
3517
3629
|
exports.ScreenVideoParameters = ScreenVideoParameters;
|
|
3518
3630
|
/**
|
|
3519
3631
|
* The audio configuration for the shared screen stream.
|
|
3632
|
+
*
|
|
3520
3633
|
* Only available where captureAudio is true.
|
|
3521
3634
|
*/
|
|
3522
3635
|
var ScreenAudioParameters = /** @class */ (function () {
|
|
@@ -3535,7 +3648,7 @@ var ScreenCaptureParameters2 = /** @class */ (function () {
|
|
|
3535
3648
|
}());
|
|
3536
3649
|
exports.ScreenCaptureParameters2 = ScreenCaptureParameters2;
|
|
3537
3650
|
/**
|
|
3538
|
-
* The rendering state of the media frame
|
|
3651
|
+
* The rendering state of the media frame.
|
|
3539
3652
|
*/
|
|
3540
3653
|
var MediaTraceEvent;
|
|
3541
3654
|
(function (MediaTraceEvent) {
|
|
@@ -3580,6 +3693,47 @@ var RecorderStreamInfo = /** @class */ (function () {
|
|
|
3580
3693
|
return RecorderStreamInfo;
|
|
3581
3694
|
}());
|
|
3582
3695
|
exports.RecorderStreamInfo = RecorderStreamInfo;
|
|
3696
|
+
/**
|
|
3697
|
+
* @ignore
|
|
3698
|
+
*/
|
|
3699
|
+
var LocalProxyMode;
|
|
3700
|
+
(function (LocalProxyMode) {
|
|
3701
|
+
/**
|
|
3702
|
+
* @ignore
|
|
3703
|
+
*/
|
|
3704
|
+
LocalProxyMode[LocalProxyMode["ConnectivityFirst"] = 0] = "ConnectivityFirst";
|
|
3705
|
+
/**
|
|
3706
|
+
* @ignore
|
|
3707
|
+
*/
|
|
3708
|
+
LocalProxyMode[LocalProxyMode["LocalOnly"] = 1] = "LocalOnly";
|
|
3709
|
+
})(LocalProxyMode = exports.LocalProxyMode || (exports.LocalProxyMode = {}));
|
|
3710
|
+
/**
|
|
3711
|
+
* @ignore
|
|
3712
|
+
*/
|
|
3713
|
+
var LogUploadServerInfo = /** @class */ (function () {
|
|
3714
|
+
function LogUploadServerInfo() {
|
|
3715
|
+
}
|
|
3716
|
+
return LogUploadServerInfo;
|
|
3717
|
+
}());
|
|
3718
|
+
exports.LogUploadServerInfo = LogUploadServerInfo;
|
|
3719
|
+
/**
|
|
3720
|
+
* @ignore
|
|
3721
|
+
*/
|
|
3722
|
+
var AdvancedConfigInfo = /** @class */ (function () {
|
|
3723
|
+
function AdvancedConfigInfo() {
|
|
3724
|
+
}
|
|
3725
|
+
return AdvancedConfigInfo;
|
|
3726
|
+
}());
|
|
3727
|
+
exports.AdvancedConfigInfo = AdvancedConfigInfo;
|
|
3728
|
+
/**
|
|
3729
|
+
* @ignore
|
|
3730
|
+
*/
|
|
3731
|
+
var LocalAccessPointConfiguration = /** @class */ (function () {
|
|
3732
|
+
function LocalAccessPointConfiguration() {
|
|
3733
|
+
}
|
|
3734
|
+
return LocalAccessPointConfiguration;
|
|
3735
|
+
}());
|
|
3736
|
+
exports.LocalAccessPointConfiguration = LocalAccessPointConfiguration;
|
|
3583
3737
|
/**
|
|
3584
3738
|
* The spatial audio parameters.
|
|
3585
3739
|
*/
|