@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/media.d.ts
CHANGED
|
@@ -730,7 +730,7 @@ export declare class CameraVideoTrack extends LocalVideoTrack implements ICamera
|
|
|
730
730
|
_enabled: boolean;
|
|
731
731
|
_deviceName: string;
|
|
732
732
|
get __className__(): string;
|
|
733
|
-
constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?:
|
|
733
|
+
constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string);
|
|
734
734
|
setDevice(deviceId: string | RequiredOnlyOneOf<{
|
|
735
735
|
facingMode: VideoFacingModeEnum;
|
|
736
736
|
deviceId: string;
|
|
@@ -803,7 +803,7 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
803
803
|
*/
|
|
804
804
|
cameraId?: string;
|
|
805
805
|
/**
|
|
806
|
-
*
|
|
806
|
+
* @自从
|
|
807
807
|
* <br>   *4.0.0*
|
|
808
808
|
*
|
|
809
809
|
* 传输优化模式。设置该值后,SDK 会自动调整码率配置以及使用不同的回退策略。
|
|
@@ -818,7 +818,7 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
818
818
|
* > 注意事项:该方法只支持 Chrome 浏览器。
|
|
819
819
|
*/
|
|
820
820
|
/** @en
|
|
821
|
-
*
|
|
821
|
+
* @since
|
|
822
822
|
* <br>   *4.0.0*
|
|
823
823
|
*
|
|
824
824
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -832,10 +832,10 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
832
832
|
*
|
|
833
833
|
* > Note: This method is only supported on Chrome.
|
|
834
834
|
*/
|
|
835
|
-
optimizationMode?:
|
|
835
|
+
optimizationMode?: "motion" | "detail";
|
|
836
836
|
/**
|
|
837
837
|
* @ignore
|
|
838
|
-
*
|
|
838
|
+
* @自从
|
|
839
839
|
* <br>   *4.18.0*
|
|
840
840
|
*
|
|
841
841
|
* SVC (可伸缩视频编码)配置。
|
|
@@ -845,7 +845,7 @@ export declare interface CameraVideoTrackInitConfig {
|
|
|
845
845
|
/** @en
|
|
846
846
|
* @ignore
|
|
847
847
|
*
|
|
848
|
-
*
|
|
848
|
+
* @since
|
|
849
849
|
* <br>   *4.18.0*
|
|
850
850
|
*
|
|
851
851
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -1002,7 +1002,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1002
1002
|
*/
|
|
1003
1003
|
mediaStreamTrack: MediaStreamTrack;
|
|
1004
1004
|
/**
|
|
1005
|
-
*
|
|
1005
|
+
* @自从
|
|
1006
1006
|
* <br>   *4.17.1*
|
|
1007
1007
|
*
|
|
1008
1008
|
* 视频的分辨率宽。
|
|
@@ -1012,7 +1012,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1012
1012
|
* 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
|
|
1013
1013
|
*/
|
|
1014
1014
|
/** @en
|
|
1015
|
-
*
|
|
1015
|
+
* @since
|
|
1016
1016
|
* <br>   *4.17.1*
|
|
1017
1017
|
*
|
|
1018
1018
|
* Width of the video.
|
|
@@ -1023,7 +1023,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1023
1023
|
*/
|
|
1024
1024
|
width?: number | ConstrainLong;
|
|
1025
1025
|
/**
|
|
1026
|
-
*
|
|
1026
|
+
* @自从
|
|
1027
1027
|
* <br>   *4.17.1*
|
|
1028
1028
|
*
|
|
1029
1029
|
* 视频的分辨率高。
|
|
@@ -1033,7 +1033,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1033
1033
|
* 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
|
|
1034
1034
|
*/
|
|
1035
1035
|
/** @en
|
|
1036
|
-
*
|
|
1036
|
+
* @since
|
|
1037
1037
|
* <br>   *4.17.1*
|
|
1038
1038
|
*
|
|
1039
1039
|
* Height of the video.
|
|
@@ -1044,7 +1044,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1044
1044
|
*/
|
|
1045
1045
|
height?: number | ConstrainLong;
|
|
1046
1046
|
/**
|
|
1047
|
-
*
|
|
1047
|
+
* @自从
|
|
1048
1048
|
* <br>   *4.17.1*
|
|
1049
1049
|
*
|
|
1050
1050
|
* 视频帧率,单位为 fps。
|
|
@@ -1054,7 +1054,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1054
1054
|
* 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
|
|
1055
1055
|
*/
|
|
1056
1056
|
/** @en
|
|
1057
|
-
*
|
|
1057
|
+
* @since
|
|
1058
1058
|
* <br>   *4.17.1*
|
|
1059
1059
|
*
|
|
1060
1060
|
* Frame rate of the video (fps).
|
|
@@ -1079,7 +1079,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1079
1079
|
*/
|
|
1080
1080
|
bitrateMax?: number;
|
|
1081
1081
|
/**
|
|
1082
|
-
*
|
|
1082
|
+
* @自从
|
|
1083
1083
|
* <br>   *4.0.0*
|
|
1084
1084
|
*
|
|
1085
1085
|
* 传输优化模式。设置该值后,SDK 会自动调整码率配置以及使用不同的回退策略。
|
|
@@ -1094,7 +1094,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1094
1094
|
* > 注意事项:该方法只支持 Chrome 浏览器。
|
|
1095
1095
|
*/
|
|
1096
1096
|
/** @en
|
|
1097
|
-
*
|
|
1097
|
+
* @since
|
|
1098
1098
|
* <br>   *4.0.0*
|
|
1099
1099
|
*
|
|
1100
1100
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -1111,7 +1111,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1111
1111
|
optimizationMode?: "motion" | "detail";
|
|
1112
1112
|
/**
|
|
1113
1113
|
* @ignore
|
|
1114
|
-
*
|
|
1114
|
+
* @自从
|
|
1115
1115
|
* <br>   *4.18.0*
|
|
1116
1116
|
*
|
|
1117
1117
|
* SVC (可伸缩视频编码)配置。
|
|
@@ -1121,7 +1121,7 @@ export declare interface CustomVideoTrackInitConfig {
|
|
|
1121
1121
|
/** @en
|
|
1122
1122
|
* @ignore
|
|
1123
1123
|
*
|
|
1124
|
-
*
|
|
1124
|
+
* @since
|
|
1125
1125
|
* <br>   *4.18.0*
|
|
1126
1126
|
*
|
|
1127
1127
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -1355,7 +1355,7 @@ declare function event_beauty_effect_overload(): void;
|
|
|
1355
1355
|
declare function event_first_frame_decoded(): void;
|
|
1356
1356
|
|
|
1357
1357
|
/**
|
|
1358
|
-
*
|
|
1358
|
+
* @自从
|
|
1359
1359
|
* <br>   *4.20.1*
|
|
1360
1360
|
*
|
|
1361
1361
|
* 从 H.264 视频流中解析出 SEI 数据时触发,此事件会返回 SEI 数据。
|
|
@@ -1365,7 +1365,7 @@ declare function event_first_frame_decoded(): void;
|
|
|
1365
1365
|
* @event
|
|
1366
1366
|
*/
|
|
1367
1367
|
/** @en
|
|
1368
|
-
*
|
|
1368
|
+
* @since
|
|
1369
1369
|
* <br>   *4.20.1*
|
|
1370
1370
|
*
|
|
1371
1371
|
* Parsing SEI data from the H.264 video stream triggers this event, which returns the SEI data.
|
|
@@ -1430,8 +1430,6 @@ declare function event_source_state_change(currentState: AudioSourceState): void
|
|
|
1430
1430
|
*/
|
|
1431
1431
|
declare function event_track_ended(): void;
|
|
1432
1432
|
|
|
1433
|
-
export declare function event_track_updated(track: MediaStreamTrack): void;
|
|
1434
|
-
|
|
1435
1433
|
/**
|
|
1436
1434
|
* 当前轨道的 `RTCRtpTransceiver` 实例更新回调。
|
|
1437
1435
|
*
|
|
@@ -1502,7 +1500,7 @@ declare function event_user_datachannel_message(data: ArrayBuffer): void;
|
|
|
1502
1500
|
declare function event_user_datachannel_open(): void;
|
|
1503
1501
|
|
|
1504
1502
|
/**
|
|
1505
|
-
*
|
|
1503
|
+
* @自从
|
|
1506
1504
|
* <br>   *4.8.0*
|
|
1507
1505
|
*
|
|
1508
1506
|
* 提示 HTML `<video>` 标签的可见状态和不可见原因。SDK 每 30 秒触发一次该事件。
|
|
@@ -1514,7 +1512,7 @@ declare function event_user_datachannel_open(): void;
|
|
|
1514
1512
|
* @event
|
|
1515
1513
|
*/
|
|
1516
1514
|
/** @en
|
|
1517
|
-
*
|
|
1515
|
+
* @since
|
|
1518
1516
|
* <br>   *4.8.0*
|
|
1519
1517
|
*
|
|
1520
1518
|
* Indicates the visibility of the `<video>` HTML tag.
|
|
@@ -1530,7 +1528,7 @@ declare function event_user_datachannel_open(): void;
|
|
|
1530
1528
|
declare function event_video_element_visible_status(data?: CheckVideoVisibleResult): void;
|
|
1531
1529
|
|
|
1532
1530
|
/**
|
|
1533
|
-
*
|
|
1531
|
+
* @自从
|
|
1534
1532
|
* <br>   *4.8.0*
|
|
1535
1533
|
*
|
|
1536
1534
|
* 提示 HTML `<video>` 标签的可见状态和不可见原因。SDK 每 30 秒触发一次该事件。
|
|
@@ -1542,7 +1540,7 @@ declare function event_video_element_visible_status(data?: CheckVideoVisibleResu
|
|
|
1542
1540
|
* @event
|
|
1543
1541
|
*/
|
|
1544
1542
|
/** @en
|
|
1545
|
-
*
|
|
1543
|
+
* @since
|
|
1546
1544
|
* <br>   *4.8.0*
|
|
1547
1545
|
*
|
|
1548
1546
|
* Indicates the visibility of the `<video>` HTML tag.
|
|
@@ -1616,14 +1614,6 @@ export declare function getAudioEncoderConfiguration(profile: AudioEncoderConfig
|
|
|
1616
1614
|
|
|
1617
1615
|
export declare function getBitrateConstrainRange(width: number, height: number, frameRate: number, bitrateMin?: number, bitrateMax?: number): DoubleRange;
|
|
1618
1616
|
|
|
1619
|
-
/**
|
|
1620
|
-
* get bitrate, use STANDARD_BITRATE to make sure the response
|
|
1621
|
-
* @param width
|
|
1622
|
-
* @param height
|
|
1623
|
-
* @param fps
|
|
1624
|
-
*/
|
|
1625
|
-
export declare function getBitrateFromResAndFps(width: number, height: number, fps: number): Required<DoubleRange>;
|
|
1626
|
-
|
|
1627
1617
|
export declare function getCompatibility(): AgoraRTCCompatibility;
|
|
1628
1618
|
|
|
1629
1619
|
export declare function getConstraintsFromCameraConfig(config: CameraVideoTrackInitConfig): MediaTrackConstraints;
|
|
@@ -1640,22 +1630,6 @@ export declare function getElectronScreenStreamByUserSelect(config: ScreenConstr
|
|
|
1640
1630
|
|
|
1641
1631
|
export declare function getLocalStream(config: GetUserMediaConfig, id: string): Promise<MediaStream>;
|
|
1642
1632
|
|
|
1643
|
-
/**
|
|
1644
|
-
* 获取初始配置
|
|
1645
|
-
* 分辨率:track.getMediaStreamTrackSettings > 客户设置
|
|
1646
|
-
* 帧率: track.getMediaStreamTrackSettings > 客户设置
|
|
1647
|
-
* 码率: 客户设置 > 根据分辨率计算
|
|
1648
|
-
*
|
|
1649
|
-
* ⚠️:理论上不存在没有分辨率的情况,如果出现不足任何处理
|
|
1650
|
-
*/
|
|
1651
|
-
export declare const getOriginSenderConfig: (track: LocalVideoTrack) => {
|
|
1652
|
-
frameRate: number;
|
|
1653
|
-
bitrateMax: number;
|
|
1654
|
-
bitrateMin: number;
|
|
1655
|
-
scaleResolutionDownBy: number;
|
|
1656
|
-
scale: number;
|
|
1657
|
-
};
|
|
1658
|
-
|
|
1659
1633
|
export declare function getScalabilityConfiguration(profile: SVCConfiguration | SVCConfigurationPreset): SVCConfiguration;
|
|
1660
1634
|
|
|
1661
1635
|
export declare function getScreenEncoderConfiguration(profile: VideoEncoderConfiguration | ScreenEncoderConfigurationPreset | string): VideoEncoderConfiguration;
|
|
@@ -1731,7 +1705,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1731
1705
|
*/
|
|
1732
1706
|
duration: number;
|
|
1733
1707
|
/**
|
|
1734
|
-
*
|
|
1708
|
+
* @自从
|
|
1735
1709
|
* <br>   *4.18.0*
|
|
1736
1710
|
*
|
|
1737
1711
|
* 当前音频文件的播放速度。取值范围为 [50,400],其中:
|
|
@@ -1740,7 +1714,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1740
1714
|
* - `400`: 4 倍速。
|
|
1741
1715
|
*/
|
|
1742
1716
|
/** @en
|
|
1743
|
-
*
|
|
1717
|
+
* @since
|
|
1744
1718
|
* <br>   *4.18.0*
|
|
1745
1719
|
*
|
|
1746
1720
|
* The playback speed of the current audio file. Valid range is [50, 400], where:
|
|
@@ -1831,7 +1805,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1831
1805
|
*/
|
|
1832
1806
|
stopProcessAudioBuffer(): void;
|
|
1833
1807
|
/**
|
|
1834
|
-
*
|
|
1808
|
+
* @自从
|
|
1835
1809
|
* <br>   *4.18.0*
|
|
1836
1810
|
*
|
|
1837
1811
|
* 设置当前音频文件的播放速度。
|
|
@@ -1844,7 +1818,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
|
|
|
1844
1818
|
* - `400`: 4 倍速。
|
|
1845
1819
|
*/
|
|
1846
1820
|
/** @en
|
|
1847
|
-
*
|
|
1821
|
+
* @since
|
|
1848
1822
|
* <br>   *4.18.0*
|
|
1849
1823
|
*
|
|
1850
1824
|
* Sets the playback speed for the current audio file.
|
|
@@ -1900,7 +1874,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1900
1874
|
deviceId: string;
|
|
1901
1875
|
}>): Promise<void>;
|
|
1902
1876
|
/**
|
|
1903
|
-
*
|
|
1877
|
+
* @自从
|
|
1904
1878
|
* <br>   *4.0.0*
|
|
1905
1879
|
*
|
|
1906
1880
|
* 启用/禁用该轨道。
|
|
@@ -1916,7 +1890,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1916
1890
|
* - `false`: 禁用该轨道.
|
|
1917
1891
|
*/
|
|
1918
1892
|
/** @en
|
|
1919
|
-
*
|
|
1893
|
+
* @since
|
|
1920
1894
|
* <br>   *4.0.0*
|
|
1921
1895
|
*
|
|
1922
1896
|
* Enables/Disables the track.
|
|
@@ -1933,7 +1907,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1933
1907
|
*/
|
|
1934
1908
|
setEnabled(enabled: boolean): Promise<void>;
|
|
1935
1909
|
/**
|
|
1936
|
-
*
|
|
1910
|
+
* @自从
|
|
1937
1911
|
* <br>   *4.19.0*
|
|
1938
1912
|
*
|
|
1939
1913
|
* 复制当前的视频轨道对象,生成一个新的视频轨道。
|
|
@@ -1945,7 +1919,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
|
|
|
1945
1919
|
* @returns 新生成的视频轨道。
|
|
1946
1920
|
*/
|
|
1947
1921
|
/** @en
|
|
1948
|
-
*
|
|
1922
|
+
* @since
|
|
1949
1923
|
* <br>   *4.19.0*
|
|
1950
1924
|
*
|
|
1951
1925
|
* Clones the current video track to create a new video track.
|
|
@@ -2091,7 +2065,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
2091
2065
|
*/
|
|
2092
2066
|
play(): void;
|
|
2093
2067
|
/**
|
|
2094
|
-
*
|
|
2068
|
+
* @自从
|
|
2095
2069
|
* <br>   *4.1.0*
|
|
2096
2070
|
*
|
|
2097
2071
|
* > 注意事项:
|
|
@@ -2102,7 +2076,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
2102
2076
|
* @param deviceId 设备 ID,可以通过 [[getPlaybackDevices]] 方法获取。
|
|
2103
2077
|
*/
|
|
2104
2078
|
/** @en
|
|
2105
|
-
*
|
|
2079
|
+
* @since
|
|
2106
2080
|
* <br>   *4.1.0*
|
|
2107
2081
|
*
|
|
2108
2082
|
* > Note:
|
|
@@ -2116,17 +2090,17 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
2116
2090
|
/**
|
|
2117
2091
|
* 获取本地音频轨道的质量相关信息。
|
|
2118
2092
|
*
|
|
2119
|
-
*
|
|
2093
|
+
* @deprecated
|
|
2120
2094
|
* 自 v4.1.0 起废弃,请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
|
|
2121
2095
|
*/
|
|
2122
2096
|
/** @en
|
|
2123
2097
|
* Gets the statistics of a local audio track.
|
|
2124
2098
|
*
|
|
2125
|
-
*
|
|
2099
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
2126
2100
|
*/
|
|
2127
2101
|
getStats(): LocalAudioTrackStats;
|
|
2128
2102
|
/**
|
|
2129
|
-
*
|
|
2103
|
+
* @自从
|
|
2130
2104
|
* <br>   *4.10.0*
|
|
2131
2105
|
*
|
|
2132
2106
|
* 将 `Processor` 注入本地音频轨道。
|
|
@@ -2143,26 +2117,26 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
|
|
|
2143
2117
|
*/
|
|
2144
2118
|
pipe(processor: IAudioProcessor): IAudioProcessor;
|
|
2145
2119
|
/**
|
|
2146
|
-
*
|
|
2120
|
+
* @自从
|
|
2147
2121
|
* <br>   *4.10.0*
|
|
2148
2122
|
*
|
|
2149
2123
|
* 取消本地音频轨道上注入的 `Processor`。
|
|
2150
2124
|
*/
|
|
2151
2125
|
/** @en
|
|
2152
|
-
*
|
|
2126
|
+
* @since
|
|
2153
2127
|
* <br>   *4.10.0*
|
|
2154
2128
|
*
|
|
2155
2129
|
* Removes the `Processor` inserted to the local audio track.
|
|
2156
2130
|
*/
|
|
2157
2131
|
unpipe(): void;
|
|
2158
2132
|
/**
|
|
2159
|
-
*
|
|
2133
|
+
* @自从
|
|
2160
2134
|
* <br>   *4.10.0*
|
|
2161
2135
|
*
|
|
2162
2136
|
* 本地音频轨道上当前媒体处理链路的最终节点。
|
|
2163
2137
|
*/
|
|
2164
2138
|
/** @en
|
|
2165
|
-
*
|
|
2139
|
+
* @since
|
|
2166
2140
|
* <br>   *4.10.0*
|
|
2167
2141
|
*
|
|
2168
2142
|
* The destination of the current processing pipeline on the local audio track.
|
|
@@ -2192,7 +2166,6 @@ export declare interface ILocalDataChannel extends IDataChannel {
|
|
|
2192
2166
|
* `LocalTrack` is the basic interface for local tracks, providing public methods for [LocalAudioTrack]{@link ILocalAudioTrack} and [LocalVideoTrack]{@link ILocalVideoTrack}.
|
|
2193
2167
|
*/
|
|
2194
2168
|
export declare interface ILocalTrack extends ITrack {
|
|
2195
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
2196
2169
|
/**
|
|
2197
2170
|
* @param event 事件名称。
|
|
2198
2171
|
* @param listener 详见 [track-ended]{@link event_track_ended}。
|
|
@@ -2214,7 +2187,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2214
2187
|
*/
|
|
2215
2188
|
on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
|
|
2216
2189
|
/**
|
|
2217
|
-
*
|
|
2190
|
+
* @自从
|
|
2218
2191
|
* <br>   *4.0.0*
|
|
2219
2192
|
*
|
|
2220
2193
|
* 启用/禁用该轨道。
|
|
@@ -2230,7 +2203,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2230
2203
|
* - `false`: 禁用该轨道。
|
|
2231
2204
|
*/
|
|
2232
2205
|
/** @en
|
|
2233
|
-
*
|
|
2206
|
+
* @since
|
|
2234
2207
|
* <br>   *4.0.0*
|
|
2235
2208
|
*
|
|
2236
2209
|
* Enables/Disables the track.
|
|
@@ -2247,7 +2220,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2247
2220
|
*/
|
|
2248
2221
|
setEnabled(enabled: boolean): Promise<void>;
|
|
2249
2222
|
/**
|
|
2250
|
-
*
|
|
2223
|
+
* @deprecated
|
|
2251
2224
|
* 自 v4.1.0 起废弃,请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
|
|
2252
2225
|
*
|
|
2253
2226
|
* 获取本地轨道相关信息。
|
|
@@ -2255,7 +2228,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2255
2228
|
* > 注意事项:获取本地视频轨道数据时,iOS 上无法获取到 `encodeDelay` 字段。
|
|
2256
2229
|
*/
|
|
2257
2230
|
/** @en
|
|
2258
|
-
*
|
|
2231
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
2259
2232
|
*
|
|
2260
2233
|
* Gets the statistics of a local track.
|
|
2261
2234
|
*
|
|
@@ -2282,7 +2255,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2282
2255
|
/**
|
|
2283
2256
|
* 发送或暂停发送该轨道的媒体数据。
|
|
2284
2257
|
*
|
|
2285
|
-
*
|
|
2258
|
+
* @自从
|
|
2286
2259
|
* <br>   *4.6.0*
|
|
2287
2260
|
*
|
|
2288
2261
|
* 如果该轨道已发布,调用 `setMuted(true)` 后,远端会触发 [user-unpublished]{@link IAgoraRTCClient.event_user_unpublished} 事件。再调用 `setMuted(false)` 后,远端会触发 [user-published]{@link IAgoraRTCClient.event_user_published} 事件。
|
|
@@ -2297,7 +2270,7 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2297
2270
|
/** @en
|
|
2298
2271
|
* Sends or stops sending the media data of the track.
|
|
2299
2272
|
*
|
|
2300
|
-
*
|
|
2273
|
+
* @since
|
|
2301
2274
|
* <br>   *4.6.0*
|
|
2302
2275
|
*
|
|
2303
2276
|
* 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.
|
|
@@ -2346,7 +2319,6 @@ export declare interface ILocalTrack extends ITrack {
|
|
|
2346
2319
|
* Inherited from `LocalVideoTrack`, [CameraVideoTrack]{@link ICameraVideoTrack} is an interface for the video captured by a local camera and adds several camera-related functions.
|
|
2347
2320
|
*/
|
|
2348
2321
|
export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
2349
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
2350
2322
|
/** @internal */
|
|
2351
2323
|
on(event: "beauty-effect-overload", listener: typeof event_beauty_effect_overload): void;
|
|
2352
2324
|
/**
|
|
@@ -2398,18 +2370,18 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2398
2370
|
/**
|
|
2399
2371
|
* 获取本地视频轨道的相关信息。
|
|
2400
2372
|
*
|
|
2401
|
-
*
|
|
2373
|
+
* @deprecated
|
|
2402
2374
|
* 自 v4.1.0 起废弃,请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
|
|
2403
2375
|
*
|
|
2404
2376
|
*/
|
|
2405
2377
|
/** @en
|
|
2406
2378
|
* Gets the statistics of a local video track.
|
|
2407
2379
|
*
|
|
2408
|
-
*
|
|
2380
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
|
|
2409
2381
|
*/
|
|
2410
2382
|
getStats(): LocalVideoTrackStats;
|
|
2411
2383
|
/**
|
|
2412
|
-
*
|
|
2384
|
+
* @自从
|
|
2413
2385
|
* <br>   *4.19.0*
|
|
2414
2386
|
*
|
|
2415
2387
|
* 复制当前的视频轨道对象,生成一个新的视频轨道。
|
|
@@ -2421,7 +2393,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2421
2393
|
* @returns 新生成的视频轨道。
|
|
2422
2394
|
*/
|
|
2423
2395
|
/** @en
|
|
2424
|
-
*
|
|
2396
|
+
* @since
|
|
2425
2397
|
* <br>   *4.19.0*
|
|
2426
2398
|
*
|
|
2427
2399
|
* Clones the current video track to create a new video track.
|
|
@@ -2475,7 +2447,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2475
2447
|
*/
|
|
2476
2448
|
setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
|
|
2477
2449
|
/**
|
|
2478
|
-
*
|
|
2450
|
+
* @自从
|
|
2479
2451
|
* <br>   *4.1.0*
|
|
2480
2452
|
*
|
|
2481
2453
|
* 获取当前渲染的视频帧数据。
|
|
@@ -2485,7 +2457,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2485
2457
|
* @returns 存储了 RGBA 数据的 `ImageData` 对象。该对象为浏览器原生对象,详见 [ImageData](https://developer.mozilla.org/zh-CN/docs/Web/API/ImageData)。
|
|
2486
2458
|
*/
|
|
2487
2459
|
/** @en
|
|
2488
|
-
*
|
|
2460
|
+
* @since
|
|
2489
2461
|
* <br>   *4.1.0*
|
|
2490
2462
|
*
|
|
2491
2463
|
* Gets the data of the video frame being rendered.
|
|
@@ -2504,7 +2476,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2504
2476
|
*/
|
|
2505
2477
|
getCurrentFrameImage(imageType: string, quality: number): Promise<ImageTypedData>;
|
|
2506
2478
|
/**
|
|
2507
|
-
*
|
|
2479
|
+
* @自从
|
|
2508
2480
|
* <br>   *4.2.0*
|
|
2509
2481
|
*
|
|
2510
2482
|
* 设置视频传输优化模式。
|
|
@@ -2525,7 +2497,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2525
2497
|
* - 大部分情况下,SDK 不会降低帧率,但是可能会降低发送分辨率。
|
|
2526
2498
|
*/
|
|
2527
2499
|
/** @en
|
|
2528
|
-
*
|
|
2500
|
+
* @since
|
|
2529
2501
|
* <br>   *4.2.0*
|
|
2530
2502
|
*
|
|
2531
2503
|
* Sets the video transmission optimization mode.
|
|
@@ -2547,7 +2519,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2547
2519
|
*/
|
|
2548
2520
|
setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>;
|
|
2549
2521
|
/**
|
|
2550
|
-
* *
|
|
2522
|
+
* * @自从
|
|
2551
2523
|
* <br>   *4.8.0*
|
|
2552
2524
|
*
|
|
2553
2525
|
* 获取 HTML `<video>` 标签的可见状态和不可见原因。
|
|
@@ -2560,7 +2532,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2560
2532
|
* - `<video>` 标签不是通过 `play` 方法调用产生的。
|
|
2561
2533
|
*/
|
|
2562
2534
|
/** @en
|
|
2563
|
-
*
|
|
2535
|
+
* @since
|
|
2564
2536
|
* <br>   *4.8.0*
|
|
2565
2537
|
*
|
|
2566
2538
|
* Gets the visibility of the `<video>` HTML tag.
|
|
@@ -2574,7 +2546,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2574
2546
|
*/
|
|
2575
2547
|
getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
|
|
2576
2548
|
/**
|
|
2577
|
-
*
|
|
2549
|
+
* @自从
|
|
2578
2550
|
* <br>   *4.10.0*
|
|
2579
2551
|
*
|
|
2580
2552
|
* 将 `Processor` 注入本地视频轨道。
|
|
@@ -2591,33 +2563,33 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2591
2563
|
*/
|
|
2592
2564
|
pipe(processor: IBaseProcessor): IBaseProcessor;
|
|
2593
2565
|
/**
|
|
2594
|
-
*
|
|
2566
|
+
* @自从
|
|
2595
2567
|
* <br>   *4.10.0*
|
|
2596
2568
|
*
|
|
2597
2569
|
* 取消本地视频轨道上注入的 `Processor`。
|
|
2598
2570
|
*/
|
|
2599
2571
|
/** @en
|
|
2600
|
-
*
|
|
2572
|
+
* @since
|
|
2601
2573
|
* <br>   *4.10.0*
|
|
2602
2574
|
*
|
|
2603
2575
|
* Removes the `Processor` inserted to the local video track.
|
|
2604
2576
|
*/
|
|
2605
2577
|
unpipe(): void;
|
|
2606
2578
|
/**
|
|
2607
|
-
*
|
|
2579
|
+
* @自从
|
|
2608
2580
|
* <br>   *4.10.0*
|
|
2609
2581
|
*
|
|
2610
2582
|
* 本地视频轨道上当前媒体处理链路的最终节点。
|
|
2611
2583
|
*/
|
|
2612
2584
|
/** @en
|
|
2613
|
-
*
|
|
2585
|
+
* @since
|
|
2614
2586
|
* <br>   *4.10.0*
|
|
2615
2587
|
*
|
|
2616
2588
|
* The destination of the current processing pipeline on the local video track.
|
|
2617
2589
|
*/
|
|
2618
2590
|
processorDestination: IBaseProcessor;
|
|
2619
2591
|
/**
|
|
2620
|
-
*
|
|
2592
|
+
* @自从
|
|
2621
2593
|
* <br>   *4.17.0*
|
|
2622
2594
|
*
|
|
2623
2595
|
* 替换本地视频轨道。
|
|
@@ -2655,7 +2627,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
|
|
|
2655
2627
|
* - 保留原有的视频轨道。
|
|
2656
2628
|
*/
|
|
2657
2629
|
/** @en
|
|
2658
|
-
*
|
|
2630
|
+
* @since
|
|
2659
2631
|
* <br>   *4.17.0*
|
|
2660
2632
|
*
|
|
2661
2633
|
* Replaces the local video track.
|
|
@@ -2749,7 +2721,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
|
|
|
2749
2721
|
*/
|
|
2750
2722
|
setDevice(deviceId: string): Promise<void>;
|
|
2751
2723
|
/**
|
|
2752
|
-
*
|
|
2724
|
+
* @自从
|
|
2753
2725
|
* <br>   *4.0.0*
|
|
2754
2726
|
*
|
|
2755
2727
|
* 启用/禁用该轨道。
|
|
@@ -2765,7 +2737,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
|
|
|
2765
2737
|
* - `false`: 禁用该轨道.
|
|
2766
2738
|
*/
|
|
2767
2739
|
/** @en
|
|
2768
|
-
*
|
|
2740
|
+
* @since
|
|
2769
2741
|
* <br>   *4.0.0*
|
|
2770
2742
|
*
|
|
2771
2743
|
* Enables/Disables the track.
|
|
@@ -2829,7 +2801,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
2829
2801
|
*/
|
|
2830
2802
|
play(): void;
|
|
2831
2803
|
/**
|
|
2832
|
-
*
|
|
2804
|
+
* @自从
|
|
2833
2805
|
* <br>   *4.1.0*
|
|
2834
2806
|
*
|
|
2835
2807
|
* 设置音频播放设备,比如扬声器。
|
|
@@ -2838,7 +2810,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
2838
2810
|
* @param deviceId 设备 ID,可以通过 [[getPlaybackDevices]] 方法获取。
|
|
2839
2811
|
*/
|
|
2840
2812
|
/** @en
|
|
2841
|
-
*
|
|
2813
|
+
* @since
|
|
2842
2814
|
* <br>   *4.1.0*
|
|
2843
2815
|
*
|
|
2844
2816
|
* Sets the audio playback device, for example, the speaker.
|
|
@@ -2919,7 +2891,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
2919
2891
|
*/
|
|
2920
2892
|
getVolumeLevel(): number;
|
|
2921
2893
|
/**
|
|
2922
|
-
*
|
|
2894
|
+
* @自从
|
|
2923
2895
|
* <br>   *4.13.0*
|
|
2924
2896
|
*
|
|
2925
2897
|
* 将 `Processor` 注入远端音频轨道。
|
|
@@ -2929,7 +2901,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
2929
2901
|
* @returns `Processor` 实例。
|
|
2930
2902
|
*/
|
|
2931
2903
|
/** @en
|
|
2932
|
-
*
|
|
2904
|
+
* @since
|
|
2933
2905
|
* <br>   *4.13.0*
|
|
2934
2906
|
*
|
|
2935
2907
|
* Inserts a `Processor` to the remote audio track.
|
|
@@ -2940,26 +2912,26 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
|
|
|
2940
2912
|
*/
|
|
2941
2913
|
pipe(processor: IAudioProcessor): IAudioProcessor;
|
|
2942
2914
|
/**
|
|
2943
|
-
*
|
|
2915
|
+
* @自从
|
|
2944
2916
|
* <br>   *4.13.0*
|
|
2945
2917
|
*
|
|
2946
2918
|
* 取消远端音频轨道上注入的 `Processor`。
|
|
2947
2919
|
*/
|
|
2948
2920
|
/** @en
|
|
2949
|
-
*
|
|
2921
|
+
* @since
|
|
2950
2922
|
* <br>   *4.13.0*
|
|
2951
2923
|
*
|
|
2952
2924
|
* Removes the `Processor` inserted to the remote audio track.
|
|
2953
2925
|
*/
|
|
2954
2926
|
unpipe(): void;
|
|
2955
2927
|
/**
|
|
2956
|
-
*
|
|
2928
|
+
* @自从
|
|
2957
2929
|
* <br>   *4.13.0*
|
|
2958
2930
|
*
|
|
2959
2931
|
* 远端音频轨道上当前媒体处理链路的最终节点。
|
|
2960
2932
|
*/
|
|
2961
2933
|
/** @en
|
|
2962
|
-
*
|
|
2934
|
+
* @since
|
|
2963
2935
|
* <br>   *4.13.0*
|
|
2964
2936
|
*
|
|
2965
2937
|
* The destination of the current processing pipeline on the remote audio track.
|
|
@@ -2989,7 +2961,6 @@ export declare interface IRemoteDataChannel extends IDataChannel {
|
|
|
2989
2961
|
* `RemoteTrack` is the basic interface for remote tracks, providing public methods for [RemoteAudioTrack]{@link IRemoteAudioTrack} and [RemoteVideoTrack]{@link IRemoteVideoTrack}.
|
|
2990
2962
|
*/
|
|
2991
2963
|
export declare interface IRemoteTrack extends ITrack {
|
|
2992
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
2993
2964
|
/**
|
|
2994
2965
|
* @param event 事件名称。
|
|
2995
2966
|
* @param listener 详见 [first-frame-decoded]{@link event_first_frame_decoded}。
|
|
@@ -3024,7 +2995,7 @@ export declare interface IRemoteTrack extends ITrack {
|
|
|
3024
2995
|
/**
|
|
3025
2996
|
* 获取远端轨道相关信息。
|
|
3026
2997
|
*
|
|
3027
|
-
*
|
|
2998
|
+
* @deprecated
|
|
3028
2999
|
*
|
|
3029
3000
|
* 自 v4.1.0 起废弃,请使用 [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} 和 [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats}。
|
|
3030
3001
|
* @return [[RemoteAudioTrackStats]] 或 [[RemoteVideoTrackStats]] 对象。
|
|
@@ -3032,7 +3003,7 @@ export declare interface IRemoteTrack extends ITrack {
|
|
|
3032
3003
|
/** @en
|
|
3033
3004
|
* Gets the statistics of a remote track.
|
|
3034
3005
|
*
|
|
3035
|
-
*
|
|
3006
|
+
* @deprecated from v4.1.0. Use [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} and [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats} instead.
|
|
3036
3007
|
* @return An [[RemoteAudioTrackStats]] or [[RemoteVideoTrackStats]] object.
|
|
3037
3008
|
*/
|
|
3038
3009
|
getStats(): RemoteAudioTrackStats | RemoteVideoTrackStats;
|
|
@@ -3057,7 +3028,6 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3057
3028
|
* @param event The event name.
|
|
3058
3029
|
* @param listener See [video-state-changed]{@link event_video_state_changed}.
|
|
3059
3030
|
*/
|
|
3060
|
-
on(event: "track-updated", listener: typeof event_track_updated): void;
|
|
3061
3031
|
on(event: "video-state-changed", listener: typeof event_video_state_changed): void;
|
|
3062
3032
|
/**
|
|
3063
3033
|
* @param event 事件名称。
|
|
@@ -3129,7 +3099,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3129
3099
|
*/
|
|
3130
3100
|
play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
|
|
3131
3101
|
/**
|
|
3132
|
-
*
|
|
3102
|
+
* @自从
|
|
3133
3103
|
* <br>   *4.1.0*
|
|
3134
3104
|
*
|
|
3135
3105
|
* 获取当前渲染的视频帧数据。
|
|
@@ -3139,7 +3109,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3139
3109
|
* @returns 存储了 RGBA 数据的 `ImageData` 对象。该对象为浏览器原生对象,详见 [ImageData](https://developer.mozilla.org/zh-CN/docs/Web/API/ImageData)。
|
|
3140
3110
|
*/
|
|
3141
3111
|
/** @en
|
|
3142
|
-
*
|
|
3112
|
+
* @since
|
|
3143
3113
|
* <br>   *4.1.0*
|
|
3144
3114
|
*
|
|
3145
3115
|
* Gets the data of the video frame being rendered.
|
|
@@ -3150,7 +3120,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3150
3120
|
*/
|
|
3151
3121
|
getCurrentFrameData(): ImageData;
|
|
3152
3122
|
/**
|
|
3153
|
-
* *
|
|
3123
|
+
* * @自从
|
|
3154
3124
|
* <br>   *4.8.0*
|
|
3155
3125
|
*
|
|
3156
3126
|
* 获取 HTML `<video>` 标签的可见状态和不可见原因。
|
|
@@ -3163,7 +3133,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3163
3133
|
* - `<video>` 标签不是通过 `play` 方法调用产生的。
|
|
3164
3134
|
*/
|
|
3165
3135
|
/** @en
|
|
3166
|
-
*
|
|
3136
|
+
* @since
|
|
3167
3137
|
* <br>   *4.8.0*
|
|
3168
3138
|
*
|
|
3169
3139
|
* Gets the visibility of the `<video>` HTML tag.
|
|
@@ -3177,7 +3147,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3177
3147
|
*/
|
|
3178
3148
|
getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
|
|
3179
3149
|
/**
|
|
3180
|
-
*
|
|
3150
|
+
* @自从
|
|
3181
3151
|
* <br>   *4.13.0*
|
|
3182
3152
|
*
|
|
3183
3153
|
* 将 `Processor` 注入远端视频轨道。
|
|
@@ -3187,7 +3157,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3187
3157
|
* @returns `Processor` 实例。
|
|
3188
3158
|
*/
|
|
3189
3159
|
/** @en
|
|
3190
|
-
*
|
|
3160
|
+
* @since
|
|
3191
3161
|
* <br>   *4.13.0*
|
|
3192
3162
|
*
|
|
3193
3163
|
* Inserts a `Processor` to the remote video track.
|
|
@@ -3198,26 +3168,26 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
|
|
|
3198
3168
|
*/
|
|
3199
3169
|
pipe(processor: IBaseProcessor): IBaseProcessor;
|
|
3200
3170
|
/**
|
|
3201
|
-
*
|
|
3171
|
+
* @自从
|
|
3202
3172
|
* <br>   *4.13.0*
|
|
3203
3173
|
*
|
|
3204
3174
|
* 取消远端视频轨道上注入的 `Processor`。
|
|
3205
3175
|
*/
|
|
3206
3176
|
/** @en
|
|
3207
|
-
*
|
|
3177
|
+
* @since
|
|
3208
3178
|
* <br>   *4.13.0*
|
|
3209
3179
|
*
|
|
3210
3180
|
* Removes the `Processor` inserted to the remote video track.
|
|
3211
3181
|
*/
|
|
3212
3182
|
unpipe(): void;
|
|
3213
3183
|
/**
|
|
3214
|
-
*
|
|
3184
|
+
* @自从
|
|
3215
3185
|
* <br>   *4.13.0*
|
|
3216
3186
|
*
|
|
3217
3187
|
* 远端视频轨道上当前媒体处理链路的最终节点。
|
|
3218
3188
|
*/
|
|
3219
3189
|
/** @en
|
|
3220
|
-
*
|
|
3190
|
+
* @since
|
|
3221
3191
|
* <br>   *4.13.0*
|
|
3222
3192
|
*
|
|
3223
3193
|
* The destination of the current processing pipeline on the remote video track.
|
|
@@ -3546,21 +3516,9 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
3546
3516
|
protected _statsTimer: number | null;
|
|
3547
3517
|
private _previousVideoVisibleStatus;
|
|
3548
3518
|
private _clearPreviousVideoVisibleStatus;
|
|
3549
|
-
_encoderConfig?: Partial<VideoEncoderConfiguration
|
|
3550
|
-
scale: number;
|
|
3551
|
-
}>;
|
|
3519
|
+
_encoderConfig?: Partial<VideoEncoderConfiguration>;
|
|
3552
3520
|
_scalabilityMode?: SVCConfiguration;
|
|
3553
|
-
_optimizationMode?:
|
|
3554
|
-
_qualityLimitationReason?: QualityLimitationReason;
|
|
3555
|
-
/**
|
|
3556
|
-
* Adaptation origin config
|
|
3557
|
-
*/
|
|
3558
|
-
private _originalSenderConfig?;
|
|
3559
|
-
_adaptationConfig?: VideoSenderConfig;
|
|
3560
|
-
/**
|
|
3561
|
-
* 轮询监听stats
|
|
3562
|
-
*/
|
|
3563
|
-
private _adaptationTimer;
|
|
3521
|
+
_optimizationMode?: "motion" | "detail" | "balanced";
|
|
3564
3522
|
_videoHeight?: number;
|
|
3565
3523
|
_videoWidth?: number;
|
|
3566
3524
|
_forceBitrateLimit?: {
|
|
@@ -3574,13 +3532,13 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
3574
3532
|
protected get processorContext(): VideoProcessorContext;
|
|
3575
3533
|
protected set processorContext(ctx: VideoProcessorContext);
|
|
3576
3534
|
get __className__(): string;
|
|
3577
|
-
constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?:
|
|
3535
|
+
constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string, hints?: TrackHint[]);
|
|
3578
3536
|
play(element: HTMLElement | HTMLVideoElement | string, config?: VideoPlayerConfig): void;
|
|
3579
3537
|
stop(): void;
|
|
3580
3538
|
setEnabled(enabled: boolean, skipChangeState?: boolean): Promise<void>;
|
|
3581
3539
|
setMuted(muted: boolean): Promise<void>;
|
|
3582
3540
|
setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset, doNotRenegoation?: boolean): Promise<void>;
|
|
3583
|
-
getStats(
|
|
3541
|
+
getStats(): LocalVideoTrackStats;
|
|
3584
3542
|
setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
|
|
3585
3543
|
getCurrentFrameData(): ImageData;
|
|
3586
3544
|
getCurrentFrameImage(imageType: string, quality?: number): Promise<ImageTypedData>;
|
|
@@ -3588,10 +3546,7 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
|
|
|
3588
3546
|
max_bitrate: number;
|
|
3589
3547
|
min_bitrate: number;
|
|
3590
3548
|
}): Promise<void>;
|
|
3591
|
-
setOptimizationMode(mode:
|
|
3592
|
-
protected applyAdaptation(config: VideoSenderConfig): Promise<void>;
|
|
3593
|
-
startVideoStreamAdapter(): void;
|
|
3594
|
-
protected updateAdapterConfig(): void;
|
|
3549
|
+
setOptimizationMode(mode: "motion" | "detail" | "balanced"): Promise<void>;
|
|
3595
3550
|
setScalabiltyMode(mode: SVCConfiguration): void;
|
|
3596
3551
|
updateMediaStreamTrackResolution(): void;
|
|
3597
3552
|
protected _updatePlayerSource(): void;
|
|
@@ -3981,8 +3936,6 @@ export declare class MixingAudioTrack extends LocalAudioTrack {
|
|
|
3981
3936
|
_updateRtpTransceiver(transceiver: RTCRtpTransceiver): void;
|
|
3982
3937
|
}
|
|
3983
3938
|
|
|
3984
|
-
export declare type OptimizationMode = "motion" | "detail";
|
|
3985
|
-
|
|
3986
3939
|
/**
|
|
3987
3940
|
* @internal
|
|
3988
3941
|
*/
|
|
@@ -4015,13 +3968,6 @@ export declare interface ProcessorUsageStats {
|
|
|
4015
3968
|
totalTs: number;
|
|
4016
3969
|
}
|
|
4017
3970
|
|
|
4018
|
-
declare enum QualityLimitationReason {
|
|
4019
|
-
BANDWIDTH = "bandwidth",
|
|
4020
|
-
CPU = "cpu",
|
|
4021
|
-
NONE = "none",
|
|
4022
|
-
OTHER = "other"
|
|
4023
|
-
}
|
|
4024
|
-
|
|
4025
3971
|
export declare class RemoteAudioTrack extends RemoteTrack implements IRemoteAudioTrack {
|
|
4026
3972
|
readonly trackMediaType: "audio" | "video";
|
|
4027
3973
|
_source: AudioTrackSource | FakeTrackSource;
|
|
@@ -4635,7 +4581,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4635
4581
|
*/
|
|
4636
4582
|
extensionId?: string;
|
|
4637
4583
|
/**
|
|
4638
|
-
*
|
|
4584
|
+
* @deprecated
|
|
4639
4585
|
*
|
|
4640
4586
|
* 自 v4.17.1 起废弃,请改用 {@link displaySurface}。
|
|
4641
4587
|
*
|
|
@@ -4643,13 +4589,13 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4643
4589
|
*/
|
|
4644
4590
|
/** @en
|
|
4645
4591
|
*
|
|
4646
|
-
*
|
|
4592
|
+
* @deprecated from v4.17.1. Use {@link displaySurface} instead.
|
|
4647
4593
|
*
|
|
4648
4594
|
* The type of the source for screen sharing.
|
|
4649
4595
|
*/
|
|
4650
4596
|
screenSourceType?: ScreenSourceType;
|
|
4651
4597
|
/**
|
|
4652
|
-
*
|
|
4598
|
+
* @自从
|
|
4653
4599
|
* <br>   *4.0.0*
|
|
4654
4600
|
*
|
|
4655
4601
|
* 传输优化模式。设置该值后,SDK 会自动调整码率配置以及使用不同的回退策略。
|
|
@@ -4663,7 +4609,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4663
4609
|
* > 注意事项:该方法只支持 Chrome 浏览器。
|
|
4664
4610
|
*/
|
|
4665
4611
|
/** @en
|
|
4666
|
-
*
|
|
4612
|
+
* @since
|
|
4667
4613
|
* <br>   *4.0.0*
|
|
4668
4614
|
*
|
|
4669
4615
|
* Transmission optimization mode. Whether to prioritize video quality or smoothness:
|
|
@@ -4680,7 +4626,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4680
4626
|
/**
|
|
4681
4627
|
* @ignore
|
|
4682
4628
|
*
|
|
4683
|
-
*
|
|
4629
|
+
* @自从
|
|
4684
4630
|
* <br>   *4.18.0*
|
|
4685
4631
|
*
|
|
4686
4632
|
* SVC (可伸缩视频编码)配置。
|
|
@@ -4690,7 +4636,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4690
4636
|
/** @en
|
|
4691
4637
|
* @ignore
|
|
4692
4638
|
*
|
|
4693
|
-
*
|
|
4639
|
+
* @since
|
|
4694
4640
|
* <br>   *4.18.0*
|
|
4695
4641
|
*
|
|
4696
4642
|
* Configurations for Scalable Video Coding (SVC).
|
|
@@ -4701,7 +4647,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4701
4647
|
*/
|
|
4702
4648
|
scalabiltyMode?: SVCConfiguration | SVCConfigurationPreset;
|
|
4703
4649
|
/**
|
|
4704
|
-
*
|
|
4650
|
+
* @自从
|
|
4705
4651
|
* <br>   *4.17.1*
|
|
4706
4652
|
*
|
|
4707
4653
|
* 默认选中的共享内容类型,支持设为标签页、应用窗口(如下图)、或屏幕。详见 [displaySurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface)。
|
|
@@ -4713,7 +4659,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4713
4659
|
*/
|
|
4714
4660
|
/** @en
|
|
4715
4661
|
*
|
|
4716
|
-
*
|
|
4662
|
+
* @since
|
|
4717
4663
|
* <br>   *4.17.1*
|
|
4718
4664
|
*
|
|
4719
4665
|
* The pre-selected pane in the media picker. See [displaySurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface) for details.
|
|
@@ -4722,7 +4668,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4722
4668
|
*/
|
|
4723
4669
|
displaySurface?: "browser" | "window" | "monitor";
|
|
4724
4670
|
/**
|
|
4725
|
-
*
|
|
4671
|
+
* @自从
|
|
4726
4672
|
* <br>   *4.17.1*
|
|
4727
4673
|
*
|
|
4728
4674
|
* 是否允许用户共享当前标签页:
|
|
@@ -4737,7 +4683,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4737
4683
|
*/
|
|
4738
4684
|
/** @en
|
|
4739
4685
|
*
|
|
4740
|
-
*
|
|
4686
|
+
* @since
|
|
4741
4687
|
* <br>   *4.17.1*
|
|
4742
4688
|
*
|
|
4743
4689
|
* Whether to allow the user to share the current tab:
|
|
@@ -4752,7 +4698,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4752
4698
|
*/
|
|
4753
4699
|
selfBrowserSurface?: "include" | "exclude";
|
|
4754
4700
|
/**
|
|
4755
|
-
*
|
|
4701
|
+
* @自从
|
|
4756
4702
|
* <br>   *4.17.1*
|
|
4757
4703
|
*
|
|
4758
4704
|
* 是否允许用户动态切换共享的标签页:
|
|
@@ -4765,7 +4711,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4765
4711
|
*/
|
|
4766
4712
|
/** @en
|
|
4767
4713
|
*
|
|
4768
|
-
*
|
|
4714
|
+
* @since
|
|
4769
4715
|
* <br>   *4.17.1*
|
|
4770
4716
|
*
|
|
4771
4717
|
* Whether to allow the user to dynamically switch between shared tabs:
|
|
@@ -4778,7 +4724,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4778
4724
|
*/
|
|
4779
4725
|
surfaceSwitching?: "include" | "exclude";
|
|
4780
4726
|
/**
|
|
4781
|
-
*
|
|
4727
|
+
* @自从
|
|
4782
4728
|
* <br>   *4.17.1*
|
|
4783
4729
|
*
|
|
4784
4730
|
* 是否允许采集系统音频:
|
|
@@ -4791,7 +4737,7 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4791
4737
|
*/
|
|
4792
4738
|
/** @en
|
|
4793
4739
|
*
|
|
4794
|
-
*
|
|
4740
|
+
* @since
|
|
4795
4741
|
* <br>   *4.17.1*
|
|
4796
4742
|
*
|
|
4797
4743
|
* Whether to capture system audio:
|
|
@@ -4805,12 +4751,6 @@ export declare interface ScreenVideoTrackInitConfig {
|
|
|
4805
4751
|
systemAudio?: "include" | "exclude";
|
|
4806
4752
|
}
|
|
4807
4753
|
|
|
4808
|
-
export declare type SenderConfig = {
|
|
4809
|
-
bitrateMax: number;
|
|
4810
|
-
bitrateMin: number;
|
|
4811
|
-
scaleResolutionDownBy: number;
|
|
4812
|
-
};
|
|
4813
|
-
|
|
4814
4754
|
/**
|
|
4815
4755
|
* 将节点输入的 AudioBuffer 返回,将节点输出的 AudioBuffer 设置成 silence
|
|
4816
4756
|
*/
|
|
@@ -4862,7 +4802,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
|
|
|
4862
4802
|
|
|
4863
4803
|
/**
|
|
4864
4804
|
* @ignore
|
|
4865
|
-
*
|
|
4805
|
+
* @自从
|
|
4866
4806
|
* <br>   *4.18.0*
|
|
4867
4807
|
*
|
|
4868
4808
|
* 自定义的 SVC 编码配置。
|
|
@@ -4874,7 +4814,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
|
|
|
4874
4814
|
*/
|
|
4875
4815
|
/** @en
|
|
4876
4816
|
* @ignore
|
|
4877
|
-
*
|
|
4817
|
+
* @since
|
|
4878
4818
|
* <br>   *4.18.0*
|
|
4879
4819
|
*
|
|
4880
4820
|
* Custom SVC encoding configurations.
|
|
@@ -4904,7 +4844,7 @@ export declare interface SVCConfiguration {
|
|
|
4904
4844
|
/**
|
|
4905
4845
|
* @ignore
|
|
4906
4846
|
*
|
|
4907
|
-
*
|
|
4847
|
+
* @自从
|
|
4908
4848
|
* <br>   *4.18.0*
|
|
4909
4849
|
*
|
|
4910
4850
|
* SDK 预设的 SVC 编码配置:
|
|
@@ -4921,7 +4861,7 @@ export declare interface SVCConfiguration {
|
|
|
4921
4861
|
/** @en
|
|
4922
4862
|
* @ignore
|
|
4923
4863
|
*
|
|
4924
|
-
*
|
|
4864
|
+
* @since
|
|
4925
4865
|
* <br>   *4.18.0*
|
|
4926
4866
|
*
|
|
4927
4867
|
* The preset SVC configurations provided by the SDK.
|
|
@@ -4949,9 +4889,7 @@ export declare abstract class Track extends EventEmitter implements ITrack {
|
|
|
4949
4889
|
/** 原始的 Track 对象,来自于采集/用户传入/订阅返回 */
|
|
4950
4890
|
_originMediaStreamTrack: MediaStreamTrack;
|
|
4951
4891
|
/** 用于播放和发布的 Track 对象,可能被各种模块修改,一般来说等于 `_originMediaStreamTrack` */
|
|
4952
|
-
|
|
4953
|
-
set _mediaStreamTrack(track: MediaStreamTrack);
|
|
4954
|
-
get _mediaStreamTrack(): MediaStreamTrack;
|
|
4892
|
+
_mediaStreamTrack: MediaStreamTrack;
|
|
4955
4893
|
/** 提供给外部插件以同步数据 */
|
|
4956
4894
|
_external: ExternalMethods;
|
|
4957
4895
|
constructor(track: MediaStreamTrack, trackId?: string);
|
|
@@ -4969,8 +4907,7 @@ export declare abstract class Track extends EventEmitter implements ITrack {
|
|
|
4969
4907
|
export declare enum TrackEvents {
|
|
4970
4908
|
TRANSCEIVER_UPDATED = "transceiver-updated",
|
|
4971
4909
|
SEI_TO_SEND = "sei-to-send",
|
|
4972
|
-
SEI_RECEIVED = "sei-received"
|
|
4973
|
-
TRACK_UPDATED = "track-updated"
|
|
4910
|
+
SEI_RECEIVED = "sei-received"
|
|
4974
4911
|
}
|
|
4975
4912
|
|
|
4976
4913
|
/**
|
|
@@ -4999,7 +4936,6 @@ export declare enum TrackInternalEvent {
|
|
|
4999
4936
|
GET_LOW_VIDEO_TRACK = "@get_low_video_track",
|
|
5000
4937
|
NEED_RESET_REMOTE_SDP = "@need_reset_remote_sdp",
|
|
5001
4938
|
NEED_UPDATE_VIDEO_ENCODER = "@need_update_video_encoder",
|
|
5002
|
-
NEED_UPDATE_VIDEO_SEND_PARAMETERS = "@need_update_video_send_parameters",
|
|
5003
4939
|
NEED_MUTE_TRACK = "@need_mute_track",
|
|
5004
4940
|
NEED_UNMUTE_TRACK = "@need_unmute_track"
|
|
5005
4941
|
}
|
|
@@ -5354,14 +5290,6 @@ export declare class VideoProcessorDestination extends EventEmitter implements I
|
|
|
5354
5290
|
reset(): void;
|
|
5355
5291
|
}
|
|
5356
5292
|
|
|
5357
|
-
declare interface VideoSenderConfig {
|
|
5358
|
-
frameRate: number;
|
|
5359
|
-
bitrateMax: number;
|
|
5360
|
-
bitrateMin: number;
|
|
5361
|
-
scaleResolutionDownBy: number;
|
|
5362
|
-
scale: number;
|
|
5363
|
-
}
|
|
5364
|
-
|
|
5365
5293
|
/**
|
|
5366
5294
|
* 视频流状态。
|
|
5367
5295
|
* @public
|