@voicenter-team/opensips-js 1.0.99 → 1.0.100

package/dist/index.d.ts

@@ -302,6 +302,13 @@ declare type CommonLogMethodType = (...args: unknown[]) => void
 
 declare type conferenceStartListener = () => void
 
+declare const CONFERENCING_MODE: {
+    WHITEBOARD: string;
+    IMAGE_WHITEBOARD: string;
+};
+
+declare type ConferencingModeType = typeof CONFERENCING_MODE[keyof typeof CONFERENCING_MODE];
+
 declare type connectionListener = (value: boolean) => void
 
 declare interface ConnectOptions {
@@ -434,6 +441,12 @@ declare interface JanusSessionEventMap {
     'peerconnection:setremotedescriptionfailed': Listener_2;
 }
 
+declare type KonvaDrawerOptions = {
+    strokeWidth?: number
+    strokeColor?: string
+    emptyDrawerRectColor?: string
+}
+
 declare type Listener = (event: unknown) => void
 
 declare type Listener_2 = (event: unknown) => void
@@ -446,6 +459,8 @@ declare type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | Inco
 
 declare type ListenersKeyType = keyof OpenSIPSEventMap
 
+declare type MaskEffectTypeConfigType = 'bokehEffect' | 'backgroundImageEffect';
+
 declare type memberHangupListener = (event: object) => void
 
 declare type memberJoinListener = (event: object) => void
@@ -776,6 +791,10 @@ declare interface OutgoingMSRPSessionEvent {
 
 declare type OutgoingMSRPSessionListener = (event: OutgoingMSRPSessionEvent) => void;
 
+declare interface PluginConfig {
+    immediate: boolean;
+}
+
 declare type readyListener = (value: boolean) => void
 
 declare interface RemoteIdentityCallType {
@@ -836,6 +855,53 @@ declare interface RTCSessionExtended extends RTCSession {
     init_icncoming(request: IncomingRequest): void
 }
 
+export declare class ScreenSharePlugin extends BaseNewStreamPlugin {
+    constructor();
+    generateStream(): Promise<MediaStream>;
+    kill(): Promise<void>;
+}
+
+declare interface ScreenShareWhiteboardOptions {
+    selectors: ScreenShareWhiteboardSelectors;
+}
+
+export declare class ScreenShareWhiteBoardPlugin extends BaseProcessStreamPlugin {
+    private static video;
+    private static wrapperEl;
+    private static screenShareKonvaDrawer;
+    private static initialStream;
+    private imageSrc;
+    private konvaDrawer;
+    mode: ConferencingModeType;
+    private screenSharePlugin;
+    private selectors;
+    constructor(screenSharePlugin: any, options?: Partial<ScreenShareWhiteboardOptions>);
+    private createVideoElement;
+    private getAspectRatioDimensions;
+    /**
+     * Starts stream processing to add mask effect for it
+     * This method is useful in cases like drawing over the screen share as we
+     * already have a screen share stream and there is no need to create another one
+     * @param {MediaStream} stream
+     * @return {MediaStream} processed stream with mask effect
+     */
+    start(stream: any): Promise<MediaStream>;
+    /**
+     * Stops stream processing
+     */
+    stop(): any;
+    setupScreenShareDrawerOptions(options: KonvaDrawerOptions): void;
+}
+
+declare interface ScreenShareWhiteboardSelectors {
+    container: string;
+    compositeCanvasContainer: string;
+    compositeCanvas: string;
+    drawerContainer: string;
+    videoElement: string;
+    videoElementContainer: string;
+}
+
 declare type startBlurListener = () => void
 
 declare type startScreenShareListener = (event: MediaStream) => void
@@ -844,6 +910,68 @@ declare type stopBlurListener = () => void
 
 declare type stopScreenShareListener = () => void
 
+declare interface StreamMaskOptions {
+    effect: MaskEffectTypeConfigType;
+    base64Image?: string;
+    visualizationConfig?: VisualizationConfigType;
+}
+
+export declare class StreamMaskPlugin extends BaseProcessStreamPlugin {
+    private visualizationConfig;
+    private maskEffectType;
+    private base64ImageMask;
+    private rafId;
+    private timeoutId;
+    private segmenter;
+    private camera;
+    private canvas;
+    private ctx;
+    private visibilityState;
+    constructor(options: StreamMaskOptions, pluginConfig?: PluginConfig);
+    /**
+     * Starts stream processing to add mask effect for it
+     * @param {MediaStream} stream
+     * @param {'bokehEffect' | 'backgroundImageEffect'} effect - defines the mask effect type
+     * @param {MediaStreamConstraints} options - media stream constraints
+     * @param {object} options - (optional) additional mask effect options
+     * @return {MediaStream} processed stream with mask effect
+     */
+    start(stream: any): Promise<MediaStream>;
+    /**
+     * Listens to visibility change (like switching active tab)
+     * and switches between different kinds of requestAnimationFrame
+     */
+    private processVisibilityChange;
+    /**
+     * Adds audio tracks to MediaStream which contains only video tracks
+     * @param {MediaStream} stream - stream with only video tracks
+     * @param {MediaStreamConstraints} options - media stream constraints
+     * @return {MediaStream} combined stream with both audio and video tracks
+     */
+    private populateWithAudioTracks;
+    /**
+     * Stops stream processing
+     */
+    stop(): void;
+    setupVisualizationConfig(config: VisualizationConfigType): void;
+    /**
+     * Starts rendering process by calling itself recursively.
+     * Uses requestAnimationFrame method for recursive invoking.
+     */
+    private renderPrediction;
+    /**
+     * Creates Body Segmenter which is used for people segmentation and poses estimation
+     * @return {segmenter} segmenter instance
+     */
+    private createSegmenter;
+    /**
+     * Render function which draws masked effect to canvas.
+     */
+    private renderResult;
+    private applyBokehEffect;
+    private applyBackgroundImageEffect;
+}
+
 declare interface StreamMediaType extends HTMLAudioElement {
     className: string
     setSinkId (id: string): Promise<void>
@@ -957,6 +1085,15 @@ declare class VideoModule {
 
 declare type VideoModuleName = typeof MODULES.VIDEO
 
+declare type VisualizationConfigType = {
+    foregroundThreshold?: number;
+    maskOpacity?: number;
+    maskBlur?: number;
+    pixelCellWidth?: number;
+    backgroundBlur?: number;
+    edgeBlur?: number;
+};
+
 declare interface WebrtcMetricsConfigType {
     refreshEvery?: number
     startAfter?: number
@@ -969,4 +1106,31 @@ declare interface WebrtcMetricsConfigType {
     ticket?: boolean
 }
 
+declare interface WhiteboardElementSelectors {
+    container: string;
+    drawerContainer: string;
+}
+
+declare interface WhiteboardOptions {
+    mode: ConferencingModeType;
+    imageSrc?: string;
+    selectors: Partial<WhiteboardElementSelectors>;
+}
+
+export declare class WhiteBoardPlugin extends BaseNewStreamPlugin {
+    private visualizationConfig;
+    private rafId;
+    private imageSrc;
+    private konvaDrawer;
+    private selectors;
+    mode: ConferencingModeType;
+    constructor(options: WhiteboardOptions);
+    setupDrawerOptions(options: KonvaDrawerOptions): void;
+    setupDrawerImage(imageSrc: any): void;
+    private drawEmptyWhiteboard;
+    private drawImageWhiteboard;
+    generateStream(): Promise<void>;
+    kill(): Promise<void>;
+}
+
 export { }