@cometchat/calls-sdk-javascript 4.0.10 → 4.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/pack/index.js +1 -1
  2. package/pack/index.js.LICENSE.txt +1 -0
  3. package/pack/src/Helper.d.ts +5 -5
  4. package/pack/src/api/APIHandler.d.ts +39 -39
  5. package/pack/src/api/endpoints.d.ts +7 -7
  6. package/pack/src/api/helper.d.ts +69 -69
  7. package/pack/src/api/index.d.ts +2 -2
  8. package/pack/src/constants/CallConstants.d.ts +217 -217
  9. package/pack/src/constants/index.d.ts +1 -1
  10. package/pack/src/defaultCallsettings.d.ts +2 -2
  11. package/pack/src/index.d.ts +7 -7
  12. package/pack/src/models/CallGroup.d.ts +14 -14
  13. package/pack/src/models/CallLog.d.ts +276 -276
  14. package/pack/src/models/CallSettings.d.ts +382 -382
  15. package/pack/src/models/CallUser.d.ts +14 -14
  16. package/pack/src/models/CallsAppSettings.d.ts +41 -41
  17. package/pack/src/models/CometChatCallLogs.d.ts +189 -189
  18. package/pack/src/models/CometChatCalls.d.ts +180 -180
  19. package/pack/src/models/CometChatCallsException.d.ts +8 -8
  20. package/pack/src/models/ErrorModel.d.ts +12 -12
  21. package/pack/src/models/Listener.d.ts +86 -86
  22. package/pack/src/models/ListnerHandler.d.ts +10 -10
  23. package/pack/src/models/Participant.d.ts +184 -184
  24. package/pack/src/models/PresenterSettings.d.ts +265 -265
  25. package/pack/src/models/RTCUser.d.ts +18 -18
  26. package/pack/src/models/Recording.d.ts +86 -86
  27. package/pack/src/models/index.d.ts +10 -10
  28. package/pack/src/types/ICallSettings.d.ts +61 -61
  29. package/pack/src/types/ICallsAppSettings.d.ts +6 -6
  30. package/pack/src/types/RTCUser.d.ts +6 -6
  31. package/pack/src/types/callEvents.d.ts +88 -88
  32. package/pack/src/types/common.d.ts +14 -14
  33. package/pack/src/types/index.d.ts +2 -2
  34. package/pack/src/util/parseJwt.d.ts +1 -1
  35. package/pack/src/util/verifyCallSettings.d.ts +4 -4
  36. package/package.json +2 -2
