miniprogram-zego-express - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
     "name": "miniprogram-zego-express",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "zego miniprogram express sdk",
@@ -5,0 +5,0 @@ "main": "./ZegoExpressMiniProgram.js",

readme.md

@@ -6,1 +6,7 @@ ### 日志更新
 Zego MiniProgram Express SDK 初版发布
+
+### 2019-11-28(version 1.1.0)
+
+1. 增加混流功能
+2. 增加房间 IM 功能
+3. 对齐各端接口，接口命名、参数命名、取值等统一

sdk/common/clientBase/common.d.ts

@@ -35,3 +35,3 @@ import { ERRO } from '../zego.entity';
     resetStreamCenter(): void;
-    protected handleFetchWebRtcUrlRsp(msg: any, success?: (stream: MediaStream) => void): void;
+    protected handleFetchWebRtcUrlRsp(msg: any): void;
 }

sdk/common/clientBase/index.d.ts

 import { Common } from './common';
-import { ERRO, StreamInfo, CdnPushConfig, MixStreamConfig, webConfig, wxConfig } from '../zego.entity';
+import { ERRO, CdnPushConfig, MixStreamConfig, WebConfig, WxConfig } from '../zego.entity';
 export declare abstract class BaseCenter extends Common {
@@ -19,16 +19,9 @@ constructor();
      * ****/
-    setConfig(option: webConfig | wxConfig): boolean;
-    login(roomId: string, token: string, param?: {
+    setConfig(option: WebConfig | WxConfig): boolean;
+    login(roomID: string, token: string, param?: {
         authToken: string;
-    }): Promise<StreamInfo[]>;
+    }): Promise<boolean>;
     logout(): Promise<void>;
-    setUserStateUpdate(update: boolean): void;
-    sendCustomCommand(dstMembers: string[], customContent: string | Record<string, any>, success: (seq: number, customContent: string) => void, error: (err: ERRO, seq: number, customContent: string) => void): boolean;
-    sendRoomMsg(msgCategory: 1 | 2, msgContent: string): Promise<{
-        seq: number;
-        msgId: string;
-        msgCategory: number;
-        msgType: number;
-        msgContent: string;
-    }>;
+    sendCustomCommand(command: string | Record<string, any>, toUserList: string[]): Promise<boolean>;
+    sendBroadcastMessage(message: string): Promise<boolean>;
     sendReliableMessage(type: string, data: string, success: (seq: number) => void, error: (err: ERRO, seq: number) => void): void;
@@ -42,3 +35,3 @@ sendBigRoomMessage(category: 1 | 2, type: 1 | 2 | 3, content: string, success: (seq: number, messageId: string) => void, error: (err: ERRO, seq: number) => void): void;
     startMixStream(mixStreamConfig: MixStreamConfig): Promise<Array<{
-        streamId?: string;
+        streamID?: string;
         rtmpUrl: string;
@@ -54,3 +47,3 @@ hlsUrl: string;
     deleteListener(listener: string, callBack?: Function): boolean;
-    static getCurrentVersion(): string;
+    getCurrentVersion(): string;
 }

sdk/common/clientBase/messageHandler.d.ts

@@ -10,3 +10,3 @@ import { SocketCenter } from './socketCenter';
     constructor(logger: Logger, stateCenter: StateCenter, socketCenter: SocketCenter);
-    sendCustomCommand(dstMembers: string[], customContent: string | Record<string, any>, success: (seq: number, customContent: string) => void, error: (err: ERRO, seq: number, customContent: string) => void): boolean;
+    sendCustomCommand(dstMembers: string[], customContent: string | Record<string, any>, success: Function, error: Function): void;
     private handleSendCustomMsgRsp;
@@ -18,3 +18,3 @@ handlePushCustomMsg(msg: {
     }): void;
-    onRecvCustomCommand(from_userid: string, from_idname: string, custom_content: string): void;
+    onRecvCustomCommand(fromUser: string, command: string): void;
     sendRoomMsg(msg_category: 1 | 2, msg_content: string, success: Function, error: Function): void;
@@ -21,0 +21,0 @@ handleSendRoomMsgRsp(msg: {

sdk/common/clientBase/roomHandler.d.ts

@@ -1,2 +0,2 @@
-import { ENUM_RUN_STATE, ERRO, StreamInfo, UserInfo } from '../zego.entity';
+import { ENUM_RUN_STATE, ERRO } from '../zego.entity';
 import { SocketCenter } from './socketCenter';
@@ -17,4 +17,3 @@ import { StateCenter } from './stateCenter';
     loginSuccessCallBack(lastRunState: number, msg: any): void;
-    onGetTotalUserList(roomId: string, userList: any[]): void;
-    login(roomid: string, token: string, authToken: string, success: (list: StreamInfo[]) => void, error: (err: ERRO) => void): void;
+    login(roomid: string, token: string, authToken: string, success: (success: boolean) => void, error: (err: ERRO) => void): void;
     loginBodyData(): void;
@@ -28,4 +27,3 @@ private tryLogin;
     logout(success: () => void, error: (err: ERRO) => void): void;
-    setUserStateUpdate(update: boolean): boolean;
-    fetchUserList(): void;
+    fetchUserList(lastRunState?: number): void;
     private fetchUserListWithPageV2;
@@ -43,3 +41,6 @@ private fetchUserListWithPage;
     }): void;
-    onUserStateUpdate(roomId: string, userList: UserInfo[]): void;
+    onUserStateUpdate(roomId: string, updateType: 0 | 1, userList: Array<{
+        userID: string;
+        userName: string;
+    }>): void;
 }

