@realsee/live 0.6.14 → 0.7.0

package/docs/classes/BrowserRTC.md

@@ -0,0 +1,436 @@
+[**如视 Live SDK**](../README.md) • **Docs**
+
+***
+
+[如视 Live SDK](../globals.md) / BrowserRTC
+
+# Class: BrowserRTC
+
+rtc 基础抽象类
+
+## Extends
+
+- [`CoreRTC`](CoreRTC.md)
+
+## Constructors
+
+### new BrowserRTC()
+
+> **new BrowserRTC**(`options`): [`BrowserRTC`](BrowserRTC.md)
+
+#### Parameters
+
+• **options**
+
+• **options.autoPlayConfirm?**
+
+• **options.getVoiceSign**
+
+#### Returns
+
+[`BrowserRTC`](BrowserRTC.md)
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`constructor`](CoreRTC.md#constructors)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:37
+
+## Properties
+
+### joined
+
+> **joined**: `boolean` = `false`
+
+是否已经加入房间
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`joined`](CoreRTC.md#joined)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:16
+
+***
+
+### micro
+
+> **micro**: `boolean` = `false`
+
+麦克风状态
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`micro`](CoreRTC.md#micro)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:17
+
+***
+
+### type
+
+> **type**: [`RTCType`](../enumerations/RTCType.md) = `RTCType.RealseeBrowserRTC`
+
+rtc 实现类型
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`type`](CoreRTC.md#type)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:15
+
+***
+
+### voiceId
+
+> **voiceId**: `string` = `''`
+
+语音房间ID
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`voiceId`](CoreRTC.md#voiceid)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:18
+
+## Methods
+
+### checkRequirement()
+
+> **checkRequirement**(): `Promise`\<`CheckResult`\>
+
+#### Returns
+
+`Promise`\<`CheckResult`\>
+
+#### Defined in
+
+rtc/BrowserRTC.ts:28
+
+***
+
+### detectMicro()
+
+> **detectMicro**(): `Promise`\<`boolean`\>
+
+监测麦克风授权。
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示麦克风是否被授权
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`detectMicro`](CoreRTC.md#detectmicro)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:139
+
+***
+
+### 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`\>
+
+返回一个Promise，表示是否成功加入房间
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`join`](CoreRTC.md#join)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:54
+
+***
+
+### 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`\>
+
+返回一个Promise，表示是否成功离开房间
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`quit`](CoreRTC.md#quit)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:121
+
+***
+
+### shock()
+
+> **shock**(): `void`
+
+震动。
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`shock`](CoreRTC.md#shock)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:165
+
+***
+
+### toggleMicro()
+
+> **toggleMicro**(`flag`?): `Promise`\<`boolean`\>
+
+关闭\开启 本地麦克风。
+
+#### Parameters
+
+• **flag?**: `boolean`
+
+是否开启麦克风，默认为切换当前状态
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+返回一个Promise，表示操作是否成功
+
+#### Overrides
+
+[`CoreRTC`](CoreRTC.md).[`toggleMicro`](CoreRTC.md#togglemicro)
+
+#### Defined in
+
+rtc/BrowserRTC.ts:157