API概览

import XYRTC from '@xylink/xy-mp-sdk';

/**
 * Client配置参数
 *
 * @property { string } server - 非必填 服务地址, IP/域名 + 端口，如: wxrtc.xylink.com
 * @property { string } appId - 非必填 SDK企业ID，通过小鱼易连企业管理平台创建
 * @property { string } extId - 非必填 SDK应用ID，通过小鱼易连企业管理平台创建
 * @property { string } layoutMode - 非必填 | AUTO | 布局模式，可选：AUTO | CUSTOM
 * @property { string } logServer - 非必填 logServer服务地址，默认不需要配置
 * @property { { offset?: number[];  } } container - 非必填 | {} | 配置layout container容器节点和偏移量
 * @property { number[] } container.offset - 非必填 | [] | 配置[left, top, width, height]的偏移量，自动布局适用
 * @property { boolean } report - 非必填 | false | 是否上报会议质量，默认不上报
 * @property { boolean } screenOn - 非必填 | true | 是否常亮,默认常亮
 * @property { number } logType - 非必填 | 0 | 日志类型, 默认微信日志
 */                                 
interface ClientConfig {
  server?: string;
  appId?: string;
  extId?: string;
  layoutMode?: LayoutMode;
  logServer?: string;
  container?: {
    offset?: number[];
  };
  screenOn?: boolean;
  report?: boolean;
  logType?: LogType;
}

/**
 * 布局模式
 *
 * @enum
 * @param  AUTO auto 自动布局，布局内容由sdk内部实现
 * @param  CUSTOM custom 自定义布局，第三方根据自己业务实现
 */
export enum LayoutMode {
  AUTO = 'auto',
  CUSTOM = 'custom'
}
  
/**
 * 日志类型
 *
 * @enum
 * @param DEFAULT 0 - 微信日志
 * @param CUSTOM 1 - 小鱼日志
 */
enum LogType {
  DEFAULT,
  CUSTOM
}

const XYClient = XYRTC.createClient(config?: ClientConfig);

import XYRTC from '@xylink/xy-mp-sdk';

/**
 * 检测微信版本是否支持xy-mp-sdk；
 *
 * @returns {boolean} isSupport - 是否支持
 */

XYRTC.checkSupportMp(): boolean

/**
 * 修改服务域名
 * 默认server: wxrtc.xylink.com
 *
 * @param { string } server - 服务域名
 */
XYClient.setServer(server: string): void

XYClient.setFeatureConfig(config: FeatureConfig): void;

/**
 * SDK功能控制开关，用于内部是否启用某些功能的运行
 *
 * @property { boolean } enableMeetingInvite 是否启用查询小鱼会议邀请链接信息，默认不启用，设置为false；
 * @property { boolean } enableLayoutAvatar 是否启用获取参会者头像，默认不启用，设置为false;
 */
interface FeatureConfig {
  enableMeetingInvite?: boolean;
  enableLayoutAvatar?: boolean;
}

XYClient.login(token: string, cb?: (response: Object) => {}): Promise<IResponse>;

XYClient.loginExternalAccount(params: LoginExternalAccountParams): Promise<StatusInfo>;

/**
 * 登录参数
 *
 * @property { string } extUserId - 第三方UserId，规则：数字、字母、\_-, 且长度不能超过 50字符
 * @property { string } displayName - 登录用户名
 */
interface LoginExternalAccountParams {
  extUserId: string;
  displayName: string;
}

/**
 * 登录结果信息
 *
 * @property { string } key - 错误码
 * @property { string } message - 消息提示
 * @property { IUserInfo } data - 登录用户信息
 */
interface StatusInfo {
  key: string;
  data: UserInfo | null;
  message: string;
}

/**
 * 用户信息
 *
 * @property { string } appId - 应用ID
 * @property { string } callNumber - 用户呼叫号码ID
 * @property { string } deviceSN - 设置SN
 * @property { string } displayName - 登录用户名
 * @property { string } enterpriseId - 登陆企业ID
 * @property { string } securityKey - 安全码
 * @property { string } userId - 用户ID
 */
interface UserInfo {
  appId: string;
  callNumber: string;
  deviceSN: string;
  displayName: string;
  enterpriseId: string;
  securityKey: string;
  userId: number;
}

XYClient.makeCall(params: MakeCallParams): Promise<IResponse>;

/**
 * 呼叫参数
 *
 *
 * @property {string}  string - 云会议室号
 * @property {string}  password - 云会议室入会密码, 默认填写为""
 * @property {string}  displayName - 入会名称
 * @property {boolean} isAudioMute - 关闭音频入会
 * @property {boolean} isVideoMute - 关闭视频入会
 * @property {CameraPosition}  cameraPosition - 前置或后置摄像头, 可选值：front，back
 */
