@realsee/live 0.6.15 → 0.7.0

package/docs/interfaces/RTCProtocol.md

@@ -0,0 +1,404 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / RTCProtocol
+
+# Interface: RTCProtocol
+
+rtc 协议接口
+
+## Extends
+
+- [`Subscribe`](../classes/Subscribe.md)\<[`RTCEventType`](../type-aliases/RTCEventType.md)\>
+
+## Properties
+
+### joined
+
+> **joined**: `boolean`
+
+是否已经加入房间
+
+#### Defined in
+
+typings/rtc/protocol.ts:16
+
+***
+
+### micro
+
+> **micro**: `boolean`
+
+麦克风状态
+
+#### Defined in
+
+typings/rtc/protocol.ts:22
+
+***
+
+### type
+
+> **type**: [`RTCType`](../enumerations/RTCType.md)
+
+rtc 实现类型
+
+#### Defined in
+
+typings/rtc/protocol.ts:34
+
+***
+
+### voiceId
+
+> **voiceId**: `string`
+
+语音房间ID
+
+#### Defined in
+
+typings/rtc/protocol.ts:28
+
+## Methods
+
+### checkRequirement()?
+
+> `optional` **checkRequirement**(): `Promise`\<`CheckResult`\>
+
+检查rtc的系统依赖是否满足
+
+#### Returns
+
+`Promise`\<`CheckResult`\>
+
+返回一个Promise，表示检查结果
+
+#### Defined in
+
+typings/rtc/protocol.ts:40
+
+***
+
+### detectMicro()
+
+> **detectMicro**(): `Promise`\<`boolean`\>
+
+监测麦克风授权。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示麦克风是否被授权
+
+#### Defined in
+
+typings/rtc/protocol.ts:74
+
+***
+
+### 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 是否被触发取消
+
+#### Inherited from
+
+[`Subscribe`](../classes/Subscribe.md).[`emit`](../classes/Subscribe.md#emit)
+
+#### Defined in
+
+utils/subscribe.ts:113
+
+***
+
+### hasListener()
+
+> **hasListener**(`name`): `boolean`
+
+判断是否注册了事件
+
+#### Parameters
+
+• **name**: keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
+
+事件类型
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`Subscribe`](../classes/Subscribe.md).[`hasListener`](../classes/Subscribe.md#haslistener)
+
+#### Defined in
+
+utils/subscribe.ts:41
+
+***
+
+### join()
+
+> **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，表示是否成功加入房间
+
+#### Defined in
+
+typings/rtc/protocol.ts:51
+
+***
+
+### 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`
+
+#### Inherited from
+
+[`Subscribe`](../classes/Subscribe.md).[`off`](../classes/Subscribe.md#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`
+
+#### Inherited from
+
+[`Subscribe`](../classes/Subscribe.md).[`on`](../classes/Subscribe.md#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`
+
+#### Inherited from
+
+[`Subscribe`](../classes/Subscribe.md).[`once`](../classes/Subscribe.md#once)
+
+#### Defined in
+
+utils/subscribe.ts:74
+
+***
+
+### quit()
+
+> **quit**(): `Promise`\<`boolean`\>
+
+离开房间。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示是否成功离开房间
+
+#### Defined in
+
+typings/rtc/protocol.ts:68
+
+***
+
+### reJoin()?
+
+> `optional` **reJoin**(): `Promise`\<`boolean`\>
+
+重新加入房间。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示是否成功重新加入房间
+
+#### Defined in
+
+typings/rtc/protocol.ts:62
+
+***
+
+### shock()?
+
+> `optional` **shock**(): `void`
+
+震动。
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+typings/rtc/protocol.ts:87
+
+***
+
+### toggleMicro()
+
+> **toggleMicro**(`flag`?): `Promise`\<`boolean`\>
+
+关闭\开启 本地麦克风。
+
+#### Parameters
+
+• **flag?**: `boolean`
+
+是否开启麦克风，默认为切换当前状态
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示操作是否成功
+
+#### Defined in
+
+typings/rtc/protocol.ts:81

package/docs/interfaces/VRWebViewRTCOptions.md

@@ -0,0 +1,41 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / VRWebViewRTCOptions
+
+# Interface: VRWebViewRTCOptions
+
+## Properties
+
+### getVoiceSign()
+
+> **getVoiceSign**: (`params`) => `Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
+
+获取用户语音签名的方法
+
+#### Parameters
+
+• **params**: [`GetVoiceSignParams`](../type-aliases/GetVoiceSignParams.md)
+
+获取语音签名所需的参数
+
+#### Returns
+
+`Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
+
+返回一个Promise，解析为语音签名的相关信息
+
+#### Defined in
+
+typings/rtc/VRWebViewRTCOptions.ts:6
+
+***
+
+### jsBridge
+
+> **jsBridge**: `JSBridgeProtocol`
+
+#### Defined in
+
+typings/rtc/VRWebViewRTCOptions.ts:5

package/docs/namespaces/SubscribeMixinType/README.md

@@ -0,0 +1,17 @@
+[**如视 Live SDK**](../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../globals.md) / SubscribeMixinType
+
+# SubscribeMixinType
+
+## Index
+
+### Interfaces
+
+- [emit](interfaces/emit.md)
+- [hasListener](interfaces/hasListener.md)
+- [off](interfaces/off.md)
+- [on](interfaces/on.md)
+- [once](interfaces/once.md)

package/docs/namespaces/SubscribeMixinType/interfaces/emit.md

@@ -0,0 +1,31 @@
+[**如视 Live SDK**](../../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../../globals.md) / [SubscribeMixinType](../README.md) / emit
+
+# Interface: emit()\<T\>
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../../../type-aliases/EventMap.md)
+
+> **emit**\<`K`\>(`name`, ...`data`): `boolean`
+
+## Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+• **name**: `K`
+
+• ...**data**: `Parameters`\<`T`\[`K`\]\>
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+utils/subscribe.ts:141

package/docs/namespaces/SubscribeMixinType/interfaces/hasListener.md

@@ -0,0 +1,25 @@
+[**如视 Live SDK**](../../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../../globals.md) / [SubscribeMixinType](../README.md) / hasListener
+
+# Interface: hasListener()\<T\>
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../../../type-aliases/EventMap.md)
+
+> **hasListener**(`name`): `boolean`
+
+## Parameters
+
+• **name**: keyof `T`
+
+## Returns
+
+`boolean`
+
+## Defined in
+
+utils/subscribe.ts:129

package/docs/namespaces/SubscribeMixinType/interfaces/off.md

@@ -0,0 +1,31 @@
+[**如视 Live SDK**](../../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../../globals.md) / [SubscribeMixinType](../README.md) / off
+
+# Interface: off()\<T\>
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../../../type-aliases/EventMap.md)
+
+> **off**\<`K`\>(`names`?, `callback`?): `void`
+
+## Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+• **names?**: `K` \| `K`[]
+
+• **callback?**
+
+## Returns
+
+`void`
+
+## Defined in
+
+utils/subscribe.ts:138

package/docs/namespaces/SubscribeMixinType/interfaces/on.md

@@ -0,0 +1,37 @@
+[**如视 Live SDK**](../../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../../globals.md) / [SubscribeMixinType](../README.md) / on
+
+# Interface: on()\<T\>
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../../../type-aliases/EventMap.md)
+
+> **on**\<`K`\>(`name`, `callback`, `once`?): () => `void`
+
+## Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+• **name**: `K`
+
+• **callback**
+
+• **once?**: `boolean`
+
+## Returns
+
+`Function`
+
+### Returns
+
+`void`
+
+## Defined in
+
+utils/subscribe.ts:132

