npm - @realsee/live - Versions diffs - 0.7.2 → 0.7.3 - Mend

@realsee/live 0.7.2 → 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 (121) hide show

package/README.md +5 -3
package/dist/index.cjs.js +3 -3
package/dist/index.cjs.js.map +1 -1
package/dist/index.es.js +1774 -1770
package/dist/index.es.js.map +1 -1
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 -435
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/interfaces/LiveOptions.md DELETED Viewed

@@ -1,246 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / LiveOptions
-# Interface: LiveOptions
-依赖配置。
-## Properties
-### \_\_debug\_\_?
-> `optional` **\_\_debug\_\_**: `boolean`
-是否开启调试模式：此模式下会在终端打印日志方便调试。
-#### Defined in
-typings/live/LiveOptions.ts:86
-***
-### autoPlayConfirm()?
-> `optional` **autoPlayConfirm**: (`options`) => `void`
-使用webRTC时会有自动播放的安全策略限制，用户有交互
-#### Parameters
-• **options**
-• **options.onConfirm**
-#### Returns
-`void`
-#### Defined in
-typings/live/LiveOptions.ts:54
-***
-### builtInRTCType?
-> `optional` **builtInRTCType**: [`BuiltInRTCType`](../enumerations/BuiltInRTCType.md)
-内置的rtc通道类型
-trtc or chime , default trtc
-#### Defined in
-typings/live/LiveOptions.ts:65
-***
-### canForbidUserKick()?
-> `optional` **canForbidUserKick**: (`users`) => `boolean`
-能否强制"踢掉"某个/些用户。
-#### Parameters
-• **users**: `string` \| `string`[]
-#### Returns
-`boolean`
-#### Defined in
-typings/live/LiveOptions.ts:82
-***
-### canForbidUserMicro()?
-> `optional` **canForbidUserMicro**: (`users`) => `boolean`
-能否禁用某个/些用户的麦克风
-#### Parameters
-• **users**: `string` \| `string`[]
-#### Returns
-`boolean`
-#### Defined in
-typings/live/LiveOptions.ts:74
-***
-### canForbidUserSync()?
-> `optional` **canForbidUserSync**: (`users`) => `boolean`
-能否限制某个/些用户的帧数据同步
-#### Parameters
-• **users**: `string` \| `string`[]
-#### Returns
-`boolean`
-#### Defined in
-typings/live/LiveOptions.ts:78
-***
-### getTicket()?
-> `optional` **getTicket**: () => `Promise`\<`string`\>
-获取建立 WebSocket 连接的依赖Tick
-#### Returns
-`Promise`\<`string`\>
-#### Defined in
-typings/live/LiveOptions.ts:35
-***
-### getVoiceSign()?
-> `optional` **getVoiceSign**: (`params`) => `Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-获取语音签名的接口
-使用内置rtc时提供给rtc实例使用
-获取用户语音签名的方法
-#### Parameters
-• **params**: [`GetVoiceSignParams`](../type-aliases/GetVoiceSignParams.md)
-获取语音签名所需的参数
-#### Returns
-`Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-返回一个Promise，解析为语音签名的相关信息
-#### Defined in
-typings/live/LiveOptions.ts:47
-***
-### initialMicroStatus?
-> `optional` **initialMicroStatus**: [`MicroStatus`](../enumerations/MicroStatus.md)
-麦克风初始状态
-#### Defined in
-typings/live/LiveOptions.ts:30
-***
-### jsBridge?
-> `optional` **jsBridge**: `JSBridgeProtocol`
-jsBridge实例
-使用内置rtc时提供给rtc实例使用
-#### Defined in
-typings/live/LiveOptions.ts:41
-***
-### rtc?
-> `optional` **rtc**: [`RTCProtocol`](RTCProtocol.md)
-RTC实例。
-优先使用该实例。
-#### Defined in
-typings/live/LiveOptions.ts:19
-***
-### rtcType?
-> `optional` **rtcType**: [`RTCType`](../enumerations/RTCType.md)
-RTC类型
-rtc 为空时使用内置的rtc实例类型
-#### Defined in
-typings/live/LiveOptions.ts:25
-***
-### url?
-> `optional` **url**: `string`
-创建`WebSocket`所依赖的URL。
-#### Defined in
-typings/live/LiveOptions.ts:14
-***
-### useBuiltInJsBridge?
-> `optional` **useBuiltInJsBridge**: `boolean`
-使用内置的jsBridge实例
-#### Defined in
-typings/live/LiveOptions.ts:70
-***
-### useBuiltInRTC?
-> `optional` **useBuiltInRTC**: `boolean`
-使用内置的rtc实例
-#### Defined in
-typings/live/LiveOptions.ts:59

