@realsee/live 0.7.3-alpha.0 → 0.7.3

package/docs/interfaces/RTCProtocol.md

@@ -1,404 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / RTCProtocol
-
-# Interface: RTCProtocol
-
-rtc 协议接口
-
-## Extends
-
-- `Subscribe`\<[`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.emit`
-
-#### Defined in
-
-utils/subscribe.ts:115
-
-***
-
-### hasListener()
-
-> **hasListener**(`name`): `boolean`
-
-判断是否注册了事件
-
-#### Parameters
-
-• **name**: keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
-
-事件类型
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-`Subscribe.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.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.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.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

@@ -1,41 +0,0 @@
-[**如视 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/type-aliases/BuiltinMsg.md

@@ -1,41 +0,0 @@
-[**如视 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/EventType.md

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

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

package/docs/type-aliases/GetVoiceSignParams.md

@@ -1,35 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / GetVoiceSignParams
-
-# Type Alias: GetVoiceSignParams
-
-> **GetVoiceSignParams**: `object`
-
-获取用户语音签名的参数
-
-## Type declaration
-
-### roomId
-
-> **roomId**: `string` \| `number`
-
-房间 id
-
-### userId
-
-> **userId**: `string`
-
-用户 id
-
-### voiceId
-
-> **voiceId**: `string`
-
-语音房间号
-
-## Defined in
-
-typings/live/GetVoiceSign.ts:26

package/docs/type-aliases/GetVoiceSignReturnType.md

@@ -1,41 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / GetVoiceSignReturnType
-
-# Type Alias: GetVoiceSignReturnType
-
-> **GetVoiceSignReturnType**: `object`
-
-语音签名的返回值
-
-## Type declaration
-
-### roomId
-
-> **roomId**: `string` \| `number`
-
-rtc 的 语音房间号
-
-### sdkAppId
-
-> **sdkAppId**: `number`
-
-rtc 的 sdkAppId
-
-### userId
-
-> **userId**: `string`
-
-rtc 的 用户 id
-
-### userSig
-
-> **userSig**: `string`
-
-rtc 的 用户签名
-
-## Defined in
-
-typings/live/GetVoiceSign.ts:4

package/docs/type-aliases/KeyframeEventType.md

@@ -1,19 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / KeyframeEventType
-
-# Type Alias: KeyframeEventType\<KeyframesSnapshot\>
-
-> **KeyframeEventType**\<`KeyframesSnapshot`\>: `{ [key in keyof KeyframesSnapshot]: Function }`
-
-帧数据订阅发布的事件描述
-
-## Type Parameters
-
-• **KeyframesSnapshot**
-
-## Defined in
-
-typings/live/EventType.ts:75

package/docs/type-aliases/LiveBuiltInData.md

@@ -1,47 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveBuiltInData
-
-# Type Alias: LiveBuiltInData\<KeyframesSnapshot\>
-
-> **LiveBuiltInData**\<`KeyframesSnapshot`\>: `object`
-
-## Type Parameters
-
-• **KeyframesSnapshot**
-
-## Type declaration
-
-### keyframes
-
-> **keyframes**: `Y.Map`\<`KeyframesSnapshot`\>
-
-### roomInfo?
-
-> `optional` **roomInfo**: [`RoomInfo`](RoomInfo.md)
-
-### rtcInfo?
-
-> `optional` **rtcInfo**: `object`
-
-### rtcInfo.type
-
-> **type**: [`RTCType`](../enumerations/RTCType.md)
-
-### rtcInfo.voiceId
-
-> **voiceId**: `string`
-
-### selfInfo?
-
-> `optional` **selfInfo**: [`UserInfo`](UserInfo.md)
-
-### userList?
-
-> `optional` **userList**: [`UserInfo`](UserInfo.md)[]
-
-## Defined in
-
-live/live.ts:34

package/docs/type-aliases/LiveConnectOptions.md

@@ -1,47 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveConnectOptions
-
-# Type Alias: LiveConnectOptions
-
-> **LiveConnectOptions**: `object`
-
-带看连接配置项
-
-## Type declaration
-
-### force?
-
-> `optional` **force**: `boolean`
-
-是否强制加入
-如果为 true，会强制加入房间，不管之前是否已经加入，会把之前的连接断开
-如果为 false，会检查是否已经加入房间，如果已经加入，不会再次加入
-
-### getTicket()?
-
-> `optional` **getTicket**: () => `Promise`\<`string`\>
-
-获取带看房间 ticket 的方法
-
-#### Returns
-
-`Promise`\<`string`\>
-
-### rtcMicStatus?
-
-> `optional` **rtcMicStatus**: [`MicroStatus`](../enumerations/MicroStatus.md)
-
-初始的麦克风状态
-
-### url?
-
-> `optional` **url**: `string`
-
-这个是带看房间的 ws 地址
-
-## Defined in
-
-typings/live/LiveConnectOptions.ts:6