Преглед изворни кода

Fixes initJitsiConference options in API.md

release-8443
hristoterezov пре 10 година
родитељ
комит
0bac10e552
1 измењених фајлова са 13 додато и 6 уклоњено
  1. 13
    6
      doc/API.md

+ 13
- 6
doc/API.md Прегледај датотеку

@@ -45,6 +45,7 @@ The ```options``` parameter is JS object with the following properties:
45 45
     6. desktopSharingFirefoxDisabled - Boolean. Whether desktop sharing should be disabled on Firefox. Example: false.
46 46
     7. desktopSharingFirefoxMaxVersionExtRequired - The maximum version of Firefox which requires a jidesha extension. Example: if set to 41, we will require the extension for Firefox versions up to and including 41. On Firefox 42 and higher, we will run without the extension. If set to -1, an extension will be required for all versions of Firefox.
47 47
     8. desktopSharingFirefoxExtensionURL - The URL to the Firefox extension for desktop sharing. "null" if no extension is required.
48
+    9. disableAudioLevels - boolean property. Enables/disables audio levels.
48 49
 
49 50
 * ```JitsiMeetJS.JitsiConnection``` - the ```JitsiConnection``` constructor. You can use that to create new server connection.
50 51
 
@@ -148,12 +149,14 @@ This objects represents the server connection. You can create new ```JitsiConnec
148 149
 4. initJitsiConference(name, options) - creates new ```JitsiConference``` object.
149 150
     - name - the name of the conference
150 151
     - options - JS object with configuration options for the conference. You can change the following properties there:
151
-        1. devices - array with the devices - "video" and "audio" that will be passed to GUM. If that property is not set GUM will try to get all available devices.
152
-        2. resolution - the prefered resolution for the local video.
153
-        3. openSctp - boolean property. Enables/disables datachannel support. **NOTE: we recommend to set that option to true**
154
-        4. disableAudioLevels - boolean property. Enables/disables audio levels.
155
-        5. recordingType - the type of recording to be used
156
-        6. jirecon
152
+        1. openSctp - boolean property. Enables/disables datachannel support. **NOTE: we recommend to set that option to true**
153
+        2. recordingType - the type of recording to be used
154
+        3. jirecon
155
+        4. callStatsID - callstats credentials
156
+        5. callStatsSecret - callstats credentials
157
+        6. disableThirdPartyRequests - if true - callstats will be disabled and
158
+        the callstats API won't be included.
159
+        **NOTE: if 4 and 5 are set the library is going to send events to callstats. Otherwise the callstats integration will be disabled.**
157 160
 
158 161
 5. addEventListener(event, listener) - Subscribes the passed listener to the event.
159 162
     - event - one of the events from ```JitsiMeetJS.events.connection``` object.
@@ -271,6 +274,10 @@ The object represents a conference. We have the following methods to control the
271 274
 
272 275
 28. isStartVideoMuted() - check if video is muted on join
273 276
 
277
+29. sendFeedback(overallFeedback, detailedFeedback) - Sends the given feedback through CallStats if enabled.
278
+    - overallFeedback an integer between 1 and 5 indicating the user feedback
279
+    - detailedFeedback detailed feedback from the user. Not yet used
280
+
274 281
 JitsiTrack
275 282
 ======
276 283
 The object represents single track - video or audio. They can be remote tracks ( from the other participants in the call) or local tracks (from the devices of the local participant).

Loading…
Откажи
Сачувај