You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

JitsiParticipant.js 2.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /**
  2. * Represents a participant in (a member of) a conference.
  3. */
  4. function JitsiParticipant(id, conference, displayName){
  5. this._id = id;
  6. this._conference = conference;
  7. this._displayName = displayName;
  8. }
  9. /**
  10. * @returns {JitsiConference} The conference that this participant belongs to.
  11. */
  12. JitsiParticipant.prototype.getConference = function() {
  13. return this._conference;
  14. }
  15. /**
  16. * @returns {Array.<JitsiTrack>} The list of media tracks for this participant.
  17. */
  18. JitsiParticipant.prototype.getTracks = function() {
  19. }
  20. /**
  21. * @returns {String} The ID (i.e. JID) of this participant.
  22. */
  23. JitsiParticipant.prototype.getId = function() {
  24. return this._id;
  25. }
  26. /**
  27. * @returns {String} The human-readable display name of this participant.
  28. */
  29. JitsiParticipant.prototype.getDisplayName = function() {
  30. return this._displayName;
  31. }
  32. /**
  33. * @returns {Boolean} Whether this participant is a moderator or not.
  34. */
  35. JitsiParticipant.prototype.isModerator = function() {
  36. }
  37. // Gets a link to an etherpad instance advertised by the participant?
  38. //JitsiParticipant.prototype.getEtherpad = function() {
  39. //
  40. //}
  41. /*
  42. * @returns {Boolean} Whether this participant has muted their audio.
  43. */
  44. JitsiParticipant.prototype.isAudioMuted = function() {
  45. }
  46. /*
  47. * @returns {Boolean} Whether this participant has muted their video.
  48. */
  49. JitsiParticipant.prototype.isVideoMuted = function() {
  50. }
  51. /*
  52. * @returns {???} The latest statistics reported by this participant (i.e. info used to populate the GSM bars)
  53. * TODO: do we expose this or handle it internally?
  54. */
  55. JitsiParticipant.prototype.getLatestStats = function() {
  56. }
  57. /**
  58. * @returns {String} The role of this participant.
  59. */
  60. JitsiParticipant.prototype.getRole = function() {
  61. }
  62. /*
  63. * @returns {Boolean} Whether this participant is the conference focus (i.e. jicofo).
  64. */
  65. JitsiParticipant.prototype.isFocus = function() {
  66. }
  67. /*
  68. * @returns {Boolean} Whether this participant is a conference recorder (i.e. jirecon).
  69. */
  70. JitsiParticipant.prototype.isRecorder = function() {
  71. }
  72. /*
  73. * @returns {Boolean} Whether this participant is a SIP gateway (i.e. jigasi).
  74. */
  75. JitsiParticipant.prototype.isSipGateway = function() {
  76. }
  77. /**
  78. * @returns {String} The ID for this participant's avatar.
  79. */
  80. JitsiParticipant.prototype.getAvatarId = function() {
  81. }
  82. /**
  83. * @returns {Boolean} Whether this participant is currently sharing their screen.
  84. */
  85. JitsiParticipant.prototype.isScreenSharing = function() {
  86. }
  87. /**
  88. * @returns {String} The user agent of this participant (i.e. browser userAgent string).
  89. */
  90. JitsiParticipant.prototype.getUserAgent = function() {
  91. }
  92. /**
  93. * Kicks the participant from the conference (requires certain privileges).
  94. */
  95. JitsiParticipant.prototype.kick = function() {
  96. }
  97. /**
  98. * Asks this participant to mute themselves.
  99. */
  100. JitsiParticipant.prototype.askToMute = function() {
  101. }
  102. module.exports = JitsiParticipant();