通过阅读本文,您可以了解Web RTS SDK的接口详情。

目录

API 描述
new AliRTS() 实例化对象。
isSupport 检测浏览器是否可用。
startLiveStream 开始拉RTS流。
stopLiveStream 停止RTS播放。
muteLiveStream 静音。
on 回调监听。

详情

  • new AliRTS():实例化对象。
    var aliRts = new AliRTS();
  • isSupport:检测浏览器是否可用。
    //调用此接口时必须传递参数,否则调用时会出现报错
    /** 
     * isSupport检测是否可用 
     * @param {Object} supportInfo 检测信息 
     * @param {Boolean} supportInfo.isReceiveVideo 是否拉视频流 
     * @return {Promise}  
     */ 
    aliRts.isSupport(supportInfo).then(re=> { 
        //可用 
    }).catch(err=> { 
      //不可用 
      console.log(`not support errorCode: ${err.errorCode}`); 
      console.log(`not support message: ${err.message}`); 
    })
  • startLiveStream:开始拉RTS流。
    /** 
     * rts开始拉流接口 
     * @param {String} pullStreamUrl 拉流地址 
     * @param {HTMLMediaElement} mediaElement 播放视频的video标签 
     * @return {Promise}  
     */ 
    aliRts.startLiveStream(pullStreamUrl, mediaElement);
  • stopLiveStream:停止RTS播放。
    aliRts.stopLiveStream();
  • muteLiveStream:静音。
    /** 
     * 拉流静音接口 
     * @param {Boolean} muted 是否开启静音 
     */ 
    aliRts.muteLiveStream(muted);
  • on:回调监听。
    /*
     * 在onError中获取到错误码10201时,此时网页的音频是静音的,
     * 需要用户在网页上手动触发事件(必须有用户交互,不能直接通过代码控制)
     * 调用aliRts.muteLiveStream(false) 来取消静音
     */
    aliRts.on("onError", (err)=> {
      console.log(`errorCode: ${err.errorCode}`);
      console.log(`message: ${err.message}`);
    })
    
    const PLAY_EVENT = {
      CANPLAY: "canplay",
      WAITING: "waiting",
      PLAYING: "playing"
    }
    
    aliRts.on('onPlayEvent', (play)=>{
      if(play.event === PLAY_EVENT.CANPLAY){
        //拉流可以播放
      }else if(play.event === PLAY_EVENT.WAITING){
        //拉流卡顿等待缓冲中 (仅Chrome)
      }else if(play.event === PLAY_EVENT.PLAYING){
        //拉流卡顿结束恢复播放 (仅Chrome)
      }
    })