浏览代码

Updated API docs to include connectvityEvents

dev1
Louis Sivillo 7 年前
父节点
当前提交
0ae96d8e18
共有 1 个文件被更改,包括 5 次插入2 次删除
  1. 5
    2
      doc/API.md

+ 5
- 2
doc/API.md 查看文件

@@ -117,7 +117,7 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
117 117
         - KICKED - notifies that user has been kicked from the conference.
118 118
         - START_MUTED_POLICY_CHANGED - notifies that all new participants will join with muted audio/video stream (parameters - JS object with 2 properties - audio(boolean), video(boolean))
119 119
         - STARTED_MUTED - notifies that the local user has started muted
120
-        - CONNECTION_STATS - New local connection statistics are received. (parameters - stats(object))
120
+        - CONNECTION_STATS - __DEPRECATED__. Use ```JitsiMeetJS.connectionQuality.LOCAL_STATS_UPDATED``` instead.
121 121
         - BEFORE_STATISTICS_DISPOSED - fired just before the statistics module is disposed and it's the last chance to submit some logs to the statistics service, before it gets disconnected
122 122
         - AUTH_STATUS_CHANGED - notifies that authentication is enabled or disabled, or local user authenticated (logged in). (parameters - isAuthEnabled(boolean), authIdentity(string))
123 123
         - ENDPOINT_MESSAGE_RECEIVED - notifies that a new message
@@ -137,7 +137,10 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
137 137
     4. mediaDevices
138 138
         - DEVICE_LIST_CHANGED - indicates that list of currently connected devices has changed (parameters - devices(MediaDeviceInfo[])).
139 139
         - PERMISSION_PROMPT_IS_SHOWN - Indicates that the environment is currently showing permission prompt to access camera and/or microphone (parameters - environmentType ('chrome'|'opera'|'firefox'|'safari'|'nwjs'|'react-native'|'android').
140
-
140
+        
141
+    5. connectionQuality
142
+        - LOCAL_STATS_UPDATED - New local connection statistics are received. (parameters - stats(object))
143
+        - REMOTE_STATS_UPDATED - New remote connection statistics are received. (parameters - id(string), stats(object))
141 144
 
142 145
 * ```JitsiMeetJS.errors``` - JS object that contains all errors used by the API. You can use that object to check the reported errors from the API
143 146
     We have three error types - connection, conference and track. You can access the events with the following code ```JitsiMeetJS.errors.<error_type>.<error_name>```.

正在加载...
取消
保存