@realsee/live 0.7.3-alpha.0 → 0.7.4

package/docs/classes/VRWebViewRTC.md

@@ -1,436 +0,0 @@
-[**如视 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:115
-
-***
-
-### 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

@@ -1,27 +0,0 @@
-[**如视 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

package/docs/enumerations/BuiltinActionType.md

@@ -1,81 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / BuiltinActionType
-
-# Enumeration: BuiltinActionType
-
-内置事件行为类型。
-
-## Enumeration Members
-
-### RoomClose
-
-> **RoomClose**: `"close"`
-
-关闭房间。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:90
-
-***
-
-### UserInfo
-
-> **UserInfo**: `"change_info"`
-
-更新用户信息。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:86
-
-***
-
-### UserMicroStatus
-
-> **UserMicroStatus**: `"change_micro_status"`
-
-修改麦克风状态。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:70
-
-***
-
-### UserMicroStatusSync
-
-> **UserMicroStatusSync**: `"sync_micro_status"`
-
-同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端
-
-#### Defined in
-
-typings/live/LiveMsg.ts:74
-
-***
-
-### UserPermission
-
-> **UserPermission**: `"change_permission"`
-
-调整某些用户的权限。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:78
-
-***
-
-### UserStatus
-
-> **UserStatus**: `"change_status"`
-
-用户状态发生改变。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:82

package/docs/enumerations/BuiltinEventType.md

@@ -1,33 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / BuiltinEventType
-
-# Enumeration: BuiltinEventType
-
-内置事件类型。
-
-## Enumeration Members
-
-### RoomChange
-
-> **RoomChange**: `"room_change"`
-
-变更房间状态。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:60
-
-***
-
-### UserChange
-
-> **UserChange**: `"user_change"`
-
-变更用户状态。
-
-#### Defined in
-
-typings/live/LiveMsg.ts:56

package/docs/enumerations/Command.md

@@ -1,107 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / Command
-
-# Enumeration: Command
-
-WebSocket 通信指令
-- 下行：服务端推送数据
-- 上行：客户端上报数据
-
-## Enumeration Members
-
-### BuiltinMsg
-
-> **BuiltinMsg**: `"BUILTIN_MSG"`
-
-内置消息：下行、上行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:16
-
-***
-
-### CustomEvent
-
-> **CustomEvent**: `"CUSTOM_EVENT"`
-
-自定义广播事件消息：下行、上行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:18
-
-***
-
-### KeyframeSync
-
-> **KeyframeSync**: `"KEYFRAME_SYNC"`
-
-帧数据同步：下行、上行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:20
-
-***
-
-### RoomInfo
-
-> **RoomInfo**: `"ROOM_INFO"`
-
-房间信息：下行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:10
-
-***
-
-### RTCInfo
-
-> **RTCInfo**: `"RTC_INFO"`
-
-RTC信息：下行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:12
-
-***
-
-### SelfUserInfo
-
-> **SelfUserInfo**: `"SELF_USER_INFO"`
-
-当前用户信息：下行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:8
-
-***
-
-### UserKickOut
-
-> **UserKickOut**: `"USER_KICK_OUT"`
-
-被踢出房间：下行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:22
-
-***
-
-### UserList
-
-> **UserList**: `"USER_LIST"`
-
-用户列表：下行
-
-#### Defined in
-
-typings/live/LiveMsg.ts:14

package/docs/enumerations/LiveState.md

@@ -1,53 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveState
-
-# Enumeration: LiveState
-
-## Enumeration Members
-
-### CLOSED
-
-> **CLOSED**: `3`
-
-连接已关闭或者链接失败
-
-#### Defined in
-
-typings/live/LiveState.ts:20
-
-***
-
-### CONNECTING
-
-> **CONNECTING**: `0`
-
-正在链接中
-
-#### Defined in
-
-typings/live/LiveState.ts:10
-
-***
-
-### NOTINITIALIZED
-
-> **NOTINITIALIZED**: `-1`
-
-#### Defined in
-
-typings/live/LiveState.ts:5
-
-***
-
-### OPEN
-
-> **OPEN**: `1`
-
-已经链接并且可以通讯
-
-#### Defined in
-
-typings/live/LiveState.ts:15