sdk/common/clientBase/stateCenter.d.ts

 import { ENUM_RUN_STATE, LinkedList } from '../zego.entity';
 export declare class StateCenter {
+    debug: boolean;
     testEnvironment: boolean;
@@ -29,2 +30,6 @@ third_token: string;
     userTempList: any;
+    userList: Array<{
+        userID: string;
+        userName: string;
+    }>;
     userSeq: number;
@@ -52,2 +57,3 @@ anchor_info: {
     bigImTimer: any;
+    msgCategory: 1 | 2;
     serverTimeOffset: number;
@@ -54,0 +60,0 @@ datiTimeWindow: number;

sdk/common/clientBase/streamHandler.d.ts

@@ -33,7 +33,7 @@ import { SocketCenter } from './socketCenter';
     makeCallbackStreamList(streamList: any[]): {
-        userId: any;
+        userID: any;
         userName: any;
         extraInfo: any;
-        streamId: any;
-        roomId: string;
+        streamID: any;
+        roomID: string;
         urlFlv: string;
@@ -40,0 +40,0 @@ urlRtmp: string;

sdk/common/zego.entity.d.ts

@@ -19,3 +19,3 @@ import { ZegoSignal } from './zego.signal';
 }
-export interface webConfig {
+export interface WebConfig {
     nickName?: string;
@@ -25,4 +25,7 @@ logLevel?: ENUM_LOG_LEVEL;
     remoteLogLevel?: ENUM_LOG_LEVEL;
+    debug?: boolean;
+    qualityInterval?: number;
+    userUpdate?: boolean;
 }
-export interface wxConfig {
+export interface WxConfig {
     nickName?: string;
@@ -32,7 +35,7 @@ logLevel?: ENUM_LOG_LEVEL;
     remoteLogLevel?: ENUM_LOG_LEVEL;
-    pushSourceType?: 0 | 1;
-    playSourceType?: 0 | 1;
+    debug?: boolean;
+    userUpdate?: boolean;
 }
-export interface UsabilityDetection {
-    webRtc: boolean;
+export interface CapabilityDetection {
+    webRTC: boolean;
     capture: boolean;
@@ -137,4 +140,2 @@ videoDecodeType: {
     LOW: {
-        width: number;
-        height: number;
         frameRate: number;
@@ -144,4 +145,2 @@ bitRate: number;
     MEDIUM: {
-        width: number;
-        height: number;
         frameRate: number;
@@ -151,4 +150,2 @@ bitRate: number;
     HIGH: {
-        width: number;
-        height: number;
         frameRate: number;
@@ -260,4 +257,4 @@ bitRate: number;
 export interface StreamInfo {
-    streamId: string;
-    userId: string;
+    streamID: string;
+    userID: string;
     userName: string;
@@ -286,3 +283,3 @@ extraInfo: string;
 export interface WaitingInfo {
-    streamId: string;
+    streamID: string;
     success: Function;
@@ -305,3 +302,3 @@ error: Function;
     retryCount: number;
-    playOption: PlayOption;
+    playOption: webPlayOption | wxPlayOption;
 }
@@ -357,4 +354,2 @@ export declare enum QUALITYLEVEL {
         videoQuality?: 1 | 2 | 3 | 4;
-        width?: number;
-        height?: number;
         bitRate?: number;
@@ -377,3 +372,3 @@ frameRate?: number;
     label: string;
-    deviceId: string;
+    deviceID: string;
 }
@@ -405,6 +400,4 @@ export declare const ENUM_SIGNAL_SUB_CMD: {
 export interface UserInfo {
-    action: 1 | 2;
-    idName: string;
-    nickName: string;
-    loginTime: string;
+    userID: string;
+    userName: string;
 }
@@ -424,3 +417,3 @@ export interface MessageInfo {
     replace?: boolean;
-    streamId: string;
+    streamID: string;
     effectId: number;
@@ -430,6 +423,6 @@ }
     type: 'addpush' | 'delpush' | 'clearpush';
-    streamId: string;
+    streamID: string;
     pushUrl: string;
 }
-export interface webQualityStats {
+export interface WebQualityStats {
     video: {
@@ -451,3 +444,3 @@ videoBitrate: number;
     };
-    streamId: string;
+    streamID: string;
     type: 1 | 0;
@@ -459,3 +452,3 @@ roomId?: string;
 }
-export interface wxQualityStats {
+export interface WxQualityStats {
     video: {
@@ -470,10 +463,9 @@ videoBitrate: number;
     };
-    streamId: string;
-    type: 0 | 1;
+    streamID: string;
     roomId: '';
 }
 export interface MixStreamConfig {
-    taskId: string;
+    taskID: string;
     inputList: Array<{
-        streamId: string;
+        streamID: string;
         layout: {
@@ -487,3 +479,3 @@ top: number;
     outputList: Array<{
-        streamId?: string;
+        streamID?: string;
         outputUrl?: string;
@@ -519,75 +511,113 @@ outputBitrate?: number;
 }
+export interface WebPublishStats {
+    video: {
+        videoBitrate: number;
+        videoFPS: number;
+        videoTransferFPS: number;
+        frameHeight: number;
+        frameWidth: number;
+    };
+    audio: {
+        audioBitrate: number;
+        audioCodeType: string;
+    };
+    streamID: string;
+    nackCount: number;
+    pliCount: number;
+    totalRoundTripTime: number;
+    currentRoundTripTime: number;
+}
+export interface WebPlayStats {
+    video: {
+        videoBitrate: number;
+        videoFPS: number;
+        videoTransferFPS: number;
+        videoFramesDecoded: number;
+        videoFramesDropped: number;
+        videoPacketsLostRate: number;
+        videoQuality: number;
+        frameHeight: number;
+        frameWidth: number;
+    };
+    audio: {
+        audioBitrate: number;
+        audioCodeType: number;
+        audioJitter: number;
+        audioLevel: number;
+        audioPacketsLost: number;
+        audioPacketsLostRate: number;
+        audioQuality: number;
+        audioSamplingRate: number;
+        audioSendLevel: number;
+    };
+    streamID: string;
+    nackCount: number;
+    pliCount: number;
+    totalRoundTripTime: number;
+    playData: number;
+    currentRoundTripTime: number;
+}
 export interface WebListener {
-    userStateUpdate: (roomId: string, userList: UserInfo[]) => void;
-    totalUserList: (roomId: string, userList: {
-        userId: string;
-        userName: string;
-    }[]) => void;
-    updateOnlineCount: (roomId: string, userCount: number) => void;
-    recvCustomCommand: (fromUserId: string, fromIdName: string, customContent: string) => void;
-    recvRoomMsg: (chatData: Array<{
-        userId: string;
-        userName: string;
-        msgId: number;
-        type: number;
-        content: string;
+    roomUserUpdate: (roomID: string, updateType: 0 | 1, userList: UserInfo[]) => void;
+    updateOnlineCount: (roomID: string, userCount: number) => void;
+    IMRecvCustomCommand: (fromUser: string, command: string) => void;
+    IMRecvBroadcastMessage: (chatData: Array<{
+        fromUser: string;
+        message: string;
         sendTime: number;
     }>) => void;
-    remoteStreamUpdated: (type: 0 | 1, streamList: StreamInfo[]) => void;
+    roomStreamUpdate: (type: 0 | 1, streamList: StreamInfo[]) => void;
     streamExtraInfoUpdated: (streamList: {
-        streamId: string;
-        userId: string;
+        streamID: string;
+        userID: string;
         userName: string;
         extraInfo: string;
     }[]) => void;
-    pullStateChange: (result: {
+    playStateUpdate: (result: {
         type: 0 | 1 | 2;
-        streamId: string;
+        streamID: string;
         error: ERRO;
     }) => void;
-    publishStateChange: (result: {
+    publishStateUpdate: (result: {
         type: 0 | 1 | 2;
-        streamId: string;
+        streamID: string;
         error: ERRO;
     }) => void;
-    roomStateUpdate: (state: 'KICKOUT' | 'DISCONNECT' | 'RECONNECT', error: ERRO) => void;
+    roomStateUpdate: (state: 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED', error: ERRO) => void;
     screenSharingEnded: () => void;
+    publishQualityUpdate: (publishStats: WebPublishStats) => void;
+    playQualityUpdate: (playStats: WebPlayStats) => void;
 }
 export interface WxListener {
-    userStateUpdate: (roomId: string, userList: UserInfo[]) => void;
-    totalUserList: (roomId: string, userList: {
-        userId: string;
-        userName: string;
-    }[]) => void;
-    updateOnlineCount: (roomId: string, userCount: number) => void;
-    recvCustomCommand: (fromUserId: string, fromIdName: string, customContent: string) => void;
-    recvRoomMsg: (chatData: Array<{
-        userId: string;
-        userName: string;
-        msgId: number;
-        type: number;
-        content: string;
+    roomUserUpdate: (roomID: string, updateType: 0 | 1, userList: UserInfo[]) => void;
+    updateOnlineCount: (roomID: string, userCount: number) => void;
+    IMRecvCustomCommand: (fromUser: string, command: string) => void;
+    IMRecvBroadcastMessage: (chatData: Array<{
+        fromUser: string;
+        message: string;
         sendTime: number;
     }>) => void;
-    remoteStreamUpdated: (type: 0 | 1, streamList: StreamInfo[]) => void;
+    roomStreamUpdate: (type: 0 | 1, streamList: StreamInfo[]) => void;
     streamExtraInfoUpdated: (streamList: {
-        streamId: string;
-        userId: string;
+        streamID: string;
+        userID: string;
         userName: string;
         extraInfo: string;
     }[]) => void;
-    pullStateChange: (result: {
+    playStateUpdate: (result: {
         type: 0 | 1 | 2;
-        streamId: string;
+        streamID: string;
         error: ERRO;
     }) => void;
-    publishStateChange: (result: {
+    publishStateUpdate: (result: {
         type: 0 | 1 | 2;
-        streamId: string;
+        streamID: string;
         error: ERRO;
     }) => void;
-    roomStateUpdate: (state: 'KICKOUT' | 'DISCONNECT' | 'RECONNECT', error: ERRO) => void;
+    roomStateUpdate: (state: 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED', error: ERRO) => void;
+    publishQualityUpdate: (publishStats: WxQualityStats) => void;
+    playQualityUpdate: (playStats: WxQualityStats) => void;
 }
 export declare enum ENUM_PLAY_SOURCE_TYPE {
-    auto = 0,
+    cdn = 0,
     ultra = 1
@@ -600,3 +630,3 @@ }
 }
-export declare type PublishOption = {
+export declare type webPublishOption = {
     streamParams?: string;
@@ -608,3 +638,8 @@ extraInfo?: string;
 };
-export declare type PlayOption = {
+export declare type wxPublishOption = {
+    sourceType?: 0 | 1;
+    streamParams?: string;
+    extraInfo?: string;
+};
+export declare type webPlayOption = {
     video?: boolean;
@@ -615,2 +650,6 @@ audio?: boolean;
 };
+export declare type wxPlayOption = {
+    streamParams?: string;
+    isMix?: boolean;
+};
 export declare enum E_CLIENT_TYPE {
@@ -617,0 +656,0 @@ ClientType_None = 0,

sdk/common/zego.logger.d.ts

 import { ENUM_REMOTE_TYPE, ENUM_LOG_LEVEL } from './zego.entity';
 import { ZegoWebSocket } from '../wechatMini/zego.webSocket';
+import { StateCenter } from './clientBase/stateCenter';
 export declare const D: string[];
@@ -14,2 +15,3 @@ export declare abstract class Logger {
     logRemoteLevel: ENUM_LOG_LEVEL;
+    stateCenter: StateCenter;
     websocket: WebSocket | ZegoWebSocket | null;
@@ -25,3 +27,3 @@ url: string;
     abstract SendHttpsLog(): void;
-    constructor();
+    constructor(stateCenter: StateCenter);
     setLogLevel(logLevel: ENUM_LOG_LEVEL): void;
@@ -28,0 +30,0 @@ setRemoteLogLevel(logLevel: ENUM_LOG_LEVEL): void;

sdk/common/zego.signal.d.ts

@@ -83,2 +83,4 @@ import { LinkedList } from './zego.entity';
     QualityReport(seq: number, sessionId: number, qualityStat: any, success: Function, error: Function): void;
+    sendStreamStatus(seq: number, sessionId: number, camera: 0 | 1, microphone: 0 | 1): void;
+    sendBroadcasterStatus(seq: number, sessionId: number, status: 0 | 1): void;
 }

sdk/common/ZegoStreamCenter.d.ts

@@ -9,2 +9,3 @@ import { Logger } from './zego.logger';
     publisherList: any;
+    playSuccessCallBack: Function | null;
     constructor(log: Logger, stateCenter: StateCenter);
@@ -16,7 +17,7 @@ abstract stopPlayingStream(streamId: string): void;
     abstract onPlayStateUpdate(type: 0 | 1 | 2, streamid: string, error: ERRO): void;
-    abstract onPlayQualityUpdate(streamId: string, streamQuality: StreamQuality): void;
+    abstract onPlayQualityUpdate(streamQuality: StreamQuality): void;
     abstract onPublishStateUpdate(type: 0 | 1 | 2, streamid: string, error: ERRO): void;
-    abstract onPublishQualityUpdate(streamId: string, streamQuality: StreamQuality): void;
+    abstract onPublishQualityUpdate(streamQuality: StreamQuality): void;
     abstract onPlayerStreamUrlUpdate(streamid: string, url: string, type: string): void;
     setSessionInfo(appid: number, userid: string, token: string, testEnvironment: boolean): void;
 }

sdk/util/client-util.d.ts

 import { ERRO } from '../common/zego.entity';
 import { Logger } from '../common/zego.logger';
+import { StateCenter } from '../common/clientBase/stateCenter';
 export declare class ClientUtil {
@@ -21,6 +22,6 @@ static checkConfigParam(appid: number, server: string, idName: string, logger: Logger): boolean;
     static getServerError(code: string | number): {
-        code: string;
+        code: number;
         msg: string;
     } | {
-        code: number;
+        code: string;
         msg: string;
@@ -33,2 +34,3 @@ };
     }): void;
+    static mergeUserList(logger: Logger, oldUserList: any[], newUserList: any[], callbackResult: (addUserList: any[], delUserList: any[]) => void): void;
     static checkCustomCommandParam(param: {
@@ -67,2 +69,3 @@ dest_id_name: string[];
     static getBrowser(): string;
+    static setDebug(server: string, stateCenter: StateCenter): void;
 }

sdk/webrtc/zego.client.web.d.ts

@@ -1,2 +0,2 @@
-import { PlayOption, Constraints, webQualityStats, ERRO, UsabilityDetection, PublishOption, WebListener, webConfig } from '../common/zego.entity';
+import { webPlayOption, Constraints, ERRO, CapabilityDetection, WebListener, WebConfig, webPublishOption } from '../common/zego.entity';
 import { ZegoStreamCenterWeb } from './zego.streamCenter.web';
@@ -10,10 +10,10 @@ import { AudioMixUtil } from '../util/AudioMixUtil';
     audioMixing: AudioMixUtil;
-    constructor(appId: number, server: string, userId: string);
+    constructor(appID: number, server: string, userID: string);
     static screenShotReady: boolean;
     static mediaRecorder: ZegoMediaRecorder;
     static recordedBlobs: Blob[];
-    config(option: webConfig): boolean;
+    config(option: WebConfig): boolean;
     protected getSocket(server: string): WebSocket;
-    on<k extends keyof WebListener>(listener: k, callBack: WebListener[k]): boolean;
-    off<k extends keyof WebListener>(listener: k, callBack?: WebListener[k]): boolean;
+    on<k extends keyof WebListener>(event: k, callBack: WebListener[k]): boolean;
+    off<k extends keyof WebListener>(event: k, callBack?: WebListener[k]): boolean;
     enableStream(localStream: MediaStream, option: {
@@ -24,11 +24,10 @@ video?: boolean;
     setAudioOutput(localVideo: HTMLMediaElement, audioOutput: string): boolean;
-    setCustomSignalUrl(signalUrl: string): false | undefined;
+    setCustomSignalUrl(signalUrl: string): boolean;
     private setQualityMonitorCycle;
-    getStats(interval: number, callBack: (stats: webQualityStats) => void): void;
-    getRemoteStream(streamId: string, playOption?: PlayOption): Promise<MediaStream>;
-    stopRemoteStream(streamId: string): boolean;
+    startPlayingStream(streamID: string, playOption?: webPlayOption): Promise<MediaStream>;
+    stopPlayingStream(streamID: string): boolean;
     createLocalStream(option?: Constraints): Promise<MediaStream>;
     destroyLocalStream(localStream: MediaStream): boolean;
-    publishLocalStream(streamId: string, localStream: MediaStream, publishOption?: PublishOption): boolean;
-    stopPublishLocalStream(streamId: string): Promise<void>;
+    startPublishingStream(streamID: string, localStream: MediaStream, publishOption?: webPublishOption): boolean;
+    stopPublishingStream(streamID: string): boolean;
     private preloadEffect;
@@ -48,6 +47,6 @@ private playEffect;
     switchDevice(localStream: MediaStream, device: {
-        cameraId: string;
-        microphoneId: string;
+        cameraID: string;
+        microphoneID: string;
     }): Promise<void>;
-    protected WebrtcOnPublishStateUpdateHandle(type: 0 | 1 | 2, streamId: string, error: ERRO): void;
+    protected WebrtcOnPublishStateUpdateHandle(type: 0 | 1 | 2, streamID: string, error: ERRO): void;
     protected setCDNInfo(streamInfo: {
@@ -70,22 +69,22 @@ urlHttpsFlv: string;
     private screenStreamFrom;
-    filterStreamList(streamId?: string): any;
+    filterStreamList(streamID?: string): any;
     private voiceChange;
     private voiceBack;
-    static detectRTC(): Promise<UsabilityDetection>;
+    detectRTC(): Promise<CapabilityDetection>;
     enumDevices(): Promise<{
         microphones: Array<{
             label: string;
-            deviceId: string;
+            deviceID: string;
         }>;
         speakers: Array<{
             label: string;
-            deviceId: string;
+            deviceID: string;
         }>;
         cameras: Array<{
             label: string;
-            deviceId: string;
+            deviceID: string;
         }>;
     }>;
-    private static enumDevices;
-    static getAudioInfo(localStream: MediaStream, errCallBack: (param: any) => void, option?: {
+    private static getDevices;
+    getAudioInfo(localStream: MediaStream, errCallBack: (param: any) => void, option?: {
         type: string;
@@ -98,11 +97,11 @@ bufferSize?: number;
     private static handleDataAvailable;
-    static startRecord(el: ZegoMediaElement): void;
-    static stopRecord(): void;
-    static resumeRecord(): void;
-    static pauseRecord(): void;
-    static saveRecord(name: string): void;
-    static takeSnapShot(el: HTMLVideoElement, img: HTMLImageElement): void;
-    static saveSnapShot(el: HTMLVideoElement, name: string): void;
+    startRecord(el: ZegoMediaElement): void;
+    stopRecord(): void;
+    resumeRecord(): void;
+    pauseRecord(): void;
+    saveRecord(name: string): void;
+    takeSnapShot(el: HTMLVideoElement, img: HTMLImageElement): void;
+    saveSnapShot(el: HTMLVideoElement, name: string): void;
     private bindWindowListener;
     private onPublishStateUpdateHandle;
 }

sdk/webrtc/zego.play.web.d.ts

@@ -1,5 +0,6 @@
-import { PlayOption, ERRO } from '../common/zego.entity';
+import { webPlayOption, ERRO } from '../common/zego.entity';
 import { ZegoDataReport } from '../common/zego.datareport';
 import { ZegoSignal } from '../common/zego.signal';
 import { Logger } from '../common/zego.logger';
+import { ZegoStreamCenter } from '../common/ZegoStreamCenter';
 export declare class ZegoPlayWeb {
@@ -9,2 +10,3 @@ logger: Logger;
     state: number;
+    streamCenter: ZegoStreamCenter;
     candidateInfo: never[];
@@ -43,3 +45,3 @@ waitICETimer: any;
     streamId: string | null;
-    sessionId: number | string;
+    sessionId: number;
     sessionSeq: number;
@@ -50,7 +52,8 @@ answerSeq: number;
     remoteStream: MediaStream | null;
+    playStream: MediaStream | null;
     peerConnection: RTCPeerConnection | any;
-    playOption: PlayOption | {};
+    playOption: webPlayOption | {};
     closeSessionSignal: boolean;
-    constructor(log: Logger, signal: ZegoSignal | null, dataReport: ZegoDataReport, qualityTimeInterval: number);
-    startPlay(streamId: string, success: (stream: MediaStream) => void, playOption?: PlayOption): void;
+    constructor(log: Logger, signal: ZegoSignal | null, dataReport: ZegoDataReport, qualityTimeInterval: number, streamCenter: ZegoStreamCenter);
+    startPlay(streamId: string, success: (stream: MediaStream) => void, playOption?: webPlayOption): void;
     private onCreatePlaySessionSuccess;
@@ -79,2 +82,3 @@ onCreateOfferSuccess(desc: {
     private onRecvCloseSession;
+    private onRecvStreamStatus;
     private onGotRemoteStream;
@@ -85,5 +89,5 @@ private sendCandidateInfo;
     onPlayStateUpdate(type: number, streamId: string | null, error?: ERRO): void;
-    onPlayQualityUpdate(streamId: string, quality: object): void;
+    onPlayQualityUpdate(quality: object): void;
     stopPlay(): void;
     onDisconnect(): void;
 }

sdk/webrtc/zego.preview.d.ts

 import { MediaStreamConstraints, ERRO } from '../common/zego.entity';
 import { Logger } from '../common/zego.logger';
+import { ZegoStreamCenter } from '../common/ZegoStreamCenter';
 export declare class ZegoPreview {
@@ -19,3 +20,3 @@ private log;
     enableMicrophone: (enable: boolean) => boolean;
-    enableCamera: (enable: boolean) => boolean;
+    enableCamera: (enable: boolean, streamCenter: ZegoStreamCenter) => boolean;
 }

sdk/webrtc/zego.publish.d.ts

 import { ZegoDataReport } from '../common/zego.datareport';
-import { VideoInfo, AudioMixConfig, ERRO, PublishOption } from '../common/zego.entity';
+import { VideoInfo, AudioMixConfig, ERRO, webPublishOption } from '../common/zego.entity';
 import { ZegoSignal } from '../common/zego.signal';
@@ -9,2 +9,3 @@ import { Logger } from '../common/zego.logger';
 import { LoggerWeb } from './zego.logger.webrtc';
+import { ZegoStreamCenter } from '../common/ZegoStreamCenter';
 export declare class ZegoPublish {
@@ -14,2 +15,3 @@ logger: Logger;
     state: number;
+    streamCenter: ZegoStreamCenter;
     sessionId: number;
@@ -51,3 +53,3 @@ waitingICETimeInterval: number;
     videoDecodeType: ZegoVideoDecodeType;
-    constructor(log: LoggerWeb, signal: ZegoSignal | null, dataReport: ZegoDataReport, qualityTimeInterval: number);
+    constructor(log: LoggerWeb, signal: ZegoSignal | null, dataReport: ZegoDataReport, qualityTimeInterval: number, streamCenter: ZegoStreamCenter);
     private publishStateUpdateError;
@@ -58,3 +60,3 @@ private resetPublish;
     private shouldSendCloseSession;
-    startPublish(streamId: string, localStream: MediaStream, videoInfo: VideoInfo, publishOption?: PublishOption): void;
+    startPublish(streamId: string, localStream: MediaStream, videoInfo: VideoInfo, publishOption?: webPublishOption): void;
     onCreatePublishSessionSuccess(data: {
@@ -61,0 +63,0 @@ session_id?: string | number;

sdk/webrtc/zego.streamCenter.web.d.ts

 import { ZegoDataReport } from '../common/zego.datareport';
 import { ZegoPreview } from './zego.preview';
-import { MediaStreamConstraints, PlayOption, SignalInfo, ScreenConfig, ERRO, PublishOption } from '../common/zego.entity';
+import { MediaStreamConstraints, webPlayOption, SignalInfo, ScreenConfig, ERRO, webPublishOption } from '../common/zego.entity';
 import { ZegoStreamCenter } from '../common/ZegoStreamCenter';
@@ -29,5 +29,5 @@ import { LoggerWeb } from './zego.logger.webrtc';
     onPlayStateUpdate(type: number, streamid: string, error: any): void;
-    onPlayQualityUpdate(streamid: any, streamQuality: any): void;
+    onPlayQualityUpdate(streamQuality: any): void;
     onPublishStateUpdate(type: number, streamid: string, error: number | ERRO | undefined): void;
-    onPublishQualityUpdate(streamid: any, streamQuality: any): void;
+    onPublishQualityUpdate(streamQuality: any): void;
     onUpdateHeartBeartIntervalHandle(interval: number): void;
@@ -42,8 +42,8 @@ switchDevice(localStream: MediaStream, deviceId: {
     stopPreview(localStream: MediaStream): boolean;
-    setPublishStateStart(streamid: string, localStream: MediaStream, publishOption: PublishOption): boolean;
+    setPublishStateStart(streamid: string, localStream: MediaStream, publishOption: webPublishOption): boolean;
     getTotalStreamId(streamid: string): string;
     startPublishingStream(streamid: string, serverUrls: string[], preferPublishSourceType?: number): boolean;
-    updateWaitingList(signalInfo: SignalInfo, isPublish: boolean, streamId: string, success: Function, error: Function): void;
+    updateWaitingList(signalInfo: SignalInfo, isPublish: boolean, streamID: string, success: Function, error: Function): void;
     publishStream(streamid: string): void;
-    connectPublishServer(streamId: string, serverUrl: string): boolean;
+    connectPublishServer(streamID: string, serverUrl: string): boolean;
     shouldRetry(stream: {
@@ -56,4 +56,4 @@ serverUrls: string[];
     setStreamAudioOutput(localVideo: any, audioOutput: string): boolean;
-    connetWithReuseSignalServer(streamId: string, isPublish: boolean, serverUrl: string, success: Function, error: Function): void;
-    setPlayStateStart(streamid: string, playOption?: PlayOption): boolean;
+    connetWithReuseSignalServer(streamID: string, isPublish: boolean, serverUrl: string, success: Function, error: Function): void;
+    setPlayStateStart(streamid: string, playOption?: webPlayOption): boolean;
     startPlayingStream(streamid: string, serverUrls: string[], success: (stream: MediaStream) => void): boolean;
@@ -74,8 +74,5 @@ private connectPlayServer;
     onPlayerStreamUrlUpdate(streamid: string, url: string, type: string): void;
-    getStats(callBack: (stats: any) => void): void;
     getScreenConstrains(screen: {
         audio?: boolean;
         videoQuality?: 1 | 2 | 3 | 4;
-        width?: number;
-        height?: number;
         bitRate?: number;
@@ -82,0 +79,0 @@ frameRate?: number;

sdk/wechatMini/zego.client.wechat.d.ts

 import { ZegoStreamCenterWechat } from './zego.streamcenter.wechat';
 import { ZegoWebSocket } from './zego.webSocket';
-import { E_CLIENT_TYPE, ENUM_DISPATCH_TYPE, ENUM_PLAY_SOURCE_TYPE, PublishOption, wxQualityStats, ERRO, WxListener, wxConfig } from '../common/zego.entity';
+import { E_CLIENT_TYPE, ENUM_DISPATCH_TYPE, ENUM_PLAY_SOURCE_TYPE, ERRO, WxListener, WxConfig, wxPublishOption } from '../common/zego.entity';
 import { BaseCenter } from '../common/clientBase/index';
@@ -15,4 +15,4 @@ export declare class ZegoClient extends BaseCenter {
     ultraPlaySourceType: string;
-    constructor(appId: number, server: string, userId: string);
-    config(option: wxConfig): boolean;
+    constructor(appID: number, server: string, userID: string);
+    config(option: WxConfig): boolean;
     protected getSocket(server: string): ZegoWebSocket;
@@ -23,18 +23,18 @@ on<k extends keyof WxListener>(listener: k, callBack: WxListener[k]): boolean;
     private setPreferPublishSourceType;
-    getPlayerUrl(streamId: string, playOption?: {
+    startPlayingStream(streamID: string, playOption?: {
         streamParams?: string;
         isMix?: boolean;
+        sourceType?: 0 | 1;
     }): Promise<{
-        streamId: string;
+        streamID: string;
         url: string;
     }>;
-    stopPlayer(streamId: string): boolean;
-    startPusher(streamId: string, publishOption?: PublishOption): Promise<{
-        streamId: string;
+    stopPlayingStream(streamID: string): boolean;
+    startPublishingStream(streamID: string, publishOption?: wxPublishOption): Promise<{
+        streamID: string;
         url: string;
     }>;
-    stopPusher(streamId: string): Promise<void>;
-    getStats(callBack: (stats: wxQualityStats) => void): void;
-    updatePlayerState(streamId: string, event: any): void;
-    updatePlayerNetStatus(streamId: string, event: any): void;
+    stopPublishingStream(streamID: string): boolean;
+    updatePlayerState(streamID: string, event: any): void;
+    updatePlayerNetStatus(streamID: string, event: any): void;
     private startPlayingStreamFromCDN;
@@ -44,3 +44,3 @@ private startPlayingStreamFromBGP;
     private fetchPlayStreamUrl;
-    updateStreamInfo(streamId: any, cmd: string | number, stream_extra_info?: any, error?: any): void;
+    updateStreamInfo(streamID: any, cmd: string | number, stream_extra_info?: any, error?: any): void;
     private handleStreamUpdateRsp;
@@ -73,3 +73,3 @@ private doPlayStream;
     protected WebrtcOnPublishStateUpdateHandle(_type: 0 | 1 | 2, _streamid: string, _error: ERRO): void;
-    static isSupportLive(): Promise<{
+    isSupportLive(): Promise<{
         code: number;
@@ -76,0 +76,0 @@ msg: string;

sdk/wechatMini/zego.play.wechat.d.ts

@@ -9,3 +9,3 @@ import { Logger } from '../common/zego.logger';
     urls: string[];
-    streamid: string;
+    streamId: string;
     playUrlIndex: number;
@@ -30,3 +30,3 @@ playUrlTryCount: number;
     playerLogUploadTime: number;
-    constructor(logger: Logger, streamid: string, urls: string[], params: any, reconnectLimit: number, streamcenter: ZegoStreamCenterWechat, sourceType: number, playerType: number, dataReport: ZegoDataReport);
+    constructor(logger: Logger, streamId: string, urls: string[], params: any, reconnectLimit: number, streamcenter: ZegoStreamCenterWechat, sourceType: number, playerType: number, dataReport: ZegoDataReport);
     resetPlayer(): void;
@@ -33,0 +33,0 @@ newPlayer(): boolean;

sdk/wechatMini/zego.streamcenter.wechat.d.ts

@@ -9,3 +9,2 @@ /**
 import { Logger } from '../common/zego.logger';
-import { wxQualityStats, StreamQuality } from '../common/zego.entity';
 export declare class ZegoStreamCenterWechat extends ZegoStreamCenter {
@@ -23,6 +22,6 @@ dataReport: ZegoDataReport;
     constructor(log: LoggerWechat | Logger, stateCenter: StateCenter);
-    updatePlayingState(streamid: string, streamParams?: any, start?: boolean): void;
-    updatePublishingState(streamid: string, streamParams?: string, start?: boolean): void;
-    updateStreamState(streamid: string, start: boolean, streamParams: string, streamList: Array<{
-        streamid: string;
+    updatePlayingState(streamId: string, streamParams?: any, start?: boolean): void;
+    updatePublishingState(streamId: string, streamParams?: string, start?: boolean): void;
+    updateStreamState(streamID: string, start: boolean, streamParams: string, streamList: Array<{
+        streamID: string;
         params: string;
@@ -32,27 +31,27 @@ }>): void;
     isPublishing(): boolean;
-    startPlayingStream(streamid: string, streamUrlList: string[], dispatchType?: number): any;
-    startPlayer(streamid: string, streamUrlList: string[], dispatchType: number, playerType: number): any;
-    stopPlayingStream(streamid: string | undefined): void;
-    stopPlayer(streamid: string | number): void;
-    startPublishingStream(streamid: string, streamUrlList: string[], dispatchType?: number): any;
-    stopPublishingStream(streamid: string | undefined): void;
-    updatePlayerState(streamid: string, event: any): void;
-    updatePlayerNetStatus(streamid: string, event: any): void;
+    startPlayingStream(streamId: string, streamUrlList: string[], dispatchType?: number): any;
+    startPlayer(streamID: string, streamUrlList: string[], dispatchType: number, playerType: number): any;
+    stopPlayingStream(streamId: string | undefined): void;
+    stopPlayer(streamId: string | number): void;
+    startPublishingStream(streamID: string, streamUrlList: string[], dispatchType?: number): any;
+    stopPublishingStream(streamId: string | undefined): void;
+    updatePlayerState(streamId: string, event: any): void;
+    updatePlayerNetStatus(streamId: string, event: any): void;
     reset(): void;
-    reportPublishEvent(streamid: string, error?: any): void;
-    reportPlayEvent(streamid: string, error?: any): void;
-    onPlayStateUpdate(type: number, streamid: string, error: any): void;
-    onPlayQualityUpdate(streamid: any, streamQuality: any): void;
-    onPublishStateUpdate(type: number, streamid: string, error: number | {
+    reportPublishEvent(streamId: string, error?: any): void;
+    reportPlayEvent(streamId: string, error?: any): void;
+    onPlayStateUpdate(type: number, streamId: string, error: any): void;
+    onPlayQualityUpdate(streamQuality: any): void;
+    onPublishStateUpdate(type: number, streamId: string, error: number | {
         code: string | number;
         msg: string;
     } | undefined): void;
-    onPublishQualityUpdate(streamid: any, streamQuality: any): void;
-    onPublisherStreamUrlUpdate(streamid: any, url: any): void;
-    onPlayerStreamUrlUpdate(streamid: any, url: any): void;
+    onPublishQualityUpdate(streamQuality: any): void;
+    onPublisherStreamUrlUpdate(streamId: any, url: any): void;
+    onPlayerStreamUrlUpdate(streamId: any, url: any): void;
     getReconnectLimit(sourceType: number): number;
-    onPlayerStart(streamid: string, playerType: number): void;
-    onPlayerStop(streamid: string, playerType: number, error: any): void;
-    onPlayerRetry(streamid: string, playerType: number): void;
-    onPlayerQuality(streamid: string, streamQuality: {
+    onPlayerStart(streamId: string, playerType: number): void;
+    onPlayerStop(streamId: string, playerType: number, error: any): void;
+    onPlayerRetry(streamId: string, playerType: number): void;
+    onPlayerQuality(streamID: string, streamQuality: {
         videoBitrate: any;
@@ -64,5 +63,3 @@ audioBitrate: any;
     }, playerType: number): void;
-    onStreamUrlUpdate(streamid: string, url: string, playerType: number): void;
-    getStats(callBack: (stats: wxQualityStats) => void): void;
-    setStats(streamId: string, streamQuality: StreamQuality, type: 0 | 1, callBack: (stats: wxQualityStats) => void): void;
+    onStreamUrlUpdate(streamId: string, url: string, playerType: number): void;
 }

No alert changes

Improved metrics

Total package byte prevSize

204424

increased by1.77%

Lines of code

2466

increased by1.94%

Number of lines in readme file

12

increased by100%

No dependency changes