interface MakeCallParams {
  number: string;
  password?: string;
  displayName?: string;
  isAudioMute?: boolean;
  isVideoMute?: boolean;
  cameraPosition?: CameraPosition;
}

/**
 * 前置或后置摄像头
 *
 * @property  FRONT front - 前置
 * @property  BACK back - 后置
 */
enum CameraPosition {
  FRONT = 'front',
  BACK = 'back'
}

/**
 * 返回结果
 *
 * @param { string } key - 错误码
 * @param { any } data - 数据
 * @param { string } message - 结果消息
 */
interface IResponse {
  key: string;
  data: any;
  message: string;
}

/**
 * 设置页面实例
 *
 * @param { * } ctx - 当前页面示例
 */
XYClient.setPageInstance(ctx): void

/**
 * 设置Client配置参数
 *
 * @param {ClientConfig} config - 配置参数
 */
XYClient.setConfig(config: ClientConfig): void;


/**
 * Client配置参数
 *
 * @property { string } server - 非必填 服务地址, IP/域名 + 端口，如: wxrtc.xylink.com
 * @property { string } appId - 非必填 SDK企业ID，通过小鱼易连企业管理平台创建
 * @property { string } extId - 非必填 SDK应用ID，通过小鱼易连企业管理平台创建
 * @property { string } layoutMode - 非必填 | AUTO | 布局模式，可选：AUTO | CUSTOM
 * @property { string } logServer - 非必填 logServer服务地址，默认不需要配置
 * @property { { offset?: number[];  } } container - 非必填 | {} | 配置layout container容器节点和偏移量
 * @property { number[] } container.offset - 非必填 | [] | 配置[left, top, width, height]的偏移量，自动布局适用
 * @property { boolean } report - 非必填 | false | 是否上报会议质量，默认不上报
 * @property { boolean } screenOn - 非必填 | true | 是否常亮,默认常亮
 * @property { number } logType - 非必填 | 0 | 日志类型, 默认微信LogManager
 */
interface ClientConfig {
  server?: string;
  appId?: string;
  extId?: string;
  layoutMode?: LayoutMode;
  logServer?: string;
  container?: {
    offset?: number[];
  };
  screenOn?: boolean;
  report?: boolean;
  logType?: LogType;
}

/**
 * 设置是否进行内部事件的console和写入logger文件
 *
 * @param { boolean } isConsole - 默认是false，禁止向控制台打印调试信息
 * @param { boolean } isLogger - 默认是true，开启日志文件写入
 */
XYClient.setDebug(isConsole: boolean, isLogger: boolean): void

/**
 * setConfig
 *
 * @param { LayoutMode } mode 布局模式: auto/custom 默认:auto
 */
XYClient.setLayoutMode(mode?: LayoutMode): void;


/**
 * 布局模式
 *
 * @enum
 * @param  AUTO auto 自动布局，布局内容由sdk内部实现
 * @param  CUSTOM custom 自定义布局，第三方根据自己业务实现
 */
enum LayoutMode {
  AUTO = 'auto',
  CUSTOM = 'custom'
}

XYClient.muteAudio():void

XYClient.unmuteAudio(): void

/**
 * 关闭摄像头
 *
 * @property { number } reason - 可选项，默认是0，填写关闭视频原因，0-7数值
 * 枚举按顺序分别代表：
 * MuteByUser：用户自行关闭视频
 * MuteByBWLimit：带宽太低，媒体自动关闭
 * MuteByNoInput：没有输入设备
 * MuteByConfMgmt：通过会控关闭
 * MuteByDeviceDetection：设备检测关闭
 * MuteByPhoneCall：电话接入，自动关闭
 * MuteBySync：未知
 * MuteByAppInBg：应用切后台
 */
XYClient.muteVideo(reason?: number): void

XYClient.unmuteVideo():void

/**
 * 举手发言 操作
 *
 * @returns { Promise<boolean> } 是否举手
 */
XYClient.onHandUp(): Promise<boolean>

/**
 * 取消举手 操作
 *
 * @returns { Promise<boolean> } 是否举手
 */
XYClient.onHandDown(): Promise<boolean>

/**
 * 结束发言 操作
 *
 * @returns { Promise<boolean> } 是否举手
 */
XYClient.onMute(): Promise<boolean>;

/**
 * 切换前置/后置摄像头
 *
 */
XYClient.switchCamera(): Promise<'front' | 'back'>;