package/docs/namespaces/SubscribeMixinType/interfaces/once.md

@@ -0,0 +1,35 @@
+[**如视 Live SDK**](../../../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../../../globals.md) / [SubscribeMixinType](../README.md) / once
+
+# Interface: once()\<T\>
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../../../type-aliases/EventMap.md)
+
+> **once**\<`K`\>(`name`, `callback`): () => `void`
+
+## Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+## Parameters
+
+• **name**: `K`
+
+• **callback**
+
+## Returns
+
+`Function`
+
+### Returns
+
+`void`
+
+## Defined in
+
+utils/subscribe.ts:135

package/docs/type-aliases/BuiltinMsg.md

@@ -0,0 +1,41 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / BuiltinMsg
+
+# Type Alias: BuiltinMsg
+
+> **BuiltinMsg**: `object`
+
+内置事件数据结构体。
+
+## Type declaration
+
+### action
+
+> **action**: [`BuiltinActionType`](../enumerations/BuiltinActionType.md)
+
+### data
+
+> **data**: `object`
+
+#### Index Signature
+
+ \[`key`: `string`\]: `any`
+
+### data.extension?
+
+> `optional` **extension**: `Record`\<`string`, `any`\>
+
+### event\_type
+
+> **event\_type**: [`BuiltinEventType`](../enumerations/BuiltinEventType.md)
+
+### to\_user\_ids
+
+> **to\_user\_ids**: `string`[]
+
+## Defined in
+
+typings/live/LiveMsg.ts:96

package/docs/type-aliases/EventMap.md

@@ -0,0 +1,17 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / EventMap
+
+# Type Alias: EventMap
+
+> **EventMap**: `object`
+
+## Index Signature
+
+ \[`name`: `string`\]: (...`args`) => `void` \| `boolean`
+
+## Defined in
+
+utils/subscribe.ts:3

package/docs/type-aliases/EventType.md

@@ -0,0 +1,19 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / EventType
+
+# Type Alias: EventType\<KeyframesSnapshot\>
+
+> **EventType**\<`KeyframesSnapshot`\>: [`LiveEventType`](LiveEventType.md)\<`KeyframesSnapshot`\>
+
+事件解析
+
+## Type Parameters
+
+• **KeyframesSnapshot**
+
+## Defined in
+
+typings/live/EventType.ts:86

package/docs/type-aliases/GetVoiceSign.md

@@ -0,0 +1,15 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / GetVoiceSign
+
+# Type Alias: GetVoiceSign
+
+> **GetVoiceSign**: *typeof* [`GetVoiceSignFn`](../functions/GetVoiceSignFn.md)
+
+获取用户语音签名的方法类型
+
+## Defined in
+
+typings/live/GetVoiceSign.ts:55