@realsee/live 0.6.14 → 0.7.0

package/docs/classes/Subscribe.md

@@ -0,0 +1,211 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / Subscribe
+
+# Class: Subscribe\<T\>
+
+监听者模式
+
+## Example
+
+```
+new Subscribe<{
+"foo": [arg1: number, arg2: string],
+"bar": [arg: boolean],
+}>()
+```
+
+## Extended by
+
+- [`CoreRTC`](CoreRTC.md)
+- [`RTCProtocol`](../interfaces/RTCProtocol.md)
+- [`Live`](Live.md)
+
+## Type Parameters
+
+• **T** *extends* [`EventMap`](../type-aliases/EventMap.md)
+
+预设的监听回调类型
+
+## Constructors
+
+### new Subscribe()
+
+> **new Subscribe**\<`T`\>(): [`Subscribe`](Subscribe.md)\<`T`\>
+
+#### Returns
+
+[`Subscribe`](Subscribe.md)\<`T`\>
+
+## Methods
+
+### emit()
+
+> **emit**\<`K`\>(`name`, ...`data`): `boolean`
+
+触发事件
+
+#### Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+预设的监听事件名称
+
+#### Parameters
+
+• **name**: `K`
+
+事件类型
+
+• ...**data**: `Parameters`\<`T`\[`K`\]\>
+
+触发事件的数据
+
+#### Returns
+
+`boolean`
+
+canceled 是否被触发取消
+
+#### Defined in
+
+utils/subscribe.ts:113
+
+***
+
+### hasListener()
+
+> **hasListener**(`name`): `boolean`
+
+判断是否注册了事件
+
+#### Parameters
+
+• **name**: keyof `T`
+
+事件类型
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+utils/subscribe.ts:41
+
+***
+
+### off()
+
+> **off**\<`K`\>(`name`?, `callback`?): `void`
+
+解除事件
+
+如果 name 不传的话解除对应所有事件
+如果 name, callback 不传的话解除所有name的所有事件
+
+#### Type Parameters
+
+• **K** *extends* `string` \| `number` \| `symbol`
+
+预设的监听事件名称
+
+#### Parameters
+
+• **name?**: `K`
+
+事件类型
+
+• **callback?**
+
+事件回调函数
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+utils/subscribe.ts:87
+
+***
+
+### on()
+
+> **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:55
+
+***
+
+### once()
+
+> **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:74

package/docs/classes/VRWebViewRTC.md

@@ -0,0 +1,436 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / VRWebViewRTC
+
+# Class: VRWebViewRTC
+
+rtc 基础抽象类
+
+## Extends
+
+- [`CoreRTC`](CoreRTC.md)
+
+## Constructors
+
+### new VRWebViewRTC()
+
+> **new VRWebViewRTC**(`__namedParameters`): [`VRWebViewRTC`](VRWebViewRTC.md)
+
+#### Parameters
+
+• **\_\_namedParameters**: [`VRWebViewRTCOptions`](../interfaces/VRWebViewRTCOptions.md)
+
+#### Returns
+
+[`VRWebViewRTC`](VRWebViewRTC.md)
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`constructor`](CoreRTC.md#constructors)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:33
+
+## Properties
+
+### joined
+
+> **joined**: `boolean` = `false`
+
+是否已经加入房间
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`joined`](CoreRTC.md#joined)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:13
+
+***
+
+### micro
+
+> **micro**: `boolean` = `false`
+
+麦克风状态
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`micro`](CoreRTC.md#micro)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:14
+
+***
+
+### type
+
+> **type**: [`RTCType`](../enumerations/RTCType.md) = `RTCType.RealseeVRWebViewRTC`
+
+rtc 实现类型
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`type`](CoreRTC.md#type)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:12
+
+***
+
+### voiceId
+
+> **voiceId**: `string` = `""`
+
+语音房间ID
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`voiceId`](CoreRTC.md#voiceid)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:15
+
+## Accessors
+
+### jsBridge
+
+> `get` **jsBridge**(): `JSBridgeProtocol`
+
+#### Returns
+
+`JSBridgeProtocol`
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:29
+
+## Methods
+
+### detectMicro()
+
+> **detectMicro**(): `Promise`\<`boolean`\>
+
+监测麦克风权限
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`detectMicro`](CoreRTC.md#detectmicro)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:296
+
+***
+
+### 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
+
+[`CoreRTC`](CoreRTC.md).[`emit`](CoreRTC.md#emit)
+
+#### Defined in
+
+utils/subscribe.ts:113
+
+***
+
+### hasListener()
+
+> **hasListener**(`name`): `boolean`
+
+判断是否注册了事件
+
+#### Parameters
+
+• **name**: keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
+
+事件类型
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`CoreRTC`](CoreRTC.md).[`hasListener`](CoreRTC.md#haslistener)
+
+#### Defined in
+
+utils/subscribe.ts:41
+
+***
+
+### 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`\>
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`join`](CoreRTC.md#join)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:69
+
+***
+
+### 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
+
+[`CoreRTC`](CoreRTC.md).[`off`](CoreRTC.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
+
+[`CoreRTC`](CoreRTC.md).[`on`](CoreRTC.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
+
+[`CoreRTC`](CoreRTC.md).[`once`](CoreRTC.md#once)
+
+#### Defined in
+
+utils/subscribe.ts:74
+
+***
+
+### quit()
+
+> **quit**(): `Promise`\<`boolean`\>
+
+退出房间
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`quit`](CoreRTC.md#quit)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:281
+
+***
+
+### reJoin()
+
+> **reJoin**(): `Promise`\<`boolean`\>
+
+重连
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:111
+
+***
+
+### shock()
+
+> **shock**(): `void`
+
+震动
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`shock`](CoreRTC.md#shock)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:325
+
+***
+
+### toggleMicro()
+
+> **toggleMicro**(`flag`?): `Promise`\<`boolean`\>
+
+修改麦克风状态
+
+#### Parameters
+
+• **flag?**: `boolean`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`toggleMicro`](CoreRTC.md#togglemicro)
+
+#### Defined in
+
+rtc/VRWebViewRTC.ts:310

package/docs/enumerations/BuiltInRTCType.md

@@ -0,0 +1,27 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / BuiltInRTCType
+
+# Enumeration: BuiltInRTCType
+
+## Enumeration Members
+
+### RealseeXChimeRTC
+
+> **RealseeXChimeRTC**: `"chime"`
+
+#### Defined in
+
+typings/rtc/type.ts:12
+
+***
+
+### RealseeXTRTC
+
+> **RealseeXTRTC**: `"trtc"`
+
+#### Defined in
+
+typings/rtc/type.ts:11