@stream-io/video-client 0.6.7 → 0.6.9

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.
@@ -100,6 +100,45 @@ export interface AcceptCallResponse {
100
100
  */
101
101
  duration: string;
102
102
  }
103
+
104
+ /**
105
+ *
106
+ * @export
107
+ * @interface AudioFeedbackRequest
108
+ */
109
+ export interface AudioFeedbackRequest {
110
+ /**
111
+ *
112
+ * @type {boolean}
113
+ * @memberof AudioFeedbackRequest
114
+ */
115
+ cannot_hear_others?: boolean;
116
+ /**
117
+ *
118
+ * @type {boolean}
119
+ * @memberof AudioFeedbackRequest
120
+ */
121
+ choppy?: boolean;
122
+ /**
123
+ *
124
+ * @type {boolean}
125
+ * @memberof AudioFeedbackRequest
126
+ */
127
+ echo?: boolean;
128
+ /**
129
+ *
130
+ * @type {boolean}
131
+ * @memberof AudioFeedbackRequest
132
+ */
133
+ others_could_not_hear_me?: boolean;
134
+ /**
135
+ *
136
+ * @type {boolean}
137
+ * @memberof AudioFeedbackRequest
138
+ */
139
+ too_noisy?: boolean;
140
+ }
141
+
103
142
  /**
104
143
  *
105
144
  * @export
@@ -373,6 +412,37 @@ export interface CallAcceptedEvent {
373
412
  */
374
413
  user: UserResponse;
375
414
  }
415
+ /**
416
+ * CallClosedCaption represents a closed caption of a call.
417
+ * @export
418
+ * @interface CallClosedCaption
419
+ */
420
+ export interface CallClosedCaption {
421
+ /**
422
+ *
423
+ * @type {string}
424
+ * @memberof CallClosedCaption
425
+ */
426
+ end_time: string;
427
+ /**
428
+ *
429
+ * @type {string}
430
+ * @memberof CallClosedCaption
431
+ */
432
+ speaker_id: string;
433
+ /**
434
+ *
435
+ * @type {string}
436
+ * @memberof CallClosedCaption
437
+ */
438
+ start_time: string;
439
+ /**
440
+ *
441
+ * @type {string}
442
+ * @memberof CallClosedCaption
443
+ */
444
+ text: string;
445
+ }
376
446
  /**
377
447
  * This event is sent when a call is created. Clients receiving this event should check if the ringing
378
448
  * field is set to true and if so, show the call screen
@@ -1691,6 +1761,143 @@ export interface CallTimeline {
1691
1761
  */
1692
1762
  events: Array<CallEvent>;
1693
1763
  }
