@realsee/live 0.5.2-dev.1 → 0.5.2-dev.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/dist/live/controller.d.ts +1 -1
- package/dist/live/createLiveReact.d.ts +1 -1
- package/dist/live/live.d.ts +1 -1
- package/dist/realsee-live.cjs.development.js +127 -124
- package/dist/realsee-live.cjs.development.js.map +1 -1
- package/dist/realsee-live.cjs.production.js +1 -1
- package/dist/realsee-live.cjs.production.js.map +1 -1
- package/dist/realsee-live.esm.js +127 -124
- package/dist/realsee-live.esm.js.map +1 -1
- package/dist/realsee-live.umd.development.js +1155 -949
- package/dist/realsee-live.umd.development.js.map +1 -1
- package/dist/realsee-live.umd.production.js +1 -1
- package/dist/realsee-live.umd.production.js.map +1 -1
- package/dist/typings/live/EventType.d.ts +3 -3
- package/dist/typings/live/GetVoiceSign.d.ts +1 -1
- package/dist/typings/live/LiveConnectOptions.d.ts +1 -1
- package/dist/typings/live/LiveMsg.d.ts +3 -3
- package/dist/typings/live/RoomInfo.d.ts +1 -1
- package/dist/typings/live/UserInfo.d.ts +20 -3
- package/dist/typings/live/UserVolume.d.ts +1 -1
- package/dist/typings/live/WebSocket.d.ts +1 -1
- package/dist/typings/react/RTCActionReactCallback.d.ts +1 -1
- package/dist/typings/rtc/eventType.d.ts +1 -1
- package/dist/utils/RobustWebSocket.d.ts +5 -5
- package/dist/utils/subscribe.d.ts +1 -1
- package/docs/classes/BrowserRTC.html +3 -3
- package/docs/modules.html +2 -2
- package/package.json +13 -12
|
@@ -4,7 +4,7 @@ import { UserInfo } from './UserInfo';
|
|
|
4
4
|
/**
|
|
5
5
|
* 带看事件列表
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
7
|
+
export type LiveEventType<KeyframesSnapshot> = {
|
|
8
8
|
/**
|
|
9
9
|
* 带看状态变化
|
|
10
10
|
* @param state
|
|
@@ -65,10 +65,10 @@ export declare type LiveEventType<KeyframesSnapshot> = {
|
|
|
65
65
|
/**
|
|
66
66
|
* 帧数据类型
|
|
67
67
|
*/
|
|
68
|
-
export
|
|
68
|
+
export type KeyframeTypes<Type> = {
|
|
69
69
|
[Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void;
|
|
70
70
|
};
|
|
71
71
|
/**
|
|
72
72
|
* 事件解析
|
|
73
73
|
*/
|
|
74
|
-
export
|
|
74
|
+
export type EventType<KeyframesSnapshot> = LiveEventType<KeyframesSnapshot>;
|
|
@@ -10,7 +10,7 @@ export interface GetVoiceSignReturnType {
|
|
|
10
10
|
/**
|
|
11
11
|
* 获取用户语音签名
|
|
12
12
|
*/
|
|
13
|
-
export
|
|
13
|
+
export type GetVoiceSign = ({ voiceId, userId, roomId, }: {
|
|
14
14
|
voiceId: string;
|
|
15
15
|
userId: string;
|
|
16
16
|
roomId: string | number;
|
|
@@ -16,7 +16,7 @@ export declare enum Command {
|
|
|
16
16
|
/**
|
|
17
17
|
* 向服务端请求数据时的数据格式。
|
|
18
18
|
*/
|
|
19
|
-
export
|
|
19
|
+
export type ReqLiveMsg = {
|
|
20
20
|
/**
|
|
21
21
|
* 请求指令。
|
|
22
22
|
*/
|
|
@@ -81,7 +81,7 @@ export declare enum BuiltinActionType {
|
|
|
81
81
|
/**
|
|
82
82
|
* 内置事件数据结构体。
|
|
83
83
|
*/
|
|
84
|
-
export
|
|
84
|
+
export type BuiltinMsg = {
|
|
85
85
|
event_type: BuiltinEventType;
|
|
86
86
|
action: BuiltinActionType;
|
|
87
87
|
to_user_ids: string[];
|
|
@@ -100,7 +100,7 @@ export declare enum MicroStatus {
|
|
|
100
100
|
/**
|
|
101
101
|
* 响应的信息结构体。
|
|
102
102
|
*/
|
|
103
|
-
export
|
|
103
|
+
export type LiveMsg = {
|
|
104
104
|
code: string;
|
|
105
105
|
message: string;
|
|
106
106
|
command: Command;
|
|
@@ -26,7 +26,7 @@ export declare enum MemUserStatus {
|
|
|
26
26
|
/**
|
|
27
27
|
* 用户信息扩展字段:比如提供用户画像相关的数据。
|
|
28
28
|
*/
|
|
29
|
-
export
|
|
29
|
+
export type UserInfoExt = {
|
|
30
30
|
/**
|
|
31
31
|
* 用户昵称。
|
|
32
32
|
*/
|
|
@@ -43,7 +43,7 @@ export declare type UserInfoExt = {
|
|
|
43
43
|
/**
|
|
44
44
|
* 带看会话房间用户的信息格式。
|
|
45
45
|
*/
|
|
46
|
-
export
|
|
46
|
+
export type UserInfo = {
|
|
47
47
|
/**
|
|
48
48
|
* 用户唯一标识ID。
|
|
49
49
|
*/
|
|
@@ -79,9 +79,26 @@ export declare type UserInfo = {
|
|
|
79
79
|
/**
|
|
80
80
|
* 当前用户的权限配置。(UI层面理解)。
|
|
81
81
|
*/
|
|
82
|
-
permission?:
|
|
82
|
+
permission?: Partial<Permission>;
|
|
83
83
|
/**
|
|
84
84
|
* 用户信息扩展字段。
|
|
85
85
|
*/
|
|
86
86
|
extension?: UserInfoExt;
|
|
87
87
|
};
|
|
88
|
+
interface Permission {
|
|
89
|
+
more_vr_scene: boolean;
|
|
90
|
+
invite_other: boolean;
|
|
91
|
+
control_own_micro: boolean;
|
|
92
|
+
control_other_micro: boolean;
|
|
93
|
+
view_own_micro_status: boolean;
|
|
94
|
+
view_other_micro_status: boolean;
|
|
95
|
+
close_live_room: boolean;
|
|
96
|
+
apply_other_phone: boolean;
|
|
97
|
+
dynamic_enter: boolean;
|
|
98
|
+
sync_frame: boolean;
|
|
99
|
+
transfer_role: boolean;
|
|
100
|
+
change_other_status: boolean;
|
|
101
|
+
control_other_sync: boolean;
|
|
102
|
+
extension: Record<string, boolean>;
|
|
103
|
+
}
|
|
104
|
+
export {};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { RTCProtocol } from '../rtc/protocol';
|
|
2
|
-
export
|
|
2
|
+
export type RTCActionReactCallback = Pick<RTCProtocol, 'join' | 'quit' | 'shock' | 'toggleMicro' | 'detectMicro'>;
|
|
@@ -2,7 +2,7 @@ import { Subscribe } from './subscribe';
|
|
|
2
2
|
/**
|
|
3
3
|
* 鲁棒ws的配置参数
|
|
4
4
|
*/
|
|
5
|
-
export
|
|
5
|
+
export type RobustWebSocketConstructorOptions = {
|
|
6
6
|
url: string | ((ws: RobustWebSocket) => string);
|
|
7
7
|
protocols?: string[];
|
|
8
8
|
robustOptions?: RobustOptions;
|
|
@@ -10,21 +10,21 @@ export declare type RobustWebSocketConstructorOptions = {
|
|
|
10
10
|
/**
|
|
11
11
|
* ws 鲁棒性的配置
|
|
12
12
|
*/
|
|
13
|
-
export
|
|
13
|
+
export type RobustOptions = {
|
|
14
14
|
timeout?: number;
|
|
15
15
|
shouldReconnect?: (event: CloseEvent, ws: RobustWebSocket) => undefined | number;
|
|
16
16
|
should1000Reconnect?: boolean;
|
|
17
17
|
ignoreConnectivityEvents?: boolean;
|
|
18
18
|
automaticOpen?: boolean;
|
|
19
19
|
};
|
|
20
|
-
export
|
|
20
|
+
export type RobustWebSocketEventDetail = {
|
|
21
21
|
reconnects: number;
|
|
22
22
|
attempts: number;
|
|
23
23
|
};
|
|
24
|
-
export
|
|
24
|
+
export type RobustWebSocketEvent<T> = Event & {
|
|
25
25
|
detail: T;
|
|
26
26
|
};
|
|
27
|
-
export
|
|
27
|
+
export type RobustWebSocketEventMap = {
|
|
28
28
|
connecting: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
|
|
29
29
|
timeout: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
|
|
30
30
|
open: (event: RobustWebSocketEvent<RobustWebSocketEventDetail>) => void;
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<p>rtc 实现类型</p>
|
|
7
7
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a id="voiceId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">voice<wbr/>Id<a href="#voiceId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">voice<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></div><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#voiceId">voiceId</a></p><ul><li>Defined in rtc/BrowserRTC.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>语音房间ID</p>
|
|
9
|
-
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_handleStreamAdded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _handle<wbr/>Stream<wbr/>Added<a href="#_handleStreamAdded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">_handle<wbr/>Stream<wbr/>Added<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:
|
|
9
|
+
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_handleStreamAdded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _handle<wbr/>Stream<wbr/>Added<a href="#_handleStreamAdded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">_handle<wbr/>Stream<wbr/>Added<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:172</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_handleStreamSubscribed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _handle<wbr/>Stream<wbr/>Subscribed<a href="#_handleStreamSubscribed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">_handle<wbr/>Stream<wbr/>Subscribed<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:179</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_initParentDom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _init<wbr/>Parent<wbr/>Dom<a href="#_initParentDom" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">_init<wbr/>Parent<wbr/>Dom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:39</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_registerRtcEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> _register<wbr/>Rtc<wbr/>Event<a href="#_registerRtcEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">_register<wbr/>Rtc<wbr/>Event<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:157</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="checkRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link">check<wbr/>Requirement<a href="#checkRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<wbr/>Requirement<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">CheckResult</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in rtc/BrowserRTC.ts:24</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">CheckResult</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="detectMicro" class="tsd-anchor"></a><h3 class="tsd-anchor-link">detect<wbr/>Micro<a href="#detectMicro" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">detect<wbr/>Micro<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#detectMicro">detectMicro</a></p><ul><li>Defined in rtc/BrowserRTC.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
10
|
<p>监测麦克风授权。</p>
|
|
11
11
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">emit<a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#emit">emit</a></p><ul><li>Defined in utils/subscribe.ts:122</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
12
|
<p>触发事件</p>
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
|
|
62
62
|
</div></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="quit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">quit<a href="#quit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">quit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#quit">quit</a></p><ul><li>Defined in rtc/BrowserRTC.ts:110</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
63
63
|
<p>离开房间。</p>
|
|
64
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="shock" class="tsd-anchor"></a><h3 class="tsd-anchor-link">shock<a href="#shock" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">shock<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#shock">shock</a></p><ul><li>Defined in rtc/BrowserRTC.ts:
|
|
64
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="shock" class="tsd-anchor"></a><h3 class="tsd-anchor-link">shock<a href="#shock" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">shock<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#shock">shock</a></p><ul><li>Defined in rtc/BrowserRTC.ts:153</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
65
65
|
<p>震动。</p>
|
|
66
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="toggleMicro" class="tsd-anchor"></a><h3 class="tsd-anchor-link">toggle<wbr/>Micro<a href="#toggleMicro" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">toggle<wbr/>Micro<span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#toggleMicro">toggleMicro</a></p><ul><li>Defined in rtc/BrowserRTC.ts:
|
|
66
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a id="toggleMicro" class="tsd-anchor"></a><h3 class="tsd-anchor-link">toggle<wbr/>Micro<a href="#toggleMicro" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">toggle<wbr/>Micro<span class="tsd-signature-symbol">(</span>flag<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="CoreRTC.html">CoreRTC</a>.<a href="CoreRTC.html#toggleMicro">toggleMicro</a></p><ul><li>Defined in rtc/BrowserRTC.ts:145</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
67
67
|
<p>关闭\开启 本地麦克风。</p>
|
|
68
68
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> flag: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="BrowserRTC.html" class="tsd-kind-icon">BrowserRTC</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_dom" class="tsd-kind-icon">$dom</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_getVoiceSign" class="tsd-kind-icon">_get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_trtc" class="tsd-kind-icon">_trtc</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#joined" class="tsd-kind-icon">joined</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#micro" class="tsd-kind-icon">micro</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#voiceId" class="tsd-kind-icon">voice<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_handleStreamAdded" class="tsd-kind-icon">_handle<wbr/>Stream<wbr/>Added</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_handleStreamSubscribed" class="tsd-kind-icon">_handle<wbr/>Stream<wbr/>Subscribed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_initParentDom" class="tsd-kind-icon">_init<wbr/>Parent<wbr/>Dom</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="BrowserRTC.html#_registerRtcEvent" class="tsd-kind-icon">_register<wbr/>Rtc<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="BrowserRTC.html#checkRequirement" class="tsd-kind-icon">check<wbr/>Requirement</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#detectMicro" class="tsd-kind-icon">detect<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BrowserRTC.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="BrowserRTC.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#join" class="tsd-kind-icon">join</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BrowserRTC.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BrowserRTC.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="BrowserRTC.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#shock" class="tsd-kind-icon">shock</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="BrowserRTC.html#toggleMicro" class="tsd-kind-icon">toggle<wbr/>Micro</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
package/docs/modules.html
CHANGED
|
@@ -79,7 +79,7 @@
|
|
|
79
79
|
<p>如果此数据仅发送给某些用户,请提供这些用户的ucid。</p>
|
|
80
80
|
</div></div></li></ul></li><li class="tsd-parameter"><h5>front_<wbr/>request_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
81
81
|
<p>前端请求时生成的uuid()。</p>
|
|
82
|
-
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="RoomInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Room<wbr/>Info<a href="#RoomInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>init_timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/RoomInfo.ts:1</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>app_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>user_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>room_<wbr/>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5>init_<wbr/>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>last_<wbr/>frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="UserInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">User<wbr/>Info<a href="#UserInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">?: </span><a href="modules.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mem_user_status<span class="tsd-signature-symbol">?: </span><a href="enums/MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a><span class="tsd-signature-symbol">; </span>micro_status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>once_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
|
82
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="RoomInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Room<wbr/>Info<a href="#RoomInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>init_timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/RoomInfo.ts:1</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>app_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>user_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>room_<wbr/>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5>init_<wbr/>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>last_<wbr/>frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="UserInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">User<wbr/>Info<a href="#UserInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">?: </span><a href="modules.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mem_user_status<span class="tsd-signature-symbol">?: </span><a href="enums/MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a><span class="tsd-signature-symbol">; </span>micro_status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>once_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Permission</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><a href="enums/UserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">UserStatus</a><span class="tsd-signature-symbol">; </span>user_role<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:49</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
83
83
|
<p>带看会话房间用户的信息格式。</p>
|
|
84
84
|
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> current_<wbr/>ws_<wbr/>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
85
85
|
<p>用户当前是否在线。</p>
|
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
<p>用户当前是否开启麦克风。</p>
|
|
94
94
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> once_<wbr/>ws_<wbr/>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
95
95
|
<p>用户曾经是否在线过,即进入房间后又由于某种原因离开后重新进入。</p>
|
|
96
|
-
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
|
96
|
+
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Permission</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
97
97
|
<p>当前用户的权限配置。(UI层面理解)。</p>
|
|
98
98
|
</div></div></li><li class="tsd-parameter"><h5>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
99
99
|
<p>RTC 环境是否就绪,即当前语音是否联通。</p>
|
package/package.json
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@realsee/live",
|
|
3
|
-
"version": "0.5.2-dev.
|
|
3
|
+
"version": "0.5.2-dev.2",
|
|
4
4
|
"description": "如视 Live SDK:基于如视 WebSocket 长链双工通信能力的前端封装,借助此 SDK 您可以快捷地实现具备同屏连线、实时语音的 VR 带看业务能力。",
|
|
5
|
+
"scripts": {
|
|
6
|
+
"build": "npx rollpkg build --addUmdBuild",
|
|
7
|
+
"dev": "npx rollpkg watch",
|
|
8
|
+
"prepublishOnly": "npm run build && npm run docs",
|
|
9
|
+
"lint": "npx eslint src",
|
|
10
|
+
"test": "npx jest",
|
|
11
|
+
"test:watch": "npx jest --watchAll",
|
|
12
|
+
"coverage": "npx live-server coverage/lcov-report",
|
|
13
|
+
"docs": "npx typedoc"
|
|
14
|
+
},
|
|
5
15
|
"main": "dist/realsee-live.cjs.js",
|
|
6
16
|
"module": "dist/realsee-live.esm.js",
|
|
7
17
|
"types": "dist/index.d.ts",
|
|
@@ -27,14 +37,5 @@
|
|
|
27
37
|
"trtc-js-sdk": "4.15.2"
|
|
28
38
|
},
|
|
29
39
|
"author": "BEIKE REALSEE TECHNOLOGY (HK) LIMITED",
|
|
30
|
-
"license": "SEE LICENSE IN TERMS.txt"
|
|
31
|
-
|
|
32
|
-
"build": "npx rollpkg build --addUmdBuild",
|
|
33
|
-
"dev": "npx rollpkg watch",
|
|
34
|
-
"lint": "npx eslint src",
|
|
35
|
-
"test": "npx jest",
|
|
36
|
-
"test:watch": "npx jest --watchAll",
|
|
37
|
-
"coverage": "npx live-server coverage/lcov-report",
|
|
38
|
-
"docs": "npx typedoc"
|
|
39
|
-
}
|
|
40
|
-
}
|
|
40
|
+
"license": "SEE LICENSE IN TERMS.txt"
|
|
41
|
+
}
|