@realsee/live 0.7.2 → 0.7.3

package/docs/type-aliases/LiveEventType.md

@@ -1,165 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveEventType
-
-# Type Alias: LiveEventType\<KeyframesSnapshot\>
-
-> **LiveEventType**\<`KeyframesSnapshot`\>: `object`
-
-带看事件列表
-
-## Type Parameters
-
-• **KeyframesSnapshot**
-
-## Type declaration
-
-### broadcast()
-
-收到其他用户的广播消息。
-
-#### Parameters
-
-• **evtMsg**: `Record`\<`string`, `any`\>
-
-• **frontRequestId**: `string`
-
-#### Returns
-
-`void`
-
-### builtinEvent()
-
-内置消息事件
-
-#### Parameters
-
-• **builtinMsg**: [`BuiltinMsg`](BuiltinMsg.md)
-
-#### Returns
-
-`void`
-
-### error()
-
-异常消息：不符合规范。
-
-#### Parameters
-
-• **liveMsg**: [`LiveMsg`](LiveMsg.md)
-
-#### Returns
-
-`void`
-
-### keyframes()
-
-获取其他用户输送的帧数据：根据此帧数据更新UI状态。
-
-#### Parameters
-
-• **keyframes**: `Partial`\<`KeyframesSnapshot`\>
-
-• **frontRequestId**: `string`
-
-#### Returns
-
-`void`
-
-### kickOut()
-
-被踢出房间
-
-#### Returns
-
-`void`
-
-### ~~readyKeyframeSync()~~
-
-带看已经就绪，可以发送帧数据。
-
-#### Parameters
-
-• **lastKeyframe**: `Partial`\<`KeyframesSnapshot`\>
-
-带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。
-
-#### Returns
-
-`void`
-
-#### Deprecated
-
-此事件已废弃，请使用 `keyframes` 事件替代，最后的帧数据会通过 `keyframes` 事件发送，同时 keyframes 对象在 ready 后会自动更新。
-
-### roomChange()
-
-内置消息事件：房间信息改变
-
-#### Parameters
-
-• **builtinMsg**: [`BuiltinMsg`](BuiltinMsg.md)
-
-#### Returns
-
-`void`
-
-### selfInfoUpdate()
-
-个人信息发生更新。
-
-#### Parameters
-
-• **userInfo**: [`UserInfo`](UserInfo.md)
-
-• **frontRequestId**: `string`
-
-#### Returns
-
-`void`
-
-### stateChange()
-
-带看状态变化
-
-#### Parameters
-
-• **state**: [`LiveState`](../enumerations/LiveState.md)
-
-• **prevState?**: [`LiveState`](../enumerations/LiveState.md)
-
-#### Returns
-
-`void`
-
-### userChange()
-
-内置消息事件: 用户信息改变
-
-#### Parameters
-
-• **builtinMsg**: [`BuiltinMsg`](BuiltinMsg.md)
-
-#### Returns
-
-`void`
-
-### userListUpdate()
-
-用户列表更新。
-
-#### Parameters
-
-• **userList**: [`UserInfo`](UserInfo.md)[]
-
-• **frontRequestId**: `string`
-
-#### Returns
-
-`void`
-
-## Defined in
-
-typings/live/EventType.ts:8

package/docs/type-aliases/LiveMsg.md

@@ -1,53 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveMsg
-
-# Type Alias: LiveMsg
-
-> **LiveMsg**: `object`
-
-响应的信息结构体。
-
-## Type declaration
-
-### appId
-
-> **appId**: `string`
-
-### code
-
-> **code**: `string`
-
-### command
-
-> **command**: [`Command`](../enumerations/Command.md)
-
-### data
-
-> **data**: `Record`\<`string`, `any`\> \| `Record`\<`string`, `any`\>[]
-
-### frontRequestId
-
-> **frontRequestId**: `string`
-
-### message
-
-> **message**: `string`
-
-### requestId
-
-> **requestId**: `string`
-
-### roomCode
-
-> **roomCode**: `string`
-
-### triggerUserId
-
-> **triggerUserId**: `string`
-
-## Defined in
-
-typings/live/LiveMsg.ts:122

