Quellcode durchsuchen

ref(RTCEvents) Fix comments

dev0
Jaya Allamsetty vor 6 Monaten
Ursprung
Commit
0a3ce2be7e
1 geänderte Dateien mit 38 neuen und 13 gelöschten Zeilen
  1. 38
    13
      service/RTC/RTCEvents.ts

+ 38
- 13
service/RTC/RTCEvents.ts Datei anzeigen

1
 export enum RTCEvents {
1
 export enum RTCEvents {
2
-
2
+    /**
3
+     * Designates an event indicating that the audio output device has changed.
4
+     */
3
     AUDIO_OUTPUT_DEVICE_CHANGED = 'rtc.audio_output_device_changed',
5
     AUDIO_OUTPUT_DEVICE_CHANGED = 'rtc.audio_output_device_changed',
4
 
6
 
5
     /**
7
     /**
6
-     * Designates an event indicating that some received audio SSRCs will now map to
7
-     * new remote sources.
8
+     * Designates an event indicating that some audio SSRCs that have already been signaled will now map to new remote
9
+     * sources.
8
      */
10
      */
9
     AUDIO_SSRCS_REMAPPED = 'rtc.audio_ssrcs_remapped',
11
     AUDIO_SSRCS_REMAPPED = 'rtc.audio_ssrcs_remapped',
10
 
12
 
17
      * Indicates error while create offer call.
19
      * Indicates error while create offer call.
18
      */
20
      */
19
     CREATE_OFFER_FAILED = 'rtc.create_offer_failed',
21
     CREATE_OFFER_FAILED = 'rtc.create_offer_failed',
22
+
23
+    /**
24
+     * Indicates that the data channel has been closed.
25
+     */
20
     DATA_CHANNEL_CLOSED = 'rtc.data_channel_closed',
26
     DATA_CHANNEL_CLOSED = 'rtc.data_channel_closed',
27
+
28
+    /**
29
+     * Indicates that the data channel has been opened.
30
+     */
21
     DATA_CHANNEL_OPEN = 'rtc.data_channel_open',
31
     DATA_CHANNEL_OPEN = 'rtc.data_channel_open',
32
+
33
+    /**
34
+     * Indicates that the list with available devices is now available.
35
+     */
22
     DEVICE_LIST_AVAILABLE = 'rtc.device_list_available',
36
     DEVICE_LIST_AVAILABLE = 'rtc.device_list_available',
23
 
37
 
38
+    /**
39
+     * Indicates that the list with available devices has changed.
40
+     */
24
     DEVICE_LIST_CHANGED = 'rtc.device_list_changed',
41
     DEVICE_LIST_CHANGED = 'rtc.device_list_changed',
25
 
42
 
26
     /**
43
     /**
28
      */
45
      */
29
     DEVICE_LIST_WILL_CHANGE = 'rtc.device_list_will_change',
46
     DEVICE_LIST_WILL_CHANGE = 'rtc.device_list_will_change',
30
 
47
 
48
+    /**
49
+     * Indicates that the dominant speaker has changed.
50
+     */
31
     DOMINANT_SPEAKER_CHANGED = 'rtc.dominant_speaker_changed',
51
     DOMINANT_SPEAKER_CHANGED = 'rtc.dominant_speaker_changed',
32
 
52
 
53
+    /**
54
+     * Indicates that the connection status of the endpoint has changed.
55
+     */
33
     ENDPOINT_CONN_STATUS_CHANGED = 'rtc.endpoint_conn_status_changed',
56
     ENDPOINT_CONN_STATUS_CHANGED = 'rtc.endpoint_conn_status_changed',
34
 
57
 
35
     /**
58
     /**
36
-     * Indicates that a message from another participant is received on
37
-     * data channel.
59
+     * Indicates that a message from another participant is received on data channel.
38
      */
60
      */
39
     ENDPOINT_MESSAGE_RECEIVED = 'rtc.endpoint_message_received',
61
     ENDPOINT_MESSAGE_RECEIVED = 'rtc.endpoint_message_received',
40
 
62
 
43
      */
65
      */
44
     ENDPOINT_STATS_RECEIVED = 'rtc.endpoint_stats_received',
66
     ENDPOINT_STATS_RECEIVED = 'rtc.endpoint_stats_received',
45
 
67
 
68
+    /**
69
+     * Indicates that the list of sources currently being forwarded by the bridge has changed.
70
+     */
46
     FORWARDED_SOURCES_CHANGED = 'rtc.forwarded_sources_changed',
71
     FORWARDED_SOURCES_CHANGED = 'rtc.forwarded_sources_changed',
47
 
72
 
48
     /**
73
     /**
49
-     * Event emitted when {@link RTC.setLastN} method is called to update with
50
-     * the new value set.
74
+     * Event emitted when {@link RTC.setLastN} method is called to update with the new value set.
51
      * The first argument is the value passed to {@link RTC.setLastN}.
75
      * The first argument is the value passed to {@link RTC.setLastN}.
52
      */
76
      */
53
     LASTN_VALUE_CHANGED = 'rtc.lastn_value_changed',
77
     LASTN_VALUE_CHANGED = 'rtc.lastn_value_changed',
94
     REMOTE_TRACK_UNMUTE = 'rtc.remote_track_unmute',
118
     REMOTE_TRACK_UNMUTE = 'rtc.remote_track_unmute',
95
 
119
 
96
     /**
120
     /**
97
-     * Designates an event indicating that the local ICE username fragment of
98
-     * the jingle session has changed.
99
-     * The first argument of the vent is <tt>TraceablePeerConnection</tt> which
100
-     * is the source of the event.
121
+     * Designates an event indicating that the local ICE username fragment of the jingle session has changed.
122
+     * 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.
123
      * The second argument is the actual "ufrag" string.
102
      */
124
      */
103
     REMOTE_UFRAG_CHANGED = 'rtc.remote_ufrag_changed',
125
     REMOTE_UFRAG_CHANGED = 'rtc.remote_ufrag_changed',
104
 
126
 
127
+    /**
128
+     * Indicates that sender constraints requested by the bridge for this endpoint have changed.
129
+     */
105
     SENDER_VIDEO_CONSTRAINTS_CHANGED = 'rtc.sender_video_constraints_changed',
130
     SENDER_VIDEO_CONSTRAINTS_CHANGED = 'rtc.sender_video_constraints_changed',
106
 
131
 
107
     /**
132
     /**
115
     SET_REMOTE_DESCRIPTION_FAILED = 'rtc.set_remote_description_failed',
140
     SET_REMOTE_DESCRIPTION_FAILED = 'rtc.set_remote_description_failed',
116
 
141
 
117
     /**
142
     /**
118
-     * Designates an event indicating that some received video SSRCs will now map to
119
-     * new remote sources.
143
+     * Designates an event indicating that some video SSRCs that have already been signaled will now map to new remote
144
+     * sources.
120
      */
145
      */
121
     VIDEO_SSRCS_REMAPPED = 'rtc.video_ssrcs_remapped'
146
     VIDEO_SSRCS_REMAPPED = 'rtc.video_ssrcs_remapped'
122
 }
147
 }

Laden…
Abbrechen
Speichern