package/docs/interfaces/MeetingResponse.md DELETED Viewed

@@ -1,55 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / MeetingResponse
-# Interface: MeetingResponse
-## Properties
-### MediaPlacement
-> **MediaPlacement**: `object`
-#### AudioFallbackUrl
-> **AudioFallbackUrl**: `string`
-#### AudioHostUrl
-> **AudioHostUrl**: `string`
-#### ScreenDataUrl
-> **ScreenDataUrl**: `string`
-#### ScreenSharingUrl
-> **ScreenSharingUrl**: `string`
-#### ScreenViewingUrl
-> **ScreenViewingUrl**: `string`
-#### SignalingUrl
-> **SignalingUrl**: `string`
-#### TurnControlUrl
-> **TurnControlUrl**: `string`
-#### Defined in
-typings/chime/MeetingResponse.ts:2
-***
-### MeetingId
-> **MeetingId**: `string`
-#### Defined in
-typings/chime/MeetingResponse.ts:11

package/docs/interfaces/MeetingSessionConfigurationOptions.md DELETED Viewed

@@ -1,93 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / MeetingSessionConfigurationOptions
-# Interface: MeetingSessionConfigurationOptions
-## Properties
-### attendence
-> **attendence**: [`AttendeeResponse`](AttendeeResponse.md)
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:5
-***
-### config
-> **config**: `object`
-#### app\_id
-> **app\_id**: `string`
-#### bypass
-> **bypass**: `any`
-#### passport
-> **passport**: `string`
-#### vendor
-> **vendor**: `string`
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:6
-***
-### expire\_time
-> **expire\_time**: `number`
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:7
-***
-### identifier
-> **identifier**: `string`
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:8
-***
-### user\_id
-> **user\_id**: `string`
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:9
-***
-### user\_sig
-> **user\_sig**: `string`
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:10
-***
-### vendor\_wrapper
-> **vendor\_wrapper**: [`MeetingResponse`](MeetingResponse.md)
-#### Defined in
-typings/chime/MeetingSessionConfigurationOptions.ts:11

package/docs/interfaces/Permission.md DELETED Viewed

@@ -1,147 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / Permission
-# Interface: Permission
-## Properties
-### apply\_other\_phone
-> **apply\_other\_phone**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:108
-***
-### change\_other\_status
-> **change\_other\_status**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:116
-***
-### close\_live\_room
-> **close\_live\_room**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:106
-***
-### control\_other\_micro
-> **control\_other\_micro**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:100
-***
-### control\_other\_sync
-> **control\_other\_sync**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:118
-***
-### control\_own\_micro
-> **control\_own\_micro**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:98
-***
-### dynamic\_enter
-> **dynamic\_enter**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:110
-***
-### extension
-> **extension**: `Record`\<`string`, `boolean`\>
-#### Defined in
-typings/live/UserInfo.ts:120
-***
-### invite\_other
-> **invite\_other**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:96
-***
-### more\_vr\_scene
-> **more\_vr\_scene**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:94
-***
-### sync\_frame
-> **sync\_frame**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:112
-***
-### transfer\_role
-> **transfer\_role**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:114
-***
-### view\_other\_micro\_status
-> **view\_other\_micro\_status**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:104
-***
-### view\_own\_micro\_status
-> **view\_own\_micro\_status**: `boolean`
-#### Defined in
-typings/live/UserInfo.ts:102

package/docs/interfaces/RTCJoinedInfo.md DELETED Viewed

@@ -1,67 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-***
-[如视 Live SDK](../globals.md) / RTCJoinedInfo
-# Interface: RTCJoinedInfo
-进入rtc房间的回调信息
-## Properties
-### code
-> **code**: [`RTCJoinedInfoCodeEnum`](../enumerations/RTCJoinedInfoCodeEnum.md)
-#### Defined in
-typings/rtc/joinedInfo.ts:32
-***
-### errInfo?
-> `optional` **errInfo**: `object`
-#### errCode
-> **errCode**: `number`
-#### errMsg
-> **errMsg**: `string`
-#### Defined in
-typings/rtc/joinedInfo.ts:36
-***
-### message
-> **message**: `string`
-#### Defined in
-typings/rtc/joinedInfo.ts:33
-***
-### roomId?
-> `optional` **roomId**: `number`
-#### Defined in
-typings/rtc/joinedInfo.ts:35
-***
-### userId?
-> `optional` **userId**: `string`
-#### Defined in
-typings/rtc/joinedInfo.ts:34