package/docs/type-aliases/LiveProviderPropTypes.md

@@ -1,27 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveProviderPropTypes
-
-# Type Alias: LiveProviderPropTypes\<KeyframesSnapshot\>
-
-> **LiveProviderPropTypes**\<`KeyframesSnapshot`\>: `object`
-
-## Type Parameters
-
-• **KeyframesSnapshot** *extends* `Record`\<`string`, `any`\>
-
-## Type declaration
-
-### children?
-
-> `optional` **children**: `React.ReactNode`
-
-### live?
-
-> `optional` **live**: [`Live`](../classes/Live.md)\<`KeyframesSnapshot`\>
-
-## Defined in
-
-live/createLiveReact.ts:19

package/docs/type-aliases/RTCActionReactCallback.md

@@ -1,13 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / RTCActionReactCallback
-
-# Type Alias: RTCActionReactCallback
-
-> **RTCActionReactCallback**: `Pick`\<[`RTCProtocol`](../interfaces/RTCProtocol.md), `"join"` \| `"quit"` \| `"shock"` \| `"toggleMicro"` \| `"detectMicro"`\>
-
-## Defined in
-
-typings/react/RTCActionReactCallback.ts:3

package/docs/type-aliases/RTCEventType.md

@@ -1,65 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / RTCEventType
-
-# Type Alias: RTCEventType
-
-> **RTCEventType**: `object`
-
-RTC 异步事件类型。
-
-## Type declaration
-
-### error()
-
-错误\异常
-
-#### Parameters
-
-• **error**: [`RTCJoinedInfo`](../interfaces/RTCJoinedInfo.md) \| `Error`
-
-#### Returns
-
-`void`
-
-### joined()
-
-成功加入语音房间。
-
-#### Returns
-
-`void`
-
-### joinWillStart()
-
-即将加入房间。
-
-#### Returns
-
-`void`
-
-### userVolumes()
-
-每个用户的音量。
-
-#### Parameters
-
-• **userVolumes**: [`UserVolume`](UserVolume.md)[]
-
-#### Returns
-
-`void`
-
-### weakNetwork()
-
-弱网提醒事件。
-
-#### Returns
-
-`void`
-
-## Defined in
-
-typings/rtc/eventType.ts:7

package/docs/type-aliases/ReqLiveMsg.md

@@ -1,45 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / ReqLiveMsg
-
-# Type Alias: ReqLiveMsg
-
-> **ReqLiveMsg**: `object`
-
-向服务端请求数据时的数据格式。
-
-## Type declaration
-
-### command
-
-> **command**: [`Command`](../enumerations/Command.md)
-
-请求指令。
-
-### data
-
-> **data**: `object`
-
-数据内容
-
-#### Index Signature
-
- \[`key`: `string`\]: `any`
-
-### data.to\_user\_ids?
-
-> `optional` **to\_user\_ids**: `string`[]
-
-如果此数据仅发送给某些用户，请提供这些用户的ucid。
-
-### front\_request\_id
-
-> **front\_request\_id**: `string` \| `number`
-
-前端请求时生成的uuid()。
-
-## Defined in
-
-typings/live/LiveMsg.ts:28

package/docs/type-aliases/RoomInfo.md

@@ -1,55 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / RoomInfo
-
-# Type Alias: RoomInfo
-
-> **RoomInfo**: `object`
-
-## Type declaration
-
-### info
-
-> **info**: `object`
-
-### info.app\_id
-
-> **app\_id**: `string`
-
-### info.create\_time
-
-> **create\_time**: `string`
-
-### info.create\_user\_id
-
-> **create\_user\_id**: `string`
-
-### info.extension
-
-> **extension**: `Record`\<`string`, `any`\>
-
-### info.id
-
-> **id**: `string` \| `number`
-
-### info.room\_code
-
-> **room\_code**: `string`
-
-### info.status
-
-> **status**: `string` \| `number`
-
-### init\_timestamp
-
-> **init\_timestamp**: `string`
-
-### last\_frame
-
-> **last\_frame**: `Record`\<`string`, `any`\>
-
-## Defined in
-
-typings/live/RoomInfo.ts:1

