"Fossies" - the Fresh Open Source Software Archive 
Member "jitsi-meet-7305/react/features/base/participants/actionTypes.ts" (26 May 2023, 5696 Bytes) of package /linux/misc/jitsi-meet-7305.tar.gz:
As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TypeScript source code syntax highlighting (style:
standard) with prefixed line numbers and
code folding option.
Alternatively you can here
view or
download the uninterpreted source code file.
See also the last
Fossies "Diffs" side-by-side code changes report for "actionTypes.ts":
jitsi-meet_8319_vs_jitsi-meet_8615.
1 /**
2 * Create an action for when dominant speaker changes.
3 *
4 * {
5 * type: DOMINANT_SPEAKER_CHANGED,
6 * participant: {
7 * conference: JitsiConference,
8 * id: string,
9 * previousSpeakers: Array<string>,
10 * silence: boolean
11 * }
12 * }
13 */
14 export const DOMINANT_SPEAKER_CHANGED = 'DOMINANT_SPEAKER_CHANGED';
15
16 /**
17 * Create an action for granting moderator to a participant.
18 *
19 * {
20 * type: GRANT_MODERATOR,
21 * id: string
22 * }
23 */
24 export const GRANT_MODERATOR = 'GRANT_MODERATOR';
25
26 /**
27 * Create an action for removing a participant from the conference.
28 *
29 * {
30 * type: KICK_PARTICIPANT,
31 * id: string
32 * }
33 */
34 export const KICK_PARTICIPANT = 'KICK_PARTICIPANT';
35
36 /**
37 * Create an action for muting a remote participant.
38 *
39 * {
40 * type: MUTE_REMOTE_PARTICIPANT,
41 * id: string
42 * }
43 */
44 export const MUTE_REMOTE_PARTICIPANT = 'MUTE_REMOTE_PARTICIPANT';
45
46 /**
47 * Create an action for when the local participant's display name is updated.
48 *
49 * {
50 * type: PARTICIPANT_DISPLAY_NAME_CHANGED,
51 * id: string,
52 * name: string
53 * }
54 */
55 export const PARTICIPANT_DISPLAY_NAME_CHANGED
56 = 'PARTICIPANT_DISPLAY_NAME_CHANGED';
57
58 /**
59 * Action to signal that ID of participant has changed. This happens when
60 * local participant joins a new conference or quits one.
61 *
62 * {
63 * type: PARTICIPANT_ID_CHANGED,
64 * conference: JitsiConference
65 * newValue: string,
66 * oldValue: string
67 * }
68 */
69 export const PARTICIPANT_ID_CHANGED = 'PARTICIPANT_ID_CHANGED';
70
71 /**
72 * Action to signal that participant role has changed. e.
73 *
74 * {
75 * type: PARTICIPANT_ROLE_CHANGED,
76 * participant: {
77 * id: string
78 * }
79 * role: string
80 * }
81 */
82 export const PARTICIPANT_ROLE_CHANGED = 'PARTICIPANT_ROLE_CHANGED';
83
84 /**
85 * Action to signal that a participant has joined.
86 *
87 * {
88 * type: PARTICIPANT_JOINED,
89 * participant: Participant
90 * }
91 */
92 export const PARTICIPANT_JOINED = 'PARTICIPANT_JOINED';
93
94 /**
95 * Action to signal that a participant has been removed from a conference by
96 * another participant.
97 *
98 * {
99 * type: PARTICIPANT_KICKED,
100 * kicked: Object,
101 * kicker: Object
102 * }
103 */
104 export const PARTICIPANT_KICKED = 'PARTICIPANT_KICKED';
105
106 /**
107 * Action to handle case when participant lefts.
108 *
109 * {
110 * type: PARTICIPANT_LEFT,
111 * participant: {
112 * id: string
113 * }
114 * }
115 */
116 export const PARTICIPANT_LEFT = 'PARTICIPANT_LEFT';
117
118 /**
119 * Action to handle case when the sources attached to a participant are updated.
120 *
121 * {
122 * type: PARTICIPANT_SOURCES_UPDATED,
123 * participant: {
124 * id: string
125 * }
126 * }
127 */
128 export const PARTICIPANT_SOURCES_UPDATED = 'PARTICIPANT_SOURCES_UPDATED';
129
130 /**
131 * Action to handle case when info about participant changes.
132 *
133 * {
134 * type: PARTICIPANT_UPDATED,
135 * participant: Participant
136 * }
137 */
138 export const PARTICIPANT_UPDATED = 'PARTICIPANT_UPDATED';
139
140 /**
141 * The type of the Redux action which pins a conference participant.
142 *
143 * {
144 * type: PIN_PARTICIPANT,
145 * participant: {
146 * id: string
147 * }
148 * }
149 */
150 export const PIN_PARTICIPANT = 'PIN_PARTICIPANT';
151
152 /**
153 * Action to signal that a hidden participant has joined.
154 *
155 * {
156 * type: HIDDEN_PARTICIPANT_JOINED,
157 * participant: Participant
158 * }
159 */
160 export const HIDDEN_PARTICIPANT_JOINED = 'HIDDEN_PARTICIPANT_JOINED';
161
162 /**
163 * Action to handle case when hidden participant leaves.
164 *
165 * {
166 * type: PARTICIPANT_LEFT,
167 * participant: {
168 * id: string
169 * }
170 * }
171 */
172 export const HIDDEN_PARTICIPANT_LEFT = 'HIDDEN_PARTICIPANT_LEFT';
173
174 /**
175 * The type of Redux action which notifies the app that the loadable avatar URL has changed.
176 *
177 * {
178 * type: SET_LOADABLE_AVATAR_URL,
179 * participant: {
180 * id: string,
181 loadableAvatarUrl: string
182 * }
183 * }
184 */
185 export const SET_LOADABLE_AVATAR_URL = 'SET_LOADABLE_AVATAR_URL';
186
187 /**
188 * The type of Redux action which notifies that the screenshare participant's display name has changed.
189 *
190 * {
191 * type: SCREENSHARE_PARTICIPANT_NAME_CHANGED,
192 * id: string,
193 * name: string
194 * }
195 */
196 export const SCREENSHARE_PARTICIPANT_NAME_CHANGED = 'SCREENSHARE_PARTICIPANT_NAME_CHANGED';
197
198 /**
199 * Raises hand for the local participant.
200 * {
201 * type: LOCAL_PARTICIPANT_RAISE_HAND
202 * }
203 */
204 export const LOCAL_PARTICIPANT_RAISE_HAND = 'LOCAL_PARTICIPANT_RAISE_HAND';
205
206 /**
207 * Updates participant in raise hand queue.
208 * {
209 * type: RAISE_HAND_UPDATED,
210 * participant: {
211 * id: string,
212 * raiseHand: boolean
213 * }
214 * }
215 */
216 export const RAISE_HAND_UPDATED = 'RAISE_HAND_UPDATED';
217
218 /**
219 * The type of Redux action which notifies that the local participant has changed the audio levels.
220 * {
221 * type: LOCAL_PARTICIPANT_AUDIO_LEVEL_CHANGED
222 * level: number
223 * }
224 */
225 export const LOCAL_PARTICIPANT_AUDIO_LEVEL_CHANGED = 'LOCAL_PARTICIPANT_AUDIO_LEVEL_CHANGED'
226
227 /**
228 * The type of Redux action which overwrites the name of a participant.
229 * {
230 * type: OVERWRITE_PARTICIPANT_NAME,
231 * id: string,
232 * name: string
233 * }
234 */
235 export const OVERWRITE_PARTICIPANT_NAME = 'OVERWRITE_PARTICIPANT_NAME';
236
237 /**
238 * The type of Redux action which overwrites the names of multiple participants.
239 * {
240 * type: OVERWRITE_PARTICIPANTS_NAMES,
241 * participantsList: Array<Object>,
242 * }
243 */
244 export const OVERWRITE_PARTICIPANTS_NAMES = 'OVERWRITE_PARTICIPANTS_NAMES';
245
246 /**
247 * Updates participants local recording status.
248 * {
249 * type: SET_LOCAL_PARTICIPANT_RECORDING_STATUS,
250 * recording: boolean,
251 * onlySelf: boolean
252 * }
253 */
254 export const SET_LOCAL_PARTICIPANT_RECORDING_STATUS = 'SET_LOCAL_PARTICIPANT_RECORDING_STATUS';