/**
 * 退出会议
 *
 */
XYClient.hangup(): void

XYClient.on(keyName: string, listenerFunction: () => {}): void

XYClient.off(keyName: string): void

XYClient.offAll(): void

XYClient.sendCustomMessage(config: ICustomMessageConfig): void;

/**
 * 用户自定义消息
 *
 * @property { number } toPid - 消息的接收方pid，0表示广播消息、非0表示单点消息；
 * @property { string } data - 消息内容，可以被JSON序列化的字符串；因业务数据可能会传输图片，需要进行base64编码，消息最大长度限制：1MB
 */
interface ICustomMessageConfig {
  toPid: number;
  data: string;
}

XYClient.convertPDF(config: CovertPDFConfig) => Promise<IResponse>);

/**
 * PDF信息
 * 
 * @param { string } pdfURL - pdf地址
 * @param { string } pdfMD5 - pdfMD5值
 * @param { string } compressLevel - 转图片时压缩比例，0-100，表示压缩等级百分比，传100就是不压缩，传1就是压缩为1%，默认是60
 */
interface CovertPDFConfig {
  pdfURL: string;
  pdfMD5: string;
  // v3.8.6+支持
  compressLevel?: number;
}

/**
 * 回调结果
 * @property { string } code - 状态码
 * @property { string } message - 消息
 * @property { null | string[] } data - 返回转换图片结果
 */
interface IResponse {
  key: string;
  message: string;
  data: null | string[];
}

/**
 * 手动播放Layout中所有的远端画面
 *
 */
XYClient.startLivePusher(successCB, failCB): void

/**
 * 停止推流
 *
 */
XYClient.stopPushLive(): void

/**
 * 手动播放Layout中所有的远端画面
 *
 */
XYClient.startLivePlayer(): void

/**
 * 处理live-pusher状态变化事件
 *
 * @param {eventhandle} e
 */
XYClient.pusherEventHandler(e): void

/**
 * 处理live-pusher网络状态数据
 *
 * @param {eventhandle} e
 */
XYClient.pusherNetStatusHandler(e): void

/**
 * 处理live-pusher渲染错误事件
 *
 * @param {eventhandle} e
 */
XYClient.pusherErrorHandler(e): void

/**
 * 处理live-pusher播放音量大小数据
 *
 * @param {eventhandle} e
 */
XYClient.pusherAudioVolumeNotify(e): void

/**
 * 处理live-player播放状态变化事件
 *
 * @param {eventhandle} e
 */
XYClient.playerEventHandler(e): void

/**
 * 处理live-player网络状态数据
 *
 * @param {eventhandle} e
 */
XYClient.playNetStatusHandler(e): void

/**
 * 处理live-player播放音量大小数据
 *
 * @param {eventhandle} e
 */
XYClient.playAudioVolumeNotify(e): void

/**
 * [custom]自定义布局更新模板
 *
 */
XYClient.updateTemplate(template: CustomTemplateInfo):void;

/**
 * 自定义布局模版信息
 *
 * @property { string } callNumber - 必填，参会者的呼叫号码，此数据可以从 Roster List 数据中获取
 * @property { number|string[] } position - 必填，参会者位置和大小信息 [left, top, width, height], 如果指定数字，则默认单位是vw, vh；如果指定string, 则用户自定义样式单位
 * @property { string } name - 必填，参会者名称，此数据可以从 Roster List 数据中获取
 * @property { QualityType } quality -必填，参会者名称，指定参会者画面清晰度，建议将大屏画面设置为 high，小屏画面设置为 normal，content 设置为 hd；
 * @property { boolean } isContent - 当前位置是否是 Content 共享内容
 * @property { string } style - 自定义样式
 */
interface CustomTemplateInfo {
  callNumber: string;
  position: number[];
  name: string;
  quality: QualityType;
  isContent?: boolean;
  style?: string;
}


/**
 * 参会者画面清晰度, 建议将大屏画面设置为 high，小屏画面设置为 normal，content 设置为 hd；
 */
enum QualityType {
  NORMAL = 'normal',
  HIGH = 'high',
  HD = 'hd'
}

/**
 * 设置某个画面全屏
 * 
 * @param {LayoutInfo} item 全屏Layout对象
 */
XYClient.handleFullScreen(item: LayoutInfo): void;


interface ILayout{
  id: string;
}

/**
 * 设置日志类型，默认微信小程序日志存储方式
 * 0：微信日志，当日志上传成功后，可以在小程序账号所对应的微信公众平台系统中的用户反馈中下载对应的日志文件
 * 1：小鱼日志，目前最大可存30M，可通过uploadLog方法上传到小鱼平台
 *
 * @param { LogType } type 0:微信日志，1:小鱼自定义日志 默认值:0
 */
