npm - @realsee/live - Versions diffs - 0.7.3-alpha.0 → 0.7.3 - Mend

@realsee/live 0.7.3-alpha.0 → 0.7.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.

Files changed (119) hide show

package/dist/index.cjs.js +1 -1
package/dist/index.cjs.js.map +1 -1
package/dist/index.es.js +44 -44
package/docs/.nojekyll +1 -0
package/docs/assets/highlight.css +99 -0
package/docs/assets/icons.js +18 -0
package/docs/assets/icons.svg +1 -0
package/docs/assets/main.js +60 -0
package/docs/assets/navigation.js +1 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1493 -0
package/docs/classes/BrowserRTC.html +60 -0
package/docs/classes/BrowserRTC4Chime.html +72 -0
package/docs/classes/CoreRTC.html +60 -0
package/docs/classes/Live.html +93 -0
package/docs/classes/VRWebViewRTC.html +53 -0
package/docs/enums/BuiltInRTCType.html +3 -0
package/docs/enums/BuiltinActionType.html +14 -0
package/docs/enums/BuiltinEventType.html +6 -0
package/docs/enums/Command.html +22 -0
package/docs/enums/LiveState.html +8 -0
package/docs/enums/MemUserStatus.html +7 -0
package/docs/enums/MicroStatus.html +6 -0
package/docs/enums/RTCJoinedInfoCodeEnum.html +12 -0
package/docs/enums/RTCType.html +5 -0
package/docs/enums/UserStatus.html +8 -0
package/docs/enums/WebSocketCloseError.html +20 -0
package/docs/enums/WebSocketErrorType.html +8 -0
package/docs/enums/WebSocketState.html +12 -0
package/docs/functions/GetVoiceSignFn.html +4 -0
package/docs/functions/_clearLiveInstanceIfNeed.html +1 -0
package/docs/functions/createLive.html +2 -0
package/docs/functions/createLiveReact.html +17 -0
package/docs/functions/parseLiveMsg.html +4 -0
package/docs/functions/parseWSClsErr.html +1 -0
package/docs/hierarchy.html +1 -0
package/docs/index.html +349 -0
package/docs/interfaces/AttendeeResponse.html +4 -0
package/docs/interfaces/LiveOptions.html +40 -0
package/docs/interfaces/MeetingResponse.html +3 -0
package/docs/interfaces/MeetingSessionConfigurationOptions.html +8 -0
package/docs/interfaces/Permission.html +15 -0
package/docs/interfaces/RTCJoinedInfo.html +7 -0
package/docs/interfaces/RTCProtocol.html +65 -0
package/docs/interfaces/VRWebViewRTCOptions.html +6 -0
package/docs/modules.html +52 -0
package/docs/types/BuiltinMsg.html +2 -0
package/docs/types/EventType.html +2 -0
package/docs/types/GetVoiceSign.html +2 -0
package/docs/types/GetVoiceSignParams.html +5 -0
package/docs/types/GetVoiceSignReturnType.html +6 -0
package/docs/types/KeyframeEventType.html +2 -0
package/docs/types/LiveBuiltInData.html +1 -0
package/docs/types/LiveConnectOptions.html +8 -0
package/docs/types/LiveEventType.html +15 -0
package/docs/types/LiveMsg.html +2 -0
package/docs/types/LiveProviderPropTypes.html +1 -0
package/docs/types/RTCActionReactCallback.html +1 -0
package/docs/types/RTCEventType.html +7 -0
package/docs/types/ReqLiveMsg.html +6 -0
package/docs/types/RoomInfo.html +1 -0
package/docs/types/UserInfo.html +12 -0
package/docs/types/UserInfoExt.html +5 -0
package/docs/types/UserVolume.html +2 -0
package/docs/types/WebSocketError.html +1 -0
package/package.json +1 -2
package/docs/README.md +0 -437
package/docs/classes/BrowserRTC.md +0 -436
package/docs/classes/BrowserRTC4Chime.md +0 -558
package/docs/classes/CoreRTC.md +0 -448
package/docs/classes/Live.md +0 -770
package/docs/classes/VRWebViewRTC.md +0 -436
package/docs/enumerations/BuiltInRTCType.md +0 -27
package/docs/enumerations/BuiltinActionType.md +0 -81
package/docs/enumerations/BuiltinEventType.md +0 -33
package/docs/enumerations/Command.md +0 -107
package/docs/enumerations/LiveState.md +0 -53
package/docs/enumerations/MemUserStatus.md +0 -67
package/docs/enumerations/MicroStatus.md +0 -33
package/docs/enumerations/RTCJoinedInfoCodeEnum.md +0 -69
package/docs/enumerations/RTCType.md +0 -39
package/docs/enumerations/UserStatus.md +0 -45
package/docs/enumerations/WebSocketCloseError.md +0 -117
package/docs/enumerations/WebSocketErrorType.md +0 -77
package/docs/enumerations/WebSocketState.md +0 -69
package/docs/functions/GetVoiceSignFn.md +0 -27
package/docs/functions/clearLiveInstanceIfNeed.md +0 -17
package/docs/functions/createLive.md +0 -27
package/docs/functions/createLiveReact.md +0 -449
package/docs/functions/parseLiveMsg.md +0 -27
package/docs/functions/parseWSClsErr.md +0 -21
package/docs/globals.md +0 -71
package/docs/interfaces/AttendeeResponse.md +0 -37
package/docs/interfaces/LiveOptions.md +0 -246
package/docs/interfaces/MeetingResponse.md +0 -55
package/docs/interfaces/MeetingSessionConfigurationOptions.md +0 -93
package/docs/interfaces/Permission.md +0 -147
package/docs/interfaces/RTCJoinedInfo.md +0 -67
package/docs/interfaces/RTCProtocol.md +0 -404
package/docs/interfaces/VRWebViewRTCOptions.md +0 -41
package/docs/type-aliases/BuiltinMsg.md +0 -41
package/docs/type-aliases/EventType.md +0 -19
package/docs/type-aliases/GetVoiceSign.md +0 -15
package/docs/type-aliases/GetVoiceSignParams.md +0 -35
package/docs/type-aliases/GetVoiceSignReturnType.md +0 -41
package/docs/type-aliases/KeyframeEventType.md +0 -19
package/docs/type-aliases/LiveBuiltInData.md +0 -47
package/docs/type-aliases/LiveConnectOptions.md +0 -47
package/docs/type-aliases/LiveEventType.md +0 -165
package/docs/type-aliases/LiveMsg.md +0 -53
package/docs/type-aliases/LiveProviderPropTypes.md +0 -27
package/docs/type-aliases/RTCActionReactCallback.md +0 -13
package/docs/type-aliases/RTCEventType.md +0 -65
package/docs/type-aliases/ReqLiveMsg.md +0 -45
package/docs/type-aliases/RoomInfo.md +0 -55
package/docs/type-aliases/UserInfo.md +0 -77
package/docs/type-aliases/UserInfoExt.md +0 -33
package/docs/type-aliases/UserVolume.md +0 -25
package/docs/type-aliases/WebSocketError.md +0 -31

