Source: ZegoExpressDefines.js

  2. /**
  3.  * 应用使用场景
  4.  * @enum {number}
  5.  */
  6. const ZegoScenario =
  7. {
  8.     /** 
  9.      * @description 通用场景，SDK 为大多数使用场景提供的默认模式，开发者如果不是很确定自己产品的使用场景，可选择此场景模式。
  10.      */
  11.     General: 0,
  12.     /** 
  13.      * @description 实时通讯场景，常用于 1V1 通话、多人通话等对实时性要求较高的通讯场景。
  14.      */
  15.     Communication: 1,
  16.     /** 
  17.      * @description 直播场景，常用于 1 对多直播 等直播场景。
  18.      */
  19.     Live: 2,
  20. }
  22. /**
  23.  * 语言
  24.  * @enum {number}
  25.  */
  26. const ZegoLanguage =
  27. {
  28.     /** 
  29.      * @description 英文
  30.      */
  31.     English: 0,
  32.     /** 
  33.      * @description 中文
  34.      */
  35.     Chinese: 1,
  36. }
  38. /**
  39.  * 引擎状态
  40.  * @enum {number}
  41.  */
  42. const ZegoEngineState =
  43. {
  44.     /** 
  45.      * @description 引擎已开启
  46.      */
  47.     Start: 0,
  48.     /** 
  49.      * @description 引擎已停止
  50.      */
  51.     Stop: 1,
  52. }
  54. /**
  55.  * 房间状态
  56.  * @enum {number}
  57.  */
  58. const ZegoRoomState =
  59. {
  60.     /** 
  61.      * @description 未连接状态，在登陆房间前和退出房间之后进入该状态。如果登陆房间的过程出现稳态异常，例如 AppID 和 AppSign 不正确，或者有相同用户名在其他地方登陆导致本端被 KickOut，都会进入该状态
  62.      */
  63.     Disconnected: 0,
  64.     /** 
  65.      * @description 正在请求连接状态，登陆房间动作执行成功后会进入此状态。通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断， SDK 会进行内部重试，也会回到正在请求连接状态
  66.      */
  67.     Connecting: 1,
  68.     /** 
  69.      * @description 连接成功状态，进入该状态表示登陆房间已经成功，用户可以正常收到房间内的用户和流信息增删的回调通知
  70.      */
  71.     Connected: 2,
  72. }
  74. /**
  75.  * 推流通道
  76.  * @enum {number}
  77.  */
  78. const ZegoPublishChannel =
  79. {
  80.     /** 
  81.      * @description 主推流通道，默认通道
  82.      */
  83.     Main: 0,
  84.     /** 
  85.      * @description 辅推流通道（第二路推流通道）
  86.      */
  87.     Aux: 1,
  88.     /** 
  89.      * @description 第三路推流通道
  90.      */
  91.     Third: 2,
  92.     /** 
  93.      * @description 第四路推流通道
  94.      */
  95.     Fourth: 3,
  96. }
  98. /**
  99.  * 视频渲染填充模式
  100.  * @enum {number}
  101.  */
  102. const ZegoViewMode =
  103. {
  104.     /** 
  105.      * @description 等比缩放，可能有黑边
  106.      */
  107.     AspectFit: 0,
  108.     /** 
  109.      * @description 等比缩放填充整个 View，可能有部分被裁减
  110.      */
  111.     AspectFill: 1,
  112.     /** 
  113.      * @description 填充整个 View，图像可能被拉伸
  114.      */
  115.     ScaleToFill: 2,
  116. }
  118. /**
  119.  * 预览或拉流端的镜像模式。
  120.  * @enum {number}
  121.  */
  122. const ZegoVideoMirrorMode =
  123. {
  124.     /** 
  125.      * @description 只有本地预览时才是镜像画面，默认采用此模式。
  126.      */
  127.     OnlyPreviewMirror: 0,
  128.     /** 
  129.      * @description 本地预览和拉流端看到的视频都是镜像画面。
  130.      */
  131.     BothMirror: 1,
  132.     /** 
  133.      * @description 本地预览和拉流端看到的视频都不是镜像画面。
  134.      */
  135.     NoMirror: 2,
  136.     /** 
  137.      * @description 只有拉流端看到的视频才是镜像画面。
  138.      */
  139.     OnlyPublishMirror: 3,
  140. }
  142. /**
  143.  * SEI 类型
  144.  * @enum {number}
  145.  */
  146. const ZegoSEIType =
  147. {
  148.     /** 
  149.      * @description 采用 H.264 的 SEI (nalu type = 6, payload type = 243) 类型打包，此类型是 SEI 标准未规定的类型，跟视频编码器或者视频文件中的 SEI 不存在冲突性，用户不需要根据 SEI 的内容做过滤，SDK 默认采用此种类型。
  150.      */
  151.     ZegoDefined: 0,
  152.     /** 
  153.      * @description 采用 H.264 的 SEI (nalu type = 6, payload type = 5) 类型打包，H.264 标准对于此类型有规定的格式：startcode + nalu type (6) + payload type (5) + len + payload (uuid + context) + trailing bits；因为视频编码器自身会产生 payload type 为 5 的 SEI，或者使用视频文件推流时，视频文件中也可能存在这样的 SEI，所以使用此类型时，用户需要把 uuid + content 当作 buffer 塞给发送 SEI 的函数；此时为了区别视频编码器自身产生的 SEI， App 在发送此类型 SEI 时，可以填写业务特定的 uuid (uuid 长度为 16 字节），接收方使用 SDK 解析 payload type 为 5 的 SEI 时，会根据设置的过滤字符串过滤出 uuid 相符的 SEI 抛给业务，如果没有设置过滤字符串，SDK 会把所有收到的 SEI 都抛给开发者。
  154.      */
  155.     UserUnregister: 1,
  156. }
  158. /**
  159.  * 推流状态
  160.  * @enum {number}
  161.  */
  162. const ZegoPublisherState =
  163. {
  164.     /** 
  165.      * @description 未推流状态，在推流前处于该状态。如果推流过程出现稳态的异常，例如 AppID 和 AppSign 不正确，或者如果其他用户已经在推送流，推送相同流 ID 的流会失败，都会进入未推流状态
  166.      */
  167.     NoPublish: 0,
  168.     /** 
  169.      * @description 正在请求推流状态，推流操作执行成功后会进入正在请求推流状态，通常通过该状态进行 UI 界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在请求推流状态
  170.      */
  171.     PublishRequesting: 1,
  172.     /** 
  173.      * @description 正在推流状态，进入该状态表明推流已经成功，用户可以正常通信
  174.      */
  175.     Publishing: 2,
  176. }
  178. /**
  179.  * 变声器预设值
  180.  * @enum {number}
  181.  */
  182. const ZegoVoiceChangerPreset =
  183. {
  184.     /** 
  185.      * @description 无变声
  186.      */
  187.     None: 0,
  188.     /** 
  189.      * @description 男声变童声（萝莉声效）
  190.      */
  191.     MenToChild: 1,
  192.     /** 
  193.      * @description 男声变女声（幼儿园声效）
  194.      */
  195.     MenToWomen: 2,
  196.     /** 
  197.      * @description 女声变童声
  198.      */
  199.     WomenToChild: 3,
  200.     /** 
  201.      * @description 女声变男声
  202.      */
  203.     WomenToMen: 4,
  204.     /** 
  205.      * @description 歪果仁声效
  206.      */
  207.     Foreigner: 5,
  208.     /** 
  209.      * @description 汽车人擎天柱声效
  210.      */
  211.     OptimusPrime: 6,
  212.     /** 
  213.      * @description 机器人声效
  214.      */
  215.     Android: 7,
  216.     /** 
  217.      * @description 空灵声效
  218.      */
  219.     Ethereal: 8,
  220.     /** 
  221.      * @description 磁性男声效
  222.      */
  223.     MaleMagnetic: 9,
  224.     /** 
  225.      * @description 清新女声效
  226.      */
  227.     FemaleFresh: 10,
  228.     /** 
  229.      * @description C大调电音音效
  230.      */
  231.     MajorC: 11,
  232.     /** 
  233.      * @description A小调电音音效
  234.      */
  235.     MinorA: 12,
  236.     /** 
  237.      * @description 和声小调电音音效
  238.      */
  239.     HarmonicMinor: 13,
  240. }
  242. /**
  243.  * 混响预设值
  244.  * @enum {number}
  245.  */
  246. const ZegoReverbPreset =
  247. {
  248.     /** 
  249.      * @description 无混响
  250.      */
  251.     None: 0,
  252.     /** 
  253.      * @description 小房间混响效果
  254.      */
  255.     SoftRoom: 1,
  256.     /** 
  257.      * @description 大房间混响效果
  258.      */
  259.     LargeRoom: 2,
  260.     /** 
  261.      * @description 音乐厅混响效果
  262.      */
  263.     ConcertHall: 3,
  264.     /** 
  265.      * @description 山谷混响效果
  266.      */
  267.     Valley: 4,
  268.     /** 
  269.      * @description 录音棚混响效果
  270.      */
  271.     RecordingStudio: 5,
  272.     /** 
  273.      * @description 地下室混响效果
  274.      */
  275.     Basement: 6,
  276.     /** 
  277.      * @description KTV 混响效果
  278.      */
  279.     KTV: 7,
  280.     /** 
  281.      * @description 流行混响效果
  282.      */
  283.     Popular: 8,
  284.     /** 
  285.      * @description 摇滚混响效果
  286.      */
  287.     Rock: 9,
  288.     /** 
  289.      * @description 演唱会混响效果
  290.      */
  291.     VocalConcert: 10,
  292.     /** 
  293.      * @description 留声机混响效果
  294.      */
  295.     GramoPhone: 11,
  296. }
  298. /**
  299.  * 视频配置分辨率与比特率预设枚举。预设的分辨率分别针对移动端与桌面端做了适配。在移动端上 height 长于 width，而桌面端相反。例如 1080p 在移动端上实际为 1080(w) x 1920(h)，而在桌面端上实际为 1920(w) x 1080(h)
  300.  * @enum {number}
  301.  */
  302. const ZegoVideoConfigPreset =
  303. {
  304.     /** 
  305.      * @description 设置分辨率为 320x180，默认采用 15 fps，码率 300 kbps
  306.      */
  307.     Preset180P: 0,
  308.     /** 
  309.      * @description 设置分辨率为 480x270，默认采用 15 fps，码率 400 kbps
  310.      */
  311.     Preset270P: 1,
  312.     /** 
  313.      * @description 设置分辨率为 640x360，默认采用 15 fps，码率 600 kbps
  314.      */
  315.     Preset360P: 2,
  316.     /** 
  317.      * @description 设置分辨率为 960x540，默认采用 15 fps，码率 1200 kbps
  318.      */
  319.     Preset540P: 3,
  320.     /** 
  321.      * @description 设置分辨率为 1280x720，默认采用 15 fps，码率 1500 kbps
  322.      */
  323.     Preset720P: 4,
  324.     /** 
  325.      * @description 设置分辨率为 1920x1080，默认采用 15 fps，码率 3000 kbps
  326.      */
  327.     Preset1080P: 5,
  328. }
  330. /**
  331.  * 流质量等级
  332.  * @enum {number}
  333.  */
  334. const ZegoStreamQualityLevel =
  335. {
  336.     /** 
  337.      * @description 质量极好
  338.      */
  339.     Excellent: 0,
  340.     /** 
  341.      * @description 质量好
  342.      */
  343.     Good: 1,
  344.     /** 
  345.      * @description 质量正常
  346.      */
  347.     Medium: 2,
  348.     /** 
  349.      * @description 质量差
  350.      */
  351.     Bad: 3,
  352.     /** 
  353.      * @description 质量异常
  354.      */
  355.     Die: 4,
  356.     /** 
  357.      * @description 质量未知
  358.      */
  359.     Unknown: 5,
  360. }
  362. /**
  363.  * 音频声道
  364.  * @enum {number}
  365.  */
  366. const ZegoAudioChannel =
  367. {
  368.     /** 
  369.      * @description 未知
  370.      */
  371.     Unknown: 0,
  372.     /** 
  373.      * @description 单声道
  374.      */
  375.     Mono: 1,
  376.     /** 
  377.      * @description 双声道
  378.      */
  379.     Stereo: 2,
  380. }
  382. /**
  383.  * 音频采集双声道模式
  384.  * @enum {number}
  385.  */
  386. const ZegoAudioCaptureStereoMode =
  387. {
  388.     /** 
  389.      * @description 不开启双声道采集，即单声道采集
  390.      */
  391.     None: 0,
  392.     /** 
  393.      * @description 始终开启双声道采集
  394.      */
  395.     Always: 1,
  396.     /** 
  397.      * @description 自适应模式，当仅推流时采集双声道，当推拉流（如通话/连麦场景）时采集单声道
  398.      */
  399.     Adaptive: 2,
  400. }
  402. /**
  403.  * 音频编码器
  404.  * @enum {number}
  405.  */
  406. const ZegoAudioCodecID =
  407. {
  408.     /** 
  409.      * @description default
  410.      */
  411.     Default: 0,
  412.     /** 
  413.      * @description Normal
  414.      */
  415.     Normal: 1,
  416.     /** 
  417.      * @description Normal2
  418.      */
  419.     Normal2: 2,
  420.     /** 
  421.      * @description Normal3
  422.      */
  423.     Normal3: 3,
  424.     /** 
  425.      * @description Low
  426.      */
  427.     Low: 4,
  428.     /** 
  429.      * @description Low2
  430.      */
  431.     Low2: 5,
  432.     /** 
  433.      * @description Low3
  434.      */
  435.     Low3: 6,
  436. }
  438. /**
  439.  * 视频编码格式
  440.  * @enum {number}
  441.  */
  442. const ZegoVideoCodecID =
  443. {
  444.     /** 
  445.      * @description 默认编码 (H.264)
  446.      */
  447.     Default: 0,
  448.     /** 
  449.      * @description 分层编码 (H.264 SVC)
  450.      */
  451.     SVC: 1,
  452.     /** 
  453.      * @description VP8
  454.      */
  455.     VP8: 2,
  456.     /** 
  457.      * @description H.265
  458.      */
  459.     H265: 3,
  460. }
  462. /**
  463.  * 拉流播放的视频分层
  464.  * @enum {number}
  465.  */
  466. const ZegoPlayerVideoLayer =
  467. {
  468.     /** 
  469.      * @description 根据网络状态选择图层
  470.      */
  471.     Auto: 0,
  472.     /** 
  473.      * @description 指定拉基本层（小分辨率）
  474.      */
  475.     Base: 1,
  476.     /** 
  477.      * @description 指定拉扩展层（大分辨率)
  478.      */
  479.     BaseExtend: 2,
  480. }
  482. /**
  483.  * 视频流类型
  484.  * @enum {number}
  485.  */
  486. const ZegoVideoStreamType =
  487. {
  488.     /** 
  489.      * @description 根据网络状态自动选择流类型
  490.      */
  491.     Default: 0,
  492.     /** 
  493.      * @description 小分辨率类型
  494.      */
  495.     Small: 1,
  496.     /** 
  497.      * @description 大分辨率类型
  498.      */
  499.     Big: 2,
  500. }
  502. /**
  503.  * 回声消除模式。
  504.  * @enum {number}
  505.  */
  506. const ZegoAECMode =
  507. {
  508.     /** 
  509.      * @description 激进的回声抵消，可能会影响音质稍微明显，但是回声会消除得很干净。
  510.      */
  511.     Aggressive: 0,
  512.     /** 
  513.      * @description 适度的回声抵消，就是可能会稍微影响一点点音质，但是残留的回声会更少。
  514.      */
  515.     Medium: 1,
  516.     /** 
  517.      * @description 舒适的回声抵消，就是回声抵消基本不会影响声音的音质，可能有时会残留一点回声，但不会影响正常听音。
  518.      */
  519.     Soft: 2,
  520. }
  522. /**
  523.  * 噪声抑制模式
  524.  * @enum {number}
  525.  */
  526. const ZegoANSMode =
  527. {
  528.     /** 
  529.      * @description 轻度的噪声抑制，基本不会损伤音质，但会残留一些噪声。
  530.      */
  531.     Soft: 0,
  532.     /** 
  533.      * @description 适度的噪声抑制，有可能损伤一些音质，但有不错的降噪效果。
  534.      */
  535.     Medium: 1,
  536.     /** 
  537.      * @description 激进的噪声抑制，有可能明显损伤音质，但有很好的降噪效果。
  538.      */
  539.     Aggressive: 2,
  540. }
  542. /**
  543.  * 当发生流量控制时可供调节的属性（位掩码枚举）
  544.  * @enum {number}
  545.  */
  546. const ZegoTrafficControlProperty =
  547. {
  548.     /** 
  549.      * @description 基础属性（自适应（降低）视频码率）
  550.      */
  551.     Basic: 0,
  552.     /** 
  553.      * @description 自适应（降低）视频帧率
  554.      */
  555.     AdaptiveFPS: 1,
  556.     /** 
  557.      * @description 自适应（降低）视频分辨率
  558.      */
  559.     AdaptiveResolution: 1 << 1,
  560.     /** 
  561.      * @description 自适应（降低）音频码率
  562.      */
  563.     AdaptiveAudioBitrate: 1 << 2,
  564. }
  566. /**
  567.  * 流控触发最低码率时的视频发送模式
  568.  * @enum {number}
  569.  */
  570. const ZegoTrafficControlMinVideoBitrateMode =
  571. {
  572.     /** 
  573.      * @description 低于设置的最低码率时，停止视频发送
  574.      */
  575.     NoVideo: 0,
  576.     /** 
  577.      * @description 低于设置的最低码率时，视频以极低的频率发送（不超过 2 FPS)
  578.      */
  579.     UltraLowFPS: 1,
  580. }
  582. /**
  583.  * 触发流量控制的因素
  584.  * @enum {number}
  585.  */
  586. const ZegoTrafficControlFocusOnMode =
  587. {
  588.     /** 
  589.      * @description 只关注本地网络
  590.      */
  591.     ZegoTrafficControlFounsOnLocalOnly: 0,
  592.     /** 
  593.      * @description 关注本地网络, 同时也兼顾远端网络,目前只在 1v1 场景下有效
  594.      */
  595.     ZegoTrafficControlFounsOnRemote: 1,
  596. }
  598. /**
  599.  * 拉流状态
  600.  * @enum {number}
  601.  */
  602. const ZegoPlayerState =
  603. {
  604.     /** 
  605.      * @description 未拉流状态，在拉流前处于该状态。如果拉流过程出现稳态的异常，例如 AppID 和 AppSign 不正确，都会进入未拉流状态
  606.      */
  607.     NoPlay: 0,
  608.     /** 
  609.      * @description 正在请求拉流状态，拉流操作执行成功后会进入正在请求拉流状态，通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在请求拉流状态
  610.      */
  611.     PlayRequesting: 1,
  612.     /** 
  613.      * @description 正在拉流状态，进入该状态表明拉流已经成功，用户可以正常通信
  614.      */
  615.     Playing: 2,
  616. }
  618. /**
  619.  * 拉流媒体事件
  620.  * @enum {number}
  621.  */
  622. const ZegoPlayerMediaEvent =
  623. {
  624.     /** 
  625.      * @description 拉流端出现音频卡顿事件
  626.      */
  627.     AudioBreakOccur: 0,
  628.     /** 
  629.      * @description 拉流端音频卡顿事件结束
  630.      */
  631.     AudioBreakResume: 1,
  632.     /** 
  633.      * @description 拉流端出现视频卡顿事件
  634.      */
  635.     VideoBreakOccur: 2,
  636.     /** 
  637.      * @description 拉流端视频卡顿事件结束
  638.      */
  639.     VideoBreakResume: 3,
  640. }
  642. /**
  643.  * 拉流资源策略模式
  644.  * @enum {number}
  645.  */
  646. const ZegoStreamResourceMode =
  647. {
  648.     /** 
  649.      * @description 默认模式。SDK 会根据拉流设置的 cdnConfig 参数以及即构的后台配置自动选择拉流资源
  650.      */
  651.     Default: 0,
  652.     /** 
  653.      * @description 仅从 CDN 拉流
  654.      */
  655.     OnlyCDN: 1,
  656.     /** 
  657.      * @description 仅从 L3 拉流
  658.      */
  659.     OnlyL3: 2,
  660.     /** 
  661.      * @description 仅从 RTC 拉流
  662.      */
  663.     OnlyRTC: 3,
  664. }
  666. /**
  667.  * 更新类型
  668.  * @enum {number}
  669.  */
  670. const ZegoUpdateType =
  671. {
  672.     /** 
  673.      * @description 添加
  674.      */
  675.     Add: 0,
  676.     /** 
  677.      * @description 删除
  678.      */
  679.     Delete: 1,
  680. }
  682. /**
  683.  * 转推 CDN 状态
  684.  * @enum {number}
  685.  */
  686. const ZegoStreamRelayCDNState =
  687. {
  688.     /** 
  689.      * @description 未转推状态，在转推前处于该状态。如果转推过程出现稳态的异常，例如 转推地址 不正确，都会进入未转推状态
  690.      */
  691.     NoRelay: 0,
  692.     /** 
  693.      * @description 正在请求转推状态，转推操作执行成功后会进入正在请求转推状态，通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断，SDK 会进行内部重试，也会回到正在转推状态
  694.      */
  695.     RelayRequesting: 1,
  696.     /** 
  697.      * @description 正在转推状态，进入该状态表明转推已成功
  698.      */
  699.     Relaying: 2,
  700. }
  702. /**
  703.  * 转发 CDN 状态改变原因
  704.  * @enum {number}
  705.  */
  706. const ZegoStreamRelayCDNUpdateReason =
  707. {
  708.     /** 
  709.      * @description 无
  710.      */
  711.     None: 0,
  712.     /** 
  713.      * @description 服务器错误
  714.      */
  715.     ServerError: 1,
  716.     /** 
  717.      * @description 握手失败
  718.      */
  719.     HandshakeFailed: 2,
  720.     /** 
  721.      * @description 接入点错误
  722.      */
  723.     AccessPointError: 3,
  724.     /** 
  725.      * @description 创建流失败
  726.      */
  727.     CreateStreamFailed: 4,
  728.     /** 
  729.      * @description 流 ID 不合法
  730.      */
  731.     BadName: 5,
  732.     /** 
  733.      * @description CDN 服务器主动断开
  734.      */
  735.     CDNServerDisconnected: 6,
  736.     /** 
  737.      * @description 主动断开
  738.      */
  739.     Disconnected: 7,
  740.     /** 
  741.      * @description 混流的全部输入流会话关闭
  742.      */
  743.     MixStreamAllInputStreamClosed: 8,
  744.     /** 
  745.      * @description 混流的全部输入流没有数据
  746.      */
  747.     MixStreamAllInputStreamNoData: 9,
  748.     /** 
  749.      * @description 混流服务器内部错误
  750.      */
  751.     MixStreamServerInternalError: 10,
  752. }
  754. /**
  755.  * 远端设备状态
  756.  * @enum {number}
  757.  */
  758. const ZegoRemoteDeviceState =
  759. {
  760.     /** 
  761.      * @description 设备开启
  762.      */
  763.     Open: 0,
  764.     /** 
  765.      * @description 设备关闭：一般性设备错误
  766.      */
  767.     GenericError: 1,
  768.     /** 
  769.      * @description 设备关闭：无效的设备 ID
  770.      */
  771.     InvalidID: 2,
  772.     /** 
  773.      * @description 设备关闭：无权限
  774.      */
  775.     NoAuthorization: 3,
  776.     /** 
  777.      * @description 设备关闭：采集帧率为 0
  778.      */
  779.     ZeroFPS: 4,
  780.     /** 
  781.      * @description 设备关闭：设备被占用
  782.      */
  783.     InUseByOther: 5,
  784.     /** 
  785.      * @description 设备关闭：设备未插入或被拔出
  786.      */
  787.     Unplugged: 6,
  788.     /** 
  789.      * @description 设备关闭：由于系统原因需要重启后才能进行下一次修改，否则重新打开也不生效
  790.      */
  791.     RebootRequired: 7,
  792.     /** 
  793.      * @description 设备关闭：系统媒体服务停止，如 iOS 平台下，当系统检测到当前压力巨大（如播放大量动画），则有可能会将媒体相关服务全部停用
  794.      */
  795.     SystemMediaServicesLost: 8,
  796.     /** 
  797.      * @description 设备关闭：禁用采集
  798.      */
  799.     Disable: 9,
  800.     /** 
  801.      * @description 设备关闭：远端设备被静音
  802.      */
  803.     Mute: 10,
  804.     /** 
  805.      * @description 设备关闭：设备被中断，如电话事件打断等
  806.      */
  807.     Interruption: 11,
  808.     /** 
  809.      * @description 设备关闭：用户 App 退到后台
  810.      */
  811.     InBackground: 12,
  812.     /** 
  813.      * @description 设备关闭：当前前台同时存在多个 App，如 iPad 应用分屏下，系统会禁止所有应用使用摄像头
  814.      */
  815.     MultiForegroundApp: 13,
  816.     /** 
  817.      * @description 设备关闭：系统处于高负载压力下，可能导致设备异常
  818.      */
  819.     BySystemPressure: 14,
  820.     /** 
  821.      * @description 设备状态未知：远端的 SDK 版本过低，不支持发布该设备状态信息
  822.      */
  823.     NotSupport: 15,
  824. }
  826. /**
  827.  * 音频设备类型
  828.  * @enum {number}
  829.  */
  830. const ZegoAudioDeviceType =
  831. {
  832.     /** 
  833.      * @description 音频输入设备
  834.      */
  835.     Input: 0,
  836.     /** 
  837.      * @description 音频输出设备
  838.      */
  839.     Output: 1,
  840. }
  842. /**
  843.  * 音频路由
  844.  * @enum {number}
  845.  */
  846. const ZegoAudioRoute =
  847. {
  848.     /** 
  849.      * @description 扬声器
  850.      */
  851.     Speaker: 0,
  852.     /** 
  853.      * @description 耳机
  854.      */
  855.     Headphone: 1,
  856.     /** 
  857.      * @description 蓝牙设备
  858.      */
  859.     Bluetooth: 2,
  860.     /** 
  861.      * @description 听筒
  862.      */
  863.     Receiver: 3,
  864.     /** 
  865.      * @description USB 音频外接设备
  866.      */
  867.     ExternalUSB: 4,
  868.     /** 
  869.      * @description Apple 隔空播放
  870.      */
  871.     AirPlay: 5,
  872. }
  874. /**
  875.  * 混流内容类型
  876.  * @enum {number}
  877.  */
  878. const ZegoMixerInputContentType =
  879. {
  880.     /** 
  881.      * @description 音频混流内容类型
  882.      */
  883.     Audio: 0,
  884.     /** 
  885.      * @description 视频混流内容类型
  886.      */
  887.     Video: 1,
  888.     /** 
  889.      * @description 仅视频混流内容类型
  890.      */
  891.     VideoOnly: 2,
  892. }
  894. /**
  895.  * 视频采集缩放时机
  896.  * @enum {number}
  897.  */
  898. const ZegoCapturePipelineScaleMode =
  899. {
  900.     /** 
  901.      * @description 采集后立即进行缩放，默认
  902.      */
  903.     Pre: 0,
  904.     /** 
  905.      * @description 编码时进行缩放
  906.      */
  907.     Post: 1,
  908. }
  910. /**
  911.  * 视频帧格式
  912.  * @enum {number}
  913.  */
  914. const ZegoVideoFrameFormat =
  915. {
  916.     /** 
  917.      * @description 未知格式，将取平台默认值
  918.      */
  919.     Unknown: 0,
  920.     /** 
  921.      * @description I420 (YUV420Planar) 格式
  922.      */
  923.     I420: 1,
  924.     /** 
  925.      * @description NV12 (YUV420SemiPlanar) 格式
  926.      */
  927.     NV12: 2,
  928.     /** 
  929.      * @description NV21 (YUV420SemiPlanar) 格式
  930.      */
  931.     NV21: 3,
  932.     /** 
  933.      * @description BGRA32 格式
  934.      */
  935.     BGRA32: 4,
  936.     /** 
  937.      * @description RGBA32 格式
  938.      */
  939.     RGBA32: 5,
  940.     /** 
  941.      * @description ARGB32 格式
  942.      */
  943.     ARGB32: 6,
  944.     /** 
  945.      * @description ABGR32 格式
  946.      */
  947.     ABGR32: 7,
  948.     /** 
  949.      * @description I422 (YUV422Planar) 格式
  950.      */
  951.     I422: 8,
  952. }
  954. /**
  955.  * 视频帧数据类型
  956.  * @enum {number}
  957.  */
  958. const ZegoVideoBufferType =
  959. {
  960.     /** 
  961.      * @description 未知类型
  962.      */
  963.     Unknown: 0,
  964.     /** 
  965.      * @description 裸数据类型视频帧
  966.      */
  967.     RawData: 1,
  968.     /** 
  969.      * @description 编码类型视频帧
  970.      */
  971.     EncodedData: 2,
  972.     /** 
  973.      * @description OpenGL Texture 2D 类型视频帧
  974.      */
  975.     GLTexture2D: 3,
  976.     /** 
  977.      * @description CVPixelBuffer 类型视频帧
  978.      */
  979.     CVPixelBuffer: 4,
  980.     /** 
  981.      * @description SurfaceTexture 类型视频帧
  982.      */
  983.     SurfaceTexture: 5,
  984.     /** 
  985.      * @description OpenGL GL_TEXTURE_EXTERNAL_OES 类型视频帧
  986.      */
  987.     GLTextureExternalOES: 6,
  988. }
  990. /**
  991.  * 视频帧格式系列
  992.  * @enum {number}
  993.  */
  994. const ZegoVideoFrameFormatSeries =
  995. {
  996.     /** 
  997.      * @description RGB 系列
  998.      */
  999.     RGB: 0,
  1000.     /** 
  1001.      * @description YUV 系列
  1002.      */
  1003.     YUV: 1,
  1004. }
  1006. /**
  1007.  * 视频帧翻转模式
  1008.  * @enum {number}
  1009.  */
  1010. const ZegoVideoFlipMode =
  1011. {
  1012.     /** 
  1013.      * @description 不翻转
  1014.      */
  1015.     None: 0,
  1016.     /** 
  1017.      * @description X 轴翻转
  1018.      */
  1019.     X: 1,
  1020.     /** 
  1021.      * @description 垂直翻转
  1022.      */
  1023.     Y: 2,
  1024.     /** 
  1025.      * @description XY 轴翻转
  1026.      */
  1027.     XY: 3,
  1028. }
  1030. /**
  1031.  * 音频配置类型
  1032.  * @enum {number}
  1033.  */
  1034. const ZegoAudioConfigPreset =
  1035. {
  1036.     /** 
  1037.      * @description 基础音质 (16 kbps, Mono, ZegoAudioCodecIDDefault)
  1038.      */
  1039.     BasicQuality: 0,
  1040.     /** 
  1041.      * @description 标准音质 (48 kbps, Mono, ZegoAudioCodecIDDefault)
  1042.      */
  1043.     StandardQuality: 1,
  1044.     /** 
  1045.      * @description 标准音质 (56 kbps, Stereo, ZegoAudioCodecIDDefault)
  1046.      */
  1047.     StandardQualityStereo: 2,
  1048.     /** 
  1049.      * @description 高音质 (128 kbps, Mono, ZegoAudioCodecIDDefault)
  1050.      */
  1051.     HighQuality: 3,
  1052.     /** 
  1053.      * @description 高音质 (192 kbps, Stereo, ZegoAudioCodecIDDefault)
  1054.      */
  1055.     HighQualityStereo: 4,
  1056. }
  1058. /**
  1059.  * 播放器状态
  1060.  * @enum {number}
  1061.  */
  1062. const ZegoMediaPlayerState =
  1063. {
  1064.     /** 
  1065.      * @description 不在播放
  1066.      */
  1067.     NoPlay: 0,
  1068.     /** 
  1069.      * @description 播放中
  1070.      */
  1071.     Playing: 1,
  1072.     /** 
  1073.      * @description 暂停播放
  1074.      */
  1075.     Pausing: 2,
  1076.     /** 
  1077.      * @description 播放结束
  1078.      */
  1079.     PlayEnded: 3,
  1080. }
  1082. /**
  1083.  * 播放器网络事件
  1084.  * @enum {number}
  1085.  */
  1086. const ZegoMediaPlayerNetworkEvent =
  1087. {
  1088.     /** 
  1089.      * @description 网络资源播放不畅，开始尝试缓存数据
  1090.      */
  1091.     BufferBegin: 0,
  1092.     /** 
  1093.      * @description 网络资源可以顺畅播放
  1094.      */
  1095.     BufferEnded: 1,
  1096. }
  1098. /**
  1099.  * 播放器声道
  1100.  * @enum {number}
  1101.  */
  1102. const ZegoMediaPlayerAudioChannel =
  1103. {
  1104.     /** 
  1105.      * @description 左声道
  1106.      */
  1107.     Left: 0,
  1108.     /** 
  1109.      * @description 右声道
  1110.      */
  1111.     Right: 1,
  1112.     /** 
  1113.      * @description 全部声道
  1114.      */
  1115.     All: 2,
  1116. }
  1118. /**
  1119.  * 音效播放器状态
  1120.  * @enum {number}
  1121.  */
  1122. const ZegoAudioEffectPlayState =
  1123. {
  1124.     /** 
  1125.      * @description 不在播放
  1126.      */
  1127.     NoPlay: 0,
  1128.     /** 
  1129.      * @description 播放中
  1130.      */
  1131.     Playing: 1,
  1132.     /** 
  1133.      * @description 暂停播放
  1134.      */
  1135.     Pausing: 2,
  1136.     /** 
  1137.      * @description 播放结束
  1138.      */
  1139.     PlayEnded: 3,
  1140. }
  1142. /**
  1143.  * 录制类型
  1144.  * @enum {number}
  1145.  */
  1146. const ZegoDataRecordType =
  1147. {
  1148.     /** 
  1149.      * @description 该字段表示纯音频 SDK 默认录制音频，音视频 SDK 默认录制音视频，当录制 .aac 格式的文件时默认也是录制音频
  1150.      */
  1151.     Default: 0,
  1152.     /** 
  1153.      * @description 只录制音频
  1154.      */
  1155.     OnlyAudio: 1,
  1156.     /** 
  1157.      * @description 只录制视频，音频的 SDK 和录制 .aac 格式文件时无效
  1158.      */
  1159.     OnlyVideo: 2,
  1160.     /** 
  1161.      * @description 同时录制音频、视频。音频的 SDK 和录制 .aac 格式文件时录制出来也只有音频
  1162.      */
  1163.     AudioAndVideo: 3,
  1164. }
  1166. /**
  1167.  * 录制状态
  1168.  * @enum {number}
  1169.  */
  1170. const ZegoDataRecordState =
  1171. {
  1172.     /** 
  1173.      * @description 未录制状态，当录制出错或者未开始录制之前处于此状态
  1174.      */
  1175.     NoRecord: 0,
  1176.     /** 
  1177.      * @description 正在录制中，当成功调用 [startRecordingCapturedData] 函数之后处于此状态
  1178.      */
  1179.     Recording: 1,
  1180.     /** 
  1181.      * @description 录制成功
  1182.      */
  1183.     Success: 2,
  1184. }
  1186. /**
  1187.  * 网络模式
  1188.  * @enum {number}
  1189.  */
  1190. const ZegoNetworkMode =
  1191. {
  1192.     /** 
  1193.      * @description 离线（无网络）
  1194.      */
  1195.     Offline: 0,
  1196.     /** 
  1197.      * @description 未知网络模式
  1198.      */
  1199.     Unknown: 1,
  1200.     /** 
  1201.      * @description 有线以太网 (LAN)
  1202.      */
  1203.     Ethernet: 2,
  1204.     /** 
  1205.      * @description 无线局域网 (WLAN)
  1206.      */
  1207.     Wifi: 3,
  1208.     /** 
  1209.      * @description 2G 网络 (GPRS/EDGE/CDMA1x/etc.)
  1210.      */
  1211.     Mode2G: 4,
  1212.     /** 
  1213.      * @description 3G 网络 (WCDMA/HSDPA/EVDO/etc.)
  1214.      */
  1215.     Mode3G: 5,
  1216.     /** 
  1217.      * @description 4G 网络 (LTE)
  1218.      */
  1219.     Mode4G: 6,
  1220.     /** 
  1221.      * @description 5G 网络 (NR (NSA/SA))
  1222.      */
  1223.     Mode5G: 7,
  1224. }
  1226. /**
  1227.  * 网速测试类型
  1228.  * @enum {number}
  1229.  */
  1230. const ZegoNetworkSpeedTestType =
  1231. {
  1232.     /** 
  1233.      * @description 上行测速
  1234.      */
  1235.     Uplink: 0,
  1236.     /** 
  1237.      * @description 下行测速
  1238.      */
  1239.     Downlink: 1,
  1240. }
  1242. /**
  1243.  * @typedef {Object} ZegoLogConfig - 日志配置
  1244.  * @property {string} logPath - 日志文件的存储路径。详情描述：用于自定义日志文件的存储路径。业务场景：当需要自定义日志存储路径时，需要这个配置。是否必填：否。默认值：各平台的默认路径有所不同，具体参考官网文档：https://doc-zh.zego.im/article/6467。注意事项：开发者需要确保对该路径下文件的读写权限。
  1245.  * @property {number} logSize - 日志文件大小上限，单位Bytes。详情描述：用于自定义日志文件大小上限。业务场景：当需要自定义日志文件大小上限时，需要这个配置。是否必填：否。默认值：5MB (5 * 1024 * 1024 Bytes)。取值范围：最小1MB (1 * 1024 * 1024 Bytes)，最大100M (100 * 1024 * 1024 Bytes)，0表示不需要写日志。注意事项：日志文件大小上限越大，承载的日志信息越多，但是日志上传时间也会更长。
  1246.  */
  1248. /**
  1249.  * @typedef {Object} ZegoEngineProfile - 创建引擎的配置
  1250.  * @property {number} appID - ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台 https://console-express.zego.im 申请。appID 取值范围 0~4294967295。
  1251.  * @property {string} appSign - 每个 AppID 对应的应用签名，请从 ZEGO 管理控制台申请。该参数为包含 64 个字符的字符串，字符取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。
  1252.  * @property {ZegoScenario} scenario - 产品的应用场景，开发者可根据所开发的 App 的场景选择其中一个，SDK 会针对该场景的作一些优化。当设置具体场景后，开发者若需要定制化更多参数，依然可以调用具体函数来设置具体参数。不同应用场景的建议配置可以参考：https://doc-zh.zego.im/faq/profile_difference。
  1253.  */
  1255. /**
  1256.  * @typedef {Object} ZegoEngineConfig - 引擎进阶配置
  1257.  * @property {ZegoLogConfig} logConfig - 日志配置，未设置时使用默认配置(详见 [ZegoLogConfig])。
  1258.  * @property {map<string, string>} advancedConfig - 进阶功能配置，未设置时默认不使用任何特殊功能，如需使用，请联系 ZEGO 技术支持。
  1259.  */
  1261. /**
  1262.  * @typedef {Object} ZegoRoomConfig - 房间进阶配置
  1263.  * @property {number} maxMemberCount - 房间最大用户数量，传 0 视为不限制，默认无限制
  1264.  * @property {boolean} isUserStatusNotify - 是否开启用户进出房间回调通知 [onRoomUserUpdate]，默认关闭。若开发者需要使用 ZEGO 房间用户广播通知，请确保每个登录的用户都将此标记设置为true
  1265.  * @property {string} token - 由开发者业务服务器下发的 token，用以保证安全性，生成规则详见 用户权限控制 https://doc-zh.zego.im/article/10360，默认为空字符串，即不鉴权。
  1266.  */
  1268. /**
  1269.  * @typedef {Object} ZegoVideoConfig - 视频配置
  1270.  * @property {number} captureWidth - 采集分辨率宽度，控制摄像头图像采集的宽度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]
  1271.  * @property {number} captureHeight - 采集分辨率高度，控制摄像头图像采集的高度。SDK 要求设置此成员为偶数。仅摄像头启动前且没有使用自定义视频采集时，设置有效。出于性能考虑，SDK 在采集摄像头画面后、渲染预览画面之前，就将视频帧缩放为编码分辨率，因此预览画面的分辨率是编码分辨率，如果您需要预览画面的分辨率为此值，请先调用 [setCapturePipelineScaleMode] 将采集缩放模式改为 [Post]
  1272.  * @property {number} encodeWidth - 编码分辨率宽度，控制编码器编码推流的图像宽度。SDK 要求设置此成员为偶数。推流前后设置均可生效
  1273.  * @property {number} encodeHeight - 编码分辨率高度，控制编码器编码推流的图像高度。SDK 要求设置此成员为偶数。推流前后设置均可生效
  1274.  * @property {number} fps - 帧率，控制摄像头采集帧率以及编码器编码帧率的大小。仅摄像头启动前设置有效
  1275.  * @property {number} bitrate - 码率，单位为 kbps。推流前后设置均可生效
  1276.  * @property {ZegoVideoCodecID} codecID - 要使用的编码器，默认为 default。仅在推流前设置生效
  1277.  */
  1279. /**
  1280.  * @typedef {Object} ZegoSEIConfig - SEI 配置
  1281.  * @property {ZegoSEIType} type - SEI 类型
  1282.  */
  1284. /**
  1285.  * @typedef {Object} ZegoVoiceChangerParam - 变声器参数
  1286.  * @property {number} pitch - 音高参数，取值范围 [-8.0, 8.0]，数值越大声音越尖，设为 0.0 即关闭变声器。注意：变声音效只针对采集的声音有效。
  1287.  */
  1289. /**
  1290.  * @typedef {Object} ZegoReverbParam - 音频混响参数
  1291.  * @property {number} roomSize - 房间大小，取值范围 [0.0, 1.0]，用于控制产生混响模拟的 “房间” 的大小，房间越大，混响越强
  1292.  * @property {number} reverberance - 余响，取值范围 [0.0, 0.5]，用于控制混响的拖尾长度
  1293.  * @property {number} damping - 混响阻尼，取值范围 [0.0, 2.0]，控制混响的衰减程度，阻尼越大，衰减越大
  1294.  * @property {number} dryWetRatio - 干湿比，取值范围大于等于 0.0，控制混响与直达声和早期反射声之间的比 例，干(dry)的部分默认定为1，当干湿比设为较小时，湿(wet)的比例较大，此时混响较强
  1295.  */
  1297. /**
  1298.  * @typedef {Object} ZegoReverbAdvancedParam - 音频混响高级参数
  1299.  * @property {number} roomSize - 房间大小（百分比），取值范围 [0.0, 100.0]，用于控制产生混响模拟的 “房间” 的大小，房间越大，混响越强
  1300.  * @property {number} reverberance - 余响（百分比），取值范围 [0.0, 100.0]，用于控制混响的拖尾长度
  1301.  * @property {number} damping - 混响阻尼（百分比），取值范围 [0.0, 100.0]，控制混响的衰减程度，阻尼越大，衰减越大
  1302.  * @property {boolean} wetOnly - 只有湿信号。设置只输出混响声音，不叠加原始输入声音，默认是false。
  1303.  * @property {number} wetGain - 湿信号增益(dB)，取值范围 [-20.0, 10.0]
  1304.  * @property {number} dryGain - 干信号增益(dB)，取值范围 [-20.0, 10.0]
  1305.  * @property {number} toneLow - 低频衰减，默认为不衰减（100%）
  1306.  * @property {number} toneHigh - 高频衰减，默认为不衰减（100%）
  1307.  * @property {number} preDelay - 初始延迟时间(ms)。取值范围[0, 200]
  1308.  * @property {number} stereoWidth - 立体声宽度（百分比），默认值为 0%
  1309.  */
  1311. /**
  1312.  * @typedef {Object} ZegoReverbEchoParam - 音频混响回声参数
  1313.  * @property {number} inGain - 输入音频信号的增益，取值范围 [0.0, 1.0]
  1314.  * @property {number} outGain - 输出音频信号的增益，取值范围 [0.0, 1.0]
  1315.  * @property {number} numDelays - 回声数量，取值范围 [0, 7]
  1316.  * @property {number[]} delay - 回声信号分别的延时，单位为毫秒，取值范围 [0, 5000] ms
  1317.  * @property {number[]} decay - 回声信号分别的衰减系数，取值范围 [0.0, 1.0]
  1318.  */
  1320. /**
  1321.  * @typedef {Object} ZegoUser - 用户对象
  1322.  * @property {string} userID - 用户 ID，最大 64 字节的字符串。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。仅支持数字，英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
  1323.  * @property {string} userName - 用户名，最大长度不超过 256 字节的字符串。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
  1324.  */
  1326. /**
  1327.  * @typedef {Object} ZegoStream - 音视频流对象
  1328.  * @property {ZegoUser} user - 用户对象实例。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
  1329.  * @property {string} streamID - 流 ID，长度不超过256的字符串。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
  1330.  * @property {string} extraInfo - 流附加信息
  1331.  */
  1333. /**
  1334.  * @typedef {Object} ZegoRoomExtraInfo - 房间附加消息
  1335.  * @property {string} key - 房间附加消息的键
  1336.  * @property {string} value - 房间附加消息的值
  1337.  * @property {ZegoUser} updateUser - 更新房间附加消息的用户。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
  1338.  * @property {number} updateTime - 房间附加消息的更新时间，UNIX 时间戳，单位为毫秒
  1339.  */
  1341. /**
  1342.  * @typedef {Object} ZegoRect - 视图相关所使用的坐标
  1343.  * @property {number} x - 矩形左上角在坐标系 X 轴上的值
  1344.  * @property {number} y - 矩形左上角在坐标系 Y 轴上的值
  1345.  * @property {number} width - 矩形宽度
  1346.  * @property {number} height - 矩形高度
  1347.  */
  1349. /**
  1350.  * @typedef {Object} ZegoView - 视图对象
  1351.  * @property {ZegoViewMode} viewMode - 视图模式，默认为 ZegoViewModeAspectFit
  1352.  * @property {number} backgroundColor - 背景颜色，格式为 0xRRGGBB，默认为黑色即 0x000000
  1353.  * @property {canvas} canvas - html canvas element
  1354.  * @property {boolean} preserveDrawingBuffer - webgl context 保存缓存
  1355.  */
  1357. /**
  1358.  * @typedef {Object} ZegoPublishStreamQuality - 推流质量对象
  1359.  * @property {number} videoCaptureFPS - 视频采集帧率，单位为 f/s
  1360.  * @property {number} videoEncodeFPS - 视频编码帧率，单位为 f/s
  1361.  * @property {number} videoSendFPS - 视频发送帧率，单位为 f/s
  1362.  * @property {number} videoKBPS - 视频码率，单位为 kbps
  1363.  * @property {number} audioCaptureFPS - 音频采集帧率，单位为 f/s
  1364.  * @property {number} audioSendFPS - 音频发送帧率，单位为 f/s
  1365.  * @property {number} audioKBPS - 音频码率，单位为 kbps
  1366.  * @property {number} rtt - 本端至服务端的延迟，单位为毫秒
  1367.  * @property {number} packetLostRate - 丢包率，单位为百分比，0.0 ~ 1.0
  1368.  * @property {ZegoStreamQualityLevel} level - 推流质量级别
  1369.  * @property {boolean} isHardwareEncode - 是否开启硬件编码
  1370.  * @property {ZegoVideoCodecID} videoCodecID - 视频编码格式
  1371.  * @property {number} totalSendBytes - 已发送的总字节数，包括音频、视频和SEI等
  1372.  * @property {number} audioSendBytes - 已发送的音频字节数
  1373.  * @property {number} videoSendBytes - 已发送的视频字节数
  1374.  */
  1376. /**
  1377.  * @typedef {Object} ZegoCDNConfig - CDN 配置对象
  1378.  * @property {string} url - CDN 的 URL
  1379.  * @property {string} authParam - URL 的鉴权参数
  1380.  */
  1382. /**
  1383.  * @typedef {Object} ZegoStreamRelayCDNInfo - 转推 CDN 信息
  1384.  * @property {string} url - CDN 推流的 URL
  1385.  * @property {ZegoStreamRelayCDNState} state - 转推状态
  1386.  * @property {ZegoStreamRelayCDNUpdateReason} updateReason - 转推状态变更的原因
  1387.  * @property {number} stateTime - 状态发生的时间，UNIX 时间戳，单位为毫秒
  1388.  */
  1390. /**
  1391.  * @typedef {Object} ZegoPlayerConfig - 拉流进阶配置。
  1392.  * @property {ZegoStreamResourceMode} resourceMode - 拉流资源策略模式。
  1393.  * @property {ZegoCDNConfig} cdnConfig - 拉流的 CDN 配置，若设置后，则按照 URL 拉流而不是按照 streamID 拉流，此后 streamID 仅作为 SDK 内部回调的标识。
  1394.  * @property {ZegoPlayerVideoLayer} videoLayer - 设置拉流的视频分层。
  1395.  * @property {string} roomID - 房间 ID。
  1396.  */
  1398. /**
  1399.  * @typedef {Object} ZegoPlayStreamQuality - 拉流质量对象
  1400.  * @property {number} videoRecvFPS - 视频接收帧率，单位为 f/s
  1401.  * @property {number} videoDejitterFPS - 视频抗抖动帧率，单位为 f/s
  1402.  * @property {number} videoDecodeFPS - 视频解码帧率，单位为 f/s
  1403.  * @property {number} videoRenderFPS - 视频渲染帧率，单位为 f/s
  1404.  * @property {number} videoKBPS - 视频码率，单位为 kbps
  1405.  * @property {number} videoBreakRate - 视频卡顿率，单位为（卡顿次数/每10秒）
  1406.  * @property {number} audioRecvFPS - 音频接收帧率，单位为 f/s
  1407.  * @property {number} audioDejitterFPS - 音频抗抖动帧率，单位为 f/s
  1408.  * @property {number} audioDecodeFPS - 音频解码帧率，单位为 f/s
  1409.  * @property {number} audioRenderFPS - 音频渲染帧率，单位为 f/s
  1410.  * @property {number} audioKBPS - 音频码率，单位为 kbps
  1411.  * @property {number} audioBreakRate - 音频卡顿率，单位为（卡顿次数/每10秒）
  1412.  * @property {number} rtt - 服务端至本端的延迟，单位为毫秒
  1413.  * @property {number} packetLostRate - 丢包率，单位为百分比，0.0 ~ 1.0
  1414.  * @property {number} peerToPeerDelay - 端到端延迟，单位为毫秒
  1415.  * @property {number} peerToPeerPacketLostRate - 端到端丢包率，单位为百分比，0.0 ~ 1.0
  1416.  * @property {ZegoStreamQualityLevel} level - 拉流质量级别
  1417.  * @property {number} delay - 本端接收到数据后到播放的延迟，单位为毫秒
  1418.  * @property {number} avTimestampDiff - 视频时间戳相对于音频时间戳的差值，用于反映音画同步情况，单位为毫秒。此值小于 0 表示视频超前音频的毫秒数, 大于 0 表示视频滞后音频的毫秒数, 等于0表示无差别。 当绝对值小于200，可基本认为音画同步，当绝对值连续 10 秒大于 200 可以认为异常
  1419.  * @property {boolean} isHardwareDecode - 是否开启硬件解码
  1420.  * @property {ZegoVideoCodecID} videoCodecID - 视频编码格式
  1421.  * @property {number} totalRecvBytes - 已接收的总字节数，包括音频、视频和 SEI 等
  1422.  * @property {number} audioRecvBytes - 已接收的音频字节数
  1423.  * @property {number} videoRecvBytes - 已接收的视频字节数
  1424.  */
  1426. /**
  1427.  * @typedef {Object} ZegoDeviceInfo - 设备信息
  1428.  * @property {string} deviceID - 设备 ID
  1429.  * @property {string} deviceName - 设备名称
  1430.  */
  1432. /**
  1433.  * @typedef {Object} ZegoPerformanceStatus - 系统性能监控状态
  1434.  * @property {number} cpuUsageApp - 当前 App 的 CPU 使用率，取值范围 [0, 1]
  1435.  * @property {number} cpuUsageSystem - 当前系统的 CPU 使用率，取值范围 [0, 1]
  1436.  * @property {number} memoryUsageApp - 当前 App 的运行内存使用率，取值范围 [0, 1]
  1437.  * @property {number} memoryUsageSystem - 当前系统的运行内存使用率，取值范围 [0, 1]
  1438.  * @property {number} memoryUsedApp - 当前 App 的运行内存使用量，单位为 MB
  1439.  */
  1441. /**
  1442.  * @typedef {Object} ZegoMixerAudioConfig - 混流音频配置
  1443.  * @property {number} bitrate - 音频码率，单位为 kbps，默认为 48 kbps，开始混流任务后不能修改
  1444.  * @property {ZegoAudioChannel} channel - 音频声道，默认为 Mono 单声道
  1445.  * @property {ZegoAudioCodecID} codecID - 编码 ID，默认为 ZegoAudioCodecIDDefault
  1446.  */
  1448. /**
  1449.  * @typedef {Object} ZegoMixerVideoConfig - 混流视频配置
  1450.  * @property {number} width - 视频分辨率宽
  1451.  * @property {number} height - 视频分辨率高
  1452.  * @property {number} fps - 视频帧率，开始混流任务后不能修改
  1453.  * @property {number} bitrate - 视频码率，单位为 kbps
  1454.  */
  1455. /**
  1456.  * @typedef {Object} ZegoMixerInput - 混流输入
  1457.  * @property {string} streamID - 流 ID，长度不超过256的字符串。不可以包含 URL 关键字，否则推拉流失败。仅支持数字，英文字符 和 '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。
  1458.  * @property {ZegoMixerInputContentType} contentType - 混流内容类型
  1459.  * @property {ZegoRect} layout - 流的布局。当混入的流为音频流时（即 ContentType 参数设置为音频混流类型），SDK内部不处理布局字段，此时无需关注该参数。
  1460.  * @property {number} soundLevelID - 当混流任务开启了声浪回调时，需要为每条输入流指定唯一的 soundLevelID
  1461.  * @property {boolean} isAudioFocus - 当前输入流是否开启焦点语音，开启了会突出此路流的声音
  1462.  */
  1464. /**
  1465.  * @typedef {Object} ZegoMixerOutput - 混流输出对象
  1466.  * @property {string} target - 混流输出目标，URL 或者流 ID，若为 URL 格式 目前只支持 RTMP URL 格式：rtmp://xxxxxxxx, 且不能传入两个相同的混流输出的地址。
  1467.  */
  1469. /**
  1470.  * @typedef {Object} ZegoWatermark - 水印对象
  1471.  * @property {string} imageURL - 水印图片路径。支持本地文件绝对路径 (file://xxx)。 格式支持 png、jpg。
  1472.  * @property {ZegoRect} layout - 水印图片的大小方位
  1473.  */
  1475. /**
  1476.  * @typedef {Object} ZegoMixerTask - 混流任务对象
  1477.  * @property {string} taskID - 混流任务 ID
  1478.  * @property {ZegoMixerInput[]} inputList - 混流任务的输入流列表
  1479.  * @property {ZegoMixerOutput[]} outputList - 混流任务的输出流列表
  1480.  * @property {ZegoMixerVideoConfig} videoConfig - 混流任务的视频配置
  1481.  * @property {ZegoMixerAudioConfig} audioConfig - 混流任务的音频配置
  1482.  * @property {ZegoWatermark} watermark - 混流任务的水印
  1483.  * @property {string} backgroundImageURL - 混流任务的背景图 URL
  1484.  * @property {boolean} enableSoundLevel - 是否开启混流的声浪回调通知，开启后拉混流时可通过 [onMixerSoundLevelUpdate] 回调收到每条单流的声浪信息
  1485.  * @property {map<string, string>} advancedConfig - 设置高级配置，如可用于指定视频编码等功能。如需使用，联系 ZEGO 技术支持。
  1486.  */
  1488. /**
  1489.  * @typedef {Object} ZegoBroadcastMessageInfo - 房间广播消息
  1490.  * @property {string} message - 消息内容
  1491.  * @property {number} messageID - 消息 ID
  1492.  * @property {number} sendTime - 消息的发送时间，UNIX 时间戳，单位为毫秒
  1493.  * @property {ZegoUser} fromUser - 消息的发送者。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
  1494.  */
  1496. /**
  1497.  * @typedef {Object} ZegoBarrageMessageInfo - 房间弹幕消息
  1498.  * @property {string} message - 消息内容
  1499.  * @property {string} messageID - 消息 ID
  1500.  * @property {number} sendTime - 消息的发送时间，UNIX 时间戳，单位为毫秒
  1501.  * @property {ZegoUser} fromUser - 消息的发送者。请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
  1502.  */
  1504. /**
  1505.  * @typedef {Object} ZegoAudioConfig - 推流音频配置
  1506.  * @property {number} bitrate - 音频码率，单位为 kbps，默认为 48 kbps. 该配置推流前后设置均可生效
  1507.  * @property {ZegoAudioChannel} channel - 音频编码声道，控制编码器编码的声道数。默认为 Mono 单声道。仅在推流前设置生效。
  1508.  * @property {ZegoAudioCodecID} codecID - 编码 ID，默认为 ZegoAudioCodecIDDefault。仅在推流前设置生效。
  1509.  */
  1511. /**
  1512.  * @typedef {Object} ZegoDataRecordConfig - 录制配置
  1513.  * @property {string} filePath - 录制文件保存路径，绝对路径，需要包含文件名, 文件名需指明后缀，目前支持 .mp4/.flv/.aac 格式文件。若多次录制为同一个路径，会覆盖同名的文件。最大长度应小于 1024 字节。
  1514.  * @property {ZegoDataRecordType} recordType - 录制文件媒体类型
  1515.  */
  1517. /**
  1518.  * @typedef {Object} ZegoDataRecordProgress - 文件录制进度
  1519.  * @property {number} duration - 当前录制时长, 单位为毫秒
  1520.  * @property {number} currentFileSize - 当前录制文件大小, 单位为字节
  1521.  */
  1523. /**
  1524.  * @typedef {Object} ZegoNetworkSpeedTestConfig - 网络测速配置
  1525.  * @property {boolean} testUplink - 是否进行上行测速
  1526.  * @property {number} expectedUplinkBitrate - 单位 kbps。用于确定网络上行环境是否适合推送指定码率的数据，建议用推流的码率来测试。
  1527.  * @property {boolean} testDownlink - 是否进行下行测速
  1528.  * @property {number} expectedDownlinkBitrate - 单位 kbps。用于确定网络下行环境是否适合拉取指定码率的数据，建议用推流的码率来测试。
  1529.  */
  1531. /**
  1532.  * @typedef {Object} ZegoNetworkSpeedTestQuality - 网络测速质量
  1533.  * @property {number} connectCost - 连接服务器耗时，单位毫秒。测速过程中如果网络连接断开会自动发起重连，此变量会相应更新。
  1534.  * @property {number} rtt - rtt，单位毫秒
  1535.  * @property {number} packetLostRate - 丢包率，单位为百分比，0.0 ~ 1.0
  1536.  */
  1538. /**
  1539.  * @typedef {Object} ZegoAudioEffectPlayConfig - 音效播放器播放配置
  1540.  * @property {number} playCount - 播放次数，当设为 0 时则无限循环播放，直到用户调用 [stop]，默认为 1 即仅播放一次。
  1541.  * @property {boolean} isPublishOut - 是否将音效混入推流中，默认 false。
  1542.  */
  1544. module.exports = {
  1545.     ZegoScenario,
  1546.     ZegoLanguage,
  1547.     ZegoEngineState,
  1548.     ZegoRoomState,
  1549.     ZegoPublishChannel,
  1550.     ZegoViewMode,
  1551.     ZegoVideoMirrorMode,
  1552.     ZegoSEIType,
  1553.     ZegoPublisherState,
  1554.     ZegoVoiceChangerPreset,
  1555.     ZegoReverbPreset,
  1556.     ZegoVideoConfigPreset,
  1557.     ZegoStreamQualityLevel,
  1558.     ZegoAudioChannel,
  1559.     ZegoAudioCaptureStereoMode,
  1560.     ZegoAudioCodecID,
  1561.     ZegoVideoCodecID,
  1562.     ZegoPlayerVideoLayer,
  1563.     ZegoAECMode,
  1564.     ZegoANSMode,
  1565.     ZegoTrafficControlProperty,
  1566.     ZegoTrafficControlMinVideoBitrateMode,
  1567.     ZegoPlayerState,
  1568.     ZegoPlayerMediaEvent,
  1569.     ZegoStreamResourceMode,
  1570.     ZegoUpdateType,
  1571.     ZegoStreamRelayCDNState,
  1572.     ZegoStreamRelayCDNUpdateReason,
  1573.     ZegoRemoteDeviceState,
  1574.     ZegoAudioDeviceType,
  1575.     ZegoAudioRoute,
  1576.     ZegoMixerInputContentType,
  1577.     ZegoCapturePipelineScaleMode,
  1578.     ZegoVideoFrameFormat,
  1579.     ZegoVideoBufferType,
  1580.     ZegoVideoFrameFormatSeries,
  1581.     ZegoVideoFlipMode,
  1582.     ZegoAudioConfigPreset,
  1583.     ZegoMediaPlayerState,
  1584.     ZegoMediaPlayerNetworkEvent,
  1585.     ZegoMediaPlayerAudioChannel,
  1586.     ZegoAudioEffectPlayState,
  1587.     ZegoDataRecordType,
  1588.     ZegoDataRecordState,
  1589.     ZegoNetworkMode,
  1590.     ZegoNetworkSpeedTestType,
  1591. 	ZegoTrafficControlFocusOnMode,
  1592.     ZegoVideoStreamType
  1593. }