agora-electron-sdk 4.2.0-dev.4 → 4.2.0-dev.8

package/js/Renderer/GlRenderer/index.d.ts

@@ -1,59 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { ShareVideoFrame } from '../../Types';
-import { IRenderer, RenderFailCallback } from '../IRenderer';
-export declare class GlRenderer extends IRenderer {
-    gl: WebGL2RenderingContext | undefined | null;
-    handleContextLost: any;
-    program: any;
-    positionLocation: any;
-    texCoordLocation: any;
-    yTexture: WebGLTexture | undefined | null;
-    uTexture: WebGLTexture | undefined | null;
-    vTexture: WebGLTexture | undefined | null;
-    texCoordBuffer: any;
-    surfaceBuffer: any;
-    parentElement: HTMLElement | undefined;
-    container: HTMLElement | undefined;
-    canvas: HTMLCanvasElement | undefined;
-    renderImageCount: number;
-    initWidth: number;
-    initHeight: number;
-    initRotation: number;
-    clientWidth: number;
-    clientHeight: number;
-    contentMode: number;
-    event: EventEmitter;
-    firstFrameRender: boolean;
-    lastImageWidth: number;
-    lastImageHeight: number;
-    lastImageRotation: number;
-    videoBuffer: {};
-    observer?: ResizeObserver;
-    failInitRenderCB: RenderFailCallback;
-    constructor(failCallback: RenderFailCallback);
-    bind(view: HTMLElement): void;
-    unbind(): void;
-    updateViewZoomLevel(rotation: number, width: number, height: number): boolean | undefined;
-    updateCanvas(rotation: number, width: number, height: number): void;
-    drawFrame(videoFrame: ShareVideoFrame): void;
-    refreshCanvas(): void;
-    renderImage(image: {
-        width: number;
-        height: number;
-        left: number;
-        top: number;
-        right: number;
-        bottom: number;
-        rotation: number;
-        yplane: Uint8Array;
-        uplane: Uint8Array;
-        vplane: Uint8Array;
-    }): void;
-    uploadYuv(width: number, height: number, yplane: Uint8Array, uplane: Uint8Array, vplane: Uint8Array): void;
-    deleteBuffer(buffer: any): void;
-    deleteTexture(texture: any): void;
-    initCanvas(view: HTMLElement, width: number, height: number, rotation: number): void;
-    initTextures(): void;
-}
-export default GlRenderer;

package/js/Renderer/IRenderer.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { RenderModeType } from '../Private/AgoraMediaBase';
-import { RendererOptions, ShareVideoFrame } from '../Types';
-export declare type RenderFailCallback = ((obj: {
-    error: string;
-}) => void) | undefined | null;
-export declare class IRenderer {
-    parentElement?: HTMLElement;
-    canvas?: HTMLCanvasElement;
-    event?: EventEmitter;
-    contentMode: RenderModeType;
-    mirror?: boolean;
-    snapshot(fileType?: string): string | null;
-    bind(element: HTMLElement): void;
-    unbind(): void;
-    equalsElement(element: Element): boolean;
-    drawFrame(imageData: ShareVideoFrame): void;
-    setRenderOption({ contentMode, mirror }: RendererOptions): void;
-    refreshCanvas(): void;
-}

package/js/Renderer/RendererManager.d.ts

