@videosdk.live/react-sdk 0.8.0 → 0.8.1

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.
@@ -1,237 +0,0 @@
1
- export class Participant {
2
- /**
3
- * @description This represents the participant's ID
4
- */
5
- id: string;
6
- /**
7
- * @description This represents the participant's name
8
- */
9
- displayName: string;
10
- /**
11
- * @description This represents the all the Streams that the participant is producing
12
- *
13
- */
14
- streams: Map<string, Stream>;
15
- /**
16
- * @description This represents the quality of video being consumed for the participant
17
- *
18
- */
19
- quality: 'low' | 'med' | 'high';
20
- /**
21
- * @description This represents if the participant is local or remote
22
- *
23
- */
24
- local: boolean;
25
- /**
26
- * @description This represents participant's current pin state
27
- *
28
- */
29
- pinState: {
30
- cam: boolean;
31
- share: boolean;
32
- };
33
- /**
34
- * @description This represents participant's current webcam status
35
- */
36
- webcamOn: boolean;
37
- /**
38
- * @description This represents participant's current mic status
39
- *
40
- */
41
- micOn: boolean;
42
- /**
43
- * @description This represents participant's current screenshare status
44
- *
45
- */
46
- screenShareOn: boolean;
47
- /**
48
- * @description This represents participant's current screenshare audio status
49
- *
50
- */
51
- screenShareAudioOn: boolean;
52
- /**
53
- * @description This represents participant's current mode
54
- *
55
- */
56
- mode: 'SEND_AND_RECV' | 'SIGNALLING_ONLY' | 'RECV_ONLY'
57
- /**
58
- * @description This represents metaData which is passed in MeetingProvider
59
- *
60
- */
61
- metaData: object;
62
-
63
- /**
64
- * @description This method can be used to kickout a participant from the meeting
65
- */
66
- remove(): void;
67
- /**
68
- * @description This method can be used to enable mic of the participant in the meeting
69
- */
70
- enableMic(): void;
71
- /**
72
- * @description This method can be used to disable mic of the participant in the meeting
73
- */
74
- disableMic(): void;
75
- /**
76
- * @description This method can be used to enable webcam of the participant in the meeting
77
- */
78
- enableWebcam(): void;
79
- /**
80
- * @description This method can be used to disable webcam of the participant in the meeting
81
- */
82
- disableWebcam(): void;
83
- /**
84
- * @description This method can be used to capture image in the meeting
85
- */
86
- captureImage({
87
- height,
88
- width
89
- }: {
90
- height?: number;
91
- width?: number;
92
- }): Promise<string | null>;
93
- /**
94
- * @description This method can be used to set the incoming video quality of the participant
95
- * @param quality
96
- */
97
- setQuality(quality: 'low' | 'med' | 'high'): void;
98
- /**
99
- * @description This method can be used to set the incoming screen sharevideo quality of the participant
100
- * @param quality
101
- */
102
- setScreenShareQuality(quality: 'low' | 'med' | 'high'): void;
103
- /**
104
- * @description This method can be used to set the video quality of the participant based on the size of the viewport it is being displayed in
105
- * @param width Width of the Viewport in which participant video is shown
106
- * @param height Height of the Viewport in which participant video is shown
107
- */
108
- setViewPort(width: number, height: number): void;
109
-
110
- /**
111
- * @param type If `SHARE_AND_CAM` is provided, it will pin screenshare and camera of the participant.
112
- * If `CAM` is provided, it will only pin the participant's camera, If `SHARE` is provided, it will only pin the participant's screen share
113
- */
114
- pin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void;
115
- /**
116
- * @param type If `SHARE_AND_CAM` is provided, it will unpin screenshare and camera of the participant.
117
- * If `CAM` is provided, it will only unpin the participant's camera, If `SHARE` is provided, it will only unpin the participant's screen share
118
- */
119
- unpin(type: 'SHARE_AND_CAM' | 'CAM' | 'SHARE'): void;
120
- /**
121
- * @description This method returns the Video Statistics of the participant.
122
- * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
123
- */
124
- getVideoStats(): Promise<
125
- Array<{
126
- bitrate: number;
127
- rtt: number;
128
- network: string;
129
- codec: string;
130
- jitter: number;
131
- limitation: any;
132
- totalPackets: number;
133
- packetsLost: number;
134
- concealmentEvents: number;
135
- insertedSamplesForDecelaration: number;
136
- removedSamplesForAccelaration: number;
137
- size: any;
138
- currentSpatialLayer: number;
139
- currentTemporalLayer: number;
140
- preferredSpatialLayer: number;
141
- preferredTemporalLayer: number;
142
- }>
143
- >;
144
- /**
145
- * @description This method returns the Screen Share Audio Statistics of the participant.
146
- * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
147
- */
148
- getShareAudioStats(): Promise<
149
- Array<{
150
- bitrate: number;
151
- rtt: number;
152
- network: string;
153
- codec: string;
154
- jitter: number;
155
- totalPackets: number;
156
- packetsLost: number;
157
- concealmentEvents: number;
158
- insertedSamplesForDecelaration: number;
159
- removedSamplesForAccelaration: number;
160
- size: any;
161
- }>
162
- >;
163
- /**
164
- * @description This method returns the Screen Share Statistics of the participant.
165
- * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
166
- */
167
- getShareStats(): Promise<
168
- Array<{
169
- bitrate: number;
170
- rtt: number;
171
- network: string;
172
- codec: string;
173
- jitter: number;
174
- limitation: any;
175
- totalPackets: number;
176
- packetsLost: number;
177
- concealmentEvents: number;
178
- insertedSamplesForDecelaration: number;
179
- removedSamplesForAccelaration: number;
180
- size: any;
181
- currentSpatialLayer: number;
182
- currentTemporalLayer: number;
183
- preferredSpatialLayer: number;
184
- preferredTemporalLayer: number;
185
- }>
186
- >;
187
- /**
188
- * @description This method returns the Audio Statistics of the participant.
189
- * To learn more about the video statistics check these [reference](https://docs.videosdk.live/react/guide/video-and-audio-calling-api-sdk/render-media/understanding-call-quality)
190
- */
191
- getAudioStats(): Promise<
192
- Array<{
193
- bitrate: number;
194
- rtt: number;
195
- network: string;
196
- codec: string;
197
- jitter: number;
198
- totalPackets: number;
199
- packetsLost: number;
200
- concealmentEvents: number;
201
- insertedSamplesForDecelaration: number;
202
- removedSamplesForAccelaration: number;
203
- size: any;
204
- }>
205
- >;
206
- consumeMicStreams(): void;
207
- consumeWebcamStreams(): void;
208
- stopConsumingWebcamStreams(): void;
209
- stopConsumingMicStreams(): void;
210
- /**
211
- * Add event listener
212
- * @param eventType Event name to which you want to subscribe.
213
- * @param listener Callback function which will be triggered when the event happens
214
- */
215
- on(
216
- eventType:
217
- | 'stream-enabled'
218
- | 'stream-disabled'
219
- | 'media-status-changed'
220
- | 'video-quality-changed',
221
- listener: (data: any) => void
222
- ): void;
223
- /**
224
- * Remove event
225
- * @param eventType Event name to which you want to unsubscribe.
226
- * @param listener Callback function which was passed while subscribing to the event
227
- */
228
- off(
229
- eventType:
230
- | 'stream-enabled'
231
- | 'stream-disabled'
232
- | 'media-status-changed'
233
- | 'video-quality-changed',
234
- listener: (data: any) => void
235
- ): void;
236
- }
237
- import { Stream } from './stream';
@@ -1,5 +0,0 @@
1
- export declare enum Permission {
2
- AUDIO = "audio",
3
- VIDEO = "video",
4
- AUDIO_AND_VIDEO = "audio_video"
5
- }
@@ -1,27 +0,0 @@
1
- export class Stream {
2
- /**
3
- * Id of the stream
4
- */
5
- id: string;
6
- /**
7
- * @description This represents the type of Stream
8
- */
9
- kind: 'audio' | 'video' | 'share' | 'shareAudio';
10
- /**
11
- * @description This represents the codec of the stream
12
- */
13
- codec: string;
14
- /**
15
- * @description This represents the track which can be used to play the audio or video of the participant
16
- */
17
- track: MediaStreamTrack;
18
- /**
19
- * @description This method can be used to pause the incoming audio stream
20
- */
21
- pause(): void;
22
- /**
23
- * @description This method can be used to resume the incoming audio stream
24
- */
25
- resume(): void;
26
- get paused(): any;
27
- }