package/docs/type-aliases/UserInfo.md

@@ -1,77 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / UserInfo
-
-# Type Alias: UserInfo
-
-> **UserInfo**: `object`
-
-带看会话房间用户的信息格式。
-
-## Type declaration
-
-### current\_ws\_online?
-
-> `optional` **current\_ws\_online**: `boolean`
-
-用户当前是否在线。
-
-### extension?
-
-> `optional` **extension**: [`UserInfoExt`](UserInfoExt.md)
-
-用户信息扩展字段。
-
-### id
-
-> **id**: `string`
-
-用户唯一标识ID。
-
-### mem\_user\_status?
-
-> `optional` **mem\_user\_status**: [`MemUserStatus`](../enumerations/MemUserStatus.md)
-
-内存中的用户状态。
-
-### micro\_status
-
-> **micro\_status**: `boolean`
-
-用户当前是否开启麦克风。
-
-### once\_ws\_online?
-
-> `optional` **once\_ws\_online**: `boolean`
-
-用户曾经是否在线过，即进入房间后又由于某种原因离开后重新进入。
-
-### permission?
-
-> `optional` **permission**: `Partial`\<[`Permission`](../interfaces/Permission.md)\>
-
-当前用户的权限配置。（UI层面理解）。
-
-### rtc
-
-> **rtc**: `boolean`
-
-RTC 环境是否就绪，即当前语音是否联通。
-
-### status?
-
-> `optional` **status**: [`UserStatus`](../enumerations/UserStatus.md)
-
-用户当前的状态。
-
-### user\_role?
-
-> `optional` **user\_role**: `number` \| `string`
-
-用户角色定义。（前端不关注此字段）。
-
-## Defined in
-
-typings/live/UserInfo.ts:49

package/docs/type-aliases/UserInfoExt.md

@@ -1,33 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / UserInfoExt
-
-# Type Alias: UserInfoExt
-
-> **UserInfoExt**: `object`
-
-用户信息扩展字段：比如提供用户画像相关的数据。
-
-## Index Signature
-
- \[`key`: `string`\]: `any`
-
-## Type declaration
-
-### avatar?
-
-> `optional` **avatar**: `string`
-
-用户头像。
-
-### nickname?
-
-> `optional` **nickname**: `string`
-
-用户昵称。
-
-## Defined in
-
-typings/live/UserInfo.ts:31

package/docs/type-aliases/UserVolume.md

@@ -1,25 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / UserVolume
-
-# Type Alias: UserVolume
-
-> **UserVolume**: `object`
-
-用户的音量信息。
-
-## Type declaration
-
-### audioVolume
-
-> **audioVolume**: `number`
-
-### userId
-
-> **userId**: `string`
-
-## Defined in
-
-typings/live/UserVolume.ts:4

package/docs/type-aliases/WebSocketError.md

@@ -1,31 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / WebSocketError
-
-# Type Alias: WebSocketError
-
-> **WebSocketError**: `object`
-
-## Type declaration
-
-### closeError?
-
-> `optional` **closeError**: [`WebSocketCloseError`](../enumerations/WebSocketCloseError.md)
-
-### error?
-
-> `optional` **error**: `any`
-
-### target?
-
-> `optional` **target**: `Event` \| `CloseEvent`
-
-### type
-
-> **type**: [`WebSocketErrorType`](../enumerations/WebSocketErrorType.md)
-
-## Defined in
-
-typings/live/WebSocket.ts:31