瀏覽代碼

Update API.md

1. JitsiMeetJS.createLocalTracks constraints missing data.
2. removed duplicate documentation for selectParticipant.
3. added setReceiverVideoConstraint function data.
dev1
Roey 6 年之前
父節點
當前提交
5da450a5a1
No account linked to committer's email address
共有 1 個文件被更改,包括 13 次插入11 次删除
  1. 13
    11
      doc/API.md

+ 13
- 11
doc/API.md 查看文件

@@ -66,11 +66,12 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
66 66
     - options - JS object with configuration options for the local media tracks. You can change the following properties there:
67 67
         1. devices - array with the devices - "desktop", "video" and "audio" that will be passed to GUM. If that property is not set GUM will try to get all available devices.
68 68
         2. resolution - the prefered resolution for the local video.
69
-        3. cameraDeviceId - the deviceID for the video device that is going to be used
70
-        4. micDeviceId - the deviceID for the audio device that is going to be used
71
-        5. minFps - the minimum frame rate for the video stream (passed to GUM)
72
-        6. maxFps - the maximum frame rate for the video stream (passed to GUM)
73
-        7. facingMode - facing mode for a camera (possible values - 'user', 'environment')
69
+        3. constraints - the prefered encoding properties for the created track (replaces 'resolution' in newer releases of browsers)
70
+        4. cameraDeviceId - the deviceID for the video device that is going to be used
71
+        5. micDeviceId - the deviceID for the audio device that is going to be used
72
+        6. minFps - the minimum frame rate for the video stream (passed to GUM)
73
+        7. maxFps - the maximum frame rate for the video stream (passed to GUM)
74
+        8. facingMode - facing mode for a camera (possible values - 'user', 'environment')
74 75
     - firePermissionPromptIsShownEvent - optional boolean parameter. If set to ```true```, ```JitsiMediaDevicesEvents.PERMISSION_PROMPT_IS_SHOWN``` will be fired when browser shows gUM permission prompt.
75 76
 
76 77
 * ```JitsiMeetJS.enumerateDevices(callback)``` - __DEPRECATED__. Use ```JitsiMeetJS.mediaDevices.enumerateDevices(callback)``` instead.
@@ -275,7 +276,10 @@ The object represents a conference. We have the following methods to control the
275 276
 10. setDisplayName(name) - changes the display name of the local participant.
276 277
     - name - the new display name
277 278
 
278
-11. selectParticipant(participantID) - Elects the participant with the given id to be the selected participant or the speaker. You should use that method if you are using simulcast.
279
+11. selectParticipant(participantId) - Elects the participant with the given id to be the selected participant in order to receive higher video quality (if simulcast is enabled).
280
+    - participantId - the identifier of the participant
281
+
282
+Throws NetworkError or InvalidStateError or Error if the operation fails.
279 283
 
280 284
 
281 285
 12. sendCommand(name, values) - sends user defined system command to the other participants
@@ -374,15 +378,13 @@ Throws NetworkError or InvalidStateError or Error if the operation fails.
374 378
 
375 379
 Throws NetworkError or InvalidStateError or Error if the operation fails.
376 380
 
377
-33. selectParticipant(participantId) - Elects the participant with the given id to be the selected participant in order to receive higher video quality (if simulcast is enabled).
381
+33. pinParticipant(participantId) - Elects the participant with the given id to be the pinned participant in order to always receive video for this participant (even when last n is enabled).
378 382
     - participantId - the identifier of the participant
379 383
 
380 384
 Throws NetworkError or InvalidStateError or Error if the operation fails.
381 385
 
382
-34. pinParticipant(participantId) - Elects the participant with the given id to be the pinned participant in order to always receive video for this participant (even when last n is enabled).
383
-    - participantId - the identifier of the participant
384
-
385
-Throws NetworkError or InvalidStateError or Error if the operation fails.
386
+34. setReceiverVideoConstraint(resolution) - set the desired resolution to get from JVB (180, 360, 720, 1080, etc).
387
+    You should use that method if you are using simulcast.
386 388
 
387 389
 JitsiTrack
388 390
 ======

Loading…
取消
儲存