XYClient.setLogType(type:LogType):void;


/**
 * 日志类型
 *
 * @enum
 * @param DEFAULT 0 - 微信日志
 * @param CUSTOM 1 - 小鱼日志
 *
 */
enum LogType {
  DEFAULT,
  CUSTOM
}

/**
 * 设置日志服务地址，仅支持小鱼自定义日志上传
 *
 * @param { string } server 日志地址 eg:xxx.xxx.xxx:port  不需要提供协议头，只需要提供完整的域名+端口
 */
XYClient.setLogServer(server:string):void;

/**
  * 上传日志，仅支持小鱼自定义日志上传
  *
  * @param { UploadLogContent } Obj
  * @property { string } Obj.account 上传账号
  * @property { string } Obj.comments 上传时备注信息
  * @returns { Promise<Object> } 上传结果
  */
XYClient.uploadLog(obj?: UploadLogContent):void;


/**
 * 上传日志内容
 *
 * @property { string } comments - 内容
 * @property { string } account - 账号
 */
export interface UploadLogContent {
  comments?: string;
  account?: string;
}

XYClient.subscribeBulkRoster(): Promise<boolean>
  

XYClient.getSnapshot(params: SnapshotParams):Promise<SnapshotResult>;

/**
 * 截图参数
 *
 * @property { string } id - LayoutID 参会者唯一ID
 * @property { 'raw' | 'compressed' } quality - 默认值:raw; raw：原图；compressed：压缩图
 * @property { 'stream' | 'view' } sourceType - 默认值:view; stream：截取视频源；view：截取渲染后的画面
 */
  
interface SnapshotParams {
  id: string;
  quality?: 'raw' | 'compressed';
  sourceType?: 'stream' | 'view';
}


/**
 * 截图结果
 *
 * @property { string } tempImagePath - 图片文件的临时路径 (本地路径)
 * @property { string } width - 图片的宽度
 * @property { string } height - 图片的高度
 */
interface SnapshotResult {
  tempImagePath: string;
  width: string;
  height: string;
}

/**
 * 对Content画面进行缩放配置
 *
 * @param { Object } config - 配置参数
 * @property { Boolean } enablePinchToZoom - 是否可以双指手动缩放
 * @property { 1 | 2 | 3 } scale - 可选参数，放大倍数，[1,3]
 */
xylinkRoom.setViewZoom({ enablePinchToZoom, scale });

XYClient.on('roomEvent', (e: any) => {
  const { type, detail } = e;
  
  // 详细type见事件列表
})

<xylink-room ... bindonRoomEvent="onRoomEvent" />

// js中定义接收函数
onRoomEvent(event) {
    const { type, detail } = event.detail;
    
  // 详细type见事件列表
}

// 解构消息体
const { detail: ConnectedInfo } = event.detail;

/**
 * 加入会议成功消息
 *
 * @property {string} meetingId - 会议ID
 * @property {string} callUri - 设备ID
 * @property {string} conferenceNumber - 会议号
 * @property {number} rtmpMode 会议模式，0：trtc模式 1：rtmp自建模式
 * @property {number} callIndex - 会议序号
 * @property {number} automute - 是否自动静音、强制静音
 * @property {number} userId - 用户ID
 * @property {number} roomid - 房间ID
 */
export interface ConnectedInfo {
  meetingId: string;
  callUri: string;
  conferenceNumber: string;
  callIndex: number;
  rtmpMode: number;
  automute: 'mute' | 'forcemute' | '';
  roomid: number;
  userId?: string;
}

const { detail: IDisconnected } = event.detail;

/**
 * 退会信息
 *
 * @property { string } code - 错误码
 * @property { any } data - 详情
 * @property { string } message - 如果存在message，则提示信息并退会，否则直接退出会议；
 */
export interface DisconnectedInfo {
  code: string;
  data: object;
  message: string;
}

// 解构消息体
const { detail: StatusInfo } = event.detail;

/**
 * 设备授权错误消息
 *
 * @property {string} key - 状态码
 * @property {any} data - 详情
 * @property {string} message - 描述信息
 */
interface StatusInfo {
  key: string;
  data: any;
  message: string;
}

// 解构消息体
const { detail: boolean } = event.detail;

// 解构消息体
const { detail: IClickEvent } = event.detail;

/**
 * 单击/长按事件类型
 *
 * 此处只需要关注：currentTarget.dataset.item值即可，上报当前画面的参会者信息
 */