@@ -1,382 +1,382 @@
1
- import { ICallsettings } from "../types";
2
- import { OngoingCallListener } from "./Listener";
3
- export declare class CallSettings {
4
- static POSITION_TOP_LEFT: string;
5
- static POSITION_TOP_RIGHT: string;
6
- static POSITION_BOTTOM_LEFT: string;
7
- static POSITION_BOTTOM_RIGHT: string;
8
- static POSITION: {
9
- readonly TOP_LEFT: "top-left";
10
- readonly TOP_RIGHT: "top-right";
11
- readonly BOTTOM_LEFT: "bottom-left";
12
- readonly BOTTOM_RIGHT: "bottom-right";
13
- };
14
- static ASPECT_RATIO_DEFAULT: string;
15
- static ASPECT_RATIO_CONTAIN: string;
16
- static ASPECT_RATIO_COVER: string;
17
- static ASPECT_RATIO: {
18
- readonly DEFAULT: "default";
19
- readonly CONTAIN: "contain";
20
- readonly COVER: "cover";
21
- };
22
- private defaultLayout;
23
- private isAudioOnly;
24
- private mode;
25
- private ShowEndCallButton;
26
- private ShowMuteAudioButton;
27
- private ShowPauseVideoButton;
28
- private ShowScreenShareButton;
29
- private ShowSwitchModeButton;
30
- private StartAudioMuted;
31
- private StartVideoMuted;
32
- private localizedObject;
33
- private analyticsSettings;
34
- private customCSS;
35
- private ShowRecordingButton;
36
- private StartRecordingOnCallStart;
37
- private callListener;
38
- private ShowSwitchToVideoCallButton;
39
- private VirtualBackground;
40
- private ShowVirtualBackgroundSetting;
41
- private MainVideoContainerSetting;
42
- constructor(builder?: CallSettingsBuilder);
43
- getCallListener(): OngoingCallListener;
44
- isRecordingButtonEnabled(): boolean;
45
- shouldStartRecordingOnCallStart(): boolean;
46
- getCustomCSS(): string;
47
- isAudioOnlyCall(): boolean;
48
- isDefaultLayoutEnabled(): boolean;
49
- getMode(): "DEFAULT" | "SPOTLIGHT" | "TILE";
50
- getStartWithAudioMuted(): boolean;
51
- getStartWithVideoMuted(): boolean;
52
- isEndCallButtonEnabled(): boolean;
53
- isMuteAudioButtonEnabled(): boolean;
54
- isPauseVideoButtonEnabled(): boolean;
55
- isScreenShareButtonEnabled(): boolean;
56
- isModeButtonEnabled(): boolean;
57
- getLocalizedStringObject(): Object;
58
- getAnalyticsSettings(): Object;
59
- isAudioToVideoButtonEnabled(): boolean;
60
- getVirtualBackground(): VirtualBackground;
61
- isVirtualBackgroundSettingEnabled(): boolean;
62
- getMainVideoContainerSetting(): MainVideoContainerSetting;
63
- }
64
- export declare class CallSettingsBuilder {
65
- /** @private */ defaultLayout: boolean;
66
- /** @private */ isAudioOnly: boolean;
67
- /** @private */ mode: ICallsettings["mode"];
68
- /** @private */ ShowEndCallButton: boolean;
69
- /** @private */ ShowMuteAudioButton: boolean;
70
- /** @private */ ShowPauseVideoButton: boolean;
71
- /** @private */ ShowScreenShareButton: boolean;
72
- /** @private */ ShowSwitchModeButton: boolean;
73
- /** @private */ StartAudioMuted: boolean;
74
- /** @private */ StartVideoMuted: boolean;
75
- /** @private */ localizedObject: Object;
76
- /** @private */ analyticsSettings: Object;
77
- /** @private */ customCSS: string;
78
- /** @private */ ShowRecordingButton: boolean;
79
- /** @private */ StartRecordingOnCallStart: boolean;
80
- /** @private */ ShowSwitchToVideoCallButton: boolean;
81
- /** @private */ virtualBackground: VirtualBackground;
82
- /** @private */ ShowVirtualBackgroundSetting: boolean;
83
- /** @private */ MainVideoContainerSetting: MainVideoContainerSetting;
84
- /** @private */ callListener: OngoingCallListener;
85
- /**
86
- *
87
- * @param {boolean} defaultLayout
88
- * This methods shows/hides the default button layout.
89
- * If set to true the default button layout will be shown.
90
- * If set to false the default button layout will be hidden.
91
- * Default value is true
92
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
93
- */
94
- enableDefaultLayout(defaultLayout: boolean): this;
95
- /**
96
- *
97
- * @param {boolean} isAudioOnly
98
- * This methods sets the type(audio/video) of the call.
99
- * If set to true, the call will be strictly an audio call.
100
- * If set to false, the call will be an audio-video call.
101
- * Default value is false
102
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
103
- */
104
- setIsAudioOnlyCall(isAudioOnly: boolean): this;
105
- /**
106
- *
107
- * @param {string} mode
108
- * This method sets the mode of the call.
109
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
110
- */
111
- setMode(mode: ICallsettings["mode"]): this;
112
- /**
113
- *
114
- * @param {boolean} showEndCallButton
115
- * This method shows/hides the end call button.
116
- * If set to true it will display the end call button.
117
- * If set to false it will hide the end call button.
118
- * Default value is true.
119
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
120
- */
121
- showEndCallButton(showEndCallButton: boolean): this;
122
- /**
123
- *
124
- * @param {boolean} showMuteAudioButton
125
- * This method shows/hides the mute audio button.
126
- * If set to true it will display the mute audio button.
127
- * If set to false it will hide the mute audio button.
128
- * Default value is true.
129
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
130
- */
131
- showMuteAudioButton(showMuteAudioButton: boolean): this;
132
- /**
133
- *
134
- * @param {boolean} showPauseVideoButton
135
- * This method shows/hides the pause video button.
136
- * If set to true it will display the pause video button.
137
- * If set to false it will hide the pause video button.
138
- * Default value is true.
139
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
140
- */
141
- showPauseVideoButton(showPauseVideoButton: boolean): this;
142
- /**
143
- *
144
- * @param {boolean} showScreenShareButton
145
- * This method shows/hides the screen share button.
146
- * If set to true it will display the screen share button.
147
- * If set to false it will hide the screen share button.
148
- * Default value is true.
149
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
150
- */
151
- showScreenShareButton(showScreenShareButton: boolean): this;
152
- /**
153
- *
154
- * @param {boolean} showModeButton
155
- * This method shows/hides the switch mode button.
156
- * If set to true it will display the switch mode button.
157
- * If set to false it will hide the switch mode button.
158
- * Default value is true.
159
- * @returns
160
- */
161
- showModeButton(showModeButton: boolean): this;
162
- /**
163
- *
164
- * @param {Object} localizedStringObject
165
- * This method will set the localized text in the call screen.
166
- * @returns
167
- */
168
- setLocalizedStringObject(localizedStringObject: Object): this;
169
- /**
170
- * @private
171
- * @param {Object} analyticsSettings
172
- * This method will set the settings required for analytics.
173
- * @returns
174
- */
175
- setAnalyticsSettings(analyticsSettings: Object): this;
176
- /**
177
- *
178
- * @param {boolean} audioMuted
179
- * This method allows the call to be started with audio muted.
180
- * If set to true, the call will start with audio muted.
181
- * Default value is false.
182
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
183
- */
184
- startWithAudioMuted(audioMuted: boolean): this;
185
- /**
186
- *
187
- * @param {boolean} videoMuted
188
- * This method allows the call to be started with video muted.
189
- * If set to true, the call will start with video muted.
190
- * Default value is false.
191
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
192
- */
193
- startWithVideoMuted(videoMuted: boolean): this;
194
- /**
195
- *
196
- * @param {boolean} showRecordingButton
197
- * This method shows/hides the recording button.
198
- * If set to true it will display the recording button.
199
- * If set to false it will hide the recording button.
200
- * Default value is false.
201
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
202
- */
203
- showRecordingButton(showRecordingButton: boolean): this;
204
- /**
205
- *
206
- * @param {boolean} startRecordingOnCallStart
207
- * This method starts the recording as soon as the call start.
208
- * If set to true it will start the recording as soon as the call start.
209
- * Default value is false.
210
- * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
211
- */
212
- startRecordingOnCallStart(startRecordingOnCallStart: boolean): this;
213
- /**
214
- *
215
- * @param {boolean} showAudioToVideoSwitchButton
216
- * This method shows/hides the switch to video call button.
217
- * If set to true it will display the switch to video call button.
218
- * If set to false it will hide the switch to video call button.
219
- * Default value is true.
220
- * @returns
221
- */
222
- showSwitchToVideoCallButton(showAudioToVideoSwitchButton: boolean): this;
223
- /**
224
- *
225
- * @param {VirtualBackground} virtualBackground
226
- * This method will set the virtual background setting.
227
- * This methods takes an Object of VirtualBackground Class.
228
- * @returns
229
- */
230
- setVirtualBackground(virtualBackground: VirtualBackground): this;
231
- /**
232
- *
233
- * @param {boolean} showVirtualBackgroundSetting
234
- * This method shows/hides the virtual background setting button.
235
- * If set to true it will display the virtual background setting button.
236
- * If set to false it will hide the virtual background setting button.
237
- * Default value is true.
238
- * @returns
239
- */
240
- showVirtualBackgroundSetting(showVirtualBackgroundSetting: boolean): this;
241
- /**
242
- *
243
- * @param {MainVideoContainerSetting} mainVideoContainerSetting
244
- * This method can be used to customize the main video container.
245
- * @returns
246
- */
247
- setMainVideoContainerSetting(mainVideoContainerSetting: MainVideoContainerSetting): this;
248
- /**
249
- *
250
- * @param {OngoingCallListener} callListener
251
- * This method can be used to subscribe to available callings events
252
- * @returns
253
- */
254
- setCallListener(callListener: OngoingCallListener): this;
255
- /**
256
- * This method will return an object of the CallSettings class.
257
- * @returns {CallSettings} Returns the CallSettings instance
258
- */
259
- build(): CallSettings;
260
- }
261
- export declare class VirtualBackground {
262
- private AllowBackgroundBlur;
263
- private AllowUserImages;
264
- private ShowDefaultImages;
265
- private SetImages;
266
- private EnforceBackgroundBlur;
267
- private EnforceBackgroundImage;
268
- constructor(builder?: VirtualBackgroundBuilder);
269
- shouldAllowBackgroundBlur(): boolean;
270
- shouldAllowUserImages(): boolean;
271
- shouldShowDefaultImages(): boolean;
272
- getImages(): Array<String>;
273
- isBackgroundBlurEnforced(): number;
274
- getEnforcedBackgroundImage(): string;
275
- }
276
- export declare class VirtualBackgroundBuilder {
277
- /** @private */ AllowBackgroundBlur: boolean;
278
- /** @private */ AllowUserImages: boolean;
279
- /** @private */ ShowDefaultImages: boolean;
280
- /** @private */ SetImages: string[];
281
- /** @private */ EnforceBackgroundBlur: number;
282
- /** @private */ EnforceBackgroundImage: string;
283
- /**
284
- *
285
- * @param {boolean} AllowBackgroundBlur
286
- * This method will show the background blur option in Virtual Background.
287
- * If set to true it will show the background blur option.
288
- * Default value is true.
289
- * @returns
290
- */
291
- allowBackgroundBlur(AllowBackgroundBlur: boolean): this;
292
- /**
293
- *
294
- * @param {boolean} AllowUserImage
295
- * This method will allow the user to add custom images as background.
296
- * If set to true it will allow the user to add custom images as background.
297
- * Default value is true.
298
- * @returns
299
- */
300
- allowUserImages(AllowUserImages: boolean): this;
301
- /**
302
- *
303
- * @param {boolean} ShowDefaultImages
304
- * This method will show the default images to be used as background.
305
- * If set to true it will show the default images to be used as background.
306
- * Default value is true.
307
- * @returns
308
- */
309
- showDefaultImages(ShowDefaultImages: boolean): this;
310
- /**
311
- *
312
- * @param {boolean} SetImages
313
- * This method will allow user to add custom Images to be used as background. It takes in an array of URLs.
314
- * @returns
315
- */
316
- setImages(SetImages: string[]): this;
317
- /**
318
- *
319
- * @param {number} EnforceBackgroundBlur
320
- * This method will enforce background blur.
321
- * This method takes number as input which decides the blur level of the background.
322
- * Default value is 0.
323
- * @returns
324
- */
325
- enforceBackgroundBlur(EnforceBackgroundBlur: number): this;
326
- /**
327
- *
328
- * @param {string} EnforceBackgroundImage
329
- * This method will enforce background image.
330
- * If an URL of the image is sent then that image will be set as background.
331
- * By default no image is set.
332
- * @returns
333
- */
334
- enforceBackgroundImage(EnforceBackgroundImage: string): this;
335
- /**
336
- * This method will return an object of the VirtualBackground class.
337
- * @returns {VirtualBackground}
338
- */
339
- build(): VirtualBackground;
340
- }
341
- export declare class MainVideoContainerSetting {
342
- private videoFit;
343
- private zoomButton;
344
- private nameLabel;
345
- private network;
346
- /**
347
- *
348
- * @param {string} mainVideoAspectRatio
349
- * This method is used to set the aspect ratio of main video.
350
- * The default value is `contain`
351
- * @returns
352
- */
353
- setMainVideoAspectRatio(mainVideoAspectRatio: typeof CallSettings.ASPECT_RATIO[keyof typeof CallSettings.ASPECT_RATIO]): void;
354
- /**
355
- *
356
- * @param {string} position
357
- * @param {boolean} visibility
358
- * This method is used to set the position & visibility parameter of the full screen button.
359
- * By default the full screen button is visible in the `bottom-right` position.
360
- * @returns
361
- */
362
- setFullScreenButtonParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean): void;
363
- /**
364
- *
365
- * @param {string} position
366
- * @param {boolean} visibility
367
- * @param {string} backgroundColor
368
- * This method is used to set the position, visibility & background color of the name label.
369
- * By default the name label is visible in the `bottom-left` position with a background-color `rgba(27, 27, 27, 0.4)`
370
- * @returns
371
- */
372
- setNameLabelParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean, backgroundColor: string): void;
373
- /**
374
- *
375
- * @param {string} position
376
- * @param {boolean} visibility
377
- * This method is used to set the position, visibility of the network label.
378
- * By default the network label is visible in the `bottom-right` position.
379
- * @returns
380
- */
381
- setNetworkLabelParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean): void;
382
- }
1
+ import { ICallsettings } from "../types";
2
+ import { OngoingCallListener } from "./Listener";
3
+ export declare class CallSettings {
4
+ static POSITION_TOP_LEFT: string;
5
+ static POSITION_TOP_RIGHT: string;
6
+ static POSITION_BOTTOM_LEFT: string;
7
+ static POSITION_BOTTOM_RIGHT: string;
8
+ static POSITION: {
9
+ readonly TOP_LEFT: "top-left";
10
+ readonly TOP_RIGHT: "top-right";
11
+ readonly BOTTOM_LEFT: "bottom-left";
12
+ readonly BOTTOM_RIGHT: "bottom-right";
13
+ };
14
+ static ASPECT_RATIO_DEFAULT: string;
15
+ static ASPECT_RATIO_CONTAIN: string;
16
+ static ASPECT_RATIO_COVER: string;
17
+ static ASPECT_RATIO: {
18
+ readonly DEFAULT: "default";
19
+ readonly CONTAIN: "contain";
20
+ readonly COVER: "cover";
21
+ };
22
+ private defaultLayout;
23
+ private isAudioOnly;
24
+ private mode;
25
+ private ShowEndCallButton;
26
+ private ShowMuteAudioButton;
27
+ private ShowPauseVideoButton;
28
+ private ShowScreenShareButton;
29
+ private ShowSwitchModeButton;
30
+ private StartAudioMuted;
31
+ private StartVideoMuted;
32
+ private localizedObject;
33
+ private analyticsSettings;
34
+ private customCSS;
35
+ private ShowRecordingButton;
36
+ private StartRecordingOnCallStart;
37
+ private callListener;
38
+ private ShowSwitchToVideoCallButton;
39
+ private VirtualBackground;
40
+ private ShowVirtualBackgroundSetting;
41
+ private MainVideoContainerSetting;
42
+ constructor(builder?: CallSettingsBuilder);
43
+ getCallListener(): OngoingCallListener;
44
+ isRecordingButtonEnabled(): boolean;
45
+ shouldStartRecordingOnCallStart(): boolean;
46
+ getCustomCSS(): string;
47
+ isAudioOnlyCall(): boolean;
48
+ isDefaultLayoutEnabled(): boolean;
49
+ getMode(): "DEFAULT" | "SPOTLIGHT" | "TILE";
50
+ getStartWithAudioMuted(): boolean;
51
+ getStartWithVideoMuted(): boolean;
52
+ isEndCallButtonEnabled(): boolean;
53
+ isMuteAudioButtonEnabled(): boolean;
54
+ isPauseVideoButtonEnabled(): boolean;
55
+ isScreenShareButtonEnabled(): boolean;
56
+ isModeButtonEnabled(): boolean;
57
+ getLocalizedStringObject(): Object;
58
+ getAnalyticsSettings(): Object;
59
+ isAudioToVideoButtonEnabled(): boolean;
60
+ getVirtualBackground(): VirtualBackground;
61
+ isVirtualBackgroundSettingEnabled(): boolean;
62
+ getMainVideoContainerSetting(): MainVideoContainerSetting;
63
+ }
64
+ export declare class CallSettingsBuilder {
65
+ /** @private */ defaultLayout: boolean;
66
+ /** @private */ isAudioOnly: boolean;
67
+ /** @private */ mode: ICallsettings["mode"];
68
+ /** @private */ ShowEndCallButton: boolean;
69
+ /** @private */ ShowMuteAudioButton: boolean;
70
+ /** @private */ ShowPauseVideoButton: boolean;
71
+ /** @private */ ShowScreenShareButton: boolean;
72
+ /** @private */ ShowSwitchModeButton: boolean;
73
+ /** @private */ StartAudioMuted: boolean;
74
+ /** @private */ StartVideoMuted: boolean;
75
+ /** @private */ localizedObject: Object;
76
+ /** @private */ analyticsSettings: Object;
77
+ /** @private */ customCSS: string;
78
+ /** @private */ ShowRecordingButton: boolean;
79
+ /** @private */ StartRecordingOnCallStart: boolean;
80
+ /** @private */ ShowSwitchToVideoCallButton: boolean;
81
+ /** @private */ virtualBackground: VirtualBackground;
82
+ /** @private */ ShowVirtualBackgroundSetting: boolean;
83
+ /** @private */ MainVideoContainerSetting: MainVideoContainerSetting;
84
+ /** @private */ callListener: OngoingCallListener;
85
+ /**
86
+ *
87
+ * @param {boolean} defaultLayout
88
+ * This methods shows/hides the default button layout.
89
+ * If set to true the default button layout will be shown.
90
+ * If set to false the default button layout will be hidden.
91
+ * Default value is true
92
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
93
+ */
94
+ enableDefaultLayout(defaultLayout: boolean): this;
95
+ /**
96
+ *
97
+ * @param {boolean} isAudioOnly
98
+ * This methods sets the type(audio/video) of the call.
99
+ * If set to true, the call will be strictly an audio call.
100
+ * If set to false, the call will be an audio-video call.
101
+ * Default value is false
102
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
103
+ */
104
+ setIsAudioOnlyCall(isAudioOnly: boolean): this;
105
+ /**
106
+ *
107
+ * @param {string} mode
108
+ * This method sets the mode of the call.
109
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
110
+ */
111
+ setMode(mode: ICallsettings["mode"]): this;
112
+ /**
113
+ *
114
+ * @param {boolean} showEndCallButton
115
+ * This method shows/hides the end call button.
116
+ * If set to true it will display the end call button.
117
+ * If set to false it will hide the end call button.
118
+ * Default value is true.
119
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
120
+ */
121
+ showEndCallButton(showEndCallButton: boolean): this;
122
+ /**
123
+ *
124
+ * @param {boolean} showMuteAudioButton
125
+ * This method shows/hides the mute audio button.
126
+ * If set to true it will display the mute audio button.
127
+ * If set to false it will hide the mute audio button.
128
+ * Default value is true.
129
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
130
+ */
131
+ showMuteAudioButton(showMuteAudioButton: boolean): this;
132
+ /**
133
+ *
134
+ * @param {boolean} showPauseVideoButton
135
+ * This method shows/hides the pause video button.
136
+ * If set to true it will display the pause video button.
137
+ * If set to false it will hide the pause video button.
138
+ * Default value is true.
139
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
140
+ */
141
+ showPauseVideoButton(showPauseVideoButton: boolean): this;
142
+ /**
143
+ *
144
+ * @param {boolean} showScreenShareButton
145
+ * This method shows/hides the screen share button.
146
+ * If set to true it will display the screen share button.
147
+ * If set to false it will hide the screen share button.
148
+ * Default value is true.
149
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
150
+ */
151
+ showScreenShareButton(showScreenShareButton: boolean): this;
152
+ /**
153
+ *
154
+ * @param {boolean} showModeButton
155
+ * This method shows/hides the switch mode button.
156
+ * If set to true it will display the switch mode button.
157
+ * If set to false it will hide the switch mode button.
158
+ * Default value is true.
159
+ * @returns
160
+ */
161
+ showModeButton(showModeButton: boolean): this;
162
+ /**
163
+ *
164
+ * @param {Object} localizedStringObject
165
+ * This method will set the localized text in the call screen.
166
+ * @returns
167
+ */
168
+ setLocalizedStringObject(localizedStringObject: Object): this;
169
+ /**
170
+ * @private
171
+ * @param {Object} analyticsSettings
172
+ * This method will set the settings required for analytics.
173
+ * @returns
174
+ */
175
+ setAnalyticsSettings(analyticsSettings: Object): this;
176
+ /**
177
+ *
178
+ * @param {boolean} audioMuted
179
+ * This method allows the call to be started with audio muted.
180
+ * If set to true, the call will start with audio muted.
181
+ * Default value is false.
182
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
183
+ */
184
+ startWithAudioMuted(audioMuted: boolean): this;
185
+ /**
186
+ *
187
+ * @param {boolean} videoMuted
188
+ * This method allows the call to be started with video muted.
189
+ * If set to true, the call will start with video muted.
190
+ * Default value is false.
191
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
192
+ */
193
+ startWithVideoMuted(videoMuted: boolean): this;
194
+ /**
195
+ *
196
+ * @param {boolean} showRecordingButton
197
+ * This method shows/hides the recording button.
198
+ * If set to true it will display the recording button.
199
+ * If set to false it will hide the recording button.
200
+ * Default value is false.
201
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
202
+ */
203
+ showRecordingButton(showRecordingButton: boolean): this;
204
+ /**
205
+ *
206
+ * @param {boolean} startRecordingOnCallStart
207
+ * This method starts the recording as soon as the call start.
208
+ * If set to true it will start the recording as soon as the call start.
209
+ * Default value is false.
210
+ * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
211
+ */
212
+ startRecordingOnCallStart(startRecordingOnCallStart: boolean): this;
213
+ /**
214
+ *
215
+ * @param {boolean} showAudioToVideoSwitchButton
216
+ * This method shows/hides the switch to video call button.
217
+ * If set to true it will display the switch to video call button.
218
+ * If set to false it will hide the switch to video call button.
219
+ * Default value is true.
220
+ * @returns
221
+ */
222
+ showSwitchToVideoCallButton(showAudioToVideoSwitchButton: boolean): this;
223
+ /**
224
+ *
225
+ * @param {VirtualBackground} virtualBackground
226
+ * This method will set the virtual background setting.
227
+ * This methods takes an Object of VirtualBackground Class.
228
+ * @returns
229
+ */
230
+ setVirtualBackground(virtualBackground: VirtualBackground): this;
231
+ /**
232
+ *
233
+ * @param {boolean} showVirtualBackgroundSetting
234
+ * This method shows/hides the virtual background setting button.
235
+ * If set to true it will display the virtual background setting button.
236
+ * If set to false it will hide the virtual background setting button.
237
+ * Default value is true.
238
+ * @returns
239
+ */
240
+ showVirtualBackgroundSetting(showVirtualBackgroundSetting: boolean): this;
241
+ /**
242
+ *
243
+ * @param {MainVideoContainerSetting} mainVideoContainerSetting
244
+ * This method can be used to customize the main video container.
245
+ * @returns
246
+ */
247
+ setMainVideoContainerSetting(mainVideoContainerSetting: MainVideoContainerSetting): this;
248
+ /**
249
+ *
250
+ * @param {OngoingCallListener} callListener
251
+ * This method can be used to subscribe to available callings events
252
+ * @returns
253
+ */
254
+ setCallListener(callListener: OngoingCallListener): this;
255
+ /**
256
+ * This method will return an object of the CallSettings class.
257
+ * @returns {CallSettings} Returns the CallSettings instance
258
+ */
259
+ build(): CallSettings;
260
+ }
261
+ export declare class VirtualBackground {
262
+ private AllowBackgroundBlur;
263
+ private AllowUserImages;
264
+ private ShowDefaultImages;
265
+ private SetImages;
266
+ private EnforceBackgroundBlur;
267
+ private EnforceBackgroundImage;
268
+ constructor(builder?: VirtualBackgroundBuilder);
269
+ shouldAllowBackgroundBlur(): boolean;
270
+ shouldAllowUserImages(): boolean;
271
+ shouldShowDefaultImages(): boolean;
272
+ getImages(): Array<String>;
273
+ isBackgroundBlurEnforced(): number;
274
+ getEnforcedBackgroundImage(): string;
275
+ }
276
+ export declare class VirtualBackgroundBuilder {
277
+ /** @private */ AllowBackgroundBlur: boolean;
278
+ /** @private */ AllowUserImages: boolean;
279
+ /** @private */ ShowDefaultImages: boolean;
280
+ /** @private */ SetImages: string[];
281
+ /** @private */ EnforceBackgroundBlur: number;
282
+ /** @private */ EnforceBackgroundImage: string;
283
+ /**
284
+ *
285
+ * @param {boolean} AllowBackgroundBlur
286
+ * This method will show the background blur option in Virtual Background.
287
+ * If set to true it will show the background blur option.
288
+ * Default value is true.
289
+ * @returns
290
+ */
291
+ allowBackgroundBlur(AllowBackgroundBlur: boolean): this;
292
+ /**
293
+ *
294
+ * @param {boolean} AllowUserImage
295
+ * This method will allow the user to add custom images as background.
296
+ * If set to true it will allow the user to add custom images as background.
297
+ * Default value is true.
298
+ * @returns
299
+ */
300
+ allowUserImages(AllowUserImages: boolean): this;
301
+ /**
302
+ *
303
+ * @param {boolean} ShowDefaultImages
304
+ * This method will show the default images to be used as background.
305
+ * If set to true it will show the default images to be used as background.
306
+ * Default value is true.
307
+ * @returns
308
+ */
309
+ showDefaultImages(ShowDefaultImages: boolean): this;
310
+ /**
311
+ *
312
+ * @param {boolean} SetImages
313
+ * This method will allow user to add custom Images to be used as background. It takes in an array of URLs.
314
+ * @returns
315
+ */
316
+ setImages(SetImages: string[]): this;
317
+ /**
318
+ *
319
+ * @param {number} EnforceBackgroundBlur
320
+ * This method will enforce background blur.
321
+ * This method takes number as input which decides the blur level of the background.
322
+ * Default value is 0.
323
+ * @returns
324
+ */
325
+ enforceBackgroundBlur(EnforceBackgroundBlur: number): this;
326
+ /**
327
+ *
328
+ * @param {string} EnforceBackgroundImage
329
+ * This method will enforce background image.
330
+ * If an URL of the image is sent then that image will be set as background.
331
+ * By default no image is set.
332
+ * @returns
333
+ */
334
+ enforceBackgroundImage(EnforceBackgroundImage: string): this;
335
+ /**
336
+ * This method will return an object of the VirtualBackground class.
337
+ * @returns {VirtualBackground}
338
+ */
339
+ build(): VirtualBackground;
340
+ }
341
+ export declare class MainVideoContainerSetting {
342
+ private videoFit;
343
+ private zoomButton;
344
+ private nameLabel;
345
+ private network;
346
+ /**
347
+ *
348
+ * @param {string} mainVideoAspectRatio
349
+ * This method is used to set the aspect ratio of main video.
350
+ * The default value is `contain`
351
+ * @returns
352
+ */
353
+ setMainVideoAspectRatio(mainVideoAspectRatio: typeof CallSettings.ASPECT_RATIO[keyof typeof CallSettings.ASPECT_RATIO]): void;
354
+ /**
355
+ *
356
+ * @param {string} position
357
+ * @param {boolean} visibility
358
+ * This method is used to set the position & visibility parameter of the full screen button.
359
+ * By default the full screen button is visible in the `bottom-right` position.
360
+ * @returns
361
+ */
362
+ setFullScreenButtonParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean): void;
363
+ /**
364
+ *
365
+ * @param {string} position
366
+ * @param {boolean} visibility
367
+ * @param {string} backgroundColor
368
+ * This method is used to set the position, visibility & background color of the name label.
369
+ * By default the name label is visible in the `bottom-left` position with a background-color `rgba(27, 27, 27, 0.4)`
370
+ * @returns
371
+ */
372
+ setNameLabelParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean, backgroundColor: string): void;
373
+ /**
374
+ *
375
+ * @param {string} position
376
+ * @param {boolean} visibility
377
+ * This method is used to set the position, visibility of the network label.
378
+ * By default the network label is visible in the `bottom-right` position.
379
+ * @returns
380
+ */
381
+ setNetworkLabelParams(position: typeof CallSettings.POSITION[keyof typeof CallSettings.POSITION], visibility: boolean): void;
382
+ }