1764
+ /**
1765
+ * CallTranscription represents a transcription of a call.
1766
+ * @export
1767
+ * @interface CallTranscription
1768
+ */
1769
+ export interface CallTranscription {
1770
+ /**
1771
+ *
1772
+ * @type {string}
1773
+ * @memberof CallTranscription
1774
+ */
1775
+ end_time: string;
1776
+ /**
1777
+ *
1778
+ * @type {string}
1779
+ * @memberof CallTranscription
1780
+ */
1781
+ filename: string;
1782
+ /**
1783
+ *
1784
+ * @type {string}
1785
+ * @memberof CallTranscription
1786
+ */
1787
+ start_time: string;
1788
+ /**
1789
+ *
1790
+ * @type {string}
1791
+ * @memberof CallTranscription
1792
+ */
1793
+ url: string;
1794
+ }
1795
+ /**
1796
+ * This event is sent when call transcription has failed
1797
+ * @export
1798
+ * @interface CallTranscriptionFailedEvent
1799
+ */
1800
+ export interface CallTranscriptionFailedEvent {
1801
+ /**
1802
+ *
1803
+ * @type {string}
1804
+ * @memberof CallTranscriptionFailedEvent
1805
+ */
1806
+ call_cid: string;
1807
+ /**
1808
+ *
1809
+ * @type {string}
1810
+ * @memberof CallTranscriptionFailedEvent
1811
+ */
1812
+ created_at: string;
1813
+ /**
1814
+ * The type of event: "call.transcription_failed" in this case
1815
+ * @type {string}
1816
+ * @memberof CallTranscriptionFailedEvent
1817
+ */
1818
+ type: string;
1819
+ }
1820
+ /**
1821
+ * This event is sent when call transcription is ready
1822
+ * @export
1823
+ * @interface CallTranscriptionReadyEvent
1824
+ */
1825
+ export interface CallTranscriptionReadyEvent {
1826
+ /**
1827
+ *
1828
+ * @type {string}
1829
+ * @memberof CallTranscriptionReadyEvent
1830
+ */
1831
+ call_cid: string;
1832
+ /**
1833
+ *
1834
+ * @type {CallTranscription}
1835
+ * @memberof CallTranscriptionReadyEvent
1836
+ */
1837
+ call_transcription: CallTranscription;
1838
+ /**
1839
+ *
1840
+ * @type {string}
1841
+ * @memberof CallTranscriptionReadyEvent
1842
+ */
1843
+ created_at: string;
1844
+ /**
1845
+ * The type of event: "call.transcription_ready" in this case
1846
+ * @type {string}
1847
+ * @memberof CallTranscriptionReadyEvent
1848
+ */
1849
+ type: string;
1850
+ }
1851
+ /**
1852
+ * This event is sent when call transcription has started
1853
+ * @export
1854
+ * @interface CallTranscriptionStartedEvent
1855
+ */
1856
+ export interface CallTranscriptionStartedEvent {
1857
+ /**
1858
+ *
1859
+ * @type {string}
1860
+ * @memberof CallTranscriptionStartedEvent
1861
+ */
1862
+ call_cid: string;
1863
+ /**
1864
+ *
1865
+ * @type {string}
1866
+ * @memberof CallTranscriptionStartedEvent
1867
+ */
1868
+ created_at: string;
1869
+ /**
1870
+ * The type of event: "call.transcription_started" in this case
1871
+ * @type {string}
1872
+ * @memberof CallTranscriptionStartedEvent
1873
+ */
1874
+ type: string;
1875
+ }
1876
+ /**
1877
+ * This event is sent when call transcription has stopped
1878
+ * @export
1879
+ * @interface CallTranscriptionStoppedEvent
1880
+ */
1881
+ export interface CallTranscriptionStoppedEvent {
1882
+ /**
1883
+ *
1884
+ * @type {string}
1885
+ * @memberof CallTranscriptionStoppedEvent
1886
+ */
1887
+ call_cid: string;
1888
+ /**
1889
+ *
1890
+ * @type {string}
1891
+ * @memberof CallTranscriptionStoppedEvent
1892
+ */
1893
+ created_at: string;
1894
+ /**
1895
+ * The type of event: "call.transcription_stopped" in this case
1896
+ * @type {string}
1897
+ * @memberof CallTranscriptionStoppedEvent
1898
+ */
1899
+ type: string;
1900
+ }
1694
1901
  /**
1695
1902
  *
1696
1903
  * @export
@@ -1809,6 +2016,101 @@ export interface CallUserMuted {
1809
2016
  */
1810
2017
  type: string;
1811
2018
  }
