agora-electron-sdk 4.2.6 → 4.3.0-dev.1

package/types/Types.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" />
-import { RenderModeType, VideoSourceType } from './Private/AgoraMediaBase';
-import { IRenderer, IRendererManager } from './Renderer';
+import { VideoCanvas } from './Private/AgoraBase';
+import { VideoFrame } from './Private/AgoraMediaBase';
+import { RtcConnection } from './Private/IAgoraRtcEngineEx';
+import { IRendererManager } from './Renderer';
 /**
  * @ignore
  */
@@ -34,49 +36,7 @@ export interface AgoraEnvType extends AgoraEnvOptions {
 /**
  * @ignore
  */
-export interface CanvasOptions {
-    /**
-     * @ignore
-     */
-    frameWidth: number;
-    /**
-     * @ignore
-     */
-    frameHeight: number;
-    /**
-     * @ignore
-     */
-    rotation: number;
-    /**
-     * @ignore
-     */
-    contentMode: RenderModeType;
-    /**
-     * @ignore
-     */
-    clientWidth: number;
-    /**
-     * @ignore
-     */
-    clientHeight: number;
-}
-/**
- * @ignore
- */
-export interface RendererOptions {
-    /**
-     * @ignore
-     */
-    contentMode?: RenderModeType;
-    /**
-     * @ignore
-     */
-    mirror?: boolean;
-}
-/**
- * @ignore
- */
-export declare enum RENDER_MODE {
+export declare enum RendererType {
     /**
      * @ignore
      */
@@ -86,124 +46,9 @@ export declare enum RENDER_MODE {
      */
     SOFTWARE = 2
 }
-export type User = 'local' | 'videoSource' | number | string;
-export type Channel = '' | string;
-/**
- * @ignore
- */
-export interface RendererVideoConfig {
-    /**
-     * @ignore
-     */
-    videoSourceType?: VideoSourceType;
-    /**
-     * @ignore
-     */
-    channelId?: Channel;
-    /**
-     * @ignore
-     */
-    uid?: number;
-    /**
-     * @ignore
-     */
-    view?: HTMLElement;
-    /**
-     * @ignore
-     */
-    rendererOptions?: RendererOptions;
-}
-/**
- * @ignore
- */
-export interface FormatRendererVideoConfig {
-    /**
-     * @ignore
-     */
-    videoSourceType: VideoSourceType;
-    /**
-     * @ignore
-     */
-    channelId: Channel;
-    /**
-     * @ignore
-     */
-    uid: number;
-    /**
-     * @ignore
-     */
-    view?: HTMLElement;
-    /**
-     * @ignore
-     */
-    rendererOptions: RendererOptions;
-}
-/**
- * @ignore
- */
-export interface VideoFrameCacheConfig {
-    /**
-     * @ignore
-     */
-    uid: number;
-    /**
-     * @ignore
-     */
-    channelId: string;
-    /**
-     * @ignore
-     */
-    videoSourceType: VideoSourceType;
-}
-/**
- * @ignore
- */
-export interface ShareVideoFrame {
-    /**
-     * @ignore
-     */
-    width: number;
-    /**
-     * @ignore
-     */
-    height: number;
-    /**
-     * @ignore
-     */
-    yStride: number;
-    /**
-     * @ignore
-     */
-    yBuffer: Buffer | Uint8Array;
-    /**
-     * @ignore
-     */
-    uBuffer: Buffer | Uint8Array;
-    /**
-     * @ignore
-     */
-    vBuffer: Buffer | Uint8Array;
-    /**
-     * @ignore
-     */
-    mirror?: boolean;
-    /**
-     * @ignore
-     */
-    rotation?: number;
-    /**
-     * @ignore
-     */
-    uid?: number;
-    /**
-     * @ignore
-     */
-    channelId?: string;
-    /**
-     * @ignore
-     */
-    videoSourceType?: VideoSourceType;
-}
+export type RENDER_MODE = RendererType;
+export type RendererContext = VideoCanvas & RtcConnection;
+export type RendererCacheContext = Pick<RendererContext, 'channelId' | 'uid' | 'sourceType'>;
 /**
  * @ignore
  */
@@ -229,34 +74,13 @@ export interface AgoraElectronBridge {
     InitializeEnv(): void;
     ReleaseEnv(): void;
     ReleaseRenderer(): void;
-    EnableVideoFrameCache(config: VideoFrameCacheConfig): void;
-    DisableVideoFrameCache(config: VideoFrameCacheConfig): void;
+    EnableVideoFrameCache(context: RendererCacheContext): void;
+    DisableVideoFrameCache(context: RendererCacheContext): void;
     GetBuffer(ptr: number, length: number): Buffer;
-    GetVideoFrame(streamInfo: ShareVideoFrame): {
+    GetVideoFrame(context: RendererCacheContext, videoFrame: VideoFrame): {
         ret: number;
         isNewFrame: boolean;
-        yStride: number;
-        width: number;
-        height: number;
-        rotation: number;
-        timestamp: number;
     };
     sendMsg: (funcName: string, params: any, buffer?: Uint8Array[], bufferCount?: number) => Result;
 }
-/**
- * @ignore
- */
-export interface RenderConfig {
-    /**
-     * @ignore
-     */
-    renders: IRenderer[];
-    /**
-     * @ignore
-     */
-    shareVideoFrame: ShareVideoFrame;
-}
-export type UidMap = Map<number, RenderConfig>;
-export type ChannelIdMap = Map<Channel, UidMap>;
-export type RenderMap = Map<VideoSourceType, ChannelIdMap>;
 //# sourceMappingURL=Types.d.ts.map

package/types/Types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../ts/Types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IACzC;;OAEG;IACH,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,cAAc,CAAC;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,QAAQ,IAAI;CACb;AAED,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7D,MAAM,MAAM,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CACL,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,CACR,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,EAAE,EACpB,YAAY,EAAE,MAAM,EAAE,EACtB,WAAW,EAAE,MAAM,KAChB,IAAI,GACR,IAAI,CAAC;IAER,OAAO,CACL,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,GAAG,EACX,MAAM,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,EACnC,WAAW,CAAC,EAAE,MAAM,GACnB,MAAM,CAAC;IAEV,aAAa,IAAI,IAAI,CAAC;IAEtB,UAAU,IAAI,IAAI,CAAC;IAEnB,eAAe,IAAI,IAAI,CAAC;IAExB,qBAAqB,CAAC,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE3D,sBAAsB,CAAC,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE5D,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAE/C,aAAa,CAAC,UAAU,EAAE,eAAe,GAAG;QAC1C,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF,OAAO,EAAE,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,GAAG,EACX,MAAM,CAAC,EAAE,UAAU,EAAE,EACrB,WAAW,CAAC,EAAE,MAAM,KACjB,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,MAAM,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAC/C,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAChD,MAAM,MAAM,SAAS,GAAG,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC"}
+{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../ts/Types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IACzC;;OAEG;IACH,oBAAoB,CAAC,EAAE,gBAAgB,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,QAAQ,IAAI;CACb;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,aAAa,CAAC;AAE1D,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,eAAe,EACf,WAAW,GAAG,KAAK,GAAG,YAAY,CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CACL,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,CACR,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,EAAE,EACpB,YAAY,EAAE,MAAM,EAAE,EACtB,WAAW,EAAE,MAAM,KAChB,IAAI,GACR,IAAI,CAAC;IAER,OAAO,CACL,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,GAAG,EACX,MAAM,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,EACnC,WAAW,CAAC,EAAE,MAAM,GACnB,MAAM,CAAC;IAEV,aAAa,IAAI,IAAI,CAAC;IAEtB,UAAU,IAAI,IAAI,CAAC;IAEnB,eAAe,IAAI,IAAI,CAAC;IAExB,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE3D,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE5D,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAE/C,aAAa,CACX,OAAO,EAAE,oBAAoB,EAC7B,UAAU,EAAE,UAAU,GACrB;QACD,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;IAEF,OAAO,EAAE,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,GAAG,EACX,MAAM,CAAC,EAAE,UAAU,EAAE,EACrB,WAAW,CAAC,EAAE,MAAM,KACjB,MAAM,CAAC;CACb"}

package/types/Utils.d.ts

@@ -1,5 +1,4 @@
-import { VideoSourceType } from './Private/AgoraMediaBase';
-import { AgoraEnvType, FormatRendererVideoConfig, RendererVideoConfig } from './Types';
+import { AgoraEnvType } from './Types';
 /**
  * @ignore
  */
@@ -8,10 +7,6 @@ export declare const TAG = "[Agora]: ";
  * @ignore
  */
 export declare const DEBUG_TAG = "[Agora Debug]: ";
-/**
- * @ignore
- */
-export declare const deprecate: (originApi?: string, replaceApi?: string) => void;
 /**
  * @ignore
  */
@@ -28,10 +23,6 @@ export declare const logInfo: (msg: string, ...optParams: any[]) => void;
  * @ignore
  */
 export declare const logDebug: (msg: string, ...optParams: any[]) => void;
-/**
- * @ignore
- */
-export declare const parseJSON: (jsonString: string) => any;
 /**
  * @ignore
  */
@@ -39,19 +30,11 @@ export declare const objsKeysToLowerCase: (array: Array<any>) => void;
 /**
  * @ignore
  */
-export declare const formatConfigByVideoSourceType: (videoSourceType?: VideoSourceType, originChannelId?: string, originUid?: number) => {
-    uid: number;
-    channelId: string;
-    videoSourceType: VideoSourceType;
-};
-/**
- * @ignore
- */
-export declare const getDefaultRendererVideoConfig: (config: RendererVideoConfig) => FormatRendererVideoConfig;
+export declare function classMix(...mixins: any[]): any;
 /**
  * @ignore
  */
-export declare function classMix(...mixins: any[]): any;
+export declare function isSupportWebGL(): boolean;
 /**
  * @ignore
  */

package/types/Utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../ts/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,eAAO,MAAM,GAAG,cAAc,CAAC;AAC/B;;GAEG;AACH,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,SAAS,eAAgB,MAAM,eAAe,MAAM,SAI9D,CAAC;AAEJ;;GAEG;AACH,eAAO,MAAM,OAAO,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,eAAgB,MAAM,QAW3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,UAAW,MAAM,GAAG,CAAC,SASpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,qBACtB,eAAe;SAI5B,MAAM;eACA,MAAM;qBACA,eAAe;CAgCjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,WAChC,mBAAmB,KAC1B,yBAcF,CAAC;AAEF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAe9C;AAaD;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,YAKtB,CAAC"}
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../ts/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,GAAG,cAAc,CAAC;AAC/B;;GAEG;AACH,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,OAAO,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAS,MAAM,gBAAgB,GAAG,EAAE,SAKxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,UAAW,MAAM,GAAG,CAAC,SASpD,CAAC;AAEF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAe9C;AAWD;;GAEG;AACH,wBAAgB,cAAc,IAAI,OAAO,CA0BxC;AAID;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,YAKtB,CAAC"}