@flashphoner/websdk 2.0.216 → 2.0.219
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.
- package/docTemplate/README.md +1 -1
- package/examples/demo/streaming/conference/conference.js +9 -1
- package/examples/demo/streaming/player/player.js +12 -2
- package/examples/demo/streaming/stream-snapshot/stream-snapshot.js +11 -11
- package/examples/demo/streaming/video-chat-and-screen-sharing/video-chat-and-screen-sharing.js +12 -0
- package/flashphoner-no-flash.js +840 -590
- package/flashphoner-no-flash.min.js +1 -1
- package/flashphoner-no-webrtc.js +840 -590
- package/flashphoner-no-webrtc.min.js +1 -1
- package/flashphoner-no-wsplayer.js +840 -590
- package/flashphoner-no-wsplayer.min.js +1 -1
- package/flashphoner-room-api.js +819 -697
- package/flashphoner-room-api.min.js +1 -1
- package/flashphoner-temasys-flash-websocket-without-adapterjs.js +840 -590
- package/flashphoner-temasys-flash-websocket.js +840 -590
- package/flashphoner-temasys-flash-websocket.min.js +1 -1
- package/flashphoner-webrtc-only.js +839 -589
- package/flashphoner-webrtc-only.min.js +1 -1
- package/flashphoner.js +840 -590
- package/flashphoner.min.js +1 -1
- package/package.json +1 -1
- package/src/constants.d.ts +792 -1
- package/src/constants.js +817 -704
- package/src/flashphoner-core.d.ts +359 -212
- package/src/flashphoner-core.js +10 -1
- package/src/media-source-media-provider.js +1 -1
- package/src/room-module.d.ts +2 -2
package/src/constants.d.ts
CHANGED
|
@@ -1 +1,792 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @namespace Flashphoner.constants.SESSION_STATUS
|
|
3
|
+
* @see Session
|
|
4
|
+
*/
|
|
5
|
+
export const SESSION_STATUS: Readonly<{
|
|
6
|
+
/**
|
|
7
|
+
* Fires when {@link Session} ws socket opens.
|
|
8
|
+
* @event CONNECTED
|
|
9
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
10
|
+
*/
|
|
11
|
+
CONNECTED: string;
|
|
12
|
+
/**
|
|
13
|
+
* Fires when {@link Session} receives connect ack from REST App.
|
|
14
|
+
* @event ESTABLISHED
|
|
15
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
16
|
+
*/
|
|
17
|
+
ESTABLISHED: string;
|
|
18
|
+
/**
|
|
19
|
+
* Fires when {@link Session} disconnects.
|
|
20
|
+
* @event DISCONNECTED
|
|
21
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
22
|
+
*/
|
|
23
|
+
DISCONNECTED: string;
|
|
24
|
+
/**
|
|
25
|
+
* Fires if {@link Session} call of rest method error.
|
|
26
|
+
* @event WARN
|
|
27
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
28
|
+
*/
|
|
29
|
+
WARN: string;
|
|
30
|
+
/**
|
|
31
|
+
* Fires if {@link Session} connection failed.
|
|
32
|
+
* Some of the reasons can be network connection failed, REST App failed
|
|
33
|
+
* @event FAILED
|
|
34
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
35
|
+
*/
|
|
36
|
+
FAILED: string;
|
|
37
|
+
/**
|
|
38
|
+
* Fires wneh {@link Session} receives debug event
|
|
39
|
+
* @event DEBUG
|
|
40
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
41
|
+
*/
|
|
42
|
+
DEBUG: string;
|
|
43
|
+
/**
|
|
44
|
+
* Fires when {@link Session} receives custom REST App message.
|
|
45
|
+
*
|
|
46
|
+
* @event APP_DATA
|
|
47
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
48
|
+
*/
|
|
49
|
+
APP_DATA: string;
|
|
50
|
+
/**
|
|
51
|
+
* Fires when {@link Session} receives status of sendData operation.
|
|
52
|
+
*
|
|
53
|
+
* @event SEND_DATA_STATUS
|
|
54
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
55
|
+
*/
|
|
56
|
+
SEND_DATA_STATUS: string;
|
|
57
|
+
/**
|
|
58
|
+
* State of newly created {@link Session}.
|
|
59
|
+
*
|
|
60
|
+
* @event PENDING
|
|
61
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
62
|
+
*/
|
|
63
|
+
PENDING: string;
|
|
64
|
+
/**
|
|
65
|
+
* Fires when {@link Session} registers as sip client.
|
|
66
|
+
*
|
|
67
|
+
* @event REGISTERED
|
|
68
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
69
|
+
*/
|
|
70
|
+
REGISTERED: string;
|
|
71
|
+
/**
|
|
72
|
+
* Fires when {@link Session} unregisters as sip client.
|
|
73
|
+
*
|
|
74
|
+
* @event UNREGISTERED
|
|
75
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
76
|
+
*/
|
|
77
|
+
UNREGISTERED: string;
|
|
78
|
+
/**
|
|
79
|
+
* Fires when {@link Session} receives an incoming call.
|
|
80
|
+
*
|
|
81
|
+
* @event INCOMING_CALL
|
|
82
|
+
* @memberof Flashphoner.constants.SESSION_STATUS
|
|
83
|
+
*/
|
|
84
|
+
INCOMING_CALL: string;
|
|
85
|
+
}>;
|
|
86
|
+
/**
|
|
87
|
+
* @namespace Flashphoner.constants.STREAM_STATUS
|
|
88
|
+
* @see Stream
|
|
89
|
+
*/
|
|
90
|
+
export const STREAM_STATUS: Readonly<{
|
|
91
|
+
/**
|
|
92
|
+
* State of newly created {@link Stream}.
|
|
93
|
+
*
|
|
94
|
+
* @event NEW
|
|
95
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
96
|
+
*/
|
|
97
|
+
NEW: string;
|
|
98
|
+
/**
|
|
99
|
+
* State before {@link Stream} publishing/playing.
|
|
100
|
+
*
|
|
101
|
+
* @event PENDING
|
|
102
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
103
|
+
*/
|
|
104
|
+
PENDING: string;
|
|
105
|
+
/**
|
|
106
|
+
* Fires when {@link Stream} starts publishing.
|
|
107
|
+
* @event PUBLISHING
|
|
108
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
109
|
+
*/
|
|
110
|
+
PUBLISHING: string;
|
|
111
|
+
/**
|
|
112
|
+
* Fires when {@link Stream} starts playing.
|
|
113
|
+
* @event PLAYING
|
|
114
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
115
|
+
*/
|
|
116
|
+
PLAYING: string;
|
|
117
|
+
/**
|
|
118
|
+
* Fires if {@link Stream} paused.
|
|
119
|
+
* @event PAUSED
|
|
120
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
121
|
+
*/
|
|
122
|
+
PAUSED: string;
|
|
123
|
+
/**
|
|
124
|
+
* Fires if {@link Stream} was unpublished.
|
|
125
|
+
* @event UNPUBLISHED
|
|
126
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
127
|
+
*/
|
|
128
|
+
UNPUBLISHED: string;
|
|
129
|
+
/**
|
|
130
|
+
* Fires if playing {@link Stream} was stopped.
|
|
131
|
+
* @event STOPPED
|
|
132
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
133
|
+
*/
|
|
134
|
+
STOPPED: string;
|
|
135
|
+
/**
|
|
136
|
+
* Fires if {@link Stream} failed.
|
|
137
|
+
* @event FAILED
|
|
138
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
139
|
+
*/
|
|
140
|
+
FAILED: string;
|
|
141
|
+
/**
|
|
142
|
+
* Fires if {@link Stream} playback problem.
|
|
143
|
+
* @event PLAYBACK_PROBLEM
|
|
144
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
145
|
+
*/
|
|
146
|
+
PLAYBACK_PROBLEM: string;
|
|
147
|
+
/**
|
|
148
|
+
* Fires if playing {@link Stream} picture resizing.
|
|
149
|
+
* @event RESIZE
|
|
150
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
151
|
+
*/
|
|
152
|
+
RESIZE: string;
|
|
153
|
+
/**
|
|
154
|
+
* Fires when {@link Stream} snapshot becomes available.
|
|
155
|
+
* Snapshot is base64 encoded png available through {@link Stream.getInfo}
|
|
156
|
+
* @event SNAPSHOT_COMPLETE
|
|
157
|
+
* @memberof Flashphoner.constants.STREAM_STATUS
|
|
158
|
+
*/
|
|
159
|
+
SNAPSHOT_COMPLETE: string;
|
|
160
|
+
/**
|
|
161
|
+
* Fires on playing {@link Stream} if bitrate is higher than available network bandwidth.
|
|
162
|
+
* @event NOT_ENOUGH_BANDWIDTH
|
|
163
|
+
* @memberof Flashphoner.constants.NOT_ENOUGH_BANDWIDTH
|
|
164
|
+
*/
|
|
165
|
+
NOT_ENOUGH_BANDWIDTH: string;
|
|
166
|
+
}>;
|
|
167
|
+
/**
|
|
168
|
+
* @namespace Flashphoner.constants.CALL_STATUS
|
|
169
|
+
* @see Call
|
|
170
|
+
*/
|
|
171
|
+
export const CALL_STATUS: Readonly<{
|
|
172
|
+
/**
|
|
173
|
+
* State of newly created {@link Call}
|
|
174
|
+
* @event NEW
|
|
175
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
176
|
+
*/
|
|
177
|
+
NEW: string;
|
|
178
|
+
/**
|
|
179
|
+
* The server is ringing to the callee
|
|
180
|
+
* @event RING
|
|
181
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
182
|
+
*/
|
|
183
|
+
RING: string;
|
|
184
|
+
RING_MEDIA: string;
|
|
185
|
+
/**
|
|
186
|
+
* The {@link Call} was put on hold
|
|
187
|
+
* @event HOLD
|
|
188
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
189
|
+
*/
|
|
190
|
+
HOLD: string;
|
|
191
|
+
/**
|
|
192
|
+
* The {@link Call} is established
|
|
193
|
+
* @event ESTABLISHED
|
|
194
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
195
|
+
*/
|
|
196
|
+
ESTABLISHED: string;
|
|
197
|
+
/**
|
|
198
|
+
* The {@link Call} is finished
|
|
199
|
+
* @event FINISH
|
|
200
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
201
|
+
*/
|
|
202
|
+
FINISH: string;
|
|
203
|
+
/**
|
|
204
|
+
* Callee is busy
|
|
205
|
+
* @event BUSY
|
|
206
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
207
|
+
*/
|
|
208
|
+
BUSY: string;
|
|
209
|
+
/**
|
|
210
|
+
* SIP session is in progress
|
|
211
|
+
* @event SESSION_PROGRESS
|
|
212
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
213
|
+
*/
|
|
214
|
+
SESSION_PROGRESS: string;
|
|
215
|
+
/**
|
|
216
|
+
* The {@link Call} is failed
|
|
217
|
+
* @event FAILED
|
|
218
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
219
|
+
*/
|
|
220
|
+
FAILED: string;
|
|
221
|
+
/**
|
|
222
|
+
* The {@link Call} state before ringing
|
|
223
|
+
* @event PENDING
|
|
224
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
225
|
+
*/
|
|
226
|
+
PENDING: string;
|
|
227
|
+
/**
|
|
228
|
+
* The server trying to establish {@link Call}
|
|
229
|
+
* @event TRYING
|
|
230
|
+
* @memberof Flashphoner.constants.CALL_STATUS
|
|
231
|
+
*/
|
|
232
|
+
TRYING: string;
|
|
233
|
+
}>;
|
|
234
|
+
/**
|
|
235
|
+
* @namespace Flashphoner.constants.STREAM_STATUS_INFO
|
|
236
|
+
* @see Stream
|
|
237
|
+
*/
|
|
238
|
+
export const STREAM_STATUS_INFO: Readonly<{
|
|
239
|
+
/**
|
|
240
|
+
* Indicates general error during ICE negotiation. Usually occurs if client is behind some exotic nat/firewall.
|
|
241
|
+
* @event FAILED_BY_ICE_ERROR
|
|
242
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
243
|
+
*/
|
|
244
|
+
FAILED_BY_ICE_ERROR: string;
|
|
245
|
+
/**
|
|
246
|
+
* Timeout has been reached during ICE establishment.
|
|
247
|
+
* @event FAILED_BY_ICE_TIMEOUT
|
|
248
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
249
|
+
*/
|
|
250
|
+
FAILED_BY_ICE_TIMEOUT: string;
|
|
251
|
+
/**
|
|
252
|
+
* ICE refresh failed on session.
|
|
253
|
+
* @event FAILED_BY_KEEP_ALIVE
|
|
254
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
255
|
+
*/
|
|
256
|
+
FAILED_BY_KEEP_ALIVE: string;
|
|
257
|
+
/**
|
|
258
|
+
* DTLS has wrong fingerprint.
|
|
259
|
+
* @event FAILED_BY_DTLS_FINGERPRINT_ERROR
|
|
260
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
261
|
+
*/
|
|
262
|
+
FAILED_BY_DTLS_FINGERPRINT_ERROR: string;
|
|
263
|
+
/**
|
|
264
|
+
* Client did not send DTLS packets or packets were lost/corrupted during transmission.
|
|
265
|
+
* @event FAILED_BY_DTLS_ERROR
|
|
266
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
267
|
+
*/
|
|
268
|
+
FAILED_BY_DTLS_ERROR: string;
|
|
269
|
+
/**
|
|
270
|
+
* Indicates general HLS packetizer error, can occur during initialization or packetization (wrong input or out of disk space).
|
|
271
|
+
* @event FAILED_BY_HLS_WRITER_ERROR
|
|
272
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
273
|
+
*/
|
|
274
|
+
FAILED_BY_HLS_WRITER_ERROR: string;
|
|
275
|
+
/**
|
|
276
|
+
* Indicates general RTMP republishing error, can occur during initialization or rtmp packetization.
|
|
277
|
+
* @event FAILED_BY_RTMP_WRITER_ERROR
|
|
278
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
279
|
+
*/
|
|
280
|
+
FAILED_BY_RTMP_WRITER_ERROR: string;
|
|
281
|
+
/**
|
|
282
|
+
* RTP session failed by RTP activity timer.
|
|
283
|
+
* @event FAILED_BY_RTP_ACTIVITY
|
|
284
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
285
|
+
*/
|
|
286
|
+
FAILED_BY_RTP_ACTIVITY: string;
|
|
287
|
+
/**
|
|
288
|
+
* Related session was disconnected.
|
|
289
|
+
* @event STOPPED_BY_SESSION_DISCONNECT
|
|
290
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
291
|
+
*/
|
|
292
|
+
STOPPED_BY_SESSION_DISCONNECT: string;
|
|
293
|
+
/**
|
|
294
|
+
* Stream was stopped by rest terminate request.
|
|
295
|
+
* @event STOPPED_BY_REST_TERMINATE
|
|
296
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
297
|
+
*/
|
|
298
|
+
STOPPED_BY_REST_TERMINATE: string;
|
|
299
|
+
/**
|
|
300
|
+
* Related publisher stopped its stream or lost connection.
|
|
301
|
+
* @event STOPPED_BY_PUBLISHER_STOP
|
|
302
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
303
|
+
*/
|
|
304
|
+
STOPPED_BY_PUBLISHER_STOP: string;
|
|
305
|
+
/**
|
|
306
|
+
* Stop the media session by user after call was finished or unpublish stream.
|
|
307
|
+
* @event STOPPED_BY_USER
|
|
308
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
309
|
+
*/
|
|
310
|
+
STOPPED_BY_USER: string;
|
|
311
|
+
/**
|
|
312
|
+
* Error occurred on the stream.
|
|
313
|
+
* @event FAILED_BY_ERROR
|
|
314
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
315
|
+
*/
|
|
316
|
+
FAILED_BY_ERROR: string;
|
|
317
|
+
/**
|
|
318
|
+
* Indicates that error occurred during media session creation. This might be SDP parsing error, all ports are busy, wrong session related config etc.
|
|
319
|
+
* @event FAILED_TO_ADD_STREAM_TO_PROXY
|
|
320
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
321
|
+
*/
|
|
322
|
+
FAILED_TO_ADD_STREAM_TO_PROXY: string;
|
|
323
|
+
/**
|
|
324
|
+
* Stopped shapshot distributor.
|
|
325
|
+
* @event DISTRIBUTOR_STOPPED
|
|
326
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
327
|
+
*/
|
|
328
|
+
DISTRIBUTOR_STOPPED: string;
|
|
329
|
+
/**
|
|
330
|
+
* Publish stream is not ready, try again later.
|
|
331
|
+
* @event PUBLISH_STREAM_IS_NOT_READY
|
|
332
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
333
|
+
*/
|
|
334
|
+
PUBLISH_STREAM_IS_NOT_READY: string;
|
|
335
|
+
/**
|
|
336
|
+
* Stream with this name is not found, check the correct of the name.
|
|
337
|
+
* @event STREAM_NOT_FOUND
|
|
338
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
339
|
+
*/
|
|
340
|
+
STREAM_NOT_FOUND: string;
|
|
341
|
+
/**
|
|
342
|
+
* Server already has a publish stream with the same name, try using different one.
|
|
343
|
+
* @event STREAM_NAME_ALREADY_IN_USE
|
|
344
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
345
|
+
*/
|
|
346
|
+
STREAM_NAME_ALREADY_IN_USE: string;
|
|
347
|
+
/**
|
|
348
|
+
* Error indicates that stream object received by server has empty mediaSessionId field.
|
|
349
|
+
* @event MEDIASESSION_ID_NULL
|
|
350
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
351
|
+
*/
|
|
352
|
+
MEDIASESSION_ID_NULL: string;
|
|
353
|
+
/**
|
|
354
|
+
* Published or subscribed sessions used this MediaSessionId.
|
|
355
|
+
* @event MEDIASESSION_ID_ALREADY_IN_USE
|
|
356
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
357
|
+
*/
|
|
358
|
+
MEDIASESSION_ID_ALREADY_IN_USE: string;
|
|
359
|
+
/**
|
|
360
|
+
* Session is not initialized or terminated on play ordinary stream.
|
|
361
|
+
* @event SESSION_NOT_READY
|
|
362
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
363
|
+
*/
|
|
364
|
+
SESSION_NOT_READY: string;
|
|
365
|
+
/**
|
|
366
|
+
* Actual session does not exist.
|
|
367
|
+
* @event SESSION_DOES_NOT_EXIST
|
|
368
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
369
|
+
*/
|
|
370
|
+
SESSION_DOES_NOT_EXIST: string;
|
|
371
|
+
/**
|
|
372
|
+
* RTSP has wrong format on play stream, check the RTSP url validity.
|
|
373
|
+
* @event RTSP_HAS_WRONG_FORMAT
|
|
374
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
375
|
+
*/
|
|
376
|
+
RTSP_HAS_WRONG_FORMAT: string;
|
|
377
|
+
/**
|
|
378
|
+
* Failed to play vod stream, this format is not supported.
|
|
379
|
+
* @event FILE_HAS_WRONG_FORMAT
|
|
380
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
381
|
+
*/
|
|
382
|
+
FILE_HAS_WRONG_FORMAT: string;
|
|
383
|
+
/**
|
|
384
|
+
* Failed to connect to rtsp stream.
|
|
385
|
+
* @event FAILED_TO_CONNECT_TO_RTSP_STREAM
|
|
386
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
387
|
+
*/
|
|
388
|
+
FAILED_TO_CONNECT_TO_RTSP_STREAM: string;
|
|
389
|
+
/**
|
|
390
|
+
* Rtsp stream is not found, agent received "404-Not Found".
|
|
391
|
+
* @event RTSP_STREAM_NOT_FOUND
|
|
392
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
393
|
+
*/
|
|
394
|
+
RTSP_STREAM_NOT_FOUND: string;
|
|
395
|
+
/**
|
|
396
|
+
* On shutdown RTSP agent.
|
|
397
|
+
* @event RTSPAGENT_SHUTDOWN
|
|
398
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
399
|
+
*/
|
|
400
|
+
RTSPAGENT_SHUTDOWN: string;
|
|
401
|
+
/**
|
|
402
|
+
* Stream failed
|
|
403
|
+
* @event STREAM_FAILED
|
|
404
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
405
|
+
*/
|
|
406
|
+
STREAM_FAILED: string;
|
|
407
|
+
/**
|
|
408
|
+
* No common codecs on setup track, did not found corresponding trackId->mediaPort.
|
|
409
|
+
* @event NO_COMMON_CODECS
|
|
410
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
411
|
+
*/
|
|
412
|
+
NO_COMMON_CODECS: string;
|
|
413
|
+
/**
|
|
414
|
+
* Bad referenced rtsp link, check for correct, example: rtsp://user:b@d_password@127.0.0.1/stream.
|
|
415
|
+
* @event BAD_URI
|
|
416
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
417
|
+
*/
|
|
418
|
+
BAD_URI: string;
|
|
419
|
+
/**
|
|
420
|
+
* General VOD error, indicates that Exception occurred while reading/processing media file.
|
|
421
|
+
* @event GOT_EXCEPTION_WHILE_STREAMING_FILE
|
|
422
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
423
|
+
*/
|
|
424
|
+
GOT_EXCEPTION_WHILE_STREAMING_FILE: string;
|
|
425
|
+
/**
|
|
426
|
+
* Requested stream shutdown.
|
|
427
|
+
* @event REQUESTED_STREAM_SHUTDOWN
|
|
428
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
429
|
+
*/
|
|
430
|
+
REQUESTED_STREAM_SHUTDOWN: string;
|
|
431
|
+
/**
|
|
432
|
+
* Failed to create movie, file can not be read.
|
|
433
|
+
* @event FAILED_TO_READ_FILE
|
|
434
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
435
|
+
*/
|
|
436
|
+
FAILED_TO_READ_FILE: string;
|
|
437
|
+
/**
|
|
438
|
+
* File does not exist, check filename.
|
|
439
|
+
* @event FILE_NOT_FOUND
|
|
440
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
441
|
+
*/
|
|
442
|
+
FILE_NOT_FOUND: string;
|
|
443
|
+
/**
|
|
444
|
+
* Server failed to establish websocket connection with origin server.
|
|
445
|
+
* @event FAILED_TO_CONNECT_TO_ORIGIN_STREAM
|
|
446
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
447
|
+
*/
|
|
448
|
+
FAILED_TO_CONNECT_TO_ORIGIN_STREAM: string;
|
|
449
|
+
/**
|
|
450
|
+
* CDN stream not found.
|
|
451
|
+
* @event CDN_STREAM_NOT_FOUND
|
|
452
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
453
|
+
*/
|
|
454
|
+
CDN_STREAM_NOT_FOUND: string;
|
|
455
|
+
/**
|
|
456
|
+
* Indicates that provided URL protocol in stream name is invalid.
|
|
457
|
+
* Valid: vod://file.mp4
|
|
458
|
+
* Invalid: dov://file.mp4
|
|
459
|
+
* @event FAILED_TO_GET_AGENT_STORAGE
|
|
460
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
461
|
+
*/
|
|
462
|
+
FAILED_TO_GET_AGENT_STORAGE: string;
|
|
463
|
+
/**
|
|
464
|
+
* Shutdown agent servicing origin stream.
|
|
465
|
+
* @event AGENT_SERVICING_ORIGIN_STREAM_IS_SHUTTING_DOWN
|
|
466
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
467
|
+
*/
|
|
468
|
+
AGENT_SERVICING_ORIGIN_STREAM_IS_SHUTTING_DOWN: string;
|
|
469
|
+
/**
|
|
470
|
+
* Terminated by keep-alive on walk through subscribers.
|
|
471
|
+
* @event TERMINATED_BY_KEEP_ALIVE
|
|
472
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
473
|
+
*/
|
|
474
|
+
TERMINATED_BY_KEEP_ALIVE: string;
|
|
475
|
+
/**
|
|
476
|
+
* Transcoding required, but disabled in server settings
|
|
477
|
+
* @event TRANSCODING_REQUIRED_BUT_DISABLED
|
|
478
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
479
|
+
*/
|
|
480
|
+
TRANSCODING_REQUIRED_BUT_DISABLED: string;
|
|
481
|
+
/**
|
|
482
|
+
* Access restricted by access list
|
|
483
|
+
* @event RESTRICTED_ACCESS
|
|
484
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
485
|
+
*/
|
|
486
|
+
RESTRICTED_ACCESS: string;
|
|
487
|
+
/**
|
|
488
|
+
* No available transcoders for stream
|
|
489
|
+
* @event NO_AVAILABLE_TRANSCODERS
|
|
490
|
+
* @memberof Flashphoner.constants.STREAM_STATUS_INFO
|
|
491
|
+
*/
|
|
492
|
+
NO_AVAILABLE_TRANSCODERS: string;
|
|
493
|
+
}>;
|
|
494
|
+
/**
|
|
495
|
+
* @namespace Flashphoner.constants.CALL_STATUS_INFO
|
|
496
|
+
* @see Call
|
|
497
|
+
*/
|
|
498
|
+
export const CALL_STATUS_INFO: Readonly<{
|
|
499
|
+
/**
|
|
500
|
+
* Normal call hangup.
|
|
501
|
+
* @event NORMAL_CALL_CLEARING
|
|
502
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
503
|
+
*/
|
|
504
|
+
NORMAL_CALL_CLEARING: string;
|
|
505
|
+
/**
|
|
506
|
+
* Error occurred while creating a session
|
|
507
|
+
* @event FAILED_BY_SESSION_CREATION
|
|
508
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
509
|
+
*/
|
|
510
|
+
FAILED_BY_SESSION_CREATION: string;
|
|
511
|
+
/**
|
|
512
|
+
* Failed by error during ICE establishment.
|
|
513
|
+
* @event FAILED_BY_ICE_ERROR
|
|
514
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
515
|
+
*/
|
|
516
|
+
FAILED_BY_ICE_ERROR: string;
|
|
517
|
+
/**
|
|
518
|
+
* RTP session failed by RTP activity timer.
|
|
519
|
+
* @event FAILED_BY_RTP_ACTIVITY
|
|
520
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
521
|
+
*/
|
|
522
|
+
FAILED_BY_RTP_ACTIVITY: string;
|
|
523
|
+
/**
|
|
524
|
+
* FF writer was failed on RTMP.
|
|
525
|
+
* @event FAILED_BY_RTMP_WRITER_ERROR
|
|
526
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
527
|
+
*/
|
|
528
|
+
FAILED_BY_RTMP_WRITER_ERROR: string;
|
|
529
|
+
/**
|
|
530
|
+
* DTLS wrong fingerprint.
|
|
531
|
+
* @event FAILED_BY_DTLS_FINGERPRINT_ERROR
|
|
532
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
533
|
+
*/
|
|
534
|
+
FAILED_BY_DTLS_FINGERPRINT_ERROR: string;
|
|
535
|
+
/**
|
|
536
|
+
* No common codecs in sdp
|
|
537
|
+
* @event NO_COMMON_CODECS
|
|
538
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
539
|
+
*/
|
|
540
|
+
NO_COMMON_CODECS: string;
|
|
541
|
+
/**
|
|
542
|
+
* Client did not send DTLS packets or packets were lost/corrupted during transmission.
|
|
543
|
+
* @event FAILED_BY_DTLS_ERROR
|
|
544
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
545
|
+
*/
|
|
546
|
+
FAILED_BY_DTLS_ERROR: string;
|
|
547
|
+
/**
|
|
548
|
+
* Error occurred during the call
|
|
549
|
+
* @event FAILED_BY_ERROR
|
|
550
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
551
|
+
*/
|
|
552
|
+
FAILED_BY_ERROR: string;
|
|
553
|
+
/**
|
|
554
|
+
* Call failed by request timeout
|
|
555
|
+
* @event FAILED_BY_REQUEST_TIMEOUT
|
|
556
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
557
|
+
*/
|
|
558
|
+
FAILED_BY_REQUEST_TIMEOUT: string;
|
|
559
|
+
/**
|
|
560
|
+
* Transcoding required, but disabled in settings
|
|
561
|
+
* @event TRANSCODING_REQUIRED_BUT_DISABLED
|
|
562
|
+
* @memberof Flashphoner.constants.CALL_STATUS_INFO
|
|
563
|
+
*/
|
|
564
|
+
TRANSCODING_REQUIRED_BUT_DISABLED: string;
|
|
565
|
+
}>;
|
|
566
|
+
/**
|
|
567
|
+
* @namespace Flashphoner.constants.ERROR_INFO
|
|
568
|
+
*/
|
|
569
|
+
export const ERROR_INFO: Readonly<{
|
|
570
|
+
/**
|
|
571
|
+
* Error if none of MediaProviders available
|
|
572
|
+
* @event NONE_OF_MEDIAPROVIDERS_AVAILABLE
|
|
573
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
574
|
+
*/
|
|
575
|
+
NONE_OF_MEDIAPROVIDERS_AVAILABLE: string;
|
|
576
|
+
/**
|
|
577
|
+
* Error if none of preferred MediaProviders available
|
|
578
|
+
* @event NONE_OF_PREFERRED_MEDIAPROVIDERS_AVAILABLE
|
|
579
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
580
|
+
*/
|
|
581
|
+
NONE_OF_PREFERRED_MEDIAPROVIDERS_AVAILABLE: string;
|
|
582
|
+
/**
|
|
583
|
+
* Error if API is not initialized
|
|
584
|
+
* @event FLASHPHONER_API_NOT_INITIALIZED
|
|
585
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
586
|
+
*/
|
|
587
|
+
FLASHPHONER_API_NOT_INITIALIZED: string;
|
|
588
|
+
/**
|
|
589
|
+
* Error if options.urlServer is not specified
|
|
590
|
+
* @event OPTIONS_URLSERVER_MUST_BE_PROVIDED
|
|
591
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
592
|
+
*/
|
|
593
|
+
OPTIONS_URLSERVER_MUST_BE_PROVIDED: string;
|
|
594
|
+
/**
|
|
595
|
+
* Error if session state is not valid
|
|
596
|
+
* @event INVALID_SESSION_STATE
|
|
597
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
598
|
+
*/
|
|
599
|
+
INVALID_SESSION_STATE: string;
|
|
600
|
+
/**
|
|
601
|
+
* Error if no options provided
|
|
602
|
+
* @event OPTIONS_MUST_BE_PROVIDED
|
|
603
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
604
|
+
*/
|
|
605
|
+
OPTIONS_MUST_BE_PROVIDED: string;
|
|
606
|
+
/**
|
|
607
|
+
* Error if call status is not {@link Flashphoner.constants.CALL_STATUS.NEW}
|
|
608
|
+
* @event INVALID_CALL_STATE
|
|
609
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
610
|
+
*/
|
|
611
|
+
INVALID_CALL_STATE: string;
|
|
612
|
+
/**
|
|
613
|
+
* Error if event is not specified
|
|
614
|
+
* @event EVENT_CANT_BE_NULL
|
|
615
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
616
|
+
*/
|
|
617
|
+
EVENT_CANT_BE_NULL: string;
|
|
618
|
+
/**
|
|
619
|
+
* Error if callback is not a valid function
|
|
620
|
+
* @event CALLBACK_NEEDS_TO_BE_A_VALID_FUNCTION
|
|
621
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
622
|
+
*/
|
|
623
|
+
CALLBACK_NEEDS_TO_BE_A_VALID_FUNCTION: string;
|
|
624
|
+
/**
|
|
625
|
+
* Error if options.name is not specified
|
|
626
|
+
* @event OPTIONS_NAME_MUST_BE_PROVIDED
|
|
627
|
+
* @memberof Flashphoner.constants.ERROR_INFO
|
|
628
|
+
*/
|
|
629
|
+
OPTIONS_NAME_MUST_BE_PROVIDED: string;
|
|
630
|
+
/**
|
|
631
|
+
* Error if number of cams is less than 2 or camera is already used by other application
|
|
632
|
+
* @event CAN_NOT_SWITCH_CAM
|
|
633
|
+
* @memberOf Flashphoner.constants.ERROR_INFO
|
|
634
|
+
*/
|
|
635
|
+
CAN_NOT_SWITCH_CAM: string;
|
|
636
|
+
/**
|
|
637
|
+
* Error if number of mics is less than 2 or microphone is already used by other application
|
|
638
|
+
* @event CAN_NOT_SWITCH_MIC
|
|
639
|
+
* @memberOf Flashphoner.constants.ERROR_INFO
|
|
640
|
+
*/
|
|
641
|
+
CAN_NOT_SWITCH_MIC: string;
|
|
642
|
+
/**
|
|
643
|
+
* Local browser error detected
|
|
644
|
+
* @event LOCAL_ERROR
|
|
645
|
+
* @memberOf Flashphoner.constants.ERROR_INFO
|
|
646
|
+
*/
|
|
647
|
+
LOCAL_ERROR: string;
|
|
648
|
+
}>;
|
|
649
|
+
/**
|
|
650
|
+
* Local media devices type
|
|
651
|
+
* @namespace Flashphoner.constants.MEDIA_DEVICE_KIND
|
|
652
|
+
*/
|
|
653
|
+
export const MEDIA_DEVICE_KIND: Readonly<{
|
|
654
|
+
/**
|
|
655
|
+
* List local media output devices
|
|
656
|
+
* @see Flashphoner.getMediaDevices
|
|
657
|
+
* @memberOf Flashphoner.constants.MEDIA_DEVICE_KIND
|
|
658
|
+
*/
|
|
659
|
+
OUTPUT: string;
|
|
660
|
+
/**
|
|
661
|
+
* List local media input devices
|
|
662
|
+
* @see Flashphoner.getMediaDevices
|
|
663
|
+
* @memberOf Flashphoner.constants.MEDIA_DEVICE_KIND
|
|
664
|
+
*/
|
|
665
|
+
INPUT: string;
|
|
666
|
+
/**
|
|
667
|
+
* List local media devices
|
|
668
|
+
* @see Flashphoner.getMediaDevices
|
|
669
|
+
* @memberOf Flashphoner.constants.MEDIA_DEVICE_KIND
|
|
670
|
+
*/
|
|
671
|
+
ALL: string;
|
|
672
|
+
}>;
|
|
673
|
+
/**
|
|
674
|
+
* WebRTC transport type
|
|
675
|
+
* @namespace Flashphoner.constants.TRANSPORT_TYPE
|
|
676
|
+
*/
|
|
677
|
+
export const TRANSPORT_TYPE: Readonly<{
|
|
678
|
+
/**
|
|
679
|
+
* WebRTC RTP traffic goes over UDP (default)
|
|
680
|
+
* @see Stream
|
|
681
|
+
* @memberOf Flashphoner.constants.TRANSPORT_TYPE
|
|
682
|
+
*/
|
|
683
|
+
UDP: string;
|
|
684
|
+
/**
|
|
685
|
+
* WebRTC RTP traffic goes over TCP
|
|
686
|
+
* @see Stream
|
|
687
|
+
* @memberOf Flashphoner.constants.TRANSPORT_TYPE
|
|
688
|
+
*/
|
|
689
|
+
TCP: string;
|
|
690
|
+
}>;
|
|
691
|
+
/**
|
|
692
|
+
* WebRTC connection quality type
|
|
693
|
+
* @namespace Flashphoner.constants.CONNECTION_QUALITY
|
|
694
|
+
*/
|
|
695
|
+
export const CONNECTION_QUALITY: Readonly<{
|
|
696
|
+
/**
|
|
697
|
+
* Channel bandwidth is perfect
|
|
698
|
+
* @see Stream
|
|
699
|
+
* @memberOf Flashphoner.constants.CONNECTION_QUALITY
|
|
700
|
+
*/
|
|
701
|
+
PERFECT: string;
|
|
702
|
+
/**
|
|
703
|
+
* Channel bandwidth is good
|
|
704
|
+
* @see Stream
|
|
705
|
+
* @memberOf Flashphoner.constants.CONNECTION_QUALITY
|
|
706
|
+
*/
|
|
707
|
+
GOOD: string;
|
|
708
|
+
/**
|
|
709
|
+
* Channel bandwidth is bad
|
|
710
|
+
* @see Stream
|
|
711
|
+
* @memberOf Flashphoner.constants.CONNECTION_QUALITY
|
|
712
|
+
*/
|
|
713
|
+
BAD: string;
|
|
714
|
+
/**
|
|
715
|
+
* Channel bandwidth is unknown (initial state)
|
|
716
|
+
* @see Stream
|
|
717
|
+
* @memberOf Flashphoner.constants.CONNECTION_QUALITY
|
|
718
|
+
*/
|
|
719
|
+
UNKNOWN: string;
|
|
720
|
+
/**
|
|
721
|
+
* Channel bandwidth is updating
|
|
722
|
+
* @see Stream
|
|
723
|
+
* @memberOf Flashphoner.constants.CONNECTION_QUALITY
|
|
724
|
+
*/
|
|
725
|
+
UPDATE: string;
|
|
726
|
+
}>;
|
|
727
|
+
/**
|
|
728
|
+
* Websocket signaling stream event
|
|
729
|
+
* @see Stream
|
|
730
|
+
* @memberOf Flashphoner.constants
|
|
731
|
+
*/
|
|
732
|
+
export const STREAM_EVENT: "STREAM_EVENT";
|
|
733
|
+
/**
|
|
734
|
+
* Websocket signaling stream event type
|
|
735
|
+
* @namespace Flashphoner.constants.STREAM_EVENT_TYPE
|
|
736
|
+
*/
|
|
737
|
+
export const STREAM_EVENT_TYPE: Readonly<{
|
|
738
|
+
/**
|
|
739
|
+
* Stream audio is muted
|
|
740
|
+
* @see Stream
|
|
741
|
+
* @memberOf Flashphoner.constants.STREAM_EVENT_TYPE
|
|
742
|
+
*/
|
|
743
|
+
AUDIO_MUTED: string;
|
|
744
|
+
/**
|
|
745
|
+
* Stream audio is unmuted
|
|
746
|
+
* @see Stream
|
|
747
|
+
* @memberOf Flashphoner.constants.STREAM_EVENT_TYPE
|
|
748
|
+
*/
|
|
749
|
+
AUDIO_UNMUTED: string;
|
|
750
|
+
/**
|
|
751
|
+
* Stream video is muted
|
|
752
|
+
* @see Stream
|
|
753
|
+
* @memberOf Flashphoner.constants.STREAM_EVENT_TYPE
|
|
754
|
+
*/
|
|
755
|
+
VIDEO_MUTED: string;
|
|
756
|
+
/**
|
|
757
|
+
* Stream videoo is unmuted
|
|
758
|
+
* @see Stream
|
|
759
|
+
* @memberOf Flashphoner.constants.STREAM_EVENT_TYPE
|
|
760
|
+
*/
|
|
761
|
+
VIDEO_UNMUTED: string;
|
|
762
|
+
/**
|
|
763
|
+
* Data bound to the stream are received
|
|
764
|
+
* @see Stream
|
|
765
|
+
* @memberOf Flashphoner.constants.STREAM_EVENT_TYPE
|
|
766
|
+
*/
|
|
767
|
+
DATA: string;
|
|
768
|
+
}>;
|
|
769
|
+
/**
|
|
770
|
+
* WebRTC video content hint type
|
|
771
|
+
* @namespace Flashphoner.constants.CONTENT_HINT_TYPE
|
|
772
|
+
*/
|
|
773
|
+
export const CONTENT_HINT_TYPE: Readonly<{
|
|
774
|
+
/**
|
|
775
|
+
* Video content is motion (webcam case): keep FPS, resolution and bitrate may change
|
|
776
|
+
* @see Stream
|
|
777
|
+
* @memberOf Flashphoner.constants.CONTENT_HINT_TYPE
|
|
778
|
+
*/
|
|
779
|
+
MOTION: string;
|
|
780
|
+
/**
|
|
781
|
+
* Video content is detail (sreen sharing case): keep resolution, bitrate may change, FPS may drop
|
|
782
|
+
* @see Stream
|
|
783
|
+
* @memberOf Flashphoner.constants.CONTENT_HINT_TYPE
|
|
784
|
+
*/
|
|
785
|
+
DETAIL: string;
|
|
786
|
+
/**
|
|
787
|
+
* Video content is text (sreen sharing case): keep resolution and bitrate, FPS may drop
|
|
788
|
+
* @see Stream
|
|
789
|
+
* @memberOf Flashphoner.constants.CONTENT_HINT_TYPE
|
|
790
|
+
*/
|
|
791
|
+
TEXT: string;
|
|
792
|
+
}>;
|