@realsee/live 0.7.3-alpha.0 → 0.7.3

package/docs/functions/createLiveReact.md

@@ -1,449 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / createLiveReact
-
-# Function: createLiveReact()
-
-> **createLiveReact**\<`KeyframesSnapshot`\>(`options`): `object`
-
-创建 LiveReact 实例，并提供 `React` 技术栈相关工具链。
-
-## Type Parameters
-
-• **KeyframesSnapshot** *extends* `Record`\<`string`, `any`\>
-
-## Parameters
-
-• **options**: [`LiveOptions`](../interfaces/LiveOptions.md)
-
-带看配置
-
-## Returns
-
-`object`
-
-返回当前的带看上下文实例
-
-### jsBridge
-
-> **jsBridge**: `JSBridgeProtocol`
-
-### live
-
-> **live**: [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-
-### LiveProvider()
-
-> **LiveProvider**: (`props`) => `FunctionComponentElement`\<`ProviderProps`\<`null` \| [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>\>\>
-
-#### Parameters
-
-• **props**: [`LiveProviderPropTypes`](../type-aliases/LiveProviderPropTypes.md)\<`KeyframesSnapshot`\>
-
-#### Returns
-
-`FunctionComponentElement`\<`ProviderProps`\<`null` \| [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>\>\>
-
-### unsafe\_\_useLiveInstance()
-
-> **unsafe\_\_useLiveInstance**: () => [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-
-不建议这样使用
-
-#### Returns
-
-[`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-
-#### Deprecated
-
-### unsafe\_\_useRTCInstance()
-
-> **unsafe\_\_useRTCInstance**: () => [`RTCProtocol`](../interfaces/RTCProtocol.md)
-
-不建议这样使用
-
-#### Returns
-
-[`RTCProtocol`](../interfaces/RTCProtocol.md)
-
-#### Deprecated
-
-### useConnect()
-
-> **useConnect**: () => (`options`) => `Promise`\<`true` \| `Error`\>
-
-带看连接操作
-
-#### Returns
-
-`Function`
-
-##### Parameters
-
-• **options**: [`LiveConnectOptions`](../type-aliases/LiveConnectOptions.md)
-
-##### Returns
-
-`Promise`\<`true` \| `Error`\>
-
-### useKeyframe()
-
-> **useKeyframe**: \<`K`\>(`key`) => (`undefined` \| `KeyframesSnapshot`\[`K`\] \| (`frame`) => `boolean` \| `Error`)[]
-
-#### Type Parameters
-
-• **K** *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-• **key**: `K`
-
-#### Returns
-
-(`undefined` \| `KeyframesSnapshot`\[`K`\] \| (`frame`) => `boolean` \| `Error`)[]
-
-### useKeyframesSnapshot()
-
-> **useKeyframesSnapshot**: () => `Partial`\<`KeyframesSnapshot`\>
-
-使用帧数据
-
-#### Returns
-
-`Partial`\<`KeyframesSnapshot`\>
-
-返回当前的帧数据
-
-### useKeyframeUpdateCallback()
-
-> **useKeyframeUpdateCallback**: \<`KeyOfKeyframe`\>(`key`, `callback`, `deps`) => () => `void`
-
-使用帧数据更新回调
-
-#### Type Parameters
-
-• **KeyOfKeyframe** *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-• **key**: `KeyOfKeyframe`
-
-帧数据的键
-
-• **callback**
-
-回调函数
-
-• **deps**: `DependencyList` = `[]`
-
-依赖项
-
-#### Returns
-
-`Function`
-
-返回一个清理函数
-
-##### Returns
-
-`void`
-
-### useLiveAction()
-
-> **useLiveAction**: () => `object`
-
-带看的一些操作
-
-#### Returns
-
-`object`
-
-返回一组与带看相关的操作函数
-
-##### broadcast()
-
-> **broadcast**: (`data`, `toUserIds`, `timeout`) => `Promise`\<`void`\>
-
-###### Parameters
-
-• **data**: `Record`\<`string`, `any`\>
-
-• **toUserIds**: `string` \| `string`[]
-
-• **timeout**: `number` = `0`
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### connect()
-
-> **connect**: (`options`) => `Promise`\<`void`\>
-
-###### Parameters
-
-• **options**: [`LiveConnectOptions`](../type-aliases/LiveConnectOptions.md)
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### exit()
-
-> **exit**: () => `Promise`\<`void`\>
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### forbidMicro()
-
-> **forbidMicro**: (`micro`, `toUserIds`) => `Promise`\<`void`\>
-
-###### Parameters
-
-• **micro**: [`MicroStatus`](../enumerations/MicroStatus.md)
-
-• **toUserIds**: `string` \| `string`[] = `[]`
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### forbidSync()
-
-> **forbidSync**: (`sync`, `toUserIds`) => `void`
-
-###### Parameters
-
-• **sync**: `boolean`
-
-• **toUserIds**: `string` \| `string`[] = `[]`
-
-###### Returns
-
-`void`
-
-##### getFramesByKey()
-
-> **getFramesByKey**: (`key`) => `undefined` \| `Partial`\<`KeyframesSnapshot`\>\[keyof `KeyframesSnapshot`\]
-
-###### Parameters
-
-• **key**: keyof `KeyframesSnapshot`
-
-###### Returns
-
-`undefined` \| `Partial`\<`KeyframesSnapshot`\>\[keyof `KeyframesSnapshot`\]
-
-##### kick()
-
-> **kick**: (`toUserIds`) => `Promise`\<`void`\>
-
-###### Parameters
-
-• **toUserIds**: `string` \| `string`[]
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### sendKeyframe()
-
-> **sendKeyframe**: (`key`, `frame`) => `void`
-
-###### Parameters
-
-• **key**: keyof `KeyframesSnapshot`
-
-• **frame**: `KeyframesSnapshot`\[keyof `KeyframesSnapshot`\]
-
-###### Returns
-
-`void`
-
-##### setSelfInfo()
-
-> **setSelfInfo**: (`userInfo`) => `void`
-
-###### Parameters
-
-• **userInfo**: `Partial`\<[`UserInfo`](../type-aliases/UserInfo.md)\>
-
-###### Returns
-
-`void`
-
-##### toggleMicro()
-
-> **toggleMicro**: (`microStatus`) => `void`
-
-###### Parameters
-
-• **microStatus**: `boolean`
-
-###### Returns
-
-`void`
-
-##### updateStatus()
-
-> **updateStatus**: (`evtType`, `atnType`, `status`, `toUserIds`?) => `void`
-
-###### Parameters
-
-• **evtType**: [`BuiltinEventType`](../enumerations/BuiltinEventType.md)
-
-• **atnType**: [`BuiltinActionType`](../enumerations/BuiltinActionType.md)
-
-• **status**: `Record`\<`string`, `any`\>
-
-• **toUserIds?**: `string` \| `string`[]
-
-###### Returns
-
-`void`
-
-### useLiveEventCallback()
-
-> **useLiveEventCallback**: \<`K`\>(`name`, `callback`, `deps`) => () => `void`
-
-#### Type Parameters
-
-• **K** *extends* keyof [`LiveEventType`](../type-aliases/LiveEventType.md)\<`KeyframesSnapshot`\>
-
-#### Parameters
-
-• **name**: `K`
-
-• **callback**
-
-• **deps**: `DependencyList` = `[]`
-
-#### Returns
-
-`Function`
-
-##### Returns
-
-`void`
-
-### useLiveState()
-
-> **useLiveState**: () => [`LiveState`](../enumerations/LiveState.md)
-
-带看状态
-
-#### Returns
-
-[`LiveState`](../enumerations/LiveState.md)
-
-### useRTCAction()
-
-> **useRTCAction**: () => `object`
-
-#### Returns
-
-`object`
-
-##### detectMicro()
-
-> **detectMicro**: () => `Promise`\<`boolean`\>
-
-###### Returns
-
-`Promise`\<`boolean`\>
-
-##### join()
-
-> **join**: (`options`) => `Promise`\<`boolean`\>
-
-###### Parameters
-
-• **options**
-
-• **options.roomId**: `string`
-
-• **options.type**: [`RTCType`](../enumerations/RTCType.md)
-
-• **options.userId**: `string`
-
-• **options.voiceId**: `string`
-
-###### Returns
-
-`Promise`\<`boolean`\>
-
-##### quit()
-
-> **quit**: () => `Promise`\<`boolean`\>
-
-###### Returns
-
-`Promise`\<`boolean`\>
-
-##### shock()
-
-> **shock**: () => `undefined` \| `void`
-
-###### Returns
-
-`undefined` \| `void`
-
-##### toggleMicro()
-
-> **toggleMicro**: (`flag`?) => `Promise`\<`boolean`\>
-
-###### Parameters
-
-• **flag?**: `boolean`
-
-###### Returns
-
-`Promise`\<`boolean`\>
-
-### useRTCEventCallback()
-
-> **useRTCEventCallback**: \<`K`\>(`name`, `callback`, `deps`) => () => `void`
-
-#### Type Parameters
-
-• **K** *extends* keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-
-#### Parameters
-
-• **name**: `K`
-
-• **callback**
-
-• **deps**: `DependencyList` = `[]`
-
-#### Returns
-
-`Function`
-
-##### Returns
-
-`void`
-
-### useSelfInfo()
-
-> **useSelfInfo**: () => (`Partial`\<[`UserInfo`](../type-aliases/UserInfo.md)\> \| (`userInfo`) => `Promise`\<`boolean`\>)[]
-
-#### Returns
-
-(`Partial`\<[`UserInfo`](../type-aliases/UserInfo.md)\> \| (`userInfo`) => `Promise`\<`boolean`\>)[]
-
-### useUserList()
-
-> **useUserList**: () => [`UserInfo`](../type-aliases/UserInfo.md)[]
-
-#### Returns
-
-[`UserInfo`](../type-aliases/UserInfo.md)[]
-
-## Defined in
-
-live/createLiveReact.ts:29

package/docs/functions/parseLiveMsg.md

@@ -1,27 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / parseLiveMsg
-
-# Function: parseLiveMsg()
-
-> **parseLiveMsg**(`jsonTxt`): [`LiveMsg`](../type-aliases/LiveMsg.md) \| `boolean`
-
-解析下后端数据格式。
-
-## Parameters
-
-• **jsonTxt**: `string`
-
-JSON序列化后的文本。
-
-## Returns
-
-[`LiveMsg`](../type-aliases/LiveMsg.md) \| `boolean`
-
-false 标识解析失败；解析成功返回 [LiveMsg](../type-aliases/LiveMsg.md) 实例。
-
-## Defined in
-
-typings/live/LiveMsg.ts:139

package/docs/functions/parseWSClsErr.md

@@ -1,21 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / parseWSClsErr
-
-# Function: parseWSClsErr()
-
-> **parseWSClsErr**(`code`): [`WebSocketCloseError`](../enumerations/WebSocketCloseError.md)
-
-## Parameters
-
-• **code**: `number`
-
-## Returns
-
-[`WebSocketCloseError`](../enumerations/WebSocketCloseError.md)
-
-## Defined in
-
-typings/live/WebSocket.ts:94

package/docs/globals.md

@@ -1,71 +0,0 @@
-[**如视 Live SDK**](README.md) • **Docs**
-
-***
-
-# 如视 Live SDK
-
-## Enumerations
-
-- [BuiltinActionType](enumerations/BuiltinActionType.md)
-- [BuiltinEventType](enumerations/BuiltinEventType.md)
-- [BuiltInRTCType](enumerations/BuiltInRTCType.md)
-- [Command](enumerations/Command.md)
-- [LiveState](enumerations/LiveState.md)
-- [MemUserStatus](enumerations/MemUserStatus.md)
-- [MicroStatus](enumerations/MicroStatus.md)
-- [RTCJoinedInfoCodeEnum](enumerations/RTCJoinedInfoCodeEnum.md)
-- [RTCType](enumerations/RTCType.md)
-- [UserStatus](enumerations/UserStatus.md)
-- [WebSocketCloseError](enumerations/WebSocketCloseError.md)
-- [WebSocketErrorType](enumerations/WebSocketErrorType.md)
-- [WebSocketState](enumerations/WebSocketState.md)
-
-## Classes
-
-- [BrowserRTC](classes/BrowserRTC.md)
-- [BrowserRTC4Chime](classes/BrowserRTC4Chime.md)
-- [CoreRTC](classes/CoreRTC.md)
-- [Live](classes/Live.md)
-- [VRWebViewRTC](classes/VRWebViewRTC.md)
-
-## Interfaces
-
-- [AttendeeResponse](interfaces/AttendeeResponse.md)
-- [LiveOptions](interfaces/LiveOptions.md)
-- [MeetingResponse](interfaces/MeetingResponse.md)
-- [MeetingSessionConfigurationOptions](interfaces/MeetingSessionConfigurationOptions.md)
-- [Permission](interfaces/Permission.md)
-- [RTCJoinedInfo](interfaces/RTCJoinedInfo.md)
-- [RTCProtocol](interfaces/RTCProtocol.md)
-- [VRWebViewRTCOptions](interfaces/VRWebViewRTCOptions.md)
-
-## Type Aliases
-
-- [BuiltinMsg](type-aliases/BuiltinMsg.md)
-- [EventType](type-aliases/EventType.md)
-- [GetVoiceSign](type-aliases/GetVoiceSign.md)
-- [GetVoiceSignParams](type-aliases/GetVoiceSignParams.md)
-- [GetVoiceSignReturnType](type-aliases/GetVoiceSignReturnType.md)
-- [KeyframeEventType](type-aliases/KeyframeEventType.md)
-- [LiveBuiltInData](type-aliases/LiveBuiltInData.md)
-- [LiveConnectOptions](type-aliases/LiveConnectOptions.md)
-- [LiveEventType](type-aliases/LiveEventType.md)
-- [LiveMsg](type-aliases/LiveMsg.md)
-- [LiveProviderPropTypes](type-aliases/LiveProviderPropTypes.md)
-- [ReqLiveMsg](type-aliases/ReqLiveMsg.md)
-- [RoomInfo](type-aliases/RoomInfo.md)
-- [RTCActionReactCallback](type-aliases/RTCActionReactCallback.md)
-- [RTCEventType](type-aliases/RTCEventType.md)
-- [UserInfo](type-aliases/UserInfo.md)
-- [UserInfoExt](type-aliases/UserInfoExt.md)
-- [UserVolume](type-aliases/UserVolume.md)
-- [WebSocketError](type-aliases/WebSocketError.md)
-
-## Functions
-
-- [\_clearLiveInstanceIfNeed](functions/clearLiveInstanceIfNeed.md)
-- [createLive](functions/createLive.md)
-- [createLiveReact](functions/createLiveReact.md)
-- [GetVoiceSignFn](functions/GetVoiceSignFn.md)
-- [parseLiveMsg](functions/parseLiveMsg.md)
-- [parseWSClsErr](functions/parseWSClsErr.md)

package/docs/interfaces/AttendeeResponse.md

@@ -1,37 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / AttendeeResponse
-
-# Interface: AttendeeResponse
-
-## Properties
-
-### attendee\_id
-
-> **attendee\_id**: `string`
-
-#### Defined in
-
-typings/chime/AttendeeResponse.ts:2
-
-***
-
-### external\_user\_id
-
-> **external\_user\_id**: `string`
-
-#### Defined in
-
-typings/chime/AttendeeResponse.ts:3
-
-***
-
-### join\_token
-
-> **join\_token**: `string`
-
-#### Defined in
-
-typings/chime/AttendeeResponse.ts:4