@realsee/live 0.6.15 → 0.7.0

package/docs/classes/CoreRTC.md

@@ -0,0 +1,448 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / CoreRTC
+
+# Class: `abstract` CoreRTC
+
+rtc 基础抽象类
+
+## Extends
+
+- [`Subscribe`](Subscribe.md)\<[`RTCEventType`](../type-aliases/RTCEventType.md)\>
+
+## Extended by
+
+- [`BrowserRTC`](BrowserRTC.md)
+- [`BrowserRTC4Chime`](BrowserRTC4Chime.md)
+- [`VRWebViewRTC`](VRWebViewRTC.md)
+
+## Implements
+
+- [`RTCProtocol`](../interfaces/RTCProtocol.md)
+
+## Constructors
+
+### new CoreRTC()
+
+> **new CoreRTC**(): [`CoreRTC`](CoreRTC.md)
+
+#### Returns
+
+[`CoreRTC`](CoreRTC.md)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`constructor`](Subscribe.md#constructors)
+
+## Properties
+
+### joined
+
+> `abstract` **joined**: `boolean`
+
+是否已经加入房间
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`joined`](../interfaces/RTCProtocol.md#joined)
+
+#### Defined in
+
+rtc/CoreRTC.ts:13
+
+***
+
+### micro
+
+> `abstract` **micro**: `boolean`
+
+麦克风状态
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`micro`](../interfaces/RTCProtocol.md#micro)
+
+#### Defined in
+
+rtc/CoreRTC.ts:15
+
+***
+
+### type
+
+> `abstract` **type**: [`RTCType`](../enumerations/RTCType.md)
+
+rtc 实现类型
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`type`](../interfaces/RTCProtocol.md#type)
+
+#### Defined in
+
+rtc/CoreRTC.ts:19
+
+***
+
+### voiceId
+
+> `abstract` **voiceId**: `string`
+
+语音房间ID
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`voiceId`](../interfaces/RTCProtocol.md#voiceid)
+
+#### Defined in
+
+rtc/CoreRTC.ts:17
+
+## Methods
+
+### detectMicro()
+
+> `abstract` **detectMicro**(): `Promise`\<`boolean`\>
+
+监测麦克风授权。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示麦克风是否被授权
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`detectMicro`](../interfaces/RTCProtocol.md#detectmicro)
+
+#### Defined in
+
+rtc/CoreRTC.ts:30
+
+***
+
+### 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 是否被触发取消
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`emit`](../interfaces/RTCProtocol.md#emit)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`emit`](Subscribe.md#emit)
+
+#### Defined in
+
+utils/subscribe.ts:113
+
+***
+
+### hasListener()
+
+> **hasListener**(`name`): `boolean`
+
+判断是否注册了事件
+
+#### Parameters
+
+• **name**: keyof [`RTCEventType`](../type-aliases/RTCEventType.md)
+
+事件类型
+
+#### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`hasListener`](../interfaces/RTCProtocol.md#haslistener)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`hasListener`](Subscribe.md#haslistener)
+
+#### Defined in
+
+utils/subscribe.ts:41
+
+***
+
+### join()
+
+> `abstract` **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，表示是否成功加入房间
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`join`](../interfaces/RTCProtocol.md#join)
+
+#### Defined in
+
+rtc/CoreRTC.ts:21
+
+***
+
+### 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`
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`off`](../interfaces/RTCProtocol.md#off)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`off`](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`
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`on`](../interfaces/RTCProtocol.md#on)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`on`](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`
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`once`](../interfaces/RTCProtocol.md#once)
+
+#### Inherited from
+
+[`Subscribe`](Subscribe.md).[`once`](Subscribe.md#once)
+
+#### Defined in
+
+utils/subscribe.ts:74
+
+***
+
+### quit()
+
+> `abstract` **quit**(): `Promise`\<`boolean`\>
+
+离开房间。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示是否成功离开房间
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`quit`](../interfaces/RTCProtocol.md#quit)
+
+#### Defined in
+
+rtc/CoreRTC.ts:28
+
+***
+
+### shock()
+
+> `abstract` **shock**(): `void`
+
+震动。
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`shock`](../interfaces/RTCProtocol.md#shock)
+
+#### Defined in
+
+rtc/CoreRTC.ts:34
+
+***
+
+### toggleMicro()
+
+> `abstract` **toggleMicro**(`flag`?): `Promise`\<`boolean`\>
+
+关闭\开启 本地麦克风。
+
+#### Parameters
+
+• **flag?**: `boolean`
+
+是否开启麦克风，默认为切换当前状态
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示操作是否成功
+
+#### Implementation of
+
+[`RTCProtocol`](../interfaces/RTCProtocol.md).[`toggleMicro`](../interfaces/RTCProtocol.md#togglemicro)
+
+#### Defined in
+
+rtc/CoreRTC.ts:32