package/docs/classes/CoreRTC.md DELETED Viewed

@@ -1,448 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / CoreRTC
-# Class: `abstract` CoreRTC
-rtc 基础抽象类
-## Extends
-- `Subscribe`\<[`RTCEventType`](../type-aliases/RTCEventType.md)\>
-## Extended by
-- [`BrowserRTC`](BrowserRTC.md)
-- [`BrowserRTC4Chime`](BrowserRTC4Chime.md)
-- [`VRWebViewRTC`](VRWebViewRTC.md)
-## Implements
-- [`RTCProtocol`](../interfaces/RTCProtocol.md)
-## Constructors
-### new CoreRTC()
-> **new CoreRTC**(): [`CoreRTC`](CoreRTC.md)
-#### Returns
-[`CoreRTC`](CoreRTC.md)
-#### Inherited from
-`Subscribe<RTCEventType>.constructor`
-## Properties
-### joined
-> `abstract` **joined**: `boolean`
-是否已经加入房间
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`joined`](../interfaces/RTCProtocol.md#joined)
-#### Defined in
-rtc/CoreRTC.ts:13
-***
-### micro
-> `abstract` **micro**: `boolean`
-麦克风状态
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`micro`](../interfaces/RTCProtocol.md#micro)
-#### Defined in
-rtc/CoreRTC.ts:15
-***
-### type
-> `abstract` **type**: [`RTCType`](../enumerations/RTCType.md)
-rtc 实现类型
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`type`](../interfaces/RTCProtocol.md#type)
-#### Defined in
-rtc/CoreRTC.ts:19
-***
-### voiceId
-> `abstract` **voiceId**: `string`
-语音房间ID
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`voiceId`](../interfaces/RTCProtocol.md#voiceid)
-#### Defined in
-rtc/CoreRTC.ts:17
-## Methods
-### detectMicro()
-> `abstract` **detectMicro**(): `Promise`\<`boolean`\>
-监测麦克风授权。
-#### Returns
-`Promise`\<`boolean`\>
-返回一个Promise，表示麦克风是否被授权
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`detectMicro`](../interfaces/RTCProtocol.md#detectmicro)
-#### Defined in
-rtc/CoreRTC.ts:30
-***
-### emit()
-> **emit**\<`K`\>(`name`, ...`data`): `boolean`
-触发事件
-#### Type Parameters
-• **K** *extends* keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-预设的监听事件名称
-#### Parameters
-• **name**: `K`
-事件类型
-• ...**data**: `Parameters`\<[`RTCEventType`](../type-aliases/RTCEventType.md)\[`K`\]\>
-触发事件的数据
-#### Returns
-`boolean`
-canceled 是否被触发取消
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`emit`](../interfaces/RTCProtocol.md#emit)
-#### Inherited from
-`Subscribe.emit`
-#### Defined in
-utils/subscribe.ts:115
-***
-### hasListener()
-> **hasListener**(`name`): `boolean`
-判断是否注册了事件
-#### Parameters
-• **name**: keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-事件类型
-#### Returns
-`boolean`
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`hasListener`](../interfaces/RTCProtocol.md#haslistener)
-#### Inherited from
-`Subscribe.hasListener`
-#### Defined in
-utils/subscribe.ts:41
-***
-### join()
-> `abstract` **join**(`options`): `Promise`\<`boolean`\>
-加入房间。
-#### Parameters
-• **options**
-加入房间的选项
-• **options.roomId**: `undefined` \| `string` \| `number`
-房间ID
-• **options.type**: [`RTCType`](../enumerations/RTCType.md)
-RTC类型
-• **options.userId**: `string`
-用户ID
-• **options.voiceId**: `string`
-语音房间ID
-#### Returns
-`Promise`\<`boolean`\>
-返回一个Promise，表示是否成功加入房间
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`join`](../interfaces/RTCProtocol.md#join)
-#### Defined in
-rtc/CoreRTC.ts:21
-***
-### off()
-> **off**\<`K`\>(`name`?, `callback`?): `void`
-解除事件
-如果 name 不传的话解除对应所有事件
-如果 name, callback 不传的话解除所有name的所有事件
-#### Type Parameters
-• **K** *extends* keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-预设的监听事件名称
-#### Parameters
-• **name?**: `K`
-事件类型
-• **callback?**
-事件回调函数
-#### Returns
-`void`
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`off`](../interfaces/RTCProtocol.md#off)
-#### Inherited from
-`Subscribe.off`
-#### Defined in
-utils/subscribe.ts:87
-***
-### on()
-> **on**\<`K`\>(`name`, `callback`, `once`?): () => `void`
-注册事件
-#### Type Parameters
-• **K** *extends* keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-预设的监听事件名称
-#### Parameters
-• **name**: `K`
-事件类型
-• **callback**
-事件回调函数
-• **once?**: `boolean`
-是否只执行一次
-#### Returns
-`Function`
-解除事件
-##### Returns
-`void`
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`on`](../interfaces/RTCProtocol.md#on)
-#### Inherited from
-`Subscribe.on`
-#### Defined in
-utils/subscribe.ts:55
-***
-### once()
-> **once**\<`K`\>(`name`, `callback`): () => `void`
-注册事件(是否只执行一次)
-#### Type Parameters
-• **K** *extends* keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-预设的监听事件名称
-#### Parameters
-• **name**: `K`
-事件类型
-• **callback**
-事件回调函数
-#### Returns
-`Function`
-解除事件
-##### Returns
-`void`
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`once`](../interfaces/RTCProtocol.md#once)
-#### Inherited from
-`Subscribe.once`
-#### Defined in
-utils/subscribe.ts:74
-***
-### quit()
-> `abstract` **quit**(): `Promise`\<`boolean`\>
-离开房间。
-#### Returns
-`Promise`\<`boolean`\>
-返回一个Promise，表示是否成功离开房间
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`quit`](../interfaces/RTCProtocol.md#quit)
-#### Defined in
-rtc/CoreRTC.ts:28
-***
-### shock()
-> `abstract` **shock**(): `void`
-震动。
-#### Returns
-`void`
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`shock`](../interfaces/RTCProtocol.md#shock)
-#### Defined in
-rtc/CoreRTC.ts:34
-***
-### toggleMicro()
-> `abstract` **toggleMicro**(`flag`?): `Promise`\<`boolean`\>
-关闭\开启 本地麦克风。
-#### Parameters
-• **flag?**: `boolean`
-是否开启麦克风，默认为切换当前状态
-#### Returns
-`Promise`\<`boolean`\>
-返回一个Promise，表示操作是否成功
-#### Implementation of
-[`RTCProtocol`](../interfaces/RTCProtocol.md).[`toggleMicro`](../interfaces/RTCProtocol.md#togglemicro)
-#### Defined in
-rtc/CoreRTC.ts:32