agora-electron-sdk 4.2.0 → 4.2.2-dev.4
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 +7 -5
- package/js/Private/AgoraBase.js +394 -1292
- package/js/Private/AgoraMediaBase.js +76 -340
- package/js/Private/AgoraMediaPlayerTypes.js +25 -122
- package/js/Private/IAgoraLog.js +5 -14
- package/js/Private/IAgoraMediaEngine.js +5 -2
- package/js/Private/IAgoraMediaPlayer.js +10 -4
- package/js/Private/IAgoraMediaRecorder.js +5 -2
- package/js/Private/IAgoraMediaStreamingSource.js +5 -12
- package/js/Private/IAgoraMusicContentCenter.js +68 -125
- package/js/Private/IAgoraRhythmPlayer.js +5 -10
- package/js/Private/IAgoraRtcEngine.js +141 -932
- package/js/Private/IAgoraRtcEngineEx.js +29 -13
- package/js/Private/IAgoraSpatialAudio.js +40 -53
- package/js/Private/IAudioDeviceManager.js +5 -2
- package/js/Private/impl/IAgoraMediaEngineImpl.js +156 -139
- package/js/Private/impl/IAgoraMediaPlayerImpl.js +538 -526
- package/js/Private/impl/IAgoraMediaRecorderImpl.js +29 -26
- package/js/Private/impl/IAgoraMusicContentCenterImpl.js +264 -192
- package/js/Private/impl/IAgoraRtcEngineExImpl.js +419 -399
- package/js/Private/impl/IAgoraRtcEngineImpl.js +2352 -2207
- package/js/Private/impl/IAgoraSpatialAudioImpl.js +192 -169
- package/js/Private/impl/IAudioDeviceManagerImpl.js +235 -232
- package/js/Private/internal/AudioDeviceManagerInternal.js +44 -24
- package/js/Private/internal/IrisApiEngine.js +109 -76
- package/js/Private/internal/LocalSpatialAudioEngineInternal.js +49 -29
- package/js/Private/internal/MediaEngineInternal.js +82 -58
- package/js/Private/internal/MediaPlayerInternal.js +132 -111
- package/js/Private/internal/MediaRecorderInternal.js +64 -38
- package/js/Private/internal/MusicContentCenterInternal.js +130 -100
- package/js/Private/internal/RtcEngineExInternal.js +265 -219
- package/js/Private/ti/AgoraBase-ti.js +2 -2
- package/js/Private/ti/AgoraMediaBase-ti.js +15 -15
- package/js/Private/ti/AgoraMediaPlayerTypes-ti.js +1 -1
- package/js/Private/ti/IAgoraLog-ti.js +1 -1
- package/js/Private/ti/IAgoraMediaEngine-ti.js +1 -1
- package/js/Private/ti/IAgoraMediaPlayer-ti.js +2 -2
- package/js/Private/ti/IAgoraMediaPlayerSource-ti.js +2 -2
- package/js/Private/ti/IAgoraMediaRecorder-ti.js +1 -1
- package/js/Private/ti/IAgoraMediaStreamingSource-ti.js +1 -1
- package/js/Private/ti/IAgoraMusicContentCenter-ti.js +5 -4
- package/js/Private/ti/IAgoraRhythmPlayer-ti.js +1 -1
- package/js/Private/ti/IAgoraRtcEngine-ti.js +2 -2
- package/js/Private/ti/IAgoraRtcEngineEx-ti.js +1 -1
- package/js/Private/ti/IAgoraSpatialAudio-ti.js +1 -1
- package/js/Private/ti/IAudioDeviceManager-ti.js +1 -1
- package/js/Renderer/AgoraView.js +145 -100
- package/js/Renderer/IRenderer.js +18 -17
- package/js/Renderer/IRendererManager.js +5 -2
- package/js/Renderer/RendererManager.js +208 -180
- package/js/Renderer/WebGLRenderer/index.js +111 -107
- package/js/Renderer/YUVCanvasRenderer/index.js +68 -51
- package/js/Utils.js +85 -36
- package/package.json +3 -3
- package/ts/AgoraSdk.ts +3 -1
- package/ts/Private/AgoraBase.ts +227 -86
- package/ts/Private/AgoraMediaBase.ts +69 -54
- package/ts/Private/AgoraMediaPlayerTypes.ts +4 -4
- package/ts/Private/IAgoraLog.ts +1 -1
- package/ts/Private/IAgoraMediaEngine.ts +42 -39
- package/ts/Private/IAgoraMediaPlayer.ts +98 -67
- package/ts/Private/IAgoraMediaPlayerSource.ts +15 -8
- package/ts/Private/IAgoraMusicContentCenter.ts +25 -4
- package/ts/Private/IAgoraRtcEngine.ts +951 -747
- package/ts/Private/IAgoraRtcEngineEx.ts +183 -157
- package/ts/Private/IAgoraSpatialAudio.ts +55 -32
- package/ts/Private/IAudioDeviceManager.ts +39 -25
- package/ts/Private/impl/IAgoraMusicContentCenterImpl.ts +72 -21
- package/ts/Private/impl/IAgoraRtcEngineImpl.ts +136 -15
- package/ts/Private/internal/RtcEngineExInternal.ts +8 -0
- package/ts/Private/ti/AgoraMediaBase-ti.ts +13 -13
- package/ts/Private/ti/IAgoraMusicContentCenter-ti.ts +3 -2
- package/types/AgoraSdk.d.ts +3 -1
- package/types/AgoraSdk.d.ts.map +1 -1
- package/types/Private/AgoraBase.d.ts +221 -86
- package/types/Private/AgoraBase.d.ts.map +1 -1
- package/types/Private/AgoraMediaBase.d.ts +69 -51
- package/types/Private/AgoraMediaBase.d.ts.map +1 -1
- package/types/Private/AgoraMediaPlayerTypes.d.ts +4 -4
- package/types/Private/IAgoraLog.d.ts +1 -1
- package/types/Private/IAgoraMediaEngine.d.ts +42 -39
- package/types/Private/IAgoraMediaEngine.d.ts.map +1 -1
- package/types/Private/IAgoraMediaPlayer.d.ts +98 -67
- package/types/Private/IAgoraMediaPlayer.d.ts.map +1 -1
- package/types/Private/IAgoraMediaPlayerSource.d.ts +15 -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 +936 -744
- package/types/Private/IAgoraRtcEngine.d.ts.map +1 -1
- package/types/Private/IAgoraRtcEngineEx.d.ts +183 -157
- package/types/Private/IAgoraRtcEngineEx.d.ts.map +1 -1
- package/types/Private/IAgoraSpatialAudio.d.ts +55 -32
- package/types/Private/IAgoraSpatialAudio.d.ts.map +1 -1
- package/types/Private/IAudioDeviceManager.d.ts +39 -25
- package/types/Private/IAudioDeviceManager.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 +18 -6
- package/types/Private/impl/IAgoraRtcEngineImpl.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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.AudioDeviceInfo = exports.VideoDeviceInfo = exports.SDKBuildInfo = exports.VideoProfileType = exports.MediaDeviceStateType = exports.QualityReportFormatType = exports.IRtcEngine = exports.ExtensionInfo = exports.DirectCdnStreamingMediaOptions = exports.DirectCdnStreamingStats = exports.DirectCdnStreamingState = exports.DirectCdnStreamingError = exports.Metadata = exports.MaxMetadataSizeType = exports.MetadataType = exports.RtcEngineContext = exports.IVideoDeviceManager = exports.LeaveChannelOptions = exports.
|
|
3
|
+
exports.AudioDeviceInfo = exports.VideoDeviceInfo = exports.SDKBuildInfo = exports.VideoProfileType = exports.MediaDeviceStateType = exports.QualityReportFormatType = exports.IRtcEngine = exports.ExtensionInfo = exports.DirectCdnStreamingMediaOptions = exports.DirectCdnStreamingStats = exports.DirectCdnStreamingState = exports.DirectCdnStreamingError = exports.Metadata = exports.MaxMetadataSizeType = exports.MetadataType = exports.RtcEngineContext = exports.IVideoDeviceManager = exports.LeaveChannelOptions = exports.ProxyType = exports.ChannelMediaOptions = exports.ImageTrackOptions = exports.AdvancedAudioOptions = exports.ScreenCaptureSourceInfo = exports.ScreenCaptureSourceType = exports.ThumbImageBuffer = exports.Size = exports.ScreenCaptureConfiguration = exports.CameraCapturerConfiguration = exports.CloudProxyType = exports.CameraDirection = exports.PublisherConfiguration = exports.RtmpStreamLifeCycleType = exports.InjectStreamConfig = exports.VideoCompositingLayout = exports.Region = exports.RemoteVideoStats = exports.RemoteAudioStats = exports.LocalVideoStats = exports.PriorityType = exports.StreamFallbackOptions = exports.AudioReverbType = exports.AudioEqualizationBandFrequency = exports.InjectStreamStatus = exports.AudioMixingReasonType = exports.AudioMixingStateType = exports.MediaDeviceType = void 0;
|
|
4
4
|
require("./extension/IAgoraRtcEngineExtension");
|
|
5
5
|
/**
|
|
6
6
|
* Media device types.
|
|
@@ -253,369 +253,60 @@ var PriorityType;
|
|
|
253
253
|
/**
|
|
254
254
|
* The statistics of the local video stream.
|
|
255
255
|
*/
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
/**
|
|
262
|
-
* The actual bitrate (Kbps) while sending the local video stream.This value does not include the bitrate for resending the video after packet loss.
|
|
263
|
-
*/
|
|
264
|
-
sentBitrate;
|
|
265
|
-
/**
|
|
266
|
-
* The actual frame rate (fps) while sending the local video stream.This value does not include the frame rate for resending the video after packet loss.
|
|
267
|
-
*/
|
|
268
|
-
sentFrameRate;
|
|
269
|
-
/**
|
|
270
|
-
* The frame rate (fps) for capturing the local video stream.
|
|
271
|
-
*/
|
|
272
|
-
captureFrameRate;
|
|
273
|
-
/**
|
|
274
|
-
* The width (px) for capturing the local video stream.
|
|
275
|
-
*/
|
|
276
|
-
captureFrameWidth;
|
|
277
|
-
/**
|
|
278
|
-
* The height (px) for capturing the local video stream.
|
|
279
|
-
*/
|
|
280
|
-
captureFrameHeight;
|
|
281
|
-
/**
|
|
282
|
-
* The frame rate (fps) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the frame rate of the video captured by the camera according to the video encoding configuration.
|
|
283
|
-
*/
|
|
284
|
-
regulatedCaptureFrameRate;
|
|
285
|
-
/**
|
|
286
|
-
* The width (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
|
|
287
|
-
*/
|
|
288
|
-
regulatedCaptureFrameWidth;
|
|
289
|
-
/**
|
|
290
|
-
* The height (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream. The regulator adjusts the height and width of the video captured by the camera according to the video encoding configuration.
|
|
291
|
-
*/
|
|
292
|
-
regulatedCaptureFrameHeight;
|
|
293
|
-
/**
|
|
294
|
-
* The output frame rate (fps) of the local video encoder.
|
|
295
|
-
*/
|
|
296
|
-
encoderOutputFrameRate;
|
|
297
|
-
/**
|
|
298
|
-
* The width of the encoded video (px).
|
|
299
|
-
*/
|
|
300
|
-
encodedFrameWidth;
|
|
301
|
-
/**
|
|
302
|
-
* The height of the encoded video (px).
|
|
303
|
-
*/
|
|
304
|
-
encodedFrameHeight;
|
|
305
|
-
/**
|
|
306
|
-
* The output frame rate (fps) of the local video renderer.
|
|
307
|
-
*/
|
|
308
|
-
rendererOutputFrameRate;
|
|
309
|
-
/**
|
|
310
|
-
* The target bitrate (Kbps) of the current encoder. This is an estimate made by the SDK based on the current network conditions.
|
|
311
|
-
*/
|
|
312
|
-
targetBitrate;
|
|
313
|
-
/**
|
|
314
|
-
* The target frame rate (fps) of the current encoder.
|
|
315
|
-
*/
|
|
316
|
-
targetFrameRate;
|
|
317
|
-
/**
|
|
318
|
-
* The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See QualityAdaptIndication .
|
|
319
|
-
*/
|
|
320
|
-
qualityAdaptIndication;
|
|
321
|
-
/**
|
|
322
|
-
* The bitrate (Kbps) while encoding the local video stream.This value does not include the bitrate for resending the video after packet loss.
|
|
323
|
-
*/
|
|
324
|
-
encodedBitrate;
|
|
325
|
-
/**
|
|
326
|
-
* The number of the sent video frames, represented by an aggregate value.
|
|
327
|
-
*/
|
|
328
|
-
encodedFrameCount;
|
|
329
|
-
/**
|
|
330
|
-
* The codec type of the local video. See VideoCodecType .
|
|
331
|
-
*/
|
|
332
|
-
codecType;
|
|
333
|
-
/**
|
|
334
|
-
* The video packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
|
|
335
|
-
*/
|
|
336
|
-
txPacketLossRate;
|
|
337
|
-
/**
|
|
338
|
-
* The brightness level of the video image captured by the local camera. See CaptureBrightnessLevelType .
|
|
339
|
-
*/
|
|
340
|
-
captureBrightnessLevel;
|
|
341
|
-
/**
|
|
342
|
-
* @ignore
|
|
343
|
-
*/
|
|
344
|
-
dualStreamEnabled;
|
|
345
|
-
/**
|
|
346
|
-
* The local video encoding acceleration type. 0: Software encoding is applied without acceleration.1: Hardware encoding is applied for acceleration.
|
|
347
|
-
*/
|
|
348
|
-
hwEncoderAccelerating;
|
|
349
|
-
}
|
|
256
|
+
var LocalVideoStats = /** @class */ (function () {
|
|
257
|
+
function LocalVideoStats() {
|
|
258
|
+
}
|
|
259
|
+
return LocalVideoStats;
|
|
260
|
+
}());
|
|
350
261
|
exports.LocalVideoStats = LocalVideoStats;
|
|
351
262
|
/**
|
|
352
263
|
* Audio statistics of the remote user.
|
|
353
264
|
*/
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* The quality of the audio stream sent by the user. See QualityType .
|
|
361
|
-
*/
|
|
362
|
-
quality;
|
|
363
|
-
/**
|
|
364
|
-
* The network delay (ms) from the sender to the receiver.
|
|
365
|
-
*/
|
|
366
|
-
networkTransportDelay;
|
|
367
|
-
/**
|
|
368
|
-
* The network delay (ms) from the audio receiver to the jitter buffer.When the receiving end is an audience member and audienceLatencyLevel of ClientRoleOptions is 1, this parameter does not take effect.
|
|
369
|
-
*/
|
|
370
|
-
jitterBufferDelay;
|
|
371
|
-
/**
|
|
372
|
-
* The frame loss rate (%) of the remote audio stream in the reported interval.
|
|
373
|
-
*/
|
|
374
|
-
audioLossRate;
|
|
375
|
-
/**
|
|
376
|
-
* The number of audio channels.
|
|
377
|
-
*/
|
|
378
|
-
numChannels;
|
|
379
|
-
/**
|
|
380
|
-
* The sampling rate of the received audio stream in the reported interval.
|
|
381
|
-
*/
|
|
382
|
-
receivedSampleRate;
|
|
383
|
-
/**
|
|
384
|
-
* The average bitrate (Kbps) of the received audio stream in the reported interval.
|
|
385
|
-
*/
|
|
386
|
-
receivedBitrate;
|
|
387
|
-
/**
|
|
388
|
-
* The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%.
|
|
389
|
-
*/
|
|
390
|
-
totalFrozenTime;
|
|
391
|
-
/**
|
|
392
|
-
* The total audio freeze time as a percentage (%) of the total time when the audio is available. The audio is considered available when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.
|
|
393
|
-
*/
|
|
394
|
-
frozenRate;
|
|
395
|
-
/**
|
|
396
|
-
* The quality of the remote audio stream in the reported interval. The quality is determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the audio quality.The subjective perception of audio quality corresponding to the Agora real-time audio MOS scores is as follows:MOS scorePerception of audio qualityGreater than 4Excellent. The audio sounds clear and smooth.From 3.5 to 4Good. The audio has some perceptible impairment but still sounds clear.From 3 to 3.5Fair. The audio freezes occasionally and requires attentive listening.From 2.5 to 3Poor. The audio sounds choppy and requires considerable effort to understand.From 2 to 2.5Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty.Less than 2Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible.
|
|
397
|
-
*/
|
|
398
|
-
mosValue;
|
|
399
|
-
/**
|
|
400
|
-
* @ignore
|
|
401
|
-
*/
|
|
402
|
-
frozenRateByCustomPlcCount;
|
|
403
|
-
/**
|
|
404
|
-
* @ignore
|
|
405
|
-
*/
|
|
406
|
-
plcCount;
|
|
407
|
-
/**
|
|
408
|
-
* The total active time (ms) between the start of the audio call and the callback of the remote user.The active time refers to the total duration of the remote user without the mute state.
|
|
409
|
-
*/
|
|
410
|
-
totalActiveTime;
|
|
411
|
-
/**
|
|
412
|
-
* The total duration (ms) of the remote audio stream.
|
|
413
|
-
*/
|
|
414
|
-
publishDuration;
|
|
415
|
-
/**
|
|
416
|
-
* The Quality of Experience (QoE) of the local user when receiving a remote audio stream. See ExperienceQualityType .
|
|
417
|
-
*/
|
|
418
|
-
qoeQuality;
|
|
419
|
-
/**
|
|
420
|
-
* Reasons why the QoE of the local user when receiving a remote audio stream is poor. See ExperiencePoorReason .
|
|
421
|
-
*/
|
|
422
|
-
qualityChangedReason;
|
|
423
|
-
/**
|
|
424
|
-
* @ignore
|
|
425
|
-
*/
|
|
426
|
-
rxAudioBytes;
|
|
427
|
-
}
|
|
265
|
+
var RemoteAudioStats = /** @class */ (function () {
|
|
266
|
+
function RemoteAudioStats() {
|
|
267
|
+
}
|
|
268
|
+
return RemoteAudioStats;
|
|
269
|
+
}());
|
|
428
270
|
exports.RemoteAudioStats = RemoteAudioStats;
|
|
429
271
|
/**
|
|
430
272
|
* Statistics of the remote video stream.
|
|
431
273
|
*/
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
/**
|
|
438
|
-
* Deprecated:In scenarios where audio and video are synchronized, you can get the video delay data from networkTransportDelay and jitterBufferDelay in RemoteAudioStats .The video delay (ms).
|
|
439
|
-
*/
|
|
440
|
-
delay;
|
|
441
|
-
/**
|
|
442
|
-
* End-to-end video latency (ms). That is, the time elapsed from the video capturing on the remote user's end to the receiving and rendering of the video on the local user's end.
|
|
443
|
-
*/
|
|
444
|
-
e2eDelay;
|
|
445
|
-
/**
|
|
446
|
-
* The width (pixels) of the video.
|
|
447
|
-
*/
|
|
448
|
-
width;
|
|
449
|
-
/**
|
|
450
|
-
* The height (pixels) of the video.
|
|
451
|
-
*/
|
|
452
|
-
height;
|
|
453
|
-
/**
|
|
454
|
-
* The bitrate (Kbps) of the remote video received since the last count.
|
|
455
|
-
*/
|
|
456
|
-
receivedBitrate;
|
|
457
|
-
/**
|
|
458
|
-
* The frame rate (fps) of decoding the remote video.
|
|
459
|
-
*/
|
|
460
|
-
decoderOutputFrameRate;
|
|
461
|
-
/**
|
|
462
|
-
* The frame rate (fps) of rendering the remote video.
|
|
463
|
-
*/
|
|
464
|
-
rendererOutputFrameRate;
|
|
465
|
-
/**
|
|
466
|
-
* The packet loss rate (%) of the remote video.
|
|
467
|
-
*/
|
|
468
|
-
frameLossRate;
|
|
469
|
-
/**
|
|
470
|
-
* The packet loss rate (%) of the remote video after using the anti-packet-loss technology.
|
|
471
|
-
*/
|
|
472
|
-
packetLossRate;
|
|
473
|
-
/**
|
|
474
|
-
* The type of the video stream. See VideoStreamType .
|
|
475
|
-
*/
|
|
476
|
-
rxStreamType;
|
|
477
|
-
/**
|
|
478
|
-
* The total freeze time (ms) of the remote video stream after the remote user joins the channel. In a video session where the frame rate is set to no less than 5 fps, video freeze occurs when the time interval between two adjacent renderable video frames is more than 500 ms.
|
|
479
|
-
*/
|
|
480
|
-
totalFrozenTime;
|
|
481
|
-
/**
|
|
482
|
-
* The total video freeze time as a percentage (%) of the total time the video is available. The video is considered available as long as that the remote user neither stops sending the video stream nor disables the video module after joining the channel.
|
|
483
|
-
*/
|
|
484
|
-
frozenRate;
|
|
485
|
-
/**
|
|
486
|
-
* The amount of time (ms) that the audio is ahead of the video.If this value is negative, the audio is lagging behind the video.
|
|
487
|
-
*/
|
|
488
|
-
avSyncTimeMs;
|
|
489
|
-
/**
|
|
490
|
-
* The total active time (ms) of the video.As long as the remote user or host neither stops sending the video stream nor disables the video module after joining the channel, the video is available.
|
|
491
|
-
*/
|
|
492
|
-
totalActiveTime;
|
|
493
|
-
/**
|
|
494
|
-
* The total duration (ms) of the remote video stream.
|
|
495
|
-
*/
|
|
496
|
-
publishDuration;
|
|
497
|
-
/**
|
|
498
|
-
* @ignore
|
|
499
|
-
*/
|
|
500
|
-
mosValue;
|
|
501
|
-
/**
|
|
502
|
-
* @ignore
|
|
503
|
-
*/
|
|
504
|
-
rxVideoBytes;
|
|
505
|
-
}
|
|
274
|
+
var RemoteVideoStats = /** @class */ (function () {
|
|
275
|
+
function RemoteVideoStats() {
|
|
276
|
+
}
|
|
277
|
+
return RemoteVideoStats;
|
|
278
|
+
}());
|
|
506
279
|
exports.RemoteVideoStats = RemoteVideoStats;
|
|
507
280
|
/**
|
|
508
281
|
* @ignore
|
|
509
282
|
*/
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
/**
|
|
516
|
-
* @ignore
|
|
517
|
-
*/
|
|
518
|
-
x;
|
|
519
|
-
/**
|
|
520
|
-
* @ignore
|
|
521
|
-
*/
|
|
522
|
-
y;
|
|
523
|
-
/**
|
|
524
|
-
* @ignore
|
|
525
|
-
*/
|
|
526
|
-
width;
|
|
527
|
-
/**
|
|
528
|
-
* @ignore
|
|
529
|
-
*/
|
|
530
|
-
height;
|
|
531
|
-
/**
|
|
532
|
-
* @ignore
|
|
533
|
-
*/
|
|
534
|
-
zOrder;
|
|
535
|
-
/**
|
|
536
|
-
* @ignore
|
|
537
|
-
*/
|
|
538
|
-
alpha;
|
|
539
|
-
/**
|
|
540
|
-
* @ignore
|
|
541
|
-
*/
|
|
542
|
-
renderMode;
|
|
543
|
-
}
|
|
283
|
+
var Region = /** @class */ (function () {
|
|
284
|
+
function Region() {
|
|
285
|
+
}
|
|
286
|
+
return Region;
|
|
287
|
+
}());
|
|
544
288
|
exports.Region = Region;
|
|
545
289
|
/**
|
|
546
290
|
* @ignore
|
|
547
291
|
*/
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
/**
|
|
554
|
-
* @ignore
|
|
555
|
-
*/
|
|
556
|
-
canvasHeight;
|
|
557
|
-
/**
|
|
558
|
-
* @ignore
|
|
559
|
-
*/
|
|
560
|
-
backgroundColor;
|
|
561
|
-
/**
|
|
562
|
-
* @ignore
|
|
563
|
-
*/
|
|
564
|
-
regions;
|
|
565
|
-
/**
|
|
566
|
-
* @ignore
|
|
567
|
-
*/
|
|
568
|
-
regionCount;
|
|
569
|
-
/**
|
|
570
|
-
* @ignore
|
|
571
|
-
*/
|
|
572
|
-
appData;
|
|
573
|
-
/**
|
|
574
|
-
* @ignore
|
|
575
|
-
*/
|
|
576
|
-
appDataLength;
|
|
577
|
-
}
|
|
292
|
+
var VideoCompositingLayout = /** @class */ (function () {
|
|
293
|
+
function VideoCompositingLayout() {
|
|
294
|
+
}
|
|
295
|
+
return VideoCompositingLayout;
|
|
296
|
+
}());
|
|
578
297
|
exports.VideoCompositingLayout = VideoCompositingLayout;
|
|
579
298
|
/**
|
|
580
299
|
* @ignore
|
|
581
300
|
*/
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
/**
|
|
588
|
-
* @ignore
|
|
589
|
-
*/
|
|
590
|
-
height;
|
|
591
|
-
/**
|
|
592
|
-
* @ignore
|
|
593
|
-
*/
|
|
594
|
-
videoGop;
|
|
595
|
-
/**
|
|
596
|
-
* @ignore
|
|
597
|
-
*/
|
|
598
|
-
videoFramerate;
|
|
599
|
-
/**
|
|
600
|
-
* @ignore
|
|
601
|
-
*/
|
|
602
|
-
videoBitrate;
|
|
603
|
-
/**
|
|
604
|
-
* @ignore
|
|
605
|
-
*/
|
|
606
|
-
audioSampleRate;
|
|
607
|
-
/**
|
|
608
|
-
* @ignore
|
|
609
|
-
*/
|
|
610
|
-
audioBitrate;
|
|
611
|
-
/**
|
|
612
|
-
* @ignore
|
|
613
|
-
*/
|
|
614
|
-
audioChannels;
|
|
615
|
-
}
|
|
301
|
+
var InjectStreamConfig = /** @class */ (function () {
|
|
302
|
+
function InjectStreamConfig() {
|
|
303
|
+
}
|
|
304
|
+
return InjectStreamConfig;
|
|
305
|
+
}());
|
|
616
306
|
exports.InjectStreamConfig = InjectStreamConfig;
|
|
617
307
|
/**
|
|
618
308
|
* Lifecycle of the CDN live video stream.
|
|
309
|
+
*
|
|
619
310
|
* Deprecated
|
|
620
311
|
*/
|
|
621
312
|
var RtmpStreamLifeCycleType;
|
|
@@ -632,60 +323,11 @@ var RtmpStreamLifeCycleType;
|
|
|
632
323
|
/**
|
|
633
324
|
* @ignore
|
|
634
325
|
*/
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
/**
|
|
641
|
-
* @ignore
|
|
642
|
-
*/
|
|
643
|
-
height;
|
|
644
|
-
/**
|
|
645
|
-
* @ignore
|
|
646
|
-
*/
|
|
647
|
-
framerate;
|
|
648
|
-
/**
|
|
649
|
-
* @ignore
|
|
650
|
-
*/
|
|
651
|
-
bitrate;
|
|
652
|
-
/**
|
|
653
|
-
* @ignore
|
|
654
|
-
*/
|
|
655
|
-
defaultLayout;
|
|
656
|
-
/**
|
|
657
|
-
* @ignore
|
|
658
|
-
*/
|
|
659
|
-
lifecycle;
|
|
660
|
-
/**
|
|
661
|
-
* @ignore
|
|
662
|
-
*/
|
|
663
|
-
owner;
|
|
664
|
-
/**
|
|
665
|
-
* @ignore
|
|
666
|
-
*/
|
|
667
|
-
injectStreamWidth;
|
|
668
|
-
/**
|
|
669
|
-
* @ignore
|
|
670
|
-
*/
|
|
671
|
-
injectStreamHeight;
|
|
672
|
-
/**
|
|
673
|
-
* @ignore
|
|
674
|
-
*/
|
|
675
|
-
injectStreamUrl;
|
|
676
|
-
/**
|
|
677
|
-
* @ignore
|
|
678
|
-
*/
|
|
679
|
-
publishUrl;
|
|
680
|
-
/**
|
|
681
|
-
* @ignore
|
|
682
|
-
*/
|
|
683
|
-
rawStreamUrl;
|
|
684
|
-
/**
|
|
685
|
-
* @ignore
|
|
686
|
-
*/
|
|
687
|
-
extraInfo;
|
|
688
|
-
}
|
|
326
|
+
var PublisherConfiguration = /** @class */ (function () {
|
|
327
|
+
function PublisherConfiguration() {
|
|
328
|
+
}
|
|
329
|
+
return PublisherConfiguration;
|
|
330
|
+
}());
|
|
689
331
|
exports.PublisherConfiguration = PublisherConfiguration;
|
|
690
332
|
/**
|
|
691
333
|
* The camera direction.
|
|
@@ -722,94 +364,43 @@ var CloudProxyType;
|
|
|
722
364
|
/**
|
|
723
365
|
* The camera capturer preference.
|
|
724
366
|
*/
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
/**
|
|
731
|
-
* This method applies to Windows only.The ID of the camera. The maximum length is MaxDeviceIdLengthType .
|
|
732
|
-
*/
|
|
733
|
-
deviceId;
|
|
734
|
-
/**
|
|
735
|
-
* The format of the video frame. See VideoFormat .
|
|
736
|
-
*/
|
|
737
|
-
format;
|
|
738
|
-
/**
|
|
739
|
-
* Whether to follow the video aspect ratio set in setVideoEncoderConfiguration :true: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame .false: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
|
|
740
|
-
*/
|
|
741
|
-
followEncodeDimensionRatio;
|
|
742
|
-
}
|
|
367
|
+
var CameraCapturerConfiguration = /** @class */ (function () {
|
|
368
|
+
function CameraCapturerConfiguration() {
|
|
369
|
+
}
|
|
370
|
+
return CameraCapturerConfiguration;
|
|
371
|
+
}());
|
|
743
372
|
exports.CameraCapturerConfiguration = CameraCapturerConfiguration;
|
|
744
373
|
/**
|
|
745
374
|
* The configuration of the captured screen.
|
|
746
375
|
*/
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
/**
|
|
753
|
-
* (macOS only) The display ID of the screen.This parameter takes effect only when you want to capture the screen on macOS.
|
|
754
|
-
*/
|
|
755
|
-
displayId;
|
|
756
|
-
/**
|
|
757
|
-
* (Windows only) The relative position of the shared screen to the virtual screen.This parameter takes effect only when you want to capture the screen on Windows.
|
|
758
|
-
*/
|
|
759
|
-
screenRect;
|
|
760
|
-
/**
|
|
761
|
-
* Window ID.This parameter takes effect only when you want to capture the window.
|
|
762
|
-
*/
|
|
763
|
-
windowId;
|
|
764
|
-
/**
|
|
765
|
-
* The screen capture configuration. See ScreenCaptureParameters .
|
|
766
|
-
*/
|
|
767
|
-
params;
|
|
768
|
-
/**
|
|
769
|
-
* Rectangle . If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in Rectangle as 0, the whole screen is shared.
|
|
770
|
-
*/
|
|
771
|
-
regionRect;
|
|
772
|
-
}
|
|
376
|
+
var ScreenCaptureConfiguration = /** @class */ (function () {
|
|
377
|
+
function ScreenCaptureConfiguration() {
|
|
378
|
+
}
|
|
379
|
+
return ScreenCaptureConfiguration;
|
|
380
|
+
}());
|
|
773
381
|
exports.ScreenCaptureConfiguration = ScreenCaptureConfiguration;
|
|
774
382
|
/**
|
|
775
383
|
* @ignore
|
|
776
384
|
*/
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
/**
|
|
783
|
-
* @ignore
|
|
784
|
-
*/
|
|
785
|
-
height;
|
|
786
|
-
}
|
|
385
|
+
var Size = /** @class */ (function () {
|
|
386
|
+
function Size() {
|
|
387
|
+
}
|
|
388
|
+
return Size;
|
|
389
|
+
}());
|
|
787
390
|
exports.Size = Size;
|
|
788
391
|
/**
|
|
789
|
-
* The image content of the thumbnail or icon. Set in ScreenCaptureSourceInfo
|
|
392
|
+
* The image content of the thumbnail or icon. Set in ScreenCaptureSourceInfo.
|
|
393
|
+
*
|
|
790
394
|
* The default image is in the ARGB format. If you need to use another format, you need to convert the image on your own.
|
|
791
395
|
*/
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
/**
|
|
798
|
-
* The buffer length of the thumbnail or icon, in bytes.
|
|
799
|
-
*/
|
|
800
|
-
length;
|
|
801
|
-
/**
|
|
802
|
-
* The actual width (px) of the thumbnail or icon.
|
|
803
|
-
*/
|
|
804
|
-
width;
|
|
805
|
-
/**
|
|
806
|
-
* The actual height (px) of the thumbnail or icon.
|
|
807
|
-
*/
|
|
808
|
-
height;
|
|
809
|
-
}
|
|
396
|
+
var ThumbImageBuffer = /** @class */ (function () {
|
|
397
|
+
function ThumbImageBuffer() {
|
|
398
|
+
}
|
|
399
|
+
return ThumbImageBuffer;
|
|
400
|
+
}());
|
|
810
401
|
exports.ThumbImageBuffer = ThumbImageBuffer;
|
|
811
402
|
/**
|
|
812
|
-
* The type of the shared target. Set in ScreenCaptureSourceInfo
|
|
403
|
+
* The type of the shared target. Set in ScreenCaptureSourceInfo.
|
|
813
404
|
*/
|
|
814
405
|
var ScreenCaptureSourceType;
|
|
815
406
|
(function (ScreenCaptureSourceType) {
|
|
@@ -833,226 +424,41 @@ var ScreenCaptureSourceType;
|
|
|
833
424
|
/**
|
|
834
425
|
* The information about the specified shareable window or screen.
|
|
835
426
|
*/
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
/**
|
|
842
|
-
* The window ID for a window or the display ID for a screen.
|
|
843
|
-
*/
|
|
844
|
-
sourceId;
|
|
845
|
-
/**
|
|
846
|
-
* The name of the window or screen. UTF-8 encoding.
|
|
847
|
-
*/
|
|
848
|
-
sourceName;
|
|
849
|
-
/**
|
|
850
|
-
* The image content of the thumbnail. See ThumbImageBuffer
|
|
851
|
-
*/
|
|
852
|
-
thumbImage;
|
|
853
|
-
/**
|
|
854
|
-
* The image content of the icon. See ThumbImageBuffer
|
|
855
|
-
*/
|
|
856
|
-
iconImage;
|
|
857
|
-
/**
|
|
858
|
-
* The process to which the window belongs. UTF-8 encoding.
|
|
859
|
-
*/
|
|
860
|
-
processPath;
|
|
861
|
-
/**
|
|
862
|
-
* The title of the window. UTF-8 encoding.
|
|
863
|
-
*/
|
|
864
|
-
sourceTitle;
|
|
865
|
-
/**
|
|
866
|
-
* Determines whether the screen is the primary display:true: The screen is the primary display.false: The screen is not the primary display.
|
|
867
|
-
*/
|
|
868
|
-
primaryMonitor;
|
|
869
|
-
/**
|
|
870
|
-
* @ignore
|
|
871
|
-
*/
|
|
872
|
-
isOccluded;
|
|
873
|
-
/**
|
|
874
|
-
* The position of a window relative to the entire screen space (including all shareable screens). See Rectangle .
|
|
875
|
-
*/
|
|
876
|
-
position;
|
|
877
|
-
/**
|
|
878
|
-
* (For Windows only) Whether the window is minimized:true: The window is minimized.false: The window is not minimized.
|
|
879
|
-
*/
|
|
880
|
-
minimizeWindow;
|
|
881
|
-
/**
|
|
882
|
-
* (For Windows only) Screen ID where the window is located. If the window is displayed across multiple screens, this parameter indicates the ID of the screen with which the window has the largest intersection area. If the window is located outside of the visible screens, the value of this member is -2.
|
|
883
|
-
*/
|
|
884
|
-
sourceDisplayId;
|
|
885
|
-
}
|
|
427
|
+
var ScreenCaptureSourceInfo = /** @class */ (function () {
|
|
428
|
+
function ScreenCaptureSourceInfo() {
|
|
429
|
+
}
|
|
430
|
+
return ScreenCaptureSourceInfo;
|
|
431
|
+
}());
|
|
886
432
|
exports.ScreenCaptureSourceInfo = ScreenCaptureSourceInfo;
|
|
887
433
|
/**
|
|
888
434
|
* The advanced options for audio.
|
|
889
435
|
*/
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
}
|
|
436
|
+
var AdvancedAudioOptions = /** @class */ (function () {
|
|
437
|
+
function AdvancedAudioOptions() {
|
|
438
|
+
}
|
|
439
|
+
return AdvancedAudioOptions;
|
|
440
|
+
}());
|
|
896
441
|
exports.AdvancedAudioOptions = AdvancedAudioOptions;
|
|
897
442
|
/**
|
|
898
443
|
* Image configurations.
|
|
899
444
|
*/
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
/**
|
|
906
|
-
* The frame rate of the video streams being published. The value range is [1,30]. The default value is 1.
|
|
907
|
-
*/
|
|
908
|
-
fps;
|
|
909
|
-
/**
|
|
910
|
-
* @ignore
|
|
911
|
-
*/
|
|
912
|
-
mirrorMode;
|
|
913
|
-
}
|
|
445
|
+
var ImageTrackOptions = /** @class */ (function () {
|
|
446
|
+
function ImageTrackOptions() {
|
|
447
|
+
}
|
|
448
|
+
return ImageTrackOptions;
|
|
449
|
+
}());
|
|
914
450
|
exports.ImageTrackOptions = ImageTrackOptions;
|
|
915
451
|
/**
|
|
916
452
|
* The channel media options.
|
|
917
|
-
*
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
* Whether to publish the video captured by the second camera:true: Publish the video captured by the second camera.false: Do not publish the video captured by the second camera.
|
|
926
|
-
*/
|
|
927
|
-
publishSecondaryCameraTrack;
|
|
928
|
-
/**
|
|
929
|
-
* Whether to publish the audio captured by the microphone:true: Publish the audio captured by the microphone.false: Do not publish the audio captured by the microphone.
|
|
930
|
-
*/
|
|
931
|
-
publishMicrophoneTrack;
|
|
932
|
-
/**
|
|
933
|
-
* Whether to publish the video captured from the screen:true: Publish the video captured from the screen.false: Do not publish the captured video from the screen.This parameter applies to Android and iOS only.
|
|
934
|
-
*/
|
|
935
|
-
publishScreenCaptureVideo;
|
|
936
|
-
/**
|
|
937
|
-
* Whether to publish the audio captured from the screen:true: Publish the audio captured from the screen.false: Publish the audio captured from the screen.This parameter applies to Android and iOS only.
|
|
938
|
-
*/
|
|
939
|
-
publishScreenCaptureAudio;
|
|
940
|
-
/**
|
|
941
|
-
* Whether to publish the video captured from the screen:true: Publish the video captured from the screen.false: (Default) Do not publish the video captured from the screen.
|
|
942
|
-
*/
|
|
943
|
-
publishScreenTrack;
|
|
944
|
-
/**
|
|
945
|
-
* Whether to publish the video captured from the second screen:true: Publish the video captured from the second screen.false: Do not publish the video captured from the second screen.
|
|
946
|
-
*/
|
|
947
|
-
publishSecondaryScreenTrack;
|
|
948
|
-
/**
|
|
949
|
-
* Whether to publish the audio captured from a custom source:true: Publish the audio captured from the custom source.false: Do not publish the captured audio from a custom source.
|
|
950
|
-
*/
|
|
951
|
-
publishCustomAudioTrack;
|
|
952
|
-
/**
|
|
953
|
-
* The ID of the custom audio source to publish. The default value is 0.If you have set sourceNumber in setExternalAudioSource to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.
|
|
954
|
-
*/
|
|
955
|
-
publishCustomAudioTrackId;
|
|
956
|
-
/**
|
|
957
|
-
* Whether to publish the video captured from a custom source:true: Publish the video captured from the custom source.false: Do not publish the captured video from a custom source.
|
|
958
|
-
*/
|
|
959
|
-
publishCustomVideoTrack;
|
|
960
|
-
/**
|
|
961
|
-
* Whether to publish the encoded video:true: Publish the encoded video.false: Do not publish the encoded video.
|
|
962
|
-
*/
|
|
963
|
-
publishEncodedVideoTrack;
|
|
964
|
-
/**
|
|
965
|
-
* Whether to publish the audio from the media player:true: Publish the audio from the media player.false: Do not publish the audio from the media player.
|
|
966
|
-
*/
|
|
967
|
-
publishMediaPlayerAudioTrack;
|
|
968
|
-
/**
|
|
969
|
-
* Whether to publish the video from the media player:true: Publish the video from the media player.false: Do not publish the video from the media player.
|
|
970
|
-
*/
|
|
971
|
-
publishMediaPlayerVideoTrack;
|
|
972
|
-
/**
|
|
973
|
-
* Whether to publish the local transcoded video:true: Publish the local transcoded video.false: Do not publish the local transcoded video.
|
|
974
|
-
*/
|
|
975
|
-
publishTranscodedVideoTrack;
|
|
976
|
-
/**
|
|
977
|
-
* Whether to automatically subscribe to all remote audio streams when the user joins a channel:true: Subscribe to all remote audio streams.false: Do not automatically subscribe to any remote audio streams.
|
|
978
|
-
*/
|
|
979
|
-
autoSubscribeAudio;
|
|
980
|
-
/**
|
|
981
|
-
* Whether to automatically subscribe to all remote video streams when the user joins the channel:true: Subscribe to all remote video streams.false: Do not automatically subscribe to any remote video streams.
|
|
982
|
-
*/
|
|
983
|
-
autoSubscribeVideo;
|
|
984
|
-
/**
|
|
985
|
-
* Whether to enable audio capturing or playback:true: Do not enable audio capturing or playback.false: Do not enable audio capturing or playback.
|
|
986
|
-
*/
|
|
987
|
-
enableAudioRecordingOrPlayout;
|
|
988
|
-
/**
|
|
989
|
-
* The ID of the media player to be published. The default value is 0.
|
|
990
|
-
*/
|
|
991
|
-
publishMediaPlayerId;
|
|
992
|
-
/**
|
|
993
|
-
* The user role. See ClientRoleType .
|
|
994
|
-
*/
|
|
995
|
-
clientRoleType;
|
|
996
|
-
/**
|
|
997
|
-
* The latency level of an audience member in interactive live streaming. See AudienceLatencyLevelType .
|
|
998
|
-
*/
|
|
999
|
-
audienceLatencyLevel;
|
|
1000
|
-
/**
|
|
1001
|
-
* The default video-stream type. See VideoStreamType .
|
|
1002
|
-
*/
|
|
1003
|
-
defaultVideoStreamType;
|
|
1004
|
-
/**
|
|
1005
|
-
* The channel profile. See ChannelProfileType .
|
|
1006
|
-
*/
|
|
1007
|
-
channelProfile;
|
|
1008
|
-
/**
|
|
1009
|
-
* @ignore
|
|
1010
|
-
*/
|
|
1011
|
-
audioDelayMs;
|
|
1012
|
-
/**
|
|
1013
|
-
* @ignore
|
|
1014
|
-
*/
|
|
1015
|
-
mediaPlayerAudioDelayMs;
|
|
1016
|
-
/**
|
|
1017
|
-
* (Optional) The token generated on your server for authentication. See This parameter takes effect only when calling updateChannelMediaOptions or updateChannelMediaOptionsEx .Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the initialize method for initializing the RTC engine, and those used by the joinChannel and joinChannelEx methods for joining the channel.
|
|
1018
|
-
*/
|
|
1019
|
-
token;
|
|
1020
|
-
/**
|
|
1021
|
-
* @ignore
|
|
1022
|
-
*/
|
|
1023
|
-
enableBuiltInMediaEncryption;
|
|
1024
|
-
/**
|
|
1025
|
-
* Whether to publish the sound of a metronome to remote users:true: Publish processed audio frames. Both the local user and remote users can hear the metronome.false: Do not publish the sound of the metronome. Only the local user can hear the metronome.
|
|
1026
|
-
*/
|
|
1027
|
-
publishRhythmPlayerTrack;
|
|
1028
|
-
/**
|
|
1029
|
-
* Whether to enable interactive mode:true: Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.false:Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the joinChannelEx method to join the other host's channel as an audience member, and set isInteractiveAudience to true.This parameter takes effect only when the user role is ClientRoleAudience.
|
|
1030
|
-
*/
|
|
1031
|
-
isInteractiveAudience;
|
|
1032
|
-
/**
|
|
1033
|
-
* The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
|
|
1034
|
-
*/
|
|
1035
|
-
customVideoTrackId;
|
|
1036
|
-
/**
|
|
1037
|
-
* Whether the audio stream being published is filtered according to the volume algorithm:true: The audio stream is not filtered. If the audio stream filter is not enabled, this setting does not takes effect.false: The audio stream is not filtered.If you need to enable this function, contact .
|
|
1038
|
-
*/
|
|
1039
|
-
isAudioFilterable;
|
|
1040
|
-
}
|
|
453
|
+
*
|
|
454
|
+
* Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection . For example, publishMicrophoneTrack , publishAudioTrack , publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack , publishScreenTrack , publishCustomVideoTrack , or publishEncodedVideoTrack can be set as true . Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
|
|
455
|
+
*/
|
|
456
|
+
var ChannelMediaOptions = /** @class */ (function () {
|
|
457
|
+
function ChannelMediaOptions() {
|
|
458
|
+
}
|
|
459
|
+
return ChannelMediaOptions;
|
|
460
|
+
}());
|
|
1041
461
|
exports.ChannelMediaOptions = ChannelMediaOptions;
|
|
1042
|
-
/**
|
|
1043
|
-
* @ignore
|
|
1044
|
-
*/
|
|
1045
|
-
var LocalProxyMode;
|
|
1046
|
-
(function (LocalProxyMode) {
|
|
1047
|
-
/**
|
|
1048
|
-
* @ignore
|
|
1049
|
-
*/
|
|
1050
|
-
LocalProxyMode[LocalProxyMode["ConnectivityFirst"] = 0] = "ConnectivityFirst";
|
|
1051
|
-
/**
|
|
1052
|
-
* @ignore
|
|
1053
|
-
*/
|
|
1054
|
-
LocalProxyMode[LocalProxyMode["LocalOnly"] = 1] = "LocalOnly";
|
|
1055
|
-
})(LocalProxyMode = exports.LocalProxyMode || (exports.LocalProxyMode = {}));
|
|
1056
462
|
/**
|
|
1057
463
|
* The cloud proxy type.
|
|
1058
464
|
*/
|
|
@@ -1087,150 +493,32 @@ var ProxyType;
|
|
|
1087
493
|
*/
|
|
1088
494
|
ProxyType[ProxyType["HttpsProxyType"] = 6] = "HttpsProxyType";
|
|
1089
495
|
})(ProxyType = exports.ProxyType || (exports.ProxyType = {}));
|
|
1090
|
-
/**
|
|
1091
|
-
* @ignore
|
|
1092
|
-
*/
|
|
1093
|
-
class LogUploadServerInfo {
|
|
1094
|
-
/**
|
|
1095
|
-
* @ignore
|
|
1096
|
-
*/
|
|
1097
|
-
serverDomain;
|
|
1098
|
-
/**
|
|
1099
|
-
* @ignore
|
|
1100
|
-
*/
|
|
1101
|
-
serverPath;
|
|
1102
|
-
/**
|
|
1103
|
-
* @ignore
|
|
1104
|
-
*/
|
|
1105
|
-
serverPort;
|
|
1106
|
-
/**
|
|
1107
|
-
* @ignore
|
|
1108
|
-
*/
|
|
1109
|
-
serverHttps;
|
|
1110
|
-
}
|
|
1111
|
-
exports.LogUploadServerInfo = LogUploadServerInfo;
|
|
1112
|
-
/**
|
|
1113
|
-
* @ignore
|
|
1114
|
-
*/
|
|
1115
|
-
class AdvancedConfigInfo {
|
|
1116
|
-
/**
|
|
1117
|
-
* @ignore
|
|
1118
|
-
*/
|
|
1119
|
-
logUploadServer;
|
|
1120
|
-
}
|
|
1121
|
-
exports.AdvancedConfigInfo = AdvancedConfigInfo;
|
|
1122
|
-
/**
|
|
1123
|
-
* @ignore
|
|
1124
|
-
*/
|
|
1125
|
-
class LocalAccessPointConfiguration {
|
|
1126
|
-
/**
|
|
1127
|
-
* @ignore
|
|
1128
|
-
*/
|
|
1129
|
-
ipList;
|
|
1130
|
-
/**
|
|
1131
|
-
* @ignore
|
|
1132
|
-
*/
|
|
1133
|
-
ipListSize;
|
|
1134
|
-
/**
|
|
1135
|
-
* @ignore
|
|
1136
|
-
*/
|
|
1137
|
-
domainList;
|
|
1138
|
-
/**
|
|
1139
|
-
* @ignore
|
|
1140
|
-
*/
|
|
1141
|
-
domainListSize;
|
|
1142
|
-
/**
|
|
1143
|
-
* @ignore
|
|
1144
|
-
*/
|
|
1145
|
-
verifyDomainName;
|
|
1146
|
-
/**
|
|
1147
|
-
* @ignore
|
|
1148
|
-
*/
|
|
1149
|
-
mode;
|
|
1150
|
-
/**
|
|
1151
|
-
* @ignore
|
|
1152
|
-
*/
|
|
1153
|
-
advancedConfig;
|
|
1154
|
-
}
|
|
1155
|
-
exports.LocalAccessPointConfiguration = LocalAccessPointConfiguration;
|
|
1156
496
|
/**
|
|
1157
497
|
* The options for leaving a channel.
|
|
1158
498
|
*/
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
/**
|
|
1165
|
-
* Whether to stop playing all audio effects when a user leaves the channel. true: (Default) Stop playing all audio effects.false: Do not stop playing any audio effect.
|
|
1166
|
-
*/
|
|
1167
|
-
stopAllEffect;
|
|
1168
|
-
/**
|
|
1169
|
-
* Whether to stop microphone recording when a user leaves the channel. true: (Default) Stop microphone recording.false: Do not stop microphone recording.
|
|
1170
|
-
*/
|
|
1171
|
-
stopMicrophoneRecording;
|
|
1172
|
-
}
|
|
499
|
+
var LeaveChannelOptions = /** @class */ (function () {
|
|
500
|
+
function LeaveChannelOptions() {
|
|
501
|
+
}
|
|
502
|
+
return LeaveChannelOptions;
|
|
503
|
+
}());
|
|
1173
504
|
exports.LeaveChannelOptions = LeaveChannelOptions;
|
|
1174
505
|
/**
|
|
1175
506
|
* Video device management methods.
|
|
1176
507
|
*/
|
|
1177
|
-
|
|
1178
|
-
|
|
508
|
+
var IVideoDeviceManager = /** @class */ (function () {
|
|
509
|
+
function IVideoDeviceManager() {
|
|
510
|
+
}
|
|
511
|
+
return IVideoDeviceManager;
|
|
512
|
+
}());
|
|
1179
513
|
exports.IVideoDeviceManager = IVideoDeviceManager;
|
|
1180
514
|
/**
|
|
1181
515
|
* Configurations for the RtcEngineContext instance.
|
|
1182
516
|
*/
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
/**
|
|
1189
|
-
* The channel profile. See ChannelProfileType .
|
|
1190
|
-
*/
|
|
1191
|
-
channelProfile;
|
|
1192
|
-
/**
|
|
1193
|
-
* @ignore
|
|
1194
|
-
*/
|
|
1195
|
-
license;
|
|
1196
|
-
/**
|
|
1197
|
-
* The audio scenarios. See AudioScenarioType . Under different audio scenarios, the device uses different volume types.
|
|
1198
|
-
*/
|
|
1199
|
-
audioScenario;
|
|
1200
|
-
/**
|
|
1201
|
-
* The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. The area codes support bitwise operation.
|
|
1202
|
-
*/
|
|
1203
|
-
areaCode;
|
|
1204
|
-
/**
|
|
1205
|
-
* The SDK log files are: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, and agorasdk.4.log.
|
|
1206
|
-
* The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log.
|
|
1207
|
-
* The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
|
|
1208
|
-
* The SDK writes the latest logs in agorasdk.log or agoraapi.log.
|
|
1209
|
-
* When agorasdk.log is full, the SDK processes the log files in the following order:
|
|
1210
|
-
* Delete the agorasdk.4.log file (if any).
|
|
1211
|
-
* Rename agorasdk.3.log to agorasdk.4.log.
|
|
1212
|
-
* Rename agorasdk.2.log to agorasdk.3.log.
|
|
1213
|
-
* Rename agorasdk.1.log to agorasdk.2.log.
|
|
1214
|
-
* Create a new agorasdk.log file. The overwrite rules for the agoraapi.log file are the same as for agorasdk.log. Sets the log file size. See LogConfig .By default, the SDK generates five SDK log files and five API call log files with the following rules:
|
|
1215
|
-
*/
|
|
1216
|
-
logConfig;
|
|
1217
|
-
/**
|
|
1218
|
-
* @ignore
|
|
1219
|
-
*/
|
|
1220
|
-
threadPriority;
|
|
1221
|
-
/**
|
|
1222
|
-
* @ignore
|
|
1223
|
-
*/
|
|
1224
|
-
useExternalEglContext;
|
|
1225
|
-
/**
|
|
1226
|
-
* Whether to enable domain name restriction:true: Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.false: (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
|
|
1227
|
-
*/
|
|
1228
|
-
domainLimit;
|
|
1229
|
-
/**
|
|
1230
|
-
* Whether to automatically register the Agora extensions when initializing IRtcEngine :true: (Default) Automatically register the Agora extensions when initializing IRtcEngine.false: Do not register the Agora extensions when initializing IRtcEngine. You need to call enableExtension to register the Agora extensions.
|
|
1231
|
-
*/
|
|
1232
|
-
autoRegisterAgoraExtensions;
|
|
1233
|
-
}
|
|
517
|
+
var RtcEngineContext = /** @class */ (function () {
|
|
518
|
+
function RtcEngineContext() {
|
|
519
|
+
}
|
|
520
|
+
return RtcEngineContext;
|
|
521
|
+
}());
|
|
1234
522
|
exports.RtcEngineContext = RtcEngineContext;
|
|
1235
523
|
/**
|
|
1236
524
|
* Metadata type of the observer. We only support video metadata for now.
|
|
@@ -1267,24 +555,11 @@ var MaxMetadataSizeType;
|
|
|
1267
555
|
/**
|
|
1268
556
|
* Media metadata.
|
|
1269
557
|
*/
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
/**
|
|
1276
|
-
* Buffer size for received or sent Metadata.
|
|
1277
|
-
*/
|
|
1278
|
-
size;
|
|
1279
|
-
/**
|
|
1280
|
-
* The buffer address of the received or sent Metadata.
|
|
1281
|
-
*/
|
|
1282
|
-
buffer;
|
|
1283
|
-
/**
|
|
1284
|
-
* The timestamp (ms) of Metadata.
|
|
1285
|
-
*/
|
|
1286
|
-
timeStampMs;
|
|
1287
|
-
}
|
|
558
|
+
var Metadata = /** @class */ (function () {
|
|
559
|
+
function Metadata() {
|
|
560
|
+
}
|
|
561
|
+
return Metadata;
|
|
562
|
+
}());
|
|
1288
563
|
exports.Metadata = Metadata;
|
|
1289
564
|
/**
|
|
1290
565
|
* The CDN streaming error.
|
|
@@ -1345,91 +620,40 @@ var DirectCdnStreamingState;
|
|
|
1345
620
|
/**
|
|
1346
621
|
* The statistics of the current CDN streaming.
|
|
1347
622
|
*/
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
/**
|
|
1354
|
-
* The height (px) of the video frame.
|
|
1355
|
-
*/
|
|
1356
|
-
videoHeight;
|
|
1357
|
-
/**
|
|
1358
|
-
* The frame rate (fps) of the current video frame.
|
|
1359
|
-
*/
|
|
1360
|
-
fps;
|
|
1361
|
-
/**
|
|
1362
|
-
* The bitrate (bps) of the current video frame.
|
|
1363
|
-
*/
|
|
1364
|
-
videoBitrate;
|
|
1365
|
-
/**
|
|
1366
|
-
* The bitrate (bps) of the current audio frame.
|
|
1367
|
-
*/
|
|
1368
|
-
audioBitrate;
|
|
1369
|
-
}
|
|
623
|
+
var DirectCdnStreamingStats = /** @class */ (function () {
|
|
624
|
+
function DirectCdnStreamingStats() {
|
|
625
|
+
}
|
|
626
|
+
return DirectCdnStreamingStats;
|
|
627
|
+
}());
|
|
1370
628
|
exports.DirectCdnStreamingStats = DirectCdnStreamingStats;
|
|
1371
629
|
/**
|
|
1372
630
|
* The media setting options for the host.
|
|
1373
631
|
*/
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
/**
|
|
1380
|
-
* Sets whether to publish the audio captured by the microphone:true: Publish the audio captured by the microphone.false: (Default) Do not publish the audio captured by the microphone.
|
|
1381
|
-
*/
|
|
1382
|
-
publishMicrophoneTrack;
|
|
1383
|
-
/**
|
|
1384
|
-
* Sets whether to publish the captured audio from a custom source:true: Publish the captured audio from a custom source.false: (Default) Do not publish the captured audio from the custom source.
|
|
1385
|
-
*/
|
|
1386
|
-
publishCustomAudioTrack;
|
|
1387
|
-
/**
|
|
1388
|
-
* Sets whether to publish the captured video from a custom source:true: Publish the captured video from a custom source.false: (Default) Do not publish the captured video from the custom source.
|
|
1389
|
-
*/
|
|
1390
|
-
publishCustomVideoTrack;
|
|
1391
|
-
/**
|
|
1392
|
-
* @ignore
|
|
1393
|
-
*/
|
|
1394
|
-
publishMediaPlayerAudioTrack;
|
|
1395
|
-
/**
|
|
1396
|
-
* @ignore
|
|
1397
|
-
*/
|
|
1398
|
-
publishMediaPlayerId;
|
|
1399
|
-
/**
|
|
1400
|
-
* The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
|
|
1401
|
-
*/
|
|
1402
|
-
customVideoTrackId;
|
|
1403
|
-
}
|
|
632
|
+
var DirectCdnStreamingMediaOptions = /** @class */ (function () {
|
|
633
|
+
function DirectCdnStreamingMediaOptions() {
|
|
634
|
+
}
|
|
635
|
+
return DirectCdnStreamingMediaOptions;
|
|
636
|
+
}());
|
|
1404
637
|
exports.DirectCdnStreamingMediaOptions = DirectCdnStreamingMediaOptions;
|
|
1405
638
|
/**
|
|
1406
639
|
* @ignore
|
|
1407
640
|
*/
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
/**
|
|
1414
|
-
* @ignore
|
|
1415
|
-
*/
|
|
1416
|
-
remoteUid;
|
|
1417
|
-
/**
|
|
1418
|
-
* @ignore
|
|
1419
|
-
*/
|
|
1420
|
-
channelId;
|
|
1421
|
-
/**
|
|
1422
|
-
* @ignore
|
|
1423
|
-
*/
|
|
1424
|
-
localUid;
|
|
1425
|
-
}
|
|
641
|
+
var ExtensionInfo = /** @class */ (function () {
|
|
642
|
+
function ExtensionInfo() {
|
|
643
|
+
}
|
|
644
|
+
return ExtensionInfo;
|
|
645
|
+
}());
|
|
1426
646
|
exports.ExtensionInfo = ExtensionInfo;
|
|
1427
647
|
/**
|
|
1428
648
|
* The basic interface of the Agora SDK that implements the core functions of real-time communication.
|
|
1429
|
-
*
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
649
|
+
*
|
|
650
|
+
* IRtcEngine provides the main methods that your app can call. Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.
|
|
651
|
+
*/
|
|
652
|
+
var IRtcEngine = /** @class */ (function () {
|
|
653
|
+
function IRtcEngine() {
|
|
654
|
+
}
|
|
655
|
+
return IRtcEngine;
|
|
656
|
+
}());
|
|
1433
657
|
exports.IRtcEngine = IRtcEngine;
|
|
1434
658
|
/**
|
|
1435
659
|
* @ignore
|
|
@@ -1764,42 +988,27 @@ var VideoProfileType;
|
|
|
1764
988
|
/**
|
|
1765
989
|
* SDK version information.
|
|
1766
990
|
*/
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
/**
|
|
1773
|
-
* SDK version information. String format, such as 4.0.0.
|
|
1774
|
-
*/
|
|
1775
|
-
version;
|
|
1776
|
-
}
|
|
991
|
+
var SDKBuildInfo = /** @class */ (function () {
|
|
992
|
+
function SDKBuildInfo() {
|
|
993
|
+
}
|
|
994
|
+
return SDKBuildInfo;
|
|
995
|
+
}());
|
|
1777
996
|
exports.SDKBuildInfo = SDKBuildInfo;
|
|
1778
997
|
/**
|
|
1779
998
|
* The VideoDeviceInfo class that contains the ID and device name of the video devices.
|
|
1780
999
|
*/
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
/**
|
|
1787
|
-
* The device name.
|
|
1788
|
-
*/
|
|
1789
|
-
deviceName;
|
|
1790
|
-
}
|
|
1000
|
+
var VideoDeviceInfo = /** @class */ (function () {
|
|
1001
|
+
function VideoDeviceInfo() {
|
|
1002
|
+
}
|
|
1003
|
+
return VideoDeviceInfo;
|
|
1004
|
+
}());
|
|
1791
1005
|
exports.VideoDeviceInfo = VideoDeviceInfo;
|
|
1792
1006
|
/**
|
|
1793
1007
|
* The AudioDeviceInfo class that contains the ID and device name of the audio devices.
|
|
1794
1008
|
*/
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
/**
|
|
1801
|
-
* The device name.
|
|
1802
|
-
*/
|
|
1803
|
-
deviceName;
|
|
1804
|
-
}
|
|
1009
|
+
var AudioDeviceInfo = /** @class */ (function () {
|
|
1010
|
+
function AudioDeviceInfo() {
|
|
1011
|
+
}
|
|
1012
|
+
return AudioDeviceInfo;
|
|
1013
|
+
}());
|
|
1805
1014
|
exports.AudioDeviceInfo = AudioDeviceInfo;
|