@seastart/srtc-web-sdk 0.3.0 → 0.3.3
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/package.json +1 -1
- package/srtc.d.mts +58 -3
- package/srtc.d.ts +58 -3
- package/srtc.js +1 -1
- package/srtc.mjs +1 -1
package/package.json
CHANGED
package/srtc.d.mts
CHANGED
|
@@ -38,6 +38,11 @@ declare abstract class BaseSRTC {
|
|
|
38
38
|
* @returns
|
|
39
39
|
*/
|
|
40
40
|
getChannelInfo(): BaseChannelInfo | null;
|
|
41
|
+
/**
|
|
42
|
+
* 获取流媒体引擎的metric快照
|
|
43
|
+
* @returns
|
|
44
|
+
*/
|
|
45
|
+
getStreamMetric(): Record<string, any> | undefined;
|
|
41
46
|
/**
|
|
42
47
|
* 获取某用户信息
|
|
43
48
|
* @returns
|
|
@@ -321,11 +326,25 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
321
326
|
*/
|
|
322
327
|
changeDeviceId(deviceId: string): Promise<void>;
|
|
323
328
|
}
|
|
329
|
+
/**
|
|
330
|
+
* 屏幕共享音频流轨道
|
|
331
|
+
*/
|
|
332
|
+
export declare class LocalScreenAudioTrack extends LocalAudioTrack {
|
|
333
|
+
constructor(captureOptions: ScreenAudioCaptureOptions | true);
|
|
334
|
+
/**
|
|
335
|
+
* 停止采集
|
|
336
|
+
*/
|
|
337
|
+
stopCapture(): void;
|
|
338
|
+
}
|
|
324
339
|
/**
|
|
325
340
|
* 本地屏幕视频流轨道
|
|
326
341
|
*/
|
|
327
342
|
export declare class LocalScreenTrack extends LocalVideoTrack {
|
|
328
343
|
constructor(captureOptions: ScreenCaptureOptions);
|
|
344
|
+
/**
|
|
345
|
+
* 获取音频轨道
|
|
346
|
+
*/
|
|
347
|
+
getAudioTrack(): LocalScreenAudioTrack | undefined;
|
|
329
348
|
/**
|
|
330
349
|
* 开始采集
|
|
331
350
|
* @param opt 采集参数
|
|
@@ -445,18 +464,28 @@ export declare class SRTC extends BaseSRTC {
|
|
|
445
464
|
/**
|
|
446
465
|
* 创建屏幕共享本地视频流
|
|
447
466
|
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
467
|
+
* @param audioPreset 屏幕共享音频预设,默认为 ScreenAudioPresets["default"]
|
|
448
468
|
*/
|
|
449
|
-
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
469
|
+
createLocalScreenTrack(preset?: ScreenPreset, audioPreset?: ScreenAudioPreset): LocalScreenTrack;
|
|
450
470
|
/**
|
|
451
471
|
* 创建自定义本地视频流
|
|
452
472
|
*/
|
|
453
473
|
createLocalCustomVideoTrack(msTrack: MediaStreamTrack): LocalVideoTrack;
|
|
474
|
+
/**
|
|
475
|
+
* 临时enable本地流轨道,如取消静音麦克风
|
|
476
|
+
*/
|
|
477
|
+
enableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
478
|
+
/**
|
|
479
|
+
* 临时disable本地流轨道,如临时静音麦克风
|
|
480
|
+
* 比unpublishLocalTrack取消发布轨道轻
|
|
481
|
+
*/
|
|
482
|
+
disableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
454
483
|
/**
|
|
455
484
|
* 发布本地流轨道
|
|
456
485
|
* @param track
|
|
457
486
|
* @returns
|
|
458
487
|
*/
|
|
459
|
-
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: AudioPublishOptions | VideoPublishOptions): Promise<void>;
|
|
488
|
+
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: Partial<AudioPublishOptions> | Partial<VideoPublishOptions>): Promise<void>;
|
|
460
489
|
/**
|
|
461
490
|
* 取消发布本地流
|
|
462
491
|
* @param track
|
|
@@ -516,6 +545,13 @@ export declare const MicPresets: {
|
|
|
516
545
|
/** 双声道,采样率48kHz,码率96Kbps */
|
|
517
546
|
musicHighQualityStereo: MicPreset;
|
|
518
547
|
};
|
|
548
|
+
/**
|
|
549
|
+
* 屏幕共享系统音频预设参数
|
|
550
|
+
*/
|
|
551
|
+
export declare const ScreenAudioPresets: {
|
|
552
|
+
/** 系统音频,码率24Kbps */
|
|
553
|
+
default: ScreenAudioPreset;
|
|
554
|
+
};
|
|
519
555
|
/**
|
|
520
556
|
* 屏幕共享预设参数
|
|
521
557
|
*/
|
|
@@ -908,6 +944,18 @@ export interface PropChangeItem<T> {
|
|
|
908
944
|
/** 更改前的值 */
|
|
909
945
|
old: any;
|
|
910
946
|
}
|
|
947
|
+
/**
|
|
948
|
+
* 屏幕采集音频配置
|
|
949
|
+
*/
|
|
950
|
+
export interface ScreenAudioCaptureOptions extends Omit<MicCaptureOptions, "deviceId"> {
|
|
951
|
+
}
|
|
952
|
+
/**
|
|
953
|
+
* 屏幕共享音频预设值
|
|
954
|
+
*/
|
|
955
|
+
export interface ScreenAudioPreset {
|
|
956
|
+
capture: ScreenAudioCaptureOptions | true;
|
|
957
|
+
publish: AudioPublishOptions;
|
|
958
|
+
}
|
|
911
959
|
/**
|
|
912
960
|
* 屏幕采集配置
|
|
913
961
|
*/
|
|
@@ -987,6 +1035,11 @@ export interface VideoPublishOptions {
|
|
|
987
1035
|
* 优先级,默认音频优先
|
|
988
1036
|
*/
|
|
989
1037
|
priority?: RTCPriorityType;
|
|
1038
|
+
/**
|
|
1039
|
+
* degradationPreference
|
|
1040
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpEncodingParameters/degradationPreference
|
|
1041
|
+
*/
|
|
1042
|
+
degradationPreference?: RTCDegradationPreference;
|
|
990
1043
|
/** 自定义属性 */
|
|
991
1044
|
props?: Record<string, any>;
|
|
992
1045
|
simulcasts?: VideoPublishOptions[];
|
|
@@ -1011,6 +1064,8 @@ interface BaseChannelInfo {
|
|
|
1011
1064
|
created_at: number;
|
|
1012
1065
|
/** 频道更新时间 */
|
|
1013
1066
|
updated_at: number;
|
|
1067
|
+
/** 白板地址 */
|
|
1068
|
+
white_board: string;
|
|
1014
1069
|
}
|
|
1015
1070
|
/**
|
|
1016
1071
|
* 流轨道信息
|
|
@@ -1035,7 +1090,7 @@ interface BaseTrackInfo {
|
|
|
1035
1090
|
/** 码率 */
|
|
1036
1091
|
bitrate: number;
|
|
1037
1092
|
/** 音频采样率 */
|
|
1038
|
-
|
|
1093
|
+
sample_rate: number;
|
|
1039
1094
|
/** 流扩展属性 */
|
|
1040
1095
|
props?: Record<string, any>;
|
|
1041
1096
|
}
|
package/srtc.d.ts
CHANGED
|
@@ -38,6 +38,11 @@ declare abstract class BaseSRTC {
|
|
|
38
38
|
* @returns
|
|
39
39
|
*/
|
|
40
40
|
getChannelInfo(): BaseChannelInfo | null;
|
|
41
|
+
/**
|
|
42
|
+
* 获取流媒体引擎的metric快照
|
|
43
|
+
* @returns
|
|
44
|
+
*/
|
|
45
|
+
getStreamMetric(): Record<string, any> | undefined;
|
|
41
46
|
/**
|
|
42
47
|
* 获取某用户信息
|
|
43
48
|
* @returns
|
|
@@ -321,11 +326,25 @@ export declare class LocalMicTrack extends LocalAudioTrack {
|
|
|
321
326
|
*/
|
|
322
327
|
changeDeviceId(deviceId: string): Promise<void>;
|
|
323
328
|
}
|
|
329
|
+
/**
|
|
330
|
+
* 屏幕共享音频流轨道
|
|
331
|
+
*/
|
|
332
|
+
export declare class LocalScreenAudioTrack extends LocalAudioTrack {
|
|
333
|
+
constructor(captureOptions: ScreenAudioCaptureOptions | true);
|
|
334
|
+
/**
|
|
335
|
+
* 停止采集
|
|
336
|
+
*/
|
|
337
|
+
stopCapture(): void;
|
|
338
|
+
}
|
|
324
339
|
/**
|
|
325
340
|
* 本地屏幕视频流轨道
|
|
326
341
|
*/
|
|
327
342
|
export declare class LocalScreenTrack extends LocalVideoTrack {
|
|
328
343
|
constructor(captureOptions: ScreenCaptureOptions);
|
|
344
|
+
/**
|
|
345
|
+
* 获取音频轨道
|
|
346
|
+
*/
|
|
347
|
+
getAudioTrack(): LocalScreenAudioTrack | undefined;
|
|
329
348
|
/**
|
|
330
349
|
* 开始采集
|
|
331
350
|
* @param opt 采集参数
|
|
@@ -445,18 +464,28 @@ export declare class SRTC extends BaseSRTC {
|
|
|
445
464
|
/**
|
|
446
465
|
* 创建屏幕共享本地视频流
|
|
447
466
|
* @param preset 屏幕共享预设,默认为 ScreenPresets["1080p"]
|
|
467
|
+
* @param audioPreset 屏幕共享音频预设,默认为 ScreenAudioPresets["default"]
|
|
448
468
|
*/
|
|
449
|
-
createLocalScreenTrack(preset?: ScreenPreset): LocalScreenTrack;
|
|
469
|
+
createLocalScreenTrack(preset?: ScreenPreset, audioPreset?: ScreenAudioPreset): LocalScreenTrack;
|
|
450
470
|
/**
|
|
451
471
|
* 创建自定义本地视频流
|
|
452
472
|
*/
|
|
453
473
|
createLocalCustomVideoTrack(msTrack: MediaStreamTrack): LocalVideoTrack;
|
|
474
|
+
/**
|
|
475
|
+
* 临时enable本地流轨道,如取消静音麦克风
|
|
476
|
+
*/
|
|
477
|
+
enableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
478
|
+
/**
|
|
479
|
+
* 临时disable本地流轨道,如临时静音麦克风
|
|
480
|
+
* 比unpublishLocalTrack取消发布轨道轻
|
|
481
|
+
*/
|
|
482
|
+
disableLocalTrack(track: LocalAudioTrack | LocalVideoTrack): void;
|
|
454
483
|
/**
|
|
455
484
|
* 发布本地流轨道
|
|
456
485
|
* @param track
|
|
457
486
|
* @returns
|
|
458
487
|
*/
|
|
459
|
-
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: AudioPublishOptions | VideoPublishOptions): Promise<void>;
|
|
488
|
+
publishLocalTrack(track: LocalAudioTrack | LocalVideoTrack, opt?: Partial<AudioPublishOptions> | Partial<VideoPublishOptions>): Promise<void>;
|
|
460
489
|
/**
|
|
461
490
|
* 取消发布本地流
|
|
462
491
|
* @param track
|
|
@@ -516,6 +545,13 @@ export declare const MicPresets: {
|
|
|
516
545
|
/** 双声道,采样率48kHz,码率96Kbps */
|
|
517
546
|
musicHighQualityStereo: MicPreset;
|
|
518
547
|
};
|
|
548
|
+
/**
|
|
549
|
+
* 屏幕共享系统音频预设参数
|
|
550
|
+
*/
|
|
551
|
+
export declare const ScreenAudioPresets: {
|
|
552
|
+
/** 系统音频,码率24Kbps */
|
|
553
|
+
default: ScreenAudioPreset;
|
|
554
|
+
};
|
|
519
555
|
/**
|
|
520
556
|
* 屏幕共享预设参数
|
|
521
557
|
*/
|
|
@@ -908,6 +944,18 @@ export interface PropChangeItem<T> {
|
|
|
908
944
|
/** 更改前的值 */
|
|
909
945
|
old: any;
|
|
910
946
|
}
|
|
947
|
+
/**
|
|
948
|
+
* 屏幕采集音频配置
|
|
949
|
+
*/
|
|
950
|
+
export interface ScreenAudioCaptureOptions extends Omit<MicCaptureOptions, "deviceId"> {
|
|
951
|
+
}
|
|
952
|
+
/**
|
|
953
|
+
* 屏幕共享音频预设值
|
|
954
|
+
*/
|
|
955
|
+
export interface ScreenAudioPreset {
|
|
956
|
+
capture: ScreenAudioCaptureOptions | true;
|
|
957
|
+
publish: AudioPublishOptions;
|
|
958
|
+
}
|
|
911
959
|
/**
|
|
912
960
|
* 屏幕采集配置
|
|
913
961
|
*/
|
|
@@ -987,6 +1035,11 @@ export interface VideoPublishOptions {
|
|
|
987
1035
|
* 优先级,默认音频优先
|
|
988
1036
|
*/
|
|
989
1037
|
priority?: RTCPriorityType;
|
|
1038
|
+
/**
|
|
1039
|
+
* degradationPreference
|
|
1040
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpEncodingParameters/degradationPreference
|
|
1041
|
+
*/
|
|
1042
|
+
degradationPreference?: RTCDegradationPreference;
|
|
990
1043
|
/** 自定义属性 */
|
|
991
1044
|
props?: Record<string, any>;
|
|
992
1045
|
simulcasts?: VideoPublishOptions[];
|
|
@@ -1011,6 +1064,8 @@ interface BaseChannelInfo {
|
|
|
1011
1064
|
created_at: number;
|
|
1012
1065
|
/** 频道更新时间 */
|
|
1013
1066
|
updated_at: number;
|
|
1067
|
+
/** 白板地址 */
|
|
1068
|
+
white_board: string;
|
|
1014
1069
|
}
|
|
1015
1070
|
/**
|
|
1016
1071
|
* 流轨道信息
|
|
@@ -1035,7 +1090,7 @@ interface BaseTrackInfo {
|
|
|
1035
1090
|
/** 码率 */
|
|
1036
1091
|
bitrate: number;
|
|
1037
1092
|
/** 音频采样率 */
|
|
1038
|
-
|
|
1093
|
+
sample_rate: number;
|
|
1039
1094
|
/** 流扩展属性 */
|
|
1040
1095
|
props?: Record<string, any>;
|
|
1041
1096
|
}
|