agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/ts/Private/ti/IAgoraRtcEngine-ti.ts

@@ -14,17 +14,17 @@ export const IRtcEngineEventHandler = t.iface([], {
   "onAudioVolumeIndication": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("speakers", t.array("AudioVolumeInfo")), t.param("speakerNumber", "number"), t.param("totalVolume", "number"))),
   "onLeaveChannel": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("stats", "RtcStats"))),
   "onRtcStats": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("stats", "RtcStats"))),
-  "onAudioDeviceStateChanged": t.opt(t.func("void", t.param("deviceId", "string"), t.param("deviceType", "MediaDeviceType"), t.param("deviceState", "number"))),
+  "onAudioDeviceStateChanged": t.opt(t.func("void", t.param("deviceId", "string"), t.param("deviceType", "MediaDeviceType"), t.param("deviceState", "MediaDeviceStateType"))),
   "onAudioMixingPositionChanged": t.opt(t.func("void", t.param("position", "number"))),
   "onAudioMixingFinished": t.opt(t.func("void")),
   "onAudioEffectFinished": t.opt(t.func("void", t.param("soundId", "number"))),
-  "onVideoDeviceStateChanged": t.opt(t.func("void", t.param("deviceId", "string"), t.param("deviceType", "MediaDeviceType"), t.param("deviceState", "number"))),
+  "onVideoDeviceStateChanged": t.opt(t.func("void", t.param("deviceId", "string"), t.param("deviceType", "MediaDeviceType"), t.param("deviceState", "MediaDeviceStateType"))),
   "onNetworkQuality": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("txQuality", "QualityType"), t.param("rxQuality", "QualityType"))),
   "onIntraRequestReceived": t.opt(t.func("void", t.param("connection", "RtcConnection"))),
   "onUplinkNetworkInfoUpdated": t.opt(t.func("void", t.param("info", "UplinkNetworkInfo"))),
   "onDownlinkNetworkInfoUpdated": t.opt(t.func("void", t.param("info", "DownlinkNetworkInfo"))),
   "onLastmileQuality": t.opt(t.func("void", t.param("quality", "QualityType"))),
-  "onFirstLocalVideoFrame": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("width", "number"), t.param("height", "number"), t.param("elapsed", "number"))),
+  "onFirstLocalVideoFrame": t.opt(t.func("void", t.param("source", "VideoSourceType"), t.param("width", "number"), t.param("height", "number"), t.param("elapsed", "number"))),
   "onFirstLocalVideoFramePublished": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("elapsed", "number"))),
   "onFirstRemoteVideoDecoded": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("width", "number"), t.param("height", "number"), t.param("elapsed", "number"))),
   "onVideoSizeChanged": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("sourceType", "VideoSourceType"), t.param("uid", "number"), t.param("width", "number"), t.param("height", "number"), t.param("rotation", "number"))),
@@ -38,7 +38,6 @@ export const IRtcEngineEventHandler = t.iface([], {
   "onUserEnableVideo": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("enabled", "boolean"))),
   "onUserStateChanged": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("state", "number"))),
   "onUserEnableLocalVideo": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("enabled", "boolean"))),
-  "onApiCallExecuted": t.opt(t.func("void", t.param("err", "ErrorCodeType"), t.param("api", "string"), t.param("result", "string"))),
   "onLocalAudioStats": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("stats", "LocalAudioStats"))),
   "onRemoteAudioStats": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("stats", "RemoteAudioStats"))),
   "onLocalVideoStats": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("stats", "LocalVideoStats"))),
@@ -97,6 +96,7 @@ export const IRtcEngineEventHandler = t.iface([], {
   "onExtensionStopped": t.opt(t.func("void", t.param("provider", "string"), t.param("extension", "string"))),
   "onExtensionError": t.opt(t.func("void", t.param("provider", "string"), t.param("extension", "string"), t.param("error", "number"), t.param("message", "string"))),
   "onUserAccountUpdated": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("remoteUid", "number"), t.param("userAccount", "string"))),
+  "onLocalVideoTranscoderError": t.opt(t.func("void", t.param("stream", "TranscodingVideoStream"), t.param("error", "VideoTranscoderError"))),
   "onVideoRenderingTracingResult": t.opt(t.func("void", t.param("connection", "RtcConnection"), t.param("uid", "number"), t.param("currentEvent", "MediaTraceEvent"), t.param("tracingInfo", "VideoRenderingTracingInfo"))),
 });
 

package/ts/Renderer/AgoraView.ts

@@ -1,6 +1,5 @@
-import { VideoSourceType } from '../Private/AgoraBase';
-import { RenderModeType } from '../Private/AgoraMediaBase';
-import AgoraRendererManager from './RendererManager';
+import { RenderModeType, VideoSourceType } from '../Private/AgoraMediaBase';
+import { AgoraEnv } from '../Utils';
 
 const VIDEO_SOURCE_TYPE_STRING = 'video-source-type';
 const UID_STRING = 'uid';
@@ -83,6 +82,7 @@ export default class AgoraView extends HTMLElement {
       this.removeAttribute(VIDEO_SOURCE_TYPE_STRING);
     }
   }
+
   get uid(): number {
     const number = Number(this.getAttribute(UID_STRING));
     return isNaN(number) ? 0 : number;
@@ -95,6 +95,7 @@ export default class AgoraView extends HTMLElement {
       this.removeAttribute(UID_STRING);
     }
   }
