全部產品
Search
文件中心

:介面說明(舊版:V1.1.0~V1.2.4)

更新時間:Jun 30, 2024

通過閱讀本文,您可以瞭解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)
      }
    })