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.

RTCEvents.ts 7.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. export enum RTCEvents {
  2. /**
  3. * Designates an event indicating that the audio output device has changed.
  4. */
  5. AUDIO_OUTPUT_DEVICE_CHANGED = 'rtc.audio_output_device_changed',
  6. /**
  7. * Designates an event indicating that some audio SSRCs that have already been signaled will now map to new remote
  8. * sources.
  9. */
  10. AUDIO_SSRCS_REMAPPED = 'rtc.audio_ssrcs_remapped',
  11. /**
  12. * Indicates error while create answer call.
  13. */
  14. CREATE_ANSWER_FAILED = 'rtc.create_answer_failed',
  15. /**
  16. * Indicates error while create offer call.
  17. */
  18. CREATE_OFFER_FAILED = 'rtc.create_offer_failed',
  19. /**
  20. * Indicates that the data channel has been closed.
  21. */
  22. DATA_CHANNEL_CLOSED = 'rtc.data_channel_closed',
  23. /**
  24. * Indicates that the data channel has been opened.
  25. */
  26. DATA_CHANNEL_OPEN = 'rtc.data_channel_open',
  27. /**
  28. * Indicates that the list with available devices is now available.
  29. */
  30. DEVICE_LIST_AVAILABLE = 'rtc.device_list_available',
  31. /**
  32. * Indicates that the list with available devices has changed.
  33. */
  34. DEVICE_LIST_CHANGED = 'rtc.device_list_changed',
  35. /**
  36. * Indicates that the list with available devices will change.
  37. */
  38. DEVICE_LIST_WILL_CHANGE = 'rtc.device_list_will_change',
  39. /**
  40. * Indicates that the dominant speaker has changed.
  41. */
  42. DOMINANT_SPEAKER_CHANGED = 'rtc.dominant_speaker_changed',
  43. /**
  44. * Indicates that the connection status of the endpoint has changed.
  45. */
  46. ENDPOINT_CONN_STATUS_CHANGED = 'rtc.endpoint_conn_status_changed',
  47. /**
  48. * Indicates that a message from another participant is received on data channel.
  49. */
  50. ENDPOINT_MESSAGE_RECEIVED = 'rtc.endpoint_message_received',
  51. /**
  52. * Indicates that the remote endpoint stats have been received on data channel.
  53. */
  54. ENDPOINT_STATS_RECEIVED = 'rtc.endpoint_stats_received',
  55. /**
  56. * Indicates that the list of sources currently being forwarded by the bridge has changed.
  57. */
  58. FORWARDED_SOURCES_CHANGED = 'rtc.forwarded_sources_changed',
  59. /**
  60. * Event emitted when {@link RTC.setLastN} method is called to update with the new value set.
  61. * The first argument is the value passed to {@link RTC.setLastN}.
  62. */
  63. LASTN_VALUE_CHANGED = 'rtc.lastn_value_changed',
  64. /**
  65. * The max enabled resolution of a local video track was changed.
  66. */
  67. LOCAL_TRACK_MAX_ENABLED_RESOLUTION_CHANGED = 'rtc.local_track_max_enabled_resolution_changed',
  68. /**
  69. * Designates an event indicating that the local ICE username fragment of
  70. * the jingle session has changed.
  71. * The first argument of the vent is <tt>TraceablePeerConnection</tt> which
  72. * is the source of the event.
  73. * The second argument is the actual "ufrag" string.
  74. */
  75. LOCAL_UFRAG_CHANGED = 'rtc.local_ufrag_changed',
  76. /**
  77. * Event emitted when the user granted/blocked a permission for the camera / mic.
  78. * Used to keep track of the granted permissions on browsers which don't
  79. * support the Permissions API.
  80. */
  81. PERMISSIONS_CHANGED = 'rtc.permissions_changed',
  82. /**
  83. * Event fired when we remote track is added to the conference.
  84. * 1st event argument is the added <tt>JitsiRemoteTrack</tt> instance.
  85. **/
  86. REMOTE_TRACK_ADDED = 'rtc.remote_track_added',
  87. // FIXME get rid of this event in favour of NO_DATA_FROM_SOURCE event
  88. // (currently implemented for local tracks only)
  89. REMOTE_TRACK_MUTE = 'rtc.remote_track_mute',
  90. /**
  91. * Indicates that the remote track has been removed from the conference.
  92. * 1st event argument is the removed {@link JitsiRemoteTrack} instance.
  93. */
  94. REMOTE_TRACK_REMOVED = 'rtc.remote_track_removed',
  95. // FIXME get rid of this event in favour of NO_DATA_FROM_SOURCE event
  96. // (currently implemented for local tracks only)
  97. REMOTE_TRACK_UNMUTE = 'rtc.remote_track_unmute',
  98. /**
  99. * Designates an event indicating that the local ICE username fragment of the jingle session has changed.
  100. * The first argument of the vent is <tt>TraceablePeerConnection</tt> which is the source of the event.
  101. * The second argument is the actual "ufrag" string.
  102. */
  103. REMOTE_UFRAG_CHANGED = 'rtc.remote_ufrag_changed',
  104. /**
  105. * Indicates that sender constraints requested by the bridge for this endpoint have changed.
  106. */
  107. SENDER_VIDEO_CONSTRAINTS_CHANGED = 'rtc.sender_video_constraints_changed',
  108. /**
  109. * Indicates error while set local description.
  110. */
  111. SET_LOCAL_DESCRIPTION_FAILED = 'rtc.set_local_description_failed',
  112. /**
  113. * Indicates error while set remote description.
  114. */
  115. SET_REMOTE_DESCRIPTION_FAILED = 'rtc.set_remote_description_failed',
  116. /**
  117. * Designates an event indicating that some video SSRCs that have already been signaled will now map to new remote
  118. * sources.
  119. */
  120. VIDEO_SSRCS_REMAPPED = 'rtc.video_ssrcs_remapped'
  121. }
  122. export const CREATE_ANSWER_FAILED = RTCEvents.CREATE_ANSWER_FAILED;
  123. export const CREATE_OFFER_FAILED = RTCEvents.CREATE_OFFER_FAILED;
  124. export const DATA_CHANNEL_OPEN = RTCEvents.DATA_CHANNEL_OPEN;
  125. export const DATA_CHANNEL_CLOSED = RTCEvents.DATA_CHANNEL_CLOSED;
  126. export const ENDPOINT_CONN_STATUS_CHANGED = RTCEvents.ENDPOINT_CONN_STATUS_CHANGED;
  127. export const DOMINANT_SPEAKER_CHANGED = RTCEvents.DOMINANT_SPEAKER_CHANGED;
  128. export const FORWARDED_SOURCES_CHANGED = RTCEvents.FORWARDED_SOURCES_CHANGED;
  129. export const PERMISSIONS_CHANGED = RTCEvents.PERMISSIONS_CHANGED;
  130. export const SENDER_VIDEO_CONSTRAINTS_CHANGED = RTCEvents.SENDER_VIDEO_CONSTRAINTS_CHANGED;
  131. export const LASTN_VALUE_CHANGED = RTCEvents.LASTN_VALUE_CHANGED;
  132. export const LOCAL_TRACK_MAX_ENABLED_RESOLUTION_CHANGED = RTCEvents.LOCAL_TRACK_MAX_ENABLED_RESOLUTION_CHANGED;
  133. export const REMOTE_TRACK_ADDED = RTCEvents.REMOTE_TRACK_ADDED;
  134. export const REMOTE_TRACK_MUTE = RTCEvents.REMOTE_TRACK_MUTE;
  135. export const REMOTE_TRACK_REMOVED = RTCEvents.REMOTE_TRACK_REMOVED;
  136. export const REMOTE_TRACK_UNMUTE = RTCEvents.REMOTE_TRACK_UNMUTE;
  137. export const SET_LOCAL_DESCRIPTION_FAILED = RTCEvents.SET_LOCAL_DESCRIPTION_FAILED;
  138. export const SET_REMOTE_DESCRIPTION_FAILED = RTCEvents.SET_REMOTE_DESCRIPTION_FAILED;
  139. export const AUDIO_OUTPUT_DEVICE_CHANGED = RTCEvents.AUDIO_OUTPUT_DEVICE_CHANGED;
  140. export const DEVICE_LIST_CHANGED = RTCEvents.DEVICE_LIST_CHANGED;
  141. export const DEVICE_LIST_WILL_CHANGE = RTCEvents.DEVICE_LIST_WILL_CHANGE;
  142. export const DEVICE_LIST_AVAILABLE = RTCEvents.DEVICE_LIST_AVAILABLE;
  143. export const ENDPOINT_MESSAGE_RECEIVED = RTCEvents.ENDPOINT_MESSAGE_RECEIVED;
  144. export const ENDPOINT_STATS_RECEIVED = RTCEvents.ENDPOINT_STATS_RECEIVED;
  145. export const LOCAL_UFRAG_CHANGED = RTCEvents.LOCAL_UFRAG_CHANGED;
  146. export const REMOTE_UFRAG_CHANGED = RTCEvents.REMOTE_UFRAG_CHANGED;
  147. export const VIDEO_SSRCS_REMAPPED = RTCEvents.VIDEO_SSRCS_REMAPPED;
  148. export const AUDIO_SSRCS_REMAPPED = RTCEvents.AUDIO_SSRCS_REMAPPED;
  149. // TODO: this was a pre-ES6 module using module.exports = RTCEvents which doesn't translate well
  150. // it is used in a number of places and should be updated to use the named export
  151. export default RTCEvents;