Browse Source

fix(conference) Update JSDoc for JitsiConference:setReceiverConstraints()

master
Jaya Allamsetty 2 years ago
parent
commit
107e63d1ef
1 changed files with 6 additions and 6 deletions
  1. 6
    6
      JitsiConference.js

+ 6
- 6
JitsiConference.js View File

3761
 /**
3761
 /**
3762
  * Sets the constraints for the video that is requested from the bridge.
3762
  * Sets the constraints for the video that is requested from the bridge.
3763
  *
3763
  *
3764
- * @param {Object} videoConstraints The constraints which are specified in the
3765
- * following format. The message updates the fields that are present and leaves the
3766
- * rest unchanged on the bridge. Therefore, any field that is not applicable anymore
3767
- * should be cleared by passing an empty object or list (whatever is applicable).
3764
+ * @param {Object} videoConstraints The constraints which are specified in the following format. The message updates
3765
+ * the fields that are present and leaves the rest unchanged on the bridge. Therefore, any field that is not applicable
3766
+ * anymore should be cleared by passing an empty object or list (whatever is applicable).
3768
  * {
3767
  * {
3769
  *      'lastN': 20,
3768
  *      'lastN': 20,
3770
- *      'selectedEndpoints': ['A', 'B', 'C'],
3771
- *      'onStageEndpoints': ['A'],
3769
+ *      'selectedSources': ['A', 'B', 'C'],
3770
+ *      'onStageSources': ['A'],
3772
  *      'defaultConstraints': { 'maxHeight': 180 },
3771
  *      'defaultConstraints': { 'maxHeight': 180 },
3773
  *      'constraints': {
3772
  *      'constraints': {
3774
  *          'A': { 'maxHeight': 720 }
3773
  *          'A': { 'maxHeight': 720 }
3775
  *      }
3774
  *      }
3776
  * }
3775
  * }
3776
+ * Where A, B and C are source-names of the remote tracks that are being requested from the bridge.
3777
  */
3777
  */
3778
 JitsiConference.prototype.setReceiverConstraints = function(videoConstraints) {
3778
 JitsiConference.prototype.setReceiverConstraints = function(videoConstraints) {
3779
     this.receiveVideoController.setReceiverConstraints(videoConstraints);
3779
     this.receiveVideoController.setReceiverConstraints(videoConstraints);

Loading…
Cancel
Save