+
   get channelId(): string {
     return this.getAttribute(CHANNEL_ID_STRING) || '';
   }
@@ -122,6 +123,7 @@ export default class AgoraView extends HTMLElement {
       this.removeAttribute(RENDERER_CONTENT_MODE_STRING);
     }
   }
+
   get renderMirror(): boolean {
     return this.getAttribute(RENDERER_MIRROR_STRING) === 'true';
   }
@@ -137,9 +139,10 @@ export default class AgoraView extends HTMLElement {
   constructor() {
     super();
   }
+
   initializeRender = () => {
-    AgoraRendererManager.destroyRendererByView(this);
-    AgoraRendererManager.setupVideo({
+    AgoraEnv.AgoraRendererManager?.destroyRendererByView(this);
+    AgoraEnv.AgoraRendererManager?.setupVideo({
       videoSourceType: this.videoSourceType,
       view: this,
       uid: this.uid,
@@ -150,8 +153,9 @@ export default class AgoraView extends HTMLElement {
       },
     });
   };
+
   destroyRender = () => {
-    AgoraRendererManager.destroyRendererByView(this);
+    AgoraEnv.AgoraRendererManager?.destroyRendererByView(this);
   };
 
   connectedCallback() {
@@ -169,7 +173,7 @@ export default class AgoraView extends HTMLElement {
     ].includes(attrName);
 
     if (isSetRenderOption) {
-      AgoraRendererManager.setRenderOption(
+      AgoraEnv.AgoraRendererManager?.setRenderOption(
         this,
         this.renderContentMode,
         this.renderMirror
@@ -182,6 +186,7 @@ export default class AgoraView extends HTMLElement {
     }
     this.initializeRender();
   }
+
   disconnectedCallback() {
     this.isConnectedCallback = false;
     this.destroyRender();

package/ts/Renderer/IRenderer.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+
 import { RenderModeType } from '../Private/AgoraMediaBase';
 import { RendererOptions, ShareVideoFrame } from '../Types';
 
@@ -6,32 +7,31 @@ export type RenderFailCallback =
   | ((obj: { error: string }) => void)
   | undefined
   | null;
-export class IRenderer {
+
+export abstract class IRenderer {
   parentElement?: HTMLElement;
   canvas?: HTMLCanvasElement;
   event?: EventEmitter;
   contentMode = RenderModeType.RenderModeFit;
   mirror?: boolean;
 
-  snapshot(fileType = 'image/png') {
+  public snapshot(fileType = 'image/png') {
     if (this.canvas && this.canvas.toDataURL) {
       return this.canvas.toDataURL(fileType);
     }
     return null;
   }
 
-  bind(element: HTMLElement) {
+  public bind(element: HTMLElement) {
     if (!element) {
       throw new Error('You have pass a element');
     }
     this.parentElement = element;
   }
 
-  unbind() {
-    throw new Error('You have to declare your own custom render');
-  }
+  abstract unbind(): void;
 
-  equalsElement(element: Element): boolean {
+  public equalsElement(element: Element): boolean {
     if (!element) {
       throw new Error('You have pass a element');
     }
@@ -41,20 +41,15 @@ export class IRenderer {
     return element === this.parentElement;
   }
 
-  drawFrame(imageData: ShareVideoFrame) {
-    throw new Error('You have to declare your own custom render');
-  }
+  abstract drawFrame(imageData: ShareVideoFrame): void;
 
-  setRenderOption({ contentMode, mirror }: RendererOptions) {
-    this.contentMode =
-      contentMode === undefined ? RenderModeType.RenderModeFit : contentMode;
+  public setRenderOption({ contentMode, mirror }: RendererOptions) {
+    this.contentMode = contentMode ?? RenderModeType.RenderModeFit;
     this.mirror = mirror;
     Object.assign(this.parentElement!.style, {
       transform: mirror ? 'rotateY(180deg)' : '',
     });
   }
 
-  refreshCanvas() {
-    throw new Error('You have to declare your own custom render');
-  }
+  abstract refreshCanvas(): void;
 }

package/ts/Renderer/IRendererManager.ts

@@ -0,0 +1,35 @@
+import { RenderModeType, VideoSourceType } from '../Private/AgoraMediaBase';
+import { Channel, RendererVideoConfig } from '../Types';
+
+/**
+ * @ignore
+ */
+export abstract class IRendererManager {
+  abstract get defaultRenderConfig(): RendererVideoConfig;
+
+  abstract enableRender(enabled?: boolean): void;
+
+  abstract clear(): void;
+
+  abstract setupVideo(rendererVideoConfig: RendererVideoConfig): number;
+
+  abstract setupLocalVideo(rendererConfig: RendererVideoConfig): number;
+
+  abstract setupRemoteVideo(rendererConfig: RendererVideoConfig): number;
+
+  abstract setRenderOptionByConfig(rendererConfig: RendererVideoConfig): number;
+
+  abstract destroyRendererByView(view: Element): void;
+
+  abstract destroyRenderersByConfig(
+    videoSourceType: VideoSourceType,
+    channelId?: Channel,
+    uid?: number
+  ): void;
+
+  abstract setRenderOption(
+    view: HTMLElement,
+    contentMode?: RenderModeType,
+    mirror?: boolean
+  ): void;
+}