2019
+
2020
+ /**
2021
+ *
2022
+ * @export
2023
+ * @interface CollectUserFeedbackRequest
2024
+ */
2025
+ export interface CollectUserFeedbackRequest {
2026
+ /**
2027
+ *
2028
+ * @type {AudioFeedbackRequest}
2029
+ * @memberof CollectUserFeedbackRequest
2030
+ */
2031
+ audio?: AudioFeedbackRequest;
2032
+ /**
2033
+ *
2034
+ * @type {boolean}
2035
+ * @memberof CollectUserFeedbackRequest
2036
+ */
2037
+ cannot_join_call?: boolean;
2038
+ /**
2039
+ *
2040
+ * @type {string}
2041
+ * @memberof CollectUserFeedbackRequest
2042
+ */
2043
+ other?: string;
2044
+ /**
2045
+ *
2046
+ * @type {number}
2047
+ * @memberof CollectUserFeedbackRequest
2048
+ */
2049
+ rating?: number;
2050
+ /**
2051
+ *
2052
+ * @type {ScreenshareFeedbackRequest}
2053
+ * @memberof CollectUserFeedbackRequest
2054
+ */
2055
+ screenshare?: ScreenshareFeedbackRequest;
2056
+ /**
2057
+ *
2058
+ * @type {string}
2059
+ * @memberof CollectUserFeedbackRequest
2060
+ */
2061
+ user_session_id?: string;
2062
+ /**
2063
+ *
2064
+ * @type {VideoFeedbackRequest}
2065
+ * @memberof CollectUserFeedbackRequest
2066
+ */
2067
+ video?: VideoFeedbackRequest;
2068
+ }
2069
+ /**
2070
+ *
2071
+ * @export
2072
+ * @interface CollectUserFeedbackResponse
2073
+ */
2074
+ export interface CollectUserFeedbackResponse {
2075
+ /**
2076
+ * Duration of the request in human-readable format
2077
+ * @type {string}
2078
+ * @memberof CollectUserFeedbackResponse
2079
+ */
2080
+ duration: string;
2081
+ }
2082
+
2083
+ /**
2084
+ * This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen
2085
+ * @export
2086
+ * @interface ClosedCaptionEvent
2087
+ */
2088
+ export interface ClosedCaptionEvent {
2089
+ /**
2090
+ *
2091
+ * @type {string}
2092
+ * @memberof ClosedCaptionEvent
2093
+ */
2094
+ call_cid: string;
2095
+ /**
2096
+ *
2097
+ * @type {CallClosedCaption}
2098
+ * @memberof ClosedCaptionEvent
2099
+ */
2100
+ closed_caption: CallClosedCaption;
2101
+ /**
2102
+ *
2103
+ * @type {string}
2104
+ * @memberof ClosedCaptionEvent
2105
+ */
2106
+ created_at: string;
2107
+ /**
2108
+ * The type of event: "call.closed_caption" in this case
2109
+ * @type {string}
2110
+ * @memberof ClosedCaptionEvent
2111
+ */
2112
+ type: string;
2113
+ }
1812
2114
  /**
1813
2115
  *
1814
2116
  * @export
@@ -1833,6 +2135,12 @@ export interface ConnectUserDetailsRequest {
1833
2135
  * @memberof ConnectUserDetailsRequest
1834
2136
  */
1835
2137
  image?: string;
2138
+ /**
2139
+ *
2140
+ * @type {string}
2141
+ * @memberof ConnectUserDetailsRequest
2142
+ */
2143
+ language?: string;
1836
2144
  /**
1837
2145
  *
1838
2146
  * @type {string}
@@ -2707,6 +3015,12 @@ export interface GoLiveRequest {
2707
3015
  * @memberof GoLiveRequest
2708
3016
  */
2709
3017
  start_transcription?: boolean;
3018
+ /**
3019
+ *
3020
+ * @type {string}
3021
+ * @memberof GoLiveRequest
3022
+ */
3023
+ transcription_storage_name?: string;
2710
3024
  }
2711
3025
  /**
2712
3026
  *
@@ -3090,6 +3404,25 @@ export interface ListRecordingsResponse {
3090
3404
  */
3091
3405
  recordings: Array<CallRecording>;
3092
3406
  }
3407
+ /**
3408
+ *
3409
+ * @export
3410
+ * @interface ListTranscriptionsResponse
3411
+ */
3412
+ export interface ListTranscriptionsResponse {
3413
+ /**
3414
+ *
3415
+ * @type {string}
3416
+ * @memberof ListTranscriptionsResponse
3417
+ */
3418
+ duration: string;
3419
+ /**
3420
+ *
3421
+ * @type {Array<CallTranscription>}
3422
+ * @memberof ListTranscriptionsResponse
3423
+ */
3424
+ transcriptions: Array<CallTranscription>;
3425
+ }
3093
3426
  /**
3094
3427
  *
3095
3428
  * @export
@@ -3988,6 +4321,39 @@ export interface SFUResponse {
3988
4321
  */