@@ -1,152 +0,0 @@
-/// <reference types="node" />
-import { RenderModeType, VideoSourceType } from '../Private/AgoraMediaBase';
-import { AgoraElectronBridge, Channel, RENDER_MODE, RenderMap, RendererVideoConfig } from '../Types';
-/**
- * @ignore
- */
-export declare class RendererManager {
-    /**
-     * @ignore
-     */
-    isRendering: boolean;
-    renderFps: number;
-    /**
-     * @ignore
-     */
-    videoFrameUpdateInterval?: NodeJS.Timer;
-    /**
-     * @ignore
-     */
-    renderers: RenderMap;
-    /**
-     * @ignore
-     */
-    renderMode: RENDER_MODE;
-    /**
-     * @ignore
-     */
-    msgBridge: AgoraElectronBridge;
-    /**
-     * @ignore
-     */
-    defaultRenderConfig: RendererVideoConfig;
-    constructor();
-    /**
-     * Sets the channel mode of the current audio file.
-     * In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.Call this method after calling open .This method only applies to stereo audio files.
-     *
-     * @param mode The channel mode. See AudioDualMonoMode .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    setRenderMode(mode: RENDER_MODE): void;
-    /**
-     * @ignore
-     */
-    setFPS(fps: number): void;
-    /**
-     * @ignore
-     */
-    setRenderOption(view: HTMLElement, contentMode?: RenderModeType, mirror?: boolean): void;
-    /**
-     * @ignore
-     */
-    setRenderOptionByConfig(rendererConfig: RendererVideoConfig): number;
-    /**
-     * @ignore
-     */
-    checkWebglEnv(): boolean;
-    /**
-     * @ignore
-     */
-    setupVideo(rendererVideoConfig: RendererVideoConfig): number;
-    /**
-     * @ignore
-     */
-    setupLocalVideo(rendererConfig: RendererVideoConfig): number;
-    /**
-     * @ignore
-     */
-    setupRemoteVideo(rendererConfig: RendererVideoConfig): number;
-    /**
-     * Destroys a video renderer object.
-     *
-     * @param view The HTMLElement object to be destroyed.
-     */
-    destroyRendererByView(view: Element): void;
-    /**
-     * @ignore
-     */
-    destroyRenderersByConfig(videoSourceType: VideoSourceType, channelId?: Channel, uid?: number): void;
-    /**
-     * @ignore
-     */
-    removeAllRenderer(): void;
-    /**
-     * @ignore
-     */
-    clear(): void;
-    /**
-     * Enables/Disables the local video capture.
-     * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
-     *
-     * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    enableRender(enabled?: boolean): void;
-    /**
-     * @ignore
-     */
-    startRenderer(): void;
-    /**
-     * @ignore
-     */
-    stopRender(): void;
-    /**
-     * @ignore
-     */
-    restartRender(): void;
-    /**
-     * @ignore
-     */
-    private createRenderer;
-    /**
-     * @ignore
-     */
-    private getRender;
-    /**
-     * @ignore
-     */
-    private getRenderers;
-    /**
-     * @ignore
-     */
-    private bindHTMLElementToRender;
-    /**
-     * @ignore
-     */
-    private forEachStream;
-    /**
-     * @ignore
-     */
-    private enableVideoFrameCache;
-    /**
-     * @ignore
-     */
-    private disableVideoFrameCache;
-    /**
-     * @ignore
-     */
-    private ensureRendererConfig;
-    /**
-     * @ignore
-     */
-    private resizeShareVideoFrame;
-    /**
-     * @ignore
-     */
-    private updateVideoFrameCacheInMap;
-}

package/js/Renderer/YUVCanvasRenderer/index.d.ts

@@ -1,16 +0,0 @@
-import { RenderModeType } from '../../Private/AgoraMediaBase';
-import { CanvasOptions, ShareVideoFrame } from '../../Types';
-import { IRenderer } from '../IRenderer';
-export declare class YUVCanvasRenderer extends IRenderer {
-    private _cacheCanvasOptions?;
-    private _yuvCanvasSink?;
-    private _container?;
-    private _videoFrame;
-    constructor();
-    bind(element: HTMLElement): void;
-    unbind(): void;
-    zoom(vertical: boolean, contentMode: RenderModeType | undefined, width: number, height: number, clientWidth: number, clientHeight: number): number;
-    updateCanvas(options?: CanvasOptions): void;
-    drawFrame(frame: ShareVideoFrame): void;
-    refreshCanvas(): void;
-}

package/js/Types.d.ts

