@opentok/client 2.22.1 → 2.22.4

package/dist/js/opentok.d.ts

@@ -78,6 +78,7 @@ declare namespace OT {
     frameRate?: 30 | 15 | 7 | 1;
     maxResolution?: Dimensions;
     resolution?: (
+      '1920x1080' |
       '1280x960' |
       '1280x720' |
       '640x480' |
@@ -90,6 +91,13 @@ declare namespace OT {
 
   export type VideoContentHint = "text" | "detail" | "motion" | "";
 
+  export type BackgroundBlurFilter = {
+    type: 'backgroundBlur';
+    blurStrength?: 'low' | 'high';
+  };
+
+  export type VideoFilter = BackgroundBlurFilter;
+
   export type PublisherProperties = WidgetProperties & GetUserMediaProperties & {
     audioBitrate?: number;
     audioFallbackEnabled?: boolean;
@@ -97,9 +105,12 @@ declare namespace OT {
     name?: string;
     publishAudio?: boolean;
     publishVideo?: boolean;
+    publishCaptions?: boolean;
+    scalableScreenshare?: boolean;
     style?: Partial<PublisherStyle>;
     videoContentHint?: VideoContentHint;
     enableDtx?: boolean;
+    videoFilter?: VideoFilter;
   };
 
   export type SubscriberStyle = WidgetStyle & {
@@ -135,7 +146,7 @@ declare namespace OT {
       width: number;
       height: number;
     };
-    videoType: 'camera' | 'screen';
+    videoType: 'camera' | 'screen' | 'custom' | undefined;
   }
 
   export type Event<Type, Target> = {
@@ -255,8 +266,12 @@ declare namespace OT {
     getStats(callback: (error?: OTError, stats?: PublisherStatsArr) => void): void;
     getRtcStatsReport(): Promise<PublisherRtcStatsReportArr>;
     getStyle(): PublisherProperties;
+    applyVideoFilter(videoFilter: VideoFilter): Promise<void>;
+    getVideoFilter(): VideoFilter | null;
+    clearVideoFilter(): Promise<void>;
     publishAudio(value: boolean): void;
     publishVideo(value: boolean): void;
+    publishCaptions(value: boolean): void;
     cycleVideo(): Promise<{ deviceId: string }>;
     setAudioSource(audioSource:string | MediaStreamTrack): Promise<undefined>;
     getAudioSource(): MediaStreamTrack;
@@ -331,7 +346,7 @@ declare namespace OT {
     signal: Event<'signal', Session> & {
       type?: string;
       data?: string;
-      from: Connection;
+      from: Connection | null;
     };
 
     streamCreated: Event<'streamCreated', Session> & {
@@ -458,6 +473,11 @@ declare namespace OT {
 
     connected: Event<'connected', Subscriber>;
 
+    captionReceived: Event<'captionReceived', Subscriber> & {
+      streamId: string;
+      caption: string;
+    };
+
     destroyed: Event<'destroyed', Subscriber> & {
       reason: string;
     };
@@ -487,6 +507,9 @@ declare namespace OT {
     getImgData(): string | null;
     getStats(callback: (error?: OTError, stats?: SubscriberStats) => void): void;
     getRtcStatsReport(): Promise<RTCStatsReport>;
+    subscribeToCaptions(value: boolean): Promise<void>;
+    isSubscribedToCaptions(): boolean;
+    isAudioBlocked(): boolean;
     restrictFrameRate(value: boolean): void;
     setAudioVolume(volume: number): void;
     setPreferredFrameRate(frameRate: number): void;