3989
4322
  ws_endpoint: string;
3990
4323
  }
4324
+
4325
+ /**
4326
+ *
4327
+ * @export
4328
+ * @interface ScreenshareFeedbackRequest
4329
+ */
4330
+ export interface ScreenshareFeedbackRequest {
4331
+ /**
4332
+ *
4333
+ * @type {boolean}
4334
+ * @memberof ScreenshareFeedbackRequest
4335
+ */
4336
+ blurry?: boolean;
4337
+ /**
4338
+ *
4339
+ * @type {boolean}
4340
+ * @memberof ScreenshareFeedbackRequest
4341
+ */
4342
+ could_not_present?: boolean;
4343
+ /**
4344
+ *
4345
+ * @type {boolean}
4346
+ * @memberof ScreenshareFeedbackRequest
4347
+ */
4348
+ could_not_see?: boolean;
4349
+ /**
4350
+ *
4351
+ * @type {boolean}
4352
+ * @memberof ScreenshareFeedbackRequest
4353
+ */
4354
+ slow_to_update?: boolean;
4355
+ }
4356
+
3991
4357
  /**
3992
4358
  *
3993
4359
  * @export
@@ -4160,6 +4526,19 @@ export interface StartRecordingResponse {
4160
4526
  */
4161
4527
  duration: string;
4162
4528
  }
4529
+ /**
4530
+ *
4531
+ * @export
4532
+ * @interface StartTranscriptionRequest
4533
+ */
4534
+ export interface StartTranscriptionRequest {
4535
+ /**
4536
+ *
4537
+ * @type {string}
4538
+ * @memberof StartTranscriptionRequest
4539
+ */
4540
+ transcription_external_storage?: string;
4541
+ }
4163
4542
  /**
4164
4543
  *
4165
4544
  * @export
@@ -4365,7 +4744,13 @@ export interface TranscriptionSettings {
4365
4744
  */
4366
4745
  closed_caption_mode: string;
4367
4746
  /**
4368
- *
4747
+ * omitempty,max=2,dive,oneof= en, fr, es, de, it, nl, pt, pl, ca, cs, da, el, fi, id, ja, ru, sv, ta, th, tr, hu, ro, zh, ar, tl, he, hi, hr, ko, ms, no, uk
4748
+ * @type {Array<string>}
4749
+ * @memberof TranscriptionSettings
4750
+ */
4751
+ languages: Array<string>;
4752
+ /**
4753
+ * oneof=available disabled auto-on
4369
4754
  * @type {string}
4370
4755
  * @memberof TranscriptionSettings
4371
4756
  */
@@ -4396,7 +4781,13 @@ export interface TranscriptionSettingsRequest {
4396
4781
  */
4397
4782
  closed_caption_mode?: string;
4398
4783
  /**
4399
- *
4784
+ * omitempty,max=2,dive,oneof= en, fr, es, de, it, nl, pt, pl, ca, cs, da, el, fi, id, ja, ru, sv, ta, th, tr, hu, ro, zh, ar, tl, he, hi, hr, ko, ms, no, uk
4785
+ * @type {Array<string>}
4786
+ * @memberof TranscriptionSettingsRequest
4787
+ */
4788
+ languages?: Array<string>;
4789
+ /**
4790
+ * oneof=available disabled auto-on
4400
4791
  * @type {string}
4401
4792
  * @memberof TranscriptionSettingsRequest
4402
4793
  */
@@ -4982,6 +5373,7 @@ export interface UserStats {
4982
5373
  export type VideoEvent =
4983
5374
  | ({ type: 'call.accepted' } & CallAcceptedEvent)
4984
5375
  | ({ type: 'call.blocked_user' } & BlockedUserEvent)
5376
+ | ({ type: 'call.closed_caption' } & ClosedCaptionEvent)
4985
5377
  | ({ type: 'call.created' } & CallCreatedEvent)
4986
5378
  | ({ type: 'call.ended' } & CallEndedEvent)
4987
5379
  | ({ type: 'call.hls_broadcasting_failed' } & CallHLSBroadcastingFailedEvent)
@@ -5016,6 +5408,10 @@ export type VideoEvent =
5016
5408
  type: 'call.session_participant_left';
5017
5409
  } & CallSessionParticipantLeftEvent)
