@agora-js/media 4.20.1-1 → 4.20.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AgoraRTC_N-media.esm.mjs +2 -2
- package/AgoraRTC_N-media.js +3 -3
- package/media.d.ts +109 -181
- package/package.json +4 -4
- package/rtc-sdk-media_en.d.ts +58 -110
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agora-js/media",
|
|
3
|
-
"version": "4.20.
|
|
3
|
+
"version": "4.20.2",
|
|
4
4
|
"description": "media module across @agora-js packages",
|
|
5
5
|
"main": "AgoraRTC_N-media.js",
|
|
6
6
|
"module": "AgoraRTC_N-media.esm.mjs",
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"homepage": "https://api-ref.agora.io/en/voice-sdk/web/4.x/index.html",
|
|
24
24
|
"peerDependencies": {},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@agora-js/shared": "4.20.
|
|
27
|
-
"@agora-js/report": "4.20.
|
|
28
|
-
"axios": "^
|
|
26
|
+
"@agora-js/shared": "4.20.2",
|
|
27
|
+
"@agora-js/report": "4.20.2",
|
|
28
|
+
"axios": "^1.6.7",
|
|
29
29
|
"agora-rte-extension": "^1.2.4",
|
|
30
30
|
"webrtc-adapter": "8.2.0",
|
|
31
31
|
"pako": "^2.1.0"
|
package/rtc-sdk-media_en.d.ts
CHANGED
|
@@ -487,7 +487,7 @@ export declare class CameraVideoTrack extends LocalVideoTrack implements ICamera
|
|
|
487
487
|
_enabled: boolean;
|
|
488
488
|
_deviceName: string;
|
|
489
489
|
get __className__(): string;
|
|
490
|
-
constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?:
|
|
490
|
+
constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string);
|
|
491
491
|
setDevice(deviceId: string | RequiredOnlyOneOf<{
|
|
492
492
|
facingMode: VideoFacingModeEnum;
|
|
493
493
|
deviceId: string;
|
|
@@ -533,7 +533,7 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
533
533
|
*/
|
|
534
534
|
cameraId?: string;
|
|
535
535
|
/**
|
|
536
|
-
*
|
|
536
|
+
* @since
|
|
537
537
|
* <br>   *4.0.0*
|
|
538
538
|
*
|
|
539
539
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -547,11 +547,11 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
547
547
|
*
|
|
548
548
|
* > Note: This method is only supported on Chrome.
|
|
549
549
|
*/
|
|
550
|
-
optimizationMode?:
|
|
550
|
+
optimizationMode?: "motion" | "detail";
|
|
551
551
|
/**
|
|
552
552
|
* @ignore
|
|
553
553
|
*
|
|
554
|
-
*
|
|
554
|
+
* @since
|
|
555
555
|
* <br>   *4.18.0*
|
|
556
556
|
*
|
|
557
557
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -657,7 +657,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
657
657
|
*/
|
|
658
658
|
mediaStreamTrack: MediaStreamTrack;
|
|
659
659
|
/**
|
|
660
|
-
*
|
|
660
|
+
* @since
|
|
661
661
|
* <br>   *4.17.1*
|
|
662
662
|
*
|
|
663
663
|
* Width of the video.
|
|
@@ -668,7 +668,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
668
668
|
*/
|
|
669
669
|
width?: number | ConstrainLong;
|
|
670
670
|
/**
|
|
671
|
-
*
|
|
671
|
+
* @since
|
|
672
672
|
* <br>   *4.17.1*
|
|
673
673
|
*
|
|
674
674
|
* Height of the video.
|
|
@@ -679,7 +679,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
679
679
|
*/
|
|
680
680
|
height?: number | ConstrainLong;
|
|
681
681
|
/**
|
|
682
|
-
*
|
|
682
|
+
* @since
|
|
683
683
|
* <br>   *4.17.1*
|
|
684
684
|
*
|
|
685
685
|
* Frame rate of the video (fps).
|
|
@@ -698,7 +698,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
698
698
|
*/
|
|
699
699
|
bitrateMax?: number;
|
|
700
700
|
/**
|
|
701
|
-
*
|
|
701
|
+
* @since
|
|
702
702
|
* <br>   *4.0.0*
|
|
703
703
|
*
|
|
704
704
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -716,7 +716,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
716
716
|
/**
|
|
717
717
|
* @ignore
|
|
718
718
|
*
|
|
719
|
-
*
|
|
719
|
+
* @since
|
|
720
720
|
* <br>   *4.18.0*
|
|
721
721
|
*
|
|
722
722
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -897,7 +897,7 @@ declare function event_beauty_effect_overload(): void;
|
|
|
897
897
|
declare function event_first_frame_decoded(): void;
|
|
898
898
|
|
|
899
899
|
/**
|
|
900
|
-
*
|
|
900
|
+
* @since
|
|
901
901
|
* <br>   *4.20.1*
|
|
902
902
|
*
|
|
903
903
|
* Parsing SEI data from the H.264 video stream triggers this event, which returns the SEI data.
|
|
@@ -939,8 +939,6 @@ declare function event_source_state_change(currentState: AudioSourceState): void
|
|
|
939
939
|
*/
|
|
940
940
|
declare function event_track_ended(): void;
|
|
941
941
|
|
|
942
|
-
export declare function event_track_updated(track: MediaStreamTrack): void;
|
|
943
|
-
|
|
944
942
|
/**
|
|
945
943
|
* Occurs when the `RTCRtpTransceiver` instance of the current track is updated.
|
|
946
944
|
*
|
|
@@ -982,7 +980,7 @@ declare function event_user_datachannel_message(data: ArrayBuffer): void;
|
|
|
982
980
|
declare function event_user_datachannel_open(): void;
|
|
983
981
|
|
|
984
982
|
/**
|
|
985
|
-
*
|
|
983
|
+
* @since
|
|
986
984
|
* <br>   *4.8.0*
|
|
987
985
|
*
|
|
988
986
|
* Indicates the visibility of the `<video>` HTML tag.
|
|
@@ -998,7 +996,7 @@ declare function event_user_datachannel_open(): void;
|
|
|
998
996
|
declare function event_video_element_visible_status(data?: CheckVideoVisibleResult): void;
|
|
999
997
|
|
|
1000
998
|
/**
|
|
1001
|
-
*
|
|
999
|
+
* @since
|
|
1002
1000
|
* <br>   *4.8.0*
|
|
1003
1001
|
*
|
|
1004
1002
|
* Indicates the visibility of the `<video>` HTML tag.
|
|
@@ -1066,8 +1064,6 @@ export declare function getAudioEncoderConfiguration(profile: AudioEncoderConfig
|
|
|
1066
1064
|
|
|
1067
1065
|
export declare function getBitrateConstrainRange(width: number, height: number, frameRate: number, bitrateMin?: number, bitrateMax?: number): DoubleRange;
|
|
1068
1066
|
|
|
1069
|
-
export declare function getBitrateFromResAndFps(width: number, height: number, fps: number): Required<DoubleRange>;
|
|
1070
|
-
|
|
1071
1067
|
export declare function getCompatibility(): AgoraRTCCompatibility;
|
|
1072
1068
|
|
|
1073
1069
|
export declare function getConstraintsFromCameraConfig(config: CameraVideoTrackInitConfig): MediaTrackConstraints;
|
|
@@ -1084,14 +1080,6 @@ export declare function getElectronScreenStreamByUserSelect(config: ScreenConstr
|
|
|
1084
1080
|
|
|
1085
1081
|
export declare function getLocalStream(config: GetUserMediaConfig, id: string): Promise<MediaStream>;
|
|
1086
1082
|
|
|
1087
|
-
export declare const getOriginSenderConfig: (track: LocalVideoTrack) => {
|
|
1088
|
-
frameRate: number;
|
|
1089
|
-
bitrateMax: number;
|
|
1090
|
-
bitrateMin: number;
|
|
1091
|
-
scaleResolutionDownBy: number;
|
|
1092
|
-
scale: number;
|
|
1093
|
-
};
|
|
1094
|
-
|
|
1095
1083
|
export declare function getScalabilityConfiguration(profile: SVCConfiguration | SVCConfigurationPreset): SVCConfiguration;
|
|
1096
1084
|
|
|
1097
1085
|
export declare function getScreenEncoderConfiguration(profile: VideoEncoderConfiguration | ScreenEncoderConfigurationPreset | string): VideoEncoderConfiguration;
|
|
@@ -1140,7 +1128,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1140
1128
|
*/
|
|
1141
1129
|
duration: number;
|
|
1142
1130
|
/**
|
|
1143
|
-
*
|
|
1131
|
+
* @since
|
|
1144
1132
|
* <br>   *4.18.0*
|
|
1145
1133
|
*
|
|
1146
1134
|
* The playback speed of the current audio file. Valid range is [50, 400], where:
|
|
@@ -1195,7 +1183,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1195
1183
|
*/
|
|
1196
1184
|
stopProcessAudioBuffer(): void;
|
|
1197
1185
|
/**
|
|
1198
|
-
*
|
|
1186
|
+
* @since
|
|
1199
1187
|
* <br>   *4.18.0*
|
|
1200
1188
|
*
|
|
1201
1189
|
* Sets the playback speed for the current audio file.
|
|
@@ -1235,7 +1223,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1235
1223
|
deviceId: string;
|
|
1236
1224
|
}>): Promise<void>;
|
|
1237
1225
|
/**
|
|
1238
|
-
*
|
|
1226
|
+
* @since
|
|
1239
1227
|
* <br>   *4.0.0*
|
|
1240
1228
|
*
|
|
1241
1229
|
* Enables/Disables the track.
|
|
@@ -1252,7 +1240,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1252
1240
|
*/
|
|
1253
1241
|
setEnabled(enabled: boolean): Promise<void>;
|
|
1254
1242
|
/**
|
|
1255
|
-
*
|
|
1243
|
+
* @since
|
|
1256
1244
|
* <br>   *4.19.0*
|
|
1257
1245
|
*
|
|
1258
1246
|
* Clones the current video track to create a new video track.
|
|
@@ -1344,7 +1332,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
1344
1332
|
*/
|
|
1345
1333
|
play(): void;
|
|
1346
1334
|
/**
|
|
1347
|
-
*
|
|
1335
|
+
* @since
|
|
1348
1336
|
* <br>   *4.1.0*
|
|
1349
1337
|
*
|
|
1350
1338
|
* > Note:
|
|
@@ -1358,7 +1346,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
1358
1346
|
/**
|
|
1359
1347
|
* Gets the statistics of a local audio track.
|
|
1360
1348
|
*
|
|
1361
|
-
*
|
|
1349
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
1362
1350
|
*/
|
|
1363
1351
|
getStats(): LocalAudioTrackStats;
|
|
1364
1352
|
/**
|
|
@@ -1370,14 +1358,14 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
1370
1358
|
*/
|
|
1371
1359
|
pipe(processor: IAudioProcessor): IAudioProcessor;
|
|
1372
1360
|
/**
|
|
1373
|
-
*
|
|
1361
|
+
* @since
|
|
1374
1362
|
* <br>   *4.10.0*
|
|
1375
1363
|
*
|
|
1376
1364
|
* Removes the `Processor` inserted to the local audio track.
|
|
1377
1365
|
*/
|
|
1378
1366
|
unpipe(): void;
|
|
1379
1367
|
/**
|
|
1380
|
-
*
|
|
1368
|
+
* @since
|
|
1381
1369
|
* <br>   *4.10.0*
|
|
1382
1370
|
*
|
|
1383
1371
|
* The destination of the current processing pipeline on the local audio track.
|
|
@@ -1402,7 +1390,6 @@ export declare interface ILocalDataChannel extends IDataChannel {
|
|
|
1402
1390
|
* `LocalTrack` is the basic interface for local tracks, providing public methods for [LocalAudioTrack]{@link ILocalAudioTrack} and [LocalVideoTrack]{@link ILocalVideoTrack}.
|
|
1403
1391
|
*/
|
|
1404
1392
|
export declare interface ILocalTrack extends ITrack {
|
|
1405
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
1406
1393
|
/**
|
|
1407
1394
|
* @param event The event name.
|
|
1408
1395
|
* @param listener See [track-ended]{@link event_track_ended}.
|
|
@@ -1415,7 +1402,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
1415
1402
|
*/
|
|
1416
1403
|
on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
|
|
1417
1404
|
/**
|
|
1418
|
-
*
|
|
1405
|
+
* @since
|
|
1419
1406
|
* <br>   *4.0.0*
|
|
1420
1407
|
*
|
|
1421
1408
|
* Enables/Disables the track.
|
|
@@ -1432,7 +1419,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
1432
1419
|
*/
|
|
1433
1420
|
setEnabled(enabled: boolean): Promise<void>;
|
|
1434
1421
|
/**
|
|
1435
|
-
*
|
|
1422
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
1436
1423
|
*
|
|
1437
1424
|
* Gets the statistics of a local track.
|
|
1438
1425
|
*
|
|
@@ -1451,7 +1438,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
1451
1438
|
/**
|
|
1452
1439
|
* Sends or stops sending the media data of the track.
|
|
1453
1440
|
*
|
|
1454
|
-
*
|
|
1441
|
+
* @since
|
|
1455
1442
|
* <br>   *4.6.0*
|
|
1456
1443
|
*
|
|
1457
1444
|
* If the track is published, a successful call of `setMuted(true)` triggers the [user-unpublished]{@link IAgoraRTCClient.event_user_unpublished} event on the remote client, and a successful call of `setMuted(false)` triggers the [user-published]{@link IAgoraRTCClient.event_user_published} event.
|
|
@@ -1482,7 +1469,6 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
1482
1469
|
* Inherited from `LocalVideoTrack`, [CameraVideoTrack]{@link ICameraVideoTrack} is an interface for the video captured by a local camera and adds several camera-related functions.
|
|
1483
1470
|
*/
|
|
1484
1471
|
export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
1485
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
1486
1472
|
/** @internal */
|
|
1487
1473
|
on(event: "beauty-effect-overload", listener: typeof event_beauty_effect_overload): void;
|
|
1488
1474
|
/**
|
|
@@ -1513,11 +1499,11 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
1513
1499
|
/**
|
|
1514
1500
|
* Gets the statistics of a local video track.
|
|
1515
1501
|
*
|
|
1516
|
-
*
|
|
1502
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
1517
1503
|
*/
|
|
1518
1504
|
getStats(): LocalVideoTrackStats;
|
|
1519
1505
|
/**
|
|
1520
|
-
*
|
|
1506
|
+
* @since
|
|
1521
1507
|
* <br>   *4.19.0*
|
|
1522
1508
|
*
|
|
1523
1509
|
* Clones the current video track to create a new video track.
|
|
@@ -1552,7 +1538,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
1552
1538
|
*/
|
|
1553
1539
|
setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
|
|
1554
1540
|
/**
|
|
1555
|
-
*
|
|
1541
|
+
* @since
|
|
1556
1542
|
* <br>   *4.1.0*
|
|
1557
1543
|
*
|
|
1558
1544
|
* Gets the data of the video frame being rendered.
|
|
@@ -1568,7 +1554,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
1568
1554
|
*/
|
|
1569
1555
|
getCurrentFrameImage(imageType: string, quality: number): Promise<ImageTypedData>;
|
|
1570
1556
|
/**
|
|
1571
|
-
*
|
|
1557
|
+
* @since
|
|
1572
1558
|
* <br>   *4.2.0*
|
|
1573
1559
|
*
|
|
1574
1560
|
* Sets the video transmission optimization mode.
|
|
@@ -1590,7 +1576,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
1590
1576
|
*/
|
|
1591
1577
|
setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>;
|
|
1592
1578
|
/**
|
|
1593
|
-
*
|
|
1579
|
+
* @since
|
|
1594
1580
|
* <br>   *4.8.0*
|
|
1595
1581
|
*
|
|
1596
1582
|
* Gets the visibility of the `<video>` HTML tag.
|
|
@@ -1612,21 +1598,21 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
1612
1598
|
*/
|
|
1613
1599
|
pipe(processor: IBaseProcessor): IBaseProcessor;
|
|
1614
1600
|
/**
|
|
1615
|
-
*
|
|
1601
|
+
* @since
|
|
1616
1602
|
* <br>   *4.10.0*
|
|
1617
1603
|
*
|
|
1618
1604
|
* Removes the `Processor` inserted to the local video track.
|
|
1619
1605
|
*/
|
|
1620
1606
|
unpipe(): void;
|
|
1621
1607
|
/**
|
|
1622
|
-
*
|
|
1608
|
+
* @since
|
|
1623
1609
|
* <br>   *4.10.0*
|
|
1624
1610
|
*
|
|
1625
1611
|
* The destination of the current processing pipeline on the local video track.
|
|
1626
1612
|
*/
|
|
1627
1613
|
processorDestination: IBaseProcessor;
|
|
1628
1614
|
/**
|
|
1629
|
-
*
|
|
1615
|
+
* @since
|
|
1630
1616
|
* <br>   *4.17.0*
|
|
1631
1617
|
*
|
|
1632
1618
|
* Replaces the local video track.
|
|
@@ -1698,7 +1684,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
|
|
|
1698
1684
|
*/
|
|
1699
1685
|
setDevice(deviceId: string): Promise<void>;
|
|
1700
1686
|
/**
|
|
1701
|
-
*
|
|
1687
|
+
* @since
|
|
1702
1688
|
* <br>   *4.0.0*
|
|
1703
1689
|
*
|
|
1704
1690
|
* Enables/Disables the track.
|
|
@@ -1747,7 +1733,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
1747
1733
|
*/
|
|
1748
1734
|
play(): void;
|
|
1749
1735
|
/**
|
|
1750
|
-
*
|
|
1736
|
+
* @since
|
|
1751
1737
|
* <br>   *4.1.0*
|
|
1752
1738
|
*
|
|
1753
1739
|
* Sets the audio playback device, for example, the speaker.
|
|
@@ -1795,7 +1781,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
1795
1781
|
*/
|
|
1796
1782
|
getVolumeLevel(): number;
|
|
1797
1783
|
/**
|
|
1798
|
-
*
|
|
1784
|
+
* @since
|
|
1799
1785
|
* <br>   *4.13.0*
|
|
1800
1786
|
*
|
|
1801
1787
|
* Inserts a `Processor` to the remote audio track.
|
|
@@ -1806,14 +1792,14 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
1806
1792
|
*/
|
|
1807
1793
|
pipe(processor: IAudioProcessor): IAudioProcessor;
|
|
1808
1794
|
/**
|
|
1809
|
-
*
|
|
1795
|
+
* @since
|
|
1810
1796
|
* <br>   *4.13.0*
|
|
1811
1797
|
*
|
|
1812
1798
|
* Removes the `Processor` inserted to the remote audio track.
|
|
1813
1799
|
*/
|
|
1814
1800
|
unpipe(): void;
|
|
1815
1801
|
/**
|
|
1816
|
-
*
|
|
1802
|
+
* @since
|
|
1817
1803
|
* <br>   *4.13.0*
|
|
1818
1804
|
*
|
|
1819
1805
|
* The destination of the current processing pipeline on the remote audio track.
|
|
@@ -1839,7 +1825,6 @@ export declare interface IRemoteDataChannel extends IDataChannel {
|
|
|
1839
1825
|
* `RemoteTrack` is the basic interface for remote tracks, providing public methods for [RemoteAudioTrack]{@link IRemoteAudioTrack} and [RemoteVideoTrack]{@link IRemoteVideoTrack}.
|
|
1840
1826
|
*/
|
|
1841
1827
|
export declare interface IRemoteTrack extends ITrack {
|
|
1842
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
1843
1828
|
/**
|
|
1844
1829
|
* @param event The event name.
|
|
1845
1830
|
* @param listener See [first-frame-decoded]{@link event_first_frame_decoded}.
|
|
@@ -1860,7 +1845,7 @@ export declare interface IRemoteTrack extends ITrack {
|
|
|
1860
1845
|
/**
|
|
1861
1846
|
* Gets the statistics of a remote track.
|
|
1862
1847
|
*
|
|
1863
|
-
*
|
|
1848
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} and [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats} instead.
|
|
1864
1849
|
* @return An [[RemoteAudioTrackStats]] or [[RemoteVideoTrackStats]] object.
|
|
1865
1850
|
*/
|
|
1866
1851
|
getStats(): RemoteAudioTrackStats | RemoteVideoTrackStats;
|
|
@@ -1876,7 +1861,6 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
1876
1861
|
* @param event The event name.
|
|
1877
1862
|
* @param listener See [video-state-changed]{@link event_video_state_changed}.
|
|
1878
1863
|
*/
|
|
1879
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
1880
1864
|
on(event: "video-state-changed", listener: typeof event_video_state_changed): void;
|
|
1881
1865
|
/**
|
|
1882
1866
|
* @param event The event name.
|
|
@@ -1916,7 +1900,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
1916
1900
|
*/
|
|
1917
1901
|
play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
|
|
1918
1902
|
/**
|
|
1919
|
-
*
|
|
1903
|
+
* @since
|
|
1920
1904
|
* <br>   *4.1.0*
|
|
1921
1905
|
*
|
|
1922
1906
|
* Gets the data of the video frame being rendered.
|
|
@@ -1927,7 +1911,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
1927
1911
|
*/
|
|
1928
1912
|
getCurrentFrameData(): ImageData;
|
|
1929
1913
|
/**
|
|
1930
|
-
*
|
|
1914
|
+
* @since
|
|
1931
1915
|
* <br>   *4.8.0*
|
|
1932
1916
|
*
|
|
1933
1917
|
* Gets the visibility of the `<video>` HTML tag.
|
|
@@ -1941,7 +1925,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
1941
1925
|
*/
|
|
1942
1926
|
getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
|
|
1943
1927
|
/**
|
|
1944
|
-
*
|
|
1928
|
+
* @since
|
|
1945
1929
|
* <br>   *4.13.0*
|
|
1946
1930
|
*
|
|
1947
1931
|
* Inserts a `Processor` to the remote video track.
|
|
@@ -1952,14 +1936,14 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
1952
1936
|
*/
|
|
1953
1937
|
pipe(processor: IBaseProcessor): IBaseProcessor;
|
|
1954
1938
|
/**
|
|
1955
|
-
*
|
|
1939
|
+
* @since
|
|
1956
1940
|
* <br>   *4.13.0*
|
|
1957
1941
|
*
|
|
1958
1942
|
* Removes the `Processor` inserted to the remote video track.
|
|
1959
1943
|
*/
|
|
1960
1944
|
unpipe(): void;
|
|
1961
1945
|
/**
|
|
1962
|
-
*
|
|
1946
|
+
* @since
|
|
1963
1947
|
* <br>   *4.13.0*
|
|
1964
1948
|
*
|
|
1965
1949
|
* The destination of the current processing pipeline on the remote video track.
|
|
@@ -2184,15 +2168,9 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
2184
2168
|
protected _statsTimer: number | null;
|
|
2185
2169
|
private _previousVideoVisibleStatus;
|
|
2186
2170
|
private _clearPreviousVideoVisibleStatus;
|
|
2187
|
-
_encoderConfig?: Partial<VideoEncoderConfiguration
|
|
2188
|
-
scale: number;
|
|
2189
|
-
}>;
|
|
2171
|
+
_encoderConfig?: Partial<VideoEncoderConfiguration>;
|
|
2190
2172
|
_scalabilityMode?: SVCConfiguration;
|
|
2191
|
-
_optimizationMode?:
|
|
2192
|
-
_qualityLimitationReason?: QualityLimitationReason;
|
|
2193
|
-
private _originalSenderConfig?;
|
|
2194
|
-
_adaptationConfig?: VideoSenderConfig;
|
|
2195
|
-
private _adaptationTimer;
|
|
2173
|
+
_optimizationMode?: "motion" | "detail" | "balanced";
|
|
2196
2174
|
_videoHeight?: number;
|
|
2197
2175
|
_videoWidth?: number;
|
|
2198
2176
|
_forceBitrateLimit?: {
|
|
@@ -2206,13 +2184,13 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
2206
2184
|
protected get processorContext(): VideoProcessorContext;
|
|
2207
2185
|
protected set processorContext(ctx: VideoProcessorContext);
|
|
2208
2186
|
get __className__(): string;
|
|
2209
|
-
constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?:
|
|
2187
|
+
constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string, hints?: TrackHint[]);
|
|
2210
2188
|
play(element: HTMLElement | HTMLVideoElement | string, config?: VideoPlayerConfig): void;
|
|
2211
2189
|
stop(): void;
|
|
2212
2190
|
setEnabled(enabled: boolean, skipChangeState?: boolean): Promise<void>;
|
|
2213
2191
|
setMuted(muted: boolean): Promise<void>;
|
|
2214
2192
|
setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset, doNotRenegoation?: boolean): Promise<void>;
|
|
2215
|
-
getStats(
|
|
2193
|
+
getStats(): LocalVideoTrackStats;
|
|
2216
2194
|
setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
|
|
2217
2195
|
getCurrentFrameData(): ImageData;
|
|
2218
2196
|
getCurrentFrameImage(imageType: string, quality?: number): Promise<ImageTypedData>;
|
|
@@ -2220,10 +2198,7 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
2220
2198
|
max_bitrate: number;
|
|
2221
2199
|
min_bitrate: number;
|
|
2222
2200
|
}): Promise<void>;
|
|
2223
|
-
setOptimizationMode(mode:
|
|
2224
|
-
protected applyAdaptation(config: VideoSenderConfig): Promise<void>;
|
|
2225
|
-
startVideoStreamAdapter(): void;
|
|
2226
|
-
protected updateAdapterConfig(): void;
|
|
2201
|
+
setOptimizationMode(mode: "motion" | "detail" | "balanced"): Promise<void>;
|
|
2227
2202
|
setScalabiltyMode(mode: SVCConfiguration): void;
|
|
2228
2203
|
updateMediaStreamTrackResolution(): void;
|
|
2229
2204
|
protected _updatePlayerSource(): void;
|
|
@@ -2475,8 +2450,6 @@ export declare class MixingAudioTrack extends LocalAudioTrack {
|
|
|
2475
2450
|
_updateRtpTransceiver(transceiver: RTCRtpTransceiver): void;
|
|
2476
2451
|
}
|
|
2477
2452
|
|
|
2478
|
-
export declare type OptimizationMode = "motion" | "detail";
|
|
2479
|
-
|
|
2480
2453
|
export declare interface PlayerConfig extends VideoPlayerConfig {
|
|
2481
2454
|
trackId: string;
|
|
2482
2455
|
element: HTMLElement;
|
|
@@ -2501,13 +2474,6 @@ export declare interface ProcessorUsageStats {
|
|
|
2501
2474
|
totalTs: number;
|
|
2502
2475
|
}
|
|
2503
2476
|
|
|
2504
|
-
declare enum QualityLimitationReason {
|
|
2505
|
-
BANDWIDTH = "bandwidth",
|
|
2506
|
-
CPU = "cpu",
|
|
2507
|
-
NONE = "none",
|
|
2508
|
-
OTHER = "other"
|
|
2509
|
-
}
|
|
2510
|
-
|
|
2511
2477
|
export declare class RemoteAudioTrack extends RemoteTrack implements IRemoteAudioTrack {
|
|
2512
2478
|
readonly trackMediaType: "audio" | "video";
|
|
2513
2479
|
_source: AudioTrackSource | FakeTrackSource;
|
|
@@ -2886,13 +2852,13 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2886
2852
|
extensionId?: string;
|
|
2887
2853
|
/**
|
|
2888
2854
|
*
|
|
2889
|
-
*
|
|
2855
|
+
* @deprecated from v4.17.1. Use {@link displaySurface} instead.
|
|
2890
2856
|
*
|
|
2891
2857
|
* The type of the source for screen sharing.
|
|
2892
2858
|
*/
|
|
2893
2859
|
screenSourceType?: ScreenSourceType;
|
|
2894
2860
|
/**
|
|
2895
|
-
*
|
|
2861
|
+
* @since
|
|
2896
2862
|
* <br>   *4.0.0*
|
|
2897
2863
|
*
|
|
2898
2864
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -2909,7 +2875,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2909
2875
|
/**
|
|
2910
2876
|
* @ignore
|
|
2911
2877
|
*
|
|
2912
|
-
*
|
|
2878
|
+
* @since
|
|
2913
2879
|
* <br>   *4.18.0*
|
|
2914
2880
|
*
|
|
2915
2881
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -2921,7 +2887,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2921
2887
|
scalabiltyMode?: SVCConfiguration | SVCConfigurationPreset;
|
|
2922
2888
|
/**
|
|
2923
2889
|
*
|
|
2924
|
-
*
|
|
2890
|
+
* @since
|
|
2925
2891
|
* <br>   *4.17.1*
|
|
2926
2892
|
*
|
|
2927
2893
|
* The pre-selected pane in the media picker. See [displaySurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface) for details.
|
|
@@ -2931,7 +2897,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2931
2897
|
displaySurface?: "browser" | "window" | "monitor";
|
|
2932
2898
|
/**
|
|
2933
2899
|
*
|
|
2934
|
-
*
|
|
2900
|
+
* @since
|
|
2935
2901
|
* <br>   *4.17.1*
|
|
2936
2902
|
*
|
|
2937
2903
|
* Whether to allow the user to share the current tab:
|
|
@@ -2947,7 +2913,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2947
2913
|
selfBrowserSurface?: "include" | "exclude";
|
|
2948
2914
|
/**
|
|
2949
2915
|
*
|
|
2950
|
-
*
|
|
2916
|
+
* @since
|
|
2951
2917
|
* <br>   *4.17.1*
|
|
2952
2918
|
*
|
|
2953
2919
|
* Whether to allow the user to dynamically switch between shared tabs:
|
|
@@ -2961,7 +2927,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2961
2927
|
surfaceSwitching?: "include" | "exclude";
|
|
2962
2928
|
/**
|
|
2963
2929
|
*
|
|
2964
|
-
*
|
|
2930
|
+
* @since
|
|
2965
2931
|
* <br>   *4.17.1*
|
|
2966
2932
|
*
|
|
2967
2933
|
* Whether to capture system audio:
|
|
@@ -2975,12 +2941,6 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
2975
2941
|
systemAudio?: "include" | "exclude";
|
|
2976
2942
|
}
|
|
2977
2943
|
|
|
2978
|
-
export declare type SenderConfig = {
|
|
2979
|
-
bitrateMax: number;
|
|
2980
|
-
bitrateMin: number;
|
|
2981
|
-
scaleResolutionDownBy: number;
|
|
2982
|
-
};
|
|
2983
|
-
|
|
2984
2944
|
export declare function silenceScriptProcessHandler(e: AudioProcessingEvent): AudioBuffer;
|
|
2985
2945
|
|
|
2986
2946
|
export declare interface StatsRegistry {
|
|
@@ -3027,7 +2987,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
|
|
|
3027
2987
|
|
|
3028
2988
|
/**
|
|
3029
2989
|
* @ignore
|
|
3030
|
-
*
|
|
2990
|
+
* @since
|
|
3031
2991
|
* <br>   *4.18.0*
|
|
3032
2992
|
*
|
|
3033
2993
|
* Custom SVC encoding configurations.
|
|
@@ -3051,7 +3011,7 @@ export declare interface SVCConfiguration {
|
|
|
3051
3011
|
/**
|
|
3052
3012
|
* @ignore
|
|
3053
3013
|
*
|
|
3054
|
-
*
|
|
3014
|
+
* @since
|
|
3055
3015
|
* <br>   *4.18.0*
|
|
3056
3016
|
*
|
|
3057
3017
|
* The preset SVC configurations provided by the SDK.
|
|
@@ -3076,9 +3036,7 @@ export declare abstract class Track extends EventEmitter implements ITrack {
|
|
|
3076
3036
|
_hints: TrackHint[];
|
|
3077
3037
|
_isClosed: boolean;
|
|
3078
3038
|
_originMediaStreamTrack: MediaStreamTrack;
|
|
3079
|
-
|
|
3080
|
-
set _mediaStreamTrack(track: MediaStreamTrack);
|
|
3081
|
-
get _mediaStreamTrack(): MediaStreamTrack;
|
|
3039
|
+
_mediaStreamTrack: MediaStreamTrack;
|
|
3082
3040
|
_external: ExternalMethods;
|
|
3083
3041
|
constructor(track: MediaStreamTrack, trackId?: string);
|
|
3084
3042
|
toString(): string;
|
|
@@ -3095,8 +3053,7 @@ export declare abstract class Track extends EventEmitter implements ITrack {
|
|
|
3095
3053
|
export declare enum TrackEvents {
|
|
3096
3054
|
TRANSCEIVER_UPDATED = "transceiver-updated",
|
|
3097
3055
|
SEI_TO_SEND = "sei-to-send",
|
|
3098
|
-
SEI_RECEIVED = "sei-received"
|
|
3099
|
-
TRACK_UPDATED = "track-updated"
|
|
3056
|
+
SEI_RECEIVED = "sei-received"
|
|
3100
3057
|
}
|
|
3101
3058
|
|
|
3102
3059
|
export declare enum TrackHint {
|
|
@@ -3119,7 +3076,6 @@ export declare enum TrackInternalEvent {
|
|
|
3119
3076
|
GET_LOW_VIDEO_TRACK = "@get_low_video_track",
|
|
3120
3077
|
NEED_RESET_REMOTE_SDP = "@need_reset_remote_sdp",
|
|
3121
3078
|
NEED_UPDATE_VIDEO_ENCODER = "@need_update_video_encoder",
|
|
3122
|
-
NEED_UPDATE_VIDEO_SEND_PARAMETERS = "@need_update_video_send_parameters",
|
|
3123
3079
|
NEED_MUTE_TRACK = "@need_mute_track",
|
|
3124
3080
|
NEED_UNMUTE_TRACK = "@need_unmute_track"
|
|
3125
3081
|
}
|
|
@@ -3350,14 +3306,6 @@ export declare class VideoProcessorDestination extends EventEmitter implements I
|
|
|
3350
3306
|
reset(): void;
|
|
3351
3307
|
}
|
|
3352
3308
|
|
|
3353
|
-
declare interface VideoSenderConfig {
|
|
3354
|
-
frameRate: number;
|
|
3355
|
-
bitrateMax: number;
|
|
3356
|
-
bitrateMin: number;
|
|
3357
|
-
scaleResolutionDownBy: number;
|
|
3358
|
-
scale: number;
|
|
3359
|
-
}
|
|
3360
|
-
|
|
3361
3309
|
/**
|
|
3362
3310
|
* The state of the video stream.
|
|
3363
3311
|
*/
|