interface IClickEvent {
  changedTouches: [
    {
      clientX: number;
      clientY: 127.734375;
      force: 1;
      identifier: 0;
      pageX: 367.546875;
      pageY: 127.734375;
    }
  ];
  currentTarget: {
    dataset: {
      item: {
        deal: boolean;
        fit: string;
        id: string;
        muted: boolean;
        playUrl: string;
        position: number[];
        resolution: number;
        roster: {
          deviceType: string;
          callNumber: string;
          pid: number;
          userId: string;
          displayName: string;
          audioTxMute: true;
          isActiveSpeaker: boolean;
          isContent: boolean;
          isOnHold: boolean;
          muted: boolean;
          videoMuteReason: number;
          videoTxMute: boolean;
        };
        status: string;
        style: string;
      };
      id: string;
      offsetLeft: number;
      offsetTop: number;
    };
  };
  detail: {
    x: number;
    y: number;
  };
  type: string;
}

// 解构消息体
const { detail: IClickEvent } = event.detail;

/**
 * 双击事件类型
 *
 * 此处只需要关注：currentTarget.dataset.item值即可，上报当前画面的参会者信息
 */
interface IClickEvent {
  changedTouches: [
    {
      clientX: number;
      clientY: 127.734375;
      force: 1;
      identifier: 0;
      pageX: 367.546875;
      pageY: 127.734375;
    }
  ];
  currentTarget: {
    dataset: {
      item: {
        deal: boolean;
        fit: string;
        id: string;
        muted: boolean;
        playUrl: string;
        position: number[];
        resolution: number;
        roster: {
          deviceType: string;
          callNumber: string;
          pid: number;
          userId: string;
          displayName: string;
          audioTxMute: true;
          isActiveSpeaker: boolean;
          isContent: boolean;
          isOnHold: boolean;
          muted: boolean;
          videoMuteReason: number;
          videoTxMute: boolean;
        };
        status: string;
        style: string;
      };
      id: string;
      offsetLeft: number;
      offsetTop: number;
    };
  };
  detail: {
    x: number;
    y: number;
  };
  type: string;
}

// 解构消息体
const { detail: IClickEvent } = event.detail;

/**
 * 长按事件类型
 *
 * 此处只需要关注：currentTarget.dataset.item值即可，上报当前画面的参会者信息
 */
interface IClickEvent {
  changedTouches: [
    {
      clientX: number;
      clientY: 127.734375;
      force: 1;
      identifier: 0;
      pageX: 367.546875;
      pageY: 127.734375;
    }
  ];
  currentTarget: {
    dataset: {
      item: {
        deal: boolean;
        fit: string;
        id: string;
        muted: boolean;
        playUrl: string;
        position: number[];
        resolution: number;
        roster: {
          deviceType: string;
          callNumber: string;
          pid: number;
          userId: string;
          displayName: string;
          audioTxMute: true;
          isActiveSpeaker: boolean;
          isContent: boolean;
          isOnHold: boolean;
          muted: boolean;
          videoMuteReason: number;
          videoTxMute: boolean;
        };
        status: string;
        style: string;
      };
      id: string;
      offsetLeft: number;
      offsetTop: number;
    };
  };
  detail: {
    x: number;
    y: number;
  };
  type: string;
}

// 解构消息体
const { detail: StatusInfo } = event.detail;

/**
 * 设备授权错误消息
 *
 * @property {string} key - XYSDK:980406
 * @property {any} data - level  内存告警等级，只有 Android 才有
 */
interface StatusInfo {
  key: string;
  data: number;
}

const { detail: RosterObj } = ms.detail;


/**
 * roster相关信息
 *
 * @property { IRoster[] } rosterV - roster信息，目前最多上报20条
 * @property { number } contentSenderPid - 共享内容pid
 * @property { number } participantsNum - 参会者人数
 * @property { number } confNumber - 会议号
 */
interface RosterObj {
  rosterV: IRoster[];
  contentSenderPid: number;
  participantsNum: number;
  confNumber: number;
}

/**
 * Roster：参会者的基本信息，包含基本信息，设备信息，画面信息等
 *
 * @property { IDeviceType } deviceType - 设备类型
 * @property { string } callNumber - 用户账号
 * @property { number } pid - 参会者id
 * @property { string } userId - 参会者callUri eg:123456@WECHAT
 * @property { string } callUri - 参会者callUri eg:123456@WECHAT
 * @property { string} displayName - 参会者名称
 * @property { boolean} audioTxMute - 参会者麦克风状态，true：关闭，false：开启
 * @property { boolean} videoTxMute - 参会者摄像头状态，true：关闭，false：开启
 * @property { number } videoMuteReason - 视频关闭原因
 * @property { boolean} isContent - 参会者画面类型，true：是共享内容画面，false：people画面
 * @property { boolean} isOnHold - 参会者是否是被呼叫等待状态
 * @property { boolean } isLocal - 参会者是否是自己
 * @property { number } feccOri - ignore
 * @property { number } level - ignore
 */
