@realsee/live 0.7.2 → 0.7.3

package/docs/classes/Live.md

@@ -1,770 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / Live
-
-# Class: Live\<KeyframesSnapshot\>
-
-## Extends
-
-- `Subscribe`\<[`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>\>
-
-## Type Parameters
-
-• **KeyframesSnapshot** *extends* `Record`\<`string`, `any`\>
-
-## Constructors
-
-### new Live()
-
-> **new Live**\<`KeyframesSnapshot`\>(`opts`): [`Live`](Live.md)\<`KeyframesSnapshot`\>
-
-#### Parameters
-
-• **opts**: [`LiveOptions`](../interfaces/LiveOptions.md)
-
-#### Returns
-
-[`Live`](Live.md)\<`KeyframesSnapshot`\>
-
-#### Overrides
-
-`Subscribe<EventType<KeyframesSnapshot>>.constructor`
-
-#### Defined in
-
-live/live.ts:123
-
-## Properties
-
-### keyframes
-
-> **keyframes**: `Subscribe`\<[`KeyframeEventType`](../type-aliases/KeyframeEventType.md)\<`KeyframesSnapshot`\>\>
-
-帧数据监听
-
-#### Defined in
-
-live/live.ts:111
-
-## Accessors
-
-### $RTC
-
-> `get` **$RTC**(): [`RTCProtocol`](../interfaces/RTCProtocol.md)
-
-获取当前live使用的RTC实例
-
-#### Returns
-
-[`RTCProtocol`](../interfaces/RTCProtocol.md)
-
-#### Defined in
-
-live/live.ts:97
-
-***
-
-### jsBridge
-
-> `get` **jsBridge**(): `JSBridgeProtocol`
-
-获取当前live使用的jsBridge实例
-
-#### Returns
-
-`JSBridgeProtocol`
-
-#### Defined in
-
-live/live.ts:104
-
-***
-
-### options
-
-> `get` **options**(): [`LiveOptions`](../interfaces/LiveOptions.md)
-
-#### Returns
-
-[`LiveOptions`](../interfaces/LiveOptions.md)
-
-#### Defined in
-
-live/live.ts:67
-
-***
-
-### readyState
-
-> `get` **readyState**(): [`LiveState`](../enumerations/LiveState.md)
-
-兼容老逻辑
-
-#### Deprecated
-
-请直接读取 state 属性字段，未来将移除该属性
-
-#### Returns
-
-[`LiveState`](../enumerations/LiveState.md)
-
-#### Defined in
-
-live/live.ts:82
-
-***
-
-### roomInfo
-
-> `get` **roomInfo**(): `undefined` \| [`RoomInfo`](../type-aliases/RoomInfo.md)
-
-当前带看房间信息
-
-#### Returns
-
-`undefined` \| [`RoomInfo`](../type-aliases/RoomInfo.md)
-
-#### Defined in
-
-live/live.ts:233
-
-***
-
-### selfInfo
-
-> `get` **selfInfo**(): `undefined` \| [`UserInfo`](../type-aliases/UserInfo.md)
-
-当前用户信息
-
-#### Returns
-
-`undefined` \| [`UserInfo`](../type-aliases/UserInfo.md)
-
-#### Defined in
-
-live/live.ts:219
-
-***
-
-### snapshot
-
-> `get` **snapshot**(): `Partial`\<`KeyframesSnapshot`\>
-
-当前帧数据快照
-
-#### Returns
-
-`Partial`\<`KeyframesSnapshot`\>
-
-#### Defined in
-
-live/live.ts:141
-
-***
-
-### state
-
-> `get` **state**(): [`LiveState`](../enumerations/LiveState.md)
-
-带看状态
-
-#### Returns
-
-[`LiveState`](../enumerations/LiveState.md)
-
-#### Defined in
-
-live/live.ts:74
-
-***
-
-### url
-
-> `get` **url**(): `undefined` \| `string`
-
-获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。
-
-#### Deprecated
-
-带看不需要关注底层ws的相关信息，未来将移除
-
-#### Returns
-
-`undefined` \| `string`
-
-#### Defined in
-
-live/live.ts:90
-
-***
-
-### userList
-
-> `get` **userList**(): [`UserInfo`](../type-aliases/UserInfo.md)[]
-
-当前用户列表
-
-#### Returns
-
-[`UserInfo`](../type-aliases/UserInfo.md)[]
-
-#### Defined in
-
-live/live.ts:226
-
-## Methods
-
-### \_exit()
-
-> **\_exit**(): `Promise`\<`boolean`\>
-
-退出带看
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:604
-
-***
-
-### \_handleKeyframesChange()
-
-> **\_handleKeyframesChange**(`event`): `void`
-
-#### Parameters
-
-• **event**: `YMapEvent`\<`KeyframesSnapshot`\>
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-live/live.ts:149
-
-***
-
-### \_initializeKeyframesObservers()
-
-> **\_initializeKeyframesObservers**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-live/live.ts:145
-
-***
-
-### broadcast()
-
-> **broadcast**\<`Request`, `Response`\>(`request`, `toUserIds`, `timeout`): `false` \| `Error` \| `Promise`\<`Response`\>
-
-自定义广播
-
-#### Type Parameters
-
-• **Request** *extends* `Record`\<`string`, `any`\>
-
-• **Response**
-
-#### Parameters
-
-• **request**: `Request`
-
-广播请求的数据
-
-• **toUserIds**: `string` \| `string`[]
-
-• **timeout**: `number`
-
-#### Returns
-
-`false` \| `Error` \| `Promise`\<`Response`\>
-
-#### Defined in
-
-live/live.ts:688
-
-***
-
-### close()
-
-> **close**(): `Promise`\<`void`\>
-
-关闭带看房间
-
-#### Returns
-
-`Promise`\<`void`\>
-
-关闭结果
-
-#### Defined in
-
-live/live.ts:626
-
-***
-
-### connect()
-
-> **connect**(`options`): `Promise`\<`true` \| `Error`\>
-
-连接带看
-
-#### Parameters
-
-• **options**: [`LiveConnectOptions`](../type-aliases/LiveConnectOptions.md) = `{}`
-
-连接选项
-
-#### Returns
-
-`Promise`\<`true` \| `Error`\>
-
-连接结果，成功返回true，失败返回Error
-
-#### Defined in
-
-live/live.ts:554
-
-***
-
-### dispose()
-
-> **dispose**(): `Promise`\<`boolean`\>
-
-销毁带看
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:641
-
-***
-
-### emit()
-
-> **emit**\<`K`\>(`name`, ...`data`): `boolean`
-
-触发事件
-
-#### Type Parameters
-
-• **K** *extends* keyof [`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>
-
-预设的监听事件名称
-
-#### Parameters
-
-• **name**: `K`
-
-事件类型
-
-• ...**data**: `Parameters`\<[`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>\[`K`\]\>
-
-触发事件的数据
-
-#### Returns
-
-`boolean`
-
-canceled 是否被触发取消
-
-#### Inherited from
-
-`Subscribe.emit`
-
-#### Defined in
-
-utils/subscribe.ts:113
-
-***
-
-### exit()
-
-> **exit**(): `Promise`\<`void`\>
-
-退出带看
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Defined in
-
-live/live.ts:620
-
-***
-
-### forbidMicro()
-
-> **forbidMicro**(`microStatus`, `toUserIds`): `Promise`\<`boolean`\>
-
-控制别人的麦
-
-#### Parameters
-
-• **microStatus**: [`MicroStatus`](../enumerations/MicroStatus.md)
-
-• **toUserIds**: `string` \| `string`[]
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:747
-
-***
-
-### forbidSync()
-
-> **forbidSync**(`sync`, `toUserIds`): `Promise`\<`boolean`\>
-
-控制别人的同步全量帧数据权限
-
-#### Parameters
-
-• **sync**: `boolean`
-
-• **toUserIds**: `string` \| `string`[]
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:772
-
-***
-
-### getFramesByKey()
-
-> **getFramesByKey**\<`Key`\>(`key`): `undefined` \| `Partial`\<`KeyframesSnapshot`\>\[`Key`\]
-
-根据键值取帧数据
-
-#### Type Parameters
-
-• **Key** *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-• **key**: `Key`
-
-帧数据的键值
-
-#### Returns
-
-`undefined` \| `Partial`\<`KeyframesSnapshot`\>\[`Key`\]
-
-#### Defined in
-
-live/live.ts:188
-
-***
-
-### getSnapshotForKey()
-
-> **getSnapshotForKey**\<`Key`\>(`key`): `any`
-
-获取当前某个 keyframe 的数据快照
-
-#### Type Parameters
-
-• **Key** *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-• **key**: `Key`
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-live/live.ts:816
-
-***
-
-### hasListener()
-
-> **hasListener**(`name`): `boolean`
-
-判断是否注册了事件
-
-#### Parameters
-
-• **name**: keyof [`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>
-
-事件类型
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-`Subscribe.hasListener`
-
-#### Defined in
-
-utils/subscribe.ts:41
-
-***
-
-### kick()
-
-> **kick**(`toUserIds`): `Promise`\<`boolean`\>
-
-把用户踢出带看
-
-#### Parameters
-
-• **toUserIds**: `string` \| `string`[]
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:794
-
-***
-
-### off()
-
-> **off**\<`K`\>(`name`?, `callback`?): `void`
-
-解除事件
-
-如果 name 不传的话解除对应所有事件
-如果 name, callback 不传的话解除所有name的所有事件
-
-#### Type Parameters
-
-• **K** *extends* keyof [`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>
-
-预设的监听事件名称
-
-#### Parameters
-
-• **name?**: `K`
-
-事件类型
-
-• **callback?**
-
-事件回调函数
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`Subscribe.off`
-
-#### Defined in
-
-utils/subscribe.ts:87
-
-***
-
-### on()
-
-> **on**\<`K`\>(`name`, `callback`, `once`?): () => `void`
-
-注册事件
-
-#### Type Parameters
-
-• **K** *extends* keyof [`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>
-
-预设的监听事件名称
-
-#### Parameters
-
-• **name**: `K`
-
-事件类型
-
-• **callback**
-
-事件回调函数
-
-• **once?**: `boolean`
-
-是否只执行一次
-
-#### Returns
-
-`Function`
-
-解除事件
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-`Subscribe.on`
-
-#### Defined in
-
-utils/subscribe.ts:55
-
-***
-
-### once()
-
-> **once**\<`K`\>(`name`, `callback`): () => `void`
-
-注册事件(是否只执行一次)
-
-#### Type Parameters
-
-• **K** *extends* keyof [`EventType`](../type-aliases/EventType.md)\<`KeyframesSnapshot`\>
-
-预设的监听事件名称
-
-#### Parameters
-
-• **name**: `K`
-
-事件类型
-
-• **callback**
-
-事件回调函数
-
-#### Returns
-
-`Function`
-
-解除事件
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-`Subscribe.once`
-
-#### Defined in
-
-utils/subscribe.ts:74
-
-***
-
-### sendKeyframe()
-
-> **sendKeyframe**\<`Key`\>(`key`, `frame`): `boolean` \| `Error`
-
-发送帧数据（需要能够被序列化）
-
-#### Type Parameters
-
-• **Key** *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-• **key**: `Key`
-
-帧数据键值
-
-• **frame**: `KeyframesSnapshot`\[`Key`\]
-
-帧数据本体
-
-#### Returns
-
-`boolean` \| `Error`
-
-发送结果，成功返回true，失败返回false或Error
-
-#### Defined in
-
-live/live.ts:197
-
-***
-
-### setSelfInfo()
-
-> **setSelfInfo**(`userInfo`): `Promise`\<`boolean`\>
-
-设置自己的用户信息
-
-#### Parameters
-
-• **userInfo**: `Partial`\<[`UserInfo`](../type-aliases/UserInfo.md)\>
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:678
-
-***
-
-### toggleMicro()
-
-> **toggleMicro**(`microStatus`): `Promise`\<`boolean`\>
-
-#### Parameters
-
-• **microStatus**: `boolean`
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:723
-
-***
-
-### updateStatus()
-
-> **updateStatus**(`evtType`, `atnType`, `status`, `toUserIds`?): `Promise`\<`boolean`\>
-
-修改状态
-
-#### Parameters
-
-• **evtType**: [`BuiltinEventType`](../enumerations/BuiltinEventType.md)
-
-• **atnType**: [`BuiltinActionType`](../enumerations/BuiltinActionType.md)
-
-• **status**: `Record`\<`string`, `any`\>
-
-• **toUserIds?**: `string` \| `string`[]
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Defined in
-
-live/live.ts:655