Source: ZegoExpressMediaPlayer.js

  3. const EventEmitter = require('events').EventEmitter;
  4. const WebGLRender = require('./ZegoExpressWebgl');
  5. const {ZegoViewMode} = require('./ZegoExpressDefines');
  7. /**
  8.  * ZegoMediaPlayer
  9.  */
  10. class ZegoMediaPlayer extends EventEmitter {
  12.     /**
  13.      * 开始播放
  14.      *
  15.      * 必须在加载资源完成后才能调用
  16.      */
  17.     start(){
  18.         this.nativeMediaPlayer.start({});
  19.     }
  21.     /**
  22.      * 停止播放
  23.      */
  24.     stop(){
  25.         this.nativeMediaPlayer.stop({});
  26.     }
  28.     /**
  29.      * 暂停播放
  30.      */
  31.     pause(){
  32.         this.nativeMediaPlayer.pause({});
  33.     }
  35.     /**
  36.      * 恢复播放
  37.      */
  38.     resume(){
  39.         this.nativeMediaPlayer.resume({});
  40.     }
  42.     /**
  43.      * 加载媒体资源
  44.      *
  45.      * 可传本地资源的绝对路径或者网络资源的 URL
  46.      * @param {string} path - 本地资源路径或网络资源的 URL，不能传入 null 或 ""。
  47.      * @return {Promise<number>} - 加载资源的结果
  48.      */
  49.     loadResource(path){
  50.         return this.nativeMediaPlayer.loadResource({path});
  51.     }
  53.     /**
  54.      * 获取当前播放状态
  55.      *
  56.      * @return {ZegoMediaPlayerState} - 当前播放器状态
  57.      */
  58.     getCurrentState(){
  59.         return this.nativeMediaPlayer.getCurrentState({});
  60.     }
  62.     /**
  63.      * 设置指定的播放进度
  64.      *
  65.      * 单位为毫秒
  66.      * @param {number} millisecond - 指定的播放进度的时间点
  67.      * @return {Promise<number>} - 设置播放进度的结果
  68.      */
  69.     seekTo(millisecond){
  70.         return this.nativeMediaPlayer.seekTo({millisecond});
  71.     }
  73.     /**
  74.      * 设置播放器音量，会同时设置本地播放音量和推流音量
  75.      *
  76.      * @param {number} volume - 范围为 0 ~ 200，默认为 60。
  77.      */
  78.     setVolume(volume){
  79.         this.nativeMediaPlayer.setVolume({volume});
  80.     }
  82.     /**
  83.      * 设置播放器本地播放音量
  84.      *
  85.      * @param {number} volume - 范围为 0 ~ 200，默认为 60。
  86.      */
  87.     setPlayVolume(volume){
  88.         this.nativeMediaPlayer.setPlayVolume({volume});
  89.     }
  91.     /**
  92.      * 设置播放器推流音量
  93.      *
  94.      * @param {number} volume - 范围为 0 ~ 200，默认为 60。
  95.      */
  96.     setPublishVolume(volume){
  97.         this.nativeMediaPlayer.setPublishVolume({volume});
  98.     }
  100.     /**
  101.      * 获取当前媒体播放器本地播放的音量，范围为 0 ~ 200，默认值为 60
  102.      *
  103.      * @return {number} - 当前音量
  104.      */
  105.     getPlayVolume(){
  106.         return this.nativeMediaPlayer.getPlayVolume({});
  107.     }
  109.     /**
  110.      * 获取当前媒体播放器推流的音量，范围为 0 ~ 200，默认值为 60
  111.      *
  112.      * @return {number} - 当前音量
  113.      */
  114.     getPublishVolume(){
  115.         return this.nativeMediaPlayer.getPublishVolume({});
  116.     }
  118.     /**
  119.      * 获取媒体资源的总进度
  120.      *
  121.      * 必须在加载资源完成后才能调用，否则返回值为 0
  122.      * @return {number} - 单位为毫秒
  123.      */
  124.     getTotalDuration(){
  125.         return this.nativeMediaPlayer.getTotalDuration({});
  126.     }
  128.     /**
  129.      * 获取当前播放进度
  130.      *
  131.      * 必须在加载资源完成后才能调用，否则返回值为 0
  132.      * @return {number} - 当前播放进度
  133.      */
  134.     getCurrentProgress(){
  135.         return this.nativeMediaPlayer.getCurrentProgress({});
  136.     }
  138.     /**
  139.      * 是否静默本地播放
  140.      *
  141.      * 若开启了混音入流则推的流中仍然有声音，默认为 false。
  142.      * @param {boolean} mute - 本地静音标记，默认为 false。
  143.      */
  144.     muteLocal(mute){
  145.         this.nativeMediaPlayer.muteLocal({mute});
  146.     }
  148.     /**
  149.      * 设置播放器播放视频的视图
  150.      *
  151.      * @param {ZegoView} view - 视频渲染的画布对象
  152.      */
  153.     setPlayerView(view){
  154.         if(view == null){
  155.             this.localGLRender = null;
  156.         }
  157.         else{
  158.             view = Object.assign({ viewMode: ZegoViewMode.AspectFit, backgroundColor: 0x000000, preserveDrawingBuffer: false}, view);
  159.             this.localGLRender = new WebGLRender();
  160.             this.localGLRender.setViewMode(view.viewMode);
  161.             this.localGLRender.enablePreserveDrawingBuffer(view.preserveDrawingBuffer);
  162.             this.localGLRender.initBkColor(view.backgroundColor);
  163.             this.localGLRender.initGLfromCanvas(view.canvas);
  164.             
  165.             this.nativeMediaPlayer.setPlayerCanvas({});
  166.         }
  167.     }
  169.     /**
  170.      * 是否将播放器的声音混入正在推的流中
  171.      *
  172.      * 此接口仅会将媒体播放器声音混到主通道中
  173.      * @param {boolean} enable - 是否混音标记，默认为 false
  174.      */
  175.     enableAux(enable){
  176.         this.nativeMediaPlayer.enableAux({enable});
  177.     }
  179.     /**
  180.      * 是否将播放器的视频混入正在推的流中
  181.      *
  182.      * @param {boolean} enable - 是否推视频
  183.      * @param {number} channel - channel
  184.      */
  185.     enablePublishVideo(enable, channel){
  186.         this.nativeMediaPlayer.enablePublishVideo({enable, channel});
  187.     }
  189.     /**
  190.      * 是否重复播放
  191.      *
  192.      * @param {boolean} enable - 重复播放标记，默认为 false
  193.      */
  194.     enableRepeat(enable){
  195.         this.nativeMediaPlayer.enableRepeat({enable});
  196.     }
  198.     /**
  199.      * 设置播放进度回调间隔
  200.      *
  201.      * 可通过此函数控制 [onMediaPlayerPlayingProgress] 的回调频率，当设置回调间隔为 0 时，停止回调。默认回调间隔为 1s
  202.      * 回调不会严格按照设定的回调间隔值返回，而是以处理音频帧或者视频帧的频率来判断是否需要回调
  203.      * @param {number} millisecond - 播放进度回调间隔时间，单位为毫秒
  204.      */
  205.     setProgressInterval(millisecond){
  206.         this.nativeMediaPlayer.setProgressInterval({millisecond});
  207.     }
  209.     /**
  210.      * 获取播放文件的音轨个数
  211.      *
  212.      * @return {number} - 音轨个数
  213.      */
  214.     getAudioTrackCount(){
  215.         return this.nativeMediaPlayer.getAudioTrackCount({});
  216.     }
  218.     /**
  219.      * 设置播放文件的音轨
  220.      *
  221.      * @param {number} index - 音轨序号，可以通过 [getAudioTrackCount] 获取音轨个数
  222.      */
  223.     setAudioTrackIndex(index){
  224.         this.nativeMediaPlayer.setAudioTrackIndex({index});
  225.     }
  227.     /**
  228.      * 设置变声的具体参数
  229.      *
  230.      * @param {ZegoMediaPlayerAudioChannel} audioChannel - 要进行变声的声道
  231.      * @param {ZegoVoiceChangerParam} param - 变声参数
  232.      */
  233.     setVoiceChangerParam(audioChannel, param){
  234.         this.nativeMediaPlayer.setVoiceChangerParam({audioChannel, param});
  235.     }
  237.     /**
  238.      * 截取媒体播放器当前播放画面
  239.      *
  240.      * 只有在调用 [setPlayerCanvas] 设置显示控件和播放状态的情况下，才能正常截图
  241.      * @return {Promise<number, string>} - 快照错误代码和jpg格式图片的 base64 字符串
  242.      */
  243.     takeSnapshot(){
  244.         return this.nativeMediaPlayer.takeSnapshot({});
  245.     }
  247.     getCustomVideoCapturePlugin(){
  248.         return this.nativeMediaPlayer.getCustomVideoCapturePlugin();
  249.     }
  251.     /**
  252.      * @event ZegoMediaPlayer#onMediaPlayerStateUpdate
  253.      * @desc 媒体播放器播放状态回调。
  254.      *
  255.      * 详情描述：媒体播放器播放状态回调。
  256.      * 通知时机：当媒体播放器的播放状态改变时会触发此回调。
  257.      * 使用限制：无。
  258.      * @property {object} result - 结果数据对象
  259.      * @property {ZegoMediaPlayerState} result.state - 播放器状态。
  260.      * @property {number} result.errorCode - 错误码，详情请参考 常见错误码文档 https://doc-zh.zego.im/zh/4378.html 。
  261.      */
  263.     /**
  264.      * @event ZegoMediaPlayer#onMediaPlayerNetworkEvent
  265.      * @desc 媒体播放器网络状态事件回调。
  266.      *
  267.      * 详情描述：媒体播放器网络状态事件回调。
  268.      * 通知时机：当媒体播放器在播放网络资源时，当缓存数据的状态改变时会触发此回调。
  269.      * 使用限制：只有在播放网络资源时才会触发该回调。
  270.      * 相关接口：[setNetWorkBufferThreshold]。
  271.      * @property {object} result - 结果数据对象
  272.      * @property {ZegoMediaPlayerNetworkEvent} result.networkEvent - 网络状态事件。
  273.      */
  275.     /**
  276.      * @event ZegoMediaPlayer#onMediaPlayerPlayingProgress
  277.      * @desc 播放器播放进度回调。
  278.      *
  279.      * 详情描述：媒体播放器播放进度回调。通过调用 [setProgressInterval] 可以设置回调间隔时间。当设置回调间隔为 0 时，停止回调。默认回调间隔为 1 秒。
  280.      * 通知时机：当媒体播放器开始播放资源后会触发此回调。
  281.      * 使用限制：无。
  282.      * 相关接口：[setProgressInterval]。
  283.      * @property {object} result - 结果数据对象
  284.      * @property {number} result.millisecond - 进度，单位为毫秒。
  285.      */
  288.     callEmit() {
  289.         try {
  290.             if (arguments[0] === "onVideoData") {
  291.                 if(this.localGLRender){
  292.                     let videoFrame = {
  293.                     "videoFrameParam": arguments[1]["videoFrameParam"],
  294.                     "videoFrameBuffer": Buffer.from(arguments[1]["videoFrameBuffer"])
  295.                     }
  296.                     this.localGLRender.drawVideoFrame(videoFrame);
  297.                 }
  298.             }
  299.         } catch (error) {
  300.             // console.log("callEmit: ", error);
  301.         }
  302.         try {
  303.             this.emit(arguments[0], arguments[1]);
  304.         } catch (error) {
  305.             console.log(`error catched in your callback ${arguments[0]} : ${error}`)
  306.         }
  307.     }
  308. }
  310. module.exports = ZegoMediaPlayer;