interface IRoster {
  // 参会者设备类型，常见的如下：
  // hard：硬件设备、soft：APP设备、desk：PC客户端设备、wechat：小程序设备、webrtc：WebRTC设备
  // 323：H323设备、pstngw：电话入会设备、bruce：大鱼设备、tvbox：电视屏设备
  deviceType: IDeviceType;
  callNumber: string;
  pid: number;
  userId: string;
  callUri: string;
  displayName: string;
  audioTxMute: boolean;
  videoTxMute: boolean;
  videoMuteReason: number;
  isContent?: boolean;
  isOnHold?: boolean;
  isLocal?: boolean;
  level?: number;
  feccOri?: number;
}

const { detail: LayoutInfo[] } = ms.detail

/**
 * 布局对象
 *
 * @property { string } id - LayoutID =  callUr + (isContent? 1:0)
 * @property { boolean } isPusher - 是否是本地画面
 * @property { IRoster } roster - 参会者基本信息、状态信息，例如：用户名、麦克风/摄像头状态等信息
 * @property { number[] } position - 参会者的位置信息
 * @property { string } playUrl - 远端参会者的画面拉流地址
 * @property { PlayStatus } status - 远端参会者的画面播放状态
 * @property { string } style - 参会者的位置样式
 * @property { number } resolution - 参会者分辨率
 * @property { string } avatar - 参会者头像 v3.9.0+支持
 */
export interface LayoutInfo {
  id: string;
  isPusher: boolean;
  roster: Partial<IRoster>;
  position: number[];
  style: string;
  playUrl?: string;
  status?: PlayStatus;
  resolution?: number;
  avatar?: string;
}



/**
 * 远端画面播放状态
 *
 * @param START start - 可以播放
 * @param PULL pull - 请求中
 * @param PAUSE pause - 暂停
 */

export enum PlayStatus {
  NONE = '',
  START = 'start',
  PULL = 'pull',
  PAUSE = 'pause'
}

const { detail: MeetingControl }  = ms.detail


/**
 * 会控信息
 *
 * @property { string } chairmanUri 主会场calluri
 * @property { boolean } disableMute 是否强制静音
 * @property { string } muteOperation 音频状态
 */
export interface MeetingControl {
  chairmanUri?: string;
  muteOperation?: string;
  disableMute?: boolean;
}

const { detail: Object } = ms.detail

const { detail: Object } = ms.detail

// 网络质量：0：未定义 1：最好 2：好 3：一般 4：差 5：很差 6：不可用
const { detail: 0 | 1 | 2 | 3 | 4 | 5 | 6 } = ms.detail

const { detail: IRoster } = ms.detail;


/**
 * Roster：参会者的基本信息，包含基本信息，设备信息，画面信息等
 *
 * @property { IDeviceType } deviceType - 设备类型
 * @property { string } callNumber - 用户账号
 * @property { number } pid - 参会者id
 * @property { string } userId - 参会者callUri eg:123456@WECHAT
 * @property { string } callUri - 参会者callUri eg:123456@WECHAT
 * @property { string} displayName - 参会者名称
 * @property { boolean} audioTxMute - 参会者麦克风状态，true：关闭，false：开启
 * @property { boolean} videoTxMute - 参会者摄像头状态，true：关闭，false：开启
 * @property { number } videoMuteReason - 视频关闭原因
 * @property { boolean} isContent - 参会者画面类型，true：是共享内容画面，false：people画面
 * @property { boolean} isOnHold - 参会者是否是被呼叫等待状态
 * @property { boolean } isLocal - 参会者是否是自己
 * @property { number } feccOri - ignore
 * @property { number } level - ignore
 */
interface IRoster {
  // 参会者设备类型，常见的如下：
  // hard：硬件设备、soft：APP设备、desk：PC客户端设备、wechat：小程序设备、webrtc：WebRTC设备
  // 323：H323设备、pstngw：电话入会设备、bruce：大鱼设备、tvbox：电视屏设备
  deviceType: IDeviceType;
  callNumber: string;
  pid: number;
  userId: string;
  callUri: string;
  displayName: string;
  audioTxMute: boolean;
  videoTxMute: boolean;
  videoMuteReason: number;
  isContent?: boolean;
  isOnHold?: boolean;
  isLocal?: boolean;
  level?: number;
  feccOri?: number;
}