@@ -1,271 +0,0 @@
-/// <reference types="node" />
-import { RenderModeType, VideoSourceType } from './Private/AgoraMediaBase';
-import { IRenderer } from './Renderer/IRenderer';
-import { RendererManager } from './Renderer/RendererManager';
-/**
- * @ignore
- */
-export interface AgoraEnvType {
-    /**
-     * @ignore
-     */
-    enableLogging: boolean;
-    /**
-     * @ignore
-     */
-    enableDebugLogging: boolean;
-    /**
-     * @ignore
-     */
-    AgoraElectronBridge: AgoraElectronBridge;
-    /**
-     * @ignore
-     */
-    AgoraRendererManager?: RendererManager;
-}
-/**
- * @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 {
-    /**
-     * @ignore
-     */
-    WEBGL = 1,
-    /**
-     * @ignore
-     */
-    SOFTWARE = 2
-}
-export declare type User = 'local' | 'videoSource' | number | string;
-export declare 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;
-}
-/**
- * @ignore
- */
-export interface Result {
-    /**
-     * @ignore
-     */
-    callApiReturnCode: number;
-    /**
-     * @ignore
-     */
-    callApiResult: any;
-}
-/**
- * @ignore
- */
-export interface AgoraElectronBridge {
-    OnEvent(callbackName: string, callback: (event: string, data: string, buffer: Uint8Array[], bufferLength: number[], bufferCount: number) => void): void;
-    CallApi(funcName: string, params: any, buffer?: (Uint8Array | undefined)[], bufferCount?: number): Result;
-    InitializeEnv(): void;
-    ReleaseEnv(): void;
-    ReleaseRenderer(): void;
-    EnableVideoFrameCache(config: VideoFrameCacheConfig): void;
-    DisableVideoFrameCache(config: VideoFrameCacheConfig): void;
-    GetBuffer(ptr: number, length: number): Buffer;
-    /**
-     * @ignore
-     */
-    GetVideoFrame(streamInfo: ShareVideoFrame): {
-        ret: number;
-        /**
-         * @ignore
-         */
-        isNewFrame: boolean;
-        /**
-         * @ignore
-         */
-        yStride: number;
-        /**
-         * @ignore
-         */
-        width: number;
-        /**
-         * @ignore
-         */
-        height: number;
-        /**
-         * @ignore
-         */
-        rotation: number;
-        /**
-         * @ignore
-         */
-        timestamp: number;
-    };
-    sendMsg: (funcName: string, params: any, buffer?: Uint8Array[], bufferCount?: number) => Result;
-}
-/**
- * @ignore
- */
-export interface RenderConfig {
-    /**
-     * @ignore
-     */
-    renders: IRenderer[];
-    /**
-     * @ignore
-     */
-    shareVideoFrame: ShareVideoFrame;
-}
-export declare type UidMap = Map<number, RenderConfig>;
-export declare type ChannelIdMap = Map<Channel, UidMap>;
-export declare type RenderMap = Map<VideoSourceType, ChannelIdMap>;

package/js/Utils.d.ts

@@ -1,58 +0,0 @@
-import { VideoSourceType } from './Private/AgoraMediaBase';
-import { AgoraEnvType, FormatRendererVideoConfig, RendererVideoConfig } from './Types';
-/**
- * @ignore
- */
-export declare const TAG = "[Agora]: ";
-/**
- * @ignore
- */
-export declare const DEBUG_TAG = "[Agora Debug]: ";
-/**
- * @ignore
- */
-export declare const deprecate: (originApi?: string, replaceApi?: string) => void;
-/**
- * @ignore
- */
-export declare const logWarn: (msg: string, ...optParams: any[]) => void;
-/**
- * @ignore
- */
-export declare const logError: (msg: string, ...optParams: any[]) => void;
-/**
- * @ignore
- */
-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
- */
-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;
-/**
- * @ignore
- */
-export declare function classMix(...mixins: any[]): any;
-/**
- * @ignore
- */
-export declare const AgoraEnv: AgoraEnvType;