@realsee/live 0.7.3-alpha.0 → 0.7.3

package/docs/interfaces/LiveOptions.md

@@ -1,246 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / LiveOptions
-
-# Interface: LiveOptions
-
-依赖配置。
-
-## Properties
-
-### \_\_debug\_\_?
-
-> `optional` **\_\_debug\_\_**: `boolean`
-
-是否开启调试模式：此模式下会在终端打印日志方便调试。
-
-#### Defined in
-
-typings/live/LiveOptions.ts:86
-
-***
-
-### autoPlayConfirm()?
-
-> `optional` **autoPlayConfirm**: (`options`) => `void`
-
-使用webRTC时会有自动播放的安全策略限制，用户有交互
-
-#### Parameters
-
-• **options**
-
-• **options.onConfirm**
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-typings/live/LiveOptions.ts:54
-
-***
-
-### builtInRTCType?
-
-> `optional` **builtInRTCType**: [`BuiltInRTCType`](../enumerations/BuiltInRTCType.md)
-
-内置的rtc通道类型
-trtc or chime , default trtc
-
-#### Defined in
-
-typings/live/LiveOptions.ts:65
-
-***
-
-### canForbidUserKick()?
-
-> `optional` **canForbidUserKick**: (`users`) => `boolean`
-
-能否强制"踢掉"某个/些用户。
-
-#### Parameters
-
-• **users**: `string` \| `string`[]
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-typings/live/LiveOptions.ts:82
-
-***
-
-### canForbidUserMicro()?
-
-> `optional` **canForbidUserMicro**: (`users`) => `boolean`
-
-能否禁用某个/些用户的麦克风
-
-#### Parameters
-
-• **users**: `string` \| `string`[]
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-typings/live/LiveOptions.ts:74
-
-***
-
-### canForbidUserSync()?
-
-> `optional` **canForbidUserSync**: (`users`) => `boolean`
-
-能否限制某个/些用户的帧数据同步
-
-#### Parameters
-
-• **users**: `string` \| `string`[]
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-typings/live/LiveOptions.ts:78
-
-***
-
-### getTicket()?
-
-> `optional` **getTicket**: () => `Promise`\<`string`\>
-
-获取建立 WebSocket 连接的依赖Tick
-
-#### Returns
-
-`Promise`\<`string`\>
-
-#### Defined in
-
-typings/live/LiveOptions.ts:35
-
-***
-
-### getVoiceSign()?
-
-> `optional` **getVoiceSign**: (`params`) => `Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-
-获取语音签名的接口
-使用内置rtc时提供给rtc实例使用
-
-获取用户语音签名的方法
-
-#### Parameters
-
-• **params**: [`GetVoiceSignParams`](../type-aliases/GetVoiceSignParams.md)
-
-获取语音签名所需的参数
-
-#### Returns
-
-`Promise`\<[`GetVoiceSignReturnType`](../type-aliases/GetVoiceSignReturnType.md)\>
-
-返回一个Promise，解析为语音签名的相关信息
-
-#### Defined in
-
-typings/live/LiveOptions.ts:47
-
-***
-
-### initialMicroStatus?
-
-> `optional` **initialMicroStatus**: [`MicroStatus`](../enumerations/MicroStatus.md)
-
-麦克风初始状态
-
-#### Defined in
-
-typings/live/LiveOptions.ts:30
-
-***
-
-### jsBridge?
-
-> `optional` **jsBridge**: `JSBridgeProtocol`
-
-jsBridge实例
-使用内置rtc时提供给rtc实例使用
-
-#### Defined in
-
-typings/live/LiveOptions.ts:41
-
-***
-
-### rtc?
-
-> `optional` **rtc**: [`RTCProtocol`](RTCProtocol.md)
-
-RTC实例。
-优先使用该实例。
-
-#### Defined in
-
-typings/live/LiveOptions.ts:19
-
-***
-
-### rtcType?
-
-> `optional` **rtcType**: [`RTCType`](../enumerations/RTCType.md)
-
-RTC类型
-rtc 为空时使用内置的rtc实例类型
-
-#### Defined in
-
-typings/live/LiveOptions.ts:25
-
-***
-
-### url?
-
-> `optional` **url**: `string`
-
-创建`WebSocket`所依赖的URL。
-
-#### Defined in
-
-typings/live/LiveOptions.ts:14
-
-***
-
-### useBuiltInJsBridge?
-
-> `optional` **useBuiltInJsBridge**: `boolean`
-
-使用内置的jsBridge实例
-
-#### Defined in
-
-typings/live/LiveOptions.ts:70
-
-***
-
-### useBuiltInRTC?
-
-> `optional` **useBuiltInRTC**: `boolean`
-
-使用内置的rtc实例
-
-#### Defined in
-
-typings/live/LiveOptions.ts:59

package/docs/interfaces/MeetingResponse.md

@@ -1,55 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / MeetingResponse
-
-# Interface: MeetingResponse
-
-## Properties
-
-### MediaPlacement
-
-> **MediaPlacement**: `object`
-
-#### AudioFallbackUrl
-
-> **AudioFallbackUrl**: `string`
-
-#### AudioHostUrl
-
-> **AudioHostUrl**: `string`
-
-#### ScreenDataUrl
-
-> **ScreenDataUrl**: `string`
-
-#### ScreenSharingUrl
-
-> **ScreenSharingUrl**: `string`
-
-#### ScreenViewingUrl
-
-> **ScreenViewingUrl**: `string`
-
-#### SignalingUrl
-
-> **SignalingUrl**: `string`
-
-#### TurnControlUrl
-
-> **TurnControlUrl**: `string`
-
-#### Defined in
-
-typings/chime/MeetingResponse.ts:2
-
-***
-
-### MeetingId
-
-> **MeetingId**: `string`
-
-#### Defined in
-
-typings/chime/MeetingResponse.ts:11

package/docs/interfaces/MeetingSessionConfigurationOptions.md

@@ -1,93 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / MeetingSessionConfigurationOptions
-
-# Interface: MeetingSessionConfigurationOptions
-
-## Properties
-
-### attendence
-
-> **attendence**: [`AttendeeResponse`](AttendeeResponse.md)
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:5
-
-***
-
-### config
-
-> **config**: `object`
-
-#### app\_id
-
-> **app\_id**: `string`
-
-#### bypass
-
-> **bypass**: `any`
-
-#### passport
-
-> **passport**: `string`
-
-#### vendor
-
-> **vendor**: `string`
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:6
-
-***
-
-### expire\_time
-
-> **expire\_time**: `number`
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:7
-
-***
-
-### identifier
-
-> **identifier**: `string`
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:8
-
-***
-
-### user\_id
-
-> **user\_id**: `string`
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:9
-
-***
-
-### user\_sig
-
-> **user\_sig**: `string`
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:10
-
-***
-
-### vendor\_wrapper
-
-> **vendor\_wrapper**: [`MeetingResponse`](MeetingResponse.md)
-
-#### Defined in
-
-typings/chime/MeetingSessionConfigurationOptions.ts:11

package/docs/interfaces/Permission.md

@@ -1,147 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / Permission
-
-# Interface: Permission
-
-## Properties
-
-### apply\_other\_phone
-
-> **apply\_other\_phone**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:108
-
-***
-
-### change\_other\_status
-
-> **change\_other\_status**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:116
-
-***
-
-### close\_live\_room
-
-> **close\_live\_room**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:106
-
-***
-
-### control\_other\_micro
-
-> **control\_other\_micro**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:100
-
-***
-
-### control\_other\_sync
-
-> **control\_other\_sync**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:118
-
-***
-
-### control\_own\_micro
-
-> **control\_own\_micro**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:98
-
-***
-
-### dynamic\_enter
-
-> **dynamic\_enter**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:110
-
-***
-
-### extension
-
-> **extension**: `Record`\<`string`, `boolean`\>
-
-#### Defined in
-
-typings/live/UserInfo.ts:120
-
-***
-
-### invite\_other
-
-> **invite\_other**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:96
-
-***
-
-### more\_vr\_scene
-
-> **more\_vr\_scene**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:94
-
-***
-
-### sync\_frame
-
-> **sync\_frame**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:112
-
-***
-
-### transfer\_role
-
-> **transfer\_role**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:114
-
-***
-
-### view\_other\_micro\_status
-
-> **view\_other\_micro\_status**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:104
-
-***
-
-### view\_own\_micro\_status
-
-> **view\_own\_micro\_status**: `boolean`
-
-#### Defined in
-
-typings/live/UserInfo.ts:102

package/docs/interfaces/RTCJoinedInfo.md

@@ -1,67 +0,0 @@
-[**如视 Live SDK**](../README.md) • **Docs**
-
-***
-
-[如视 Live SDK](../globals.md) / RTCJoinedInfo
-
-# Interface: RTCJoinedInfo
-
-进入rtc房间的回调信息
-
-## Properties
-
-### code
-
-> **code**: [`RTCJoinedInfoCodeEnum`](../enumerations/RTCJoinedInfoCodeEnum.md)
-
-#### Defined in
-
-typings/rtc/joinedInfo.ts:32
-
-***
-
-### errInfo?
-
-> `optional` **errInfo**: `object`
-
-#### errCode
-
-> **errCode**: `number`
-
-#### errMsg
-
-> **errMsg**: `string`
-
-#### Defined in
-
-typings/rtc/joinedInfo.ts:36
-
-***
-
-### message
-
-> **message**: `string`
-
-#### Defined in
-
-typings/rtc/joinedInfo.ts:33
-
-***
-
-### roomId?
-
-> `optional` **roomId**: `number`
-
-#### Defined in
-
-typings/rtc/joinedInfo.ts:35
-
-***
-
-### userId?
-
-> `optional` **userId**: `string`
-
-#### Defined in
-
-typings/rtc/joinedInfo.ts:34