// 解构消息体，true代表开启等候室，false则关闭
const { detail: true | false } = ms.detail;

const { detail: NetworkInfo } = ms.detail;

/**
 * 网络质量信息
 *
 * @property {MeetingStatsInfo} info 网络质量详细信息
 * @property {string} userId 终端ID
 * @property {number} volume 音量
 * @property {number} pid 终端ID
 */
type NetworkInfo = Record<
  string,
  {
    info: NetworkInfoItem;
    userId: string;
    volume: number;
    displayName: string;
    pid?: number;
  }
>;

/**
 * 网络质量信息信息
 *
 * @property {number}  videoGOP 当前视频 GOP,也就是每两个关键帧(I帧)间隔时长，单位 s
 * @property {number}  videoFPS 当前视频帧率
 * @property {number}  netJitter 网络抖动情况，为 0 时表示没有任何抖动，值越大表明网络抖动越大，网络越不稳定
 * @property {number}  avRecvInterval 音画同步错位时间（网络），单位 ms，此数值越小，音画同步越好
 * @property {number}  videoBitrate 当前视频编/码器输出的比特率，单位 kbps
 * @property {number}  audioBitrate 当前音频编/码器输出的比特率，单位 kbps
 * @property {number}  videoHeight 视频画面的高度
 * @property {number}  videoWidth 视频画面的宽度
 * @property {number}  netSpeed 当前的发送/接收速度
 * @property {number}  netQualityLevel 网络质量：0：未定义 1：最好 2：好 3：一般 4：差 5：很差 6：不可用
 * @property {number}  videoCache 缓冲的视频总时长，单位毫秒
 * @property {number}  audioCache 缓冲的音频总时长，单位毫秒
 * @property {number}  vSumCacheSize 缓冲的总视频帧数，该数值越大，播放延迟越高
 * @property {number}  audioCacheThreshold 音频缓冲时长阈值，缓冲超过该阈值后，播放器会开始调控延时
 * @property {number}  vDecCacheSize 解码器中缓存的视频帧数 (Android 端硬解码时存在）
 * @property {NetworkQualityLevel}  netWorkLevel 小鱼网络质量等级
 */
interface NetworkInfoItem {
  videoGOP: number;
  videoFPS: number;
  netJitter: number;
  avRecvInterval: number;
  videoBitrate: number;
  audioBitrate: number;
  videoHeight: number;
  videoWidth: number;
  netSpeed: number;
  netQualityLevel: number;
  videoCache: number;
  audioCache: number;
  vSumCacheSize: number;
  audioCacheThreshold: number;
  vDecCacheSize: number;
  netWorkLevel?: NetworkQualityLevel;
}

const { detail }: IDetail = ms.detail;

interface IDetail {
  detail: IActiveSpeaker[];
}

/**
 * 当前讲话人信息
 */
interface IActiveSpeaker {
  isActiveSpeaker: boolean;
  pid: number;
  userId: string;
}

const { detail }: IDetail = ms.detail;

interface IDetail {
  detail: IReceiveCustomMessage;
}

/**
 * 接收到自定义消息
 *
 * @property { string } type - 消息Type
 * @property { number } fromPid - 消息的发送方pid
 * @property { number } toPid - 消息的接收方pid，0表示广播消息、非0表示单点消息；
 * @property { string } data - 消息内容，可以被JSON序列化的字符串；
 */
interface IReceiveCustomMessage {
  type: string;
  fromPid: number;
  toPid: number;
  data: string;
}

const { detail }: IDetail = ms.detail;

interface IDetail {
  detail: IReceiveCustomMessage;
}

/**
 * 远端参会者应用中止消息（视频无流状态）
 *
 * @param { string } callUri - 终端号
 * @param { boolean } freeze - 是否无流，true代表无流
 * @param { number } pid - 用户ID
 */
interface IStreamStatusChanged {
  callUri: string;
  freeze: boolean;
  pid: number;
}

const { detail }: IDetail = ms.detail;

interface IDetail {
  detail: NetworkParameter;
}

/**
 * 远端参会者网络质量等级
 *
 * @param { string } fromCallUri - 远端参会者唯一标识ID
 * @param { number } fromPid - 远端用户ID
 * @param { 1|2|3|4 } networkLevel - 网络等级，1差，2中，3良，4优
 */
interface NetworkParameter {
  fromCallUri: string;
  fromPid: number;
  networkLevel: NetworkQualityLevel
}