5018
5410
  | ({ type: 'call.session_started' } & CallSessionStartedEvent)
5411
+ | ({ type: 'call.transcription_failed' } & CallTranscriptionFailedEvent)
5412
+ | ({ type: 'call.transcription_ready' } & CallTranscriptionReadyEvent)
5413
+ | ({ type: 'call.transcription_started' } & CallTranscriptionStartedEvent)
5414
+ | ({ type: 'call.transcription_stopped' } & CallTranscriptionStoppedEvent)
5019
5415
  | ({ type: 'call.unblocked_user' } & UnblockedUserEvent)
5020
5416
  | ({ type: 'call.updated' } & CallUpdatedEvent)
5021
5417
  | ({ type: 'call.user_muted' } & CallUserMuted)
@@ -5023,6 +5419,46 @@ export type VideoEvent =
5023
5419
  | ({ type: 'connection.ok' } & ConnectedEvent)
5024
5420
  | ({ type: 'custom' } & CustomVideoEvent)
5025
5421
  | ({ type: 'health.check' } & HealthCheckEvent);
5422
+
5423
+ /**
5424
+ *
5425
+ * @export
5426
+ * @interface VideoFeedbackRequest
5427
+ */
5428
+ export interface VideoFeedbackRequest {
5429
+
5430
+ /**
5431
+ *
5432
+ * @type {boolean}
5433
+ * @memberof VideoFeedbackRequest
5434
+ */
5435
+ blurry?: boolean;
5436
+ /**
5437
+ *
5438
+ * @type {boolean}
5439
+ * @memberof VideoFeedbackRequest
5440
+ */
5441
+ camera_not_working?: boolean;
5442
+ /**
5443
+ *
5444
+ * @type {boolean}
5445
+ * @memberof VideoFeedbackRequest
5446
+ */
5447
+ could_not_see_others?: boolean;
5448
+ /**
5449
+ *
5450
+ * @type {boolean}
5451
+ * @memberof VideoFeedbackRequest
5452
+ */
5453
+ freezing?: boolean;
5454
+ /**
5455
+ *
5456
+ * @type {boolean}
5457
+ * @memberof VideoFeedbackRequest
5458
+ */
5459
+ video_audio_out_of_sync?: boolean;
5460
+ }
5461
+
5026
5462
  /**
5027
5463
  *
5028
5464
  * @export
@@ -369,7 +369,6 @@ export class DynascaleManager {
369
369
  // play audio through the system's default device
370
370
  const { selectedDevice } = this.call.speaker.state;
371
371
  if (selectedDevice && 'setSinkId' in audioElement) {
372
- // @ts-expect-error setSinkId is not yet in the lib
373
372
  audioElement.setSinkId(selectedDevice);
374
373
  }
375
374
  }
@@ -380,7 +379,6 @@ export class DynascaleManager {
380
379
  ? null
381
380
  : this.call.speaker.state.selectedDevice$.subscribe((deviceId) => {
382
381
  if (deviceId) {
383
- // @ts-expect-error setSinkId is not yet in the lib
384
382
  audioElement.setSinkId(deviceId);
385
383
  }
386
384
  });
@@ -405,9 +405,14 @@ export class CallState {
405
405
 
406
406
  this.eventHandlers = {
407
407
  // these events are not updating the call state:
408
+ 'call.closed_caption': undefined,
408
409
  'call.permission_request': undefined,
409
410
  'call.recording_failed': undefined,
410
411
  'call.recording_ready': undefined,
412
+ 'call.transcription_started': undefined,
413
+ 'call.transcription_stopped': undefined,
414
+ 'call.transcription_ready': undefined,
415
+ 'call.transcription_failed': undefined,
411
416
  'call.user_muted': undefined,
412
417
  'connection.error': undefined,
413
418
  'connection.ok': undefined,