zann-voice 0.1.8 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,6 +45,13 @@ voice.stopMicrophone();
|
|
|
45
45
|
voice.startMicrophone();
|
|
46
46
|
|
|
47
47
|
```
|
|
48
|
+
| 属性 | 类型| 是否必须 |备注 |
|
|
49
|
+
| -------------| :-----------: | :-----------: | :-----------: |
|
|
50
|
+
| wss | string |是 | WebSocket地址 |
|
|
51
|
+
| TURN | RTCIceServer |是 | ice配置 |
|
|
52
|
+
| maxReconnect | RTCIceServer |否 | 最大重连次数非必填， 默认5 |
|
|
53
|
+
|
|
54
|
+
|
|
48
55
|
|
|
49
56
|
### **1.connect()创建呼叫**
|
|
50
57
|
> 必须在click事件中调用，一次new 可以多次调用
|
|
@@ -74,7 +81,7 @@ voice.connect({
|
|
|
74
81
|
| onTrack | function |是 | 监听媒体流[请参考](https://developer.mozilla.org/en-US/docs/Web/API/RTCTrackEvent#example) |
|
|
75
82
|
| onError | function |是 | 监听错误问题 |
|
|
76
83
|
| onMessage | function |是 | 监听websocket 发来的内容 |
|
|
77
|
-
| onAuth | function | 是 | 监听到需要用户授权麦克风或者摄像头，返回值参考 <code>
|
|
84
|
+
| onAuth | function | 是 | 监听到需要用户授权麦克风或者摄像头，返回值参考 <code>PermissionState.state 授权状态</code>|
|
|
78
85
|
| onMicrophoneChange | function | 否 | 监听麦克风变化，并返回 MediaStream |
|
|
79
86
|
| onCameraChange | function | 否 | 监听摄像头变化，并返回 MediaStream |
|
|
80
87
|
|
|
@@ -85,6 +92,7 @@ voice.connect({
|
|
|
85
92
|
video?: boolean;
|
|
86
93
|
}
|
|
87
94
|
```
|
|
95
|
+
|
|
88
96
|
### **2.destroy()销毁，挂断**
|
|
89
97
|
> 销毁，或者挂断由connect()创建的通话
|
|
90
98
|
> <br/>必须先调用connect 才可正常调用此方法
|
|
@@ -114,7 +122,7 @@ voice.connect({
|
|
|
114
122
|
| camera | string |是 | 摄像头授权状态 |
|
|
115
123
|
|
|
116
124
|
|
|
117
|
-
**2.<code>
|
|
125
|
+
**2.<code>PermissionState.state 授权状态</code>**
|
|
118
126
|
| 属性 | 类型 |备注 |
|
|
119
127
|
| ------------- | :-----------: | :-----------: |
|
|
120
128
|
| granted | string | 用户已经授权 |
|