/**
 * 网络质量信号等级
 *
 * @param Bad 1 - 非常差
 * @param Poor 2 - 差
 * @param Good 3 - 一般
 * @param Excellent 4 - 很好
 */
enum NetworkQualityLevel {
  Bad = 1,
  Poor,
  Good,
  Excellent
}

const { detail }: IDetail = ms.detail;

interface IDetail {
  detail: NetworkQualityLevel;
}


/**
 * 网络质量信号等级
 *
 * @param Bad 1 - 非常差
 * @param Poor 2 - 差
 * @param Good 3 - 一般
 * @param Excellent 4 - 很好
 */
enum NetworkQualityLevel {
  Bad = 1,
  Poor,
  Good,
  Excellent
}

const { detail }: MeetingInfo = ms.detail;

/**
 * 会议室信息
 *
 * @property { string } callNumber 最终进入的真实会议号
 * @property { string } callUrl 呼叫号码真实url
 * @property { string } deviceId 号码id
 * @property { string } deviceType 号码类型
 * @property { string } displayName 云会议号名称
 * @property { string } number 呼叫的号码
 * @property { string } numberType 会议号类型
 * @property { string } meetingId 当前会议ID
 * @property { string } password 会议密码
 * @property { InviteInfo } inviteInfo 会议邀请信息，入会成功后上报此值 v3.9.0新增
 */
export interface MeetingInfo {
  callNumber?: string;
  callUrl?: string;
  deviceId?: string;
  deviceType?: string;
  displayName?: string;
  number?: string;
  numberType?: string;
  meetingId?: string;
  password?: string;
  inviteInfo?: InviteInfo;
}

/**
 * 会议分享信息
 *
 * @property { string } displayName - 会议室名称
 * @property { boolean } inEnterprise - 所属会议号是否在企业中
 * @property { string } inviteAppUrl - 微信邀请链接
 * @property { string } inviteUrl - 云会议室邀请链接
 * @property { string } invokSchema - 小鱼客户端Scheme获取地址
 * @property { string } linkNumber - 电话入会号码
 * @property { string } mobileWebrtcVisibleSetting - 移动端是否显示WebRTC入会
 * @property { string } number - 会议号
 * @property { string } password - 入会密码
 * @property { string } pstnNumber - 电话呼叫号码
 * @property { string } shareUrl - 邀请链接详情页地址
 * @property { string } userAvatar - 管理员头像
 * @property { string } userName - 管理员名称
 * @property { string } userProfileId - 用户ID
 * @property { string } voiceNumber - 电话呼叫时的会议号
 * @property { string } webrtcSetting - PC端是否显示WebRTC入会
 * @property { string } webrtcUrl - WebRTC入会地址
 *
 */
export interface InviteInfo {
  displayName: string;
  inEnterprise: boolean;
  inviteAppUrl: string;
  inviteUrl: string;
  invokSchema: string;
  linkNumber: string;
  mobileWebrtcVisibleSetting: boolean;
  number: string;
  password: string;
  pstnNumber: string;
  shareUrl: string;
  userAvatar: string;
  userName: string;
  userProfileId: string;
  voiceNumber: string;
  webrtcSetting: boolean;
  webrtcUrl: string;
}

const { detail }: IRoster[] = ms.detail;


/**
 * Roster：参会者的基本信息，包含基本信息，设备信息，画面信息等
 *
 * @property { IDeviceType } deviceType - 设备类型
 * @property { string } callNumber - 用户账号
 * @property { number } pid - 参会者id
 * @property { string } userId - 参会者callUri eg:123456@WECHAT
 * @property { string } callUri - 参会者callUri eg:123456@WECHAT
 * @property { string} displayName - 参会者名称
 * @property { boolean} audioTxMute - 参会者麦克风状态，true：关闭，false：开启
 * @property { boolean} videoTxMute - 参会者摄像头状态，true：关闭，false：开启
 * @property { number } videoMuteReason - 视频关闭原因
 * @property { boolean} isContent - 参会者画面类型，true：是共享内容画面，false：people画面
 * @property { boolean} isOnHold - 参会者是否是被呼叫等待状态
 * @property { boolean } isLocal - 参会者是否是自己
 * @property { number } feccOri - ignore
 * @property { number } level - roster排序级别
 */
export interface IRoster {
  deviceType: IDeviceType;
  callNumber: string;
  pid: number;
  userId: string;
  callUri: string;
  displayName: string;
  audioTxMute: boolean;
  videoTxMute: boolean;
  videoMuteReason: number;
  isContent?: boolean;
  isOnHold?: boolean;
  isLocal?: boolean;
  level?: number;
  feccOri?: number;
}