基礎(chǔ)參數(shù)

streamInfo

使用不同通道時需傳入不同的參數(shù)，目前只支持 mPaaS 通道，下表列出了在 mPaaS 通道下的相關(guān)參數(shù)。

界面顯示

Config 參數(shù)

{
  userId,  // 用戶 ID
  appId,   // 小程序 ID
    
  roomId?, // 房間 ID，創(chuàng)建不需要，加入可選
  token?,  // 房間 token，創(chuàng)建不需要，加入必選

  resolution?: 2, // 視頻的清晰度，0(640 * 360), 1(960 * 540), 2(1280 * 720)，默認為 2
  fps?: 30,       // 視頻幀率，15 / 30，默認為 30

  streamInfo: {
    // 根據(jù)不同通道傳入不同的參數(shù)，目前只支持 mPaaS 通道
    //  - mPaaS
    //    - signature
    //    - serverUrl（wss://cn-hangzhou-mrtc.cloud.alipay.com/ws）
    //    - workspaceId
    //    - bizName
    //    - subBiz
    
    // 簽名
    signature,           // 螞蟻域內(nèi)和 mPaaS 必選
        
    // mPaaS
    bizName: '',         // 使用 mPaaS 時必選
    subBiz: '',          // 使用 mPaaS 時必選
    workspaceId: '',     // 使用 mPaaS 時必選
    serverUrl: 'wss://cn-hangzhou-mrtc.cloud.alipay.com/ws'
    // mPaaS 通道下，上面這個 serverUrl 地址不變
    
  },
    
  displayInfo?: { // 界面顯示用到的配置，可選
    showFullScreen?: { // 全畫面顯示
        visible: false // 默認為 false 沉浸式 true 顯示全部畫面
    },
    callPage?: { // 接聽頁開關(guān)
        visible: true // 默認為 true 開啟接聽頁 false 關(guān)閉顯示
    },
    calling?: {
      information?: string // 接聽界面顯示的文本
    },
    
    end?: {
      information?: string // 掛斷界面顯示的文本
    },
      
    answer?: {
      pusher?: {
        visible?: boolean  // 是否顯示（配合 enableCamera 用于只想推音頻的場景）
        isMini?: boolean   // 是否以小窗顯示（默認 false，與 player.isMini 互斥，只能一個為 true）
      },
      
      player?: {
        visible?: boolean  // 是否顯示
        isMini?: boolean   // 是否以小窗顯示（默認 true，注意與 pusher.isMini 互斥，只能一個為 true）
      },
      
      actions?: {
        
        hangup?: {
          visible?: boolean // 是否顯示關(guān)閉按鈕（默認 true，只有值為 false 時隱藏）
        },
      
        mute?: {
          // ! 表示的是采集端的聲音采集，不是手機的音量
          visible?: boolean // 是否顯示靜音按鈕（默認 true，只有值為 false 時隱藏）
        },
          
        screenshot?: {
          visible?: boolean // 是否顯示截屏按鈕（默認 true，只有值為 false 時隱藏）
        },
          
        enableCamera?: {
          visible?: boolean // 是否顯示開啟攝像頭按鈕（默認 true，只有值為 false 時隱藏）
        },
        
        switchCamera?: {
          visible?: boolean // 是否顯示切換攝像頭按鈕（默認 true，只有值為 false 時隱藏）
        },
        switchScreenCapture?:{
           visible?: boolean // 是否顯示投屏按鈕（默認 true，只有值為 false 時隱藏）
        }
      },
        
      users?: {
        visible?: boolean, // 是否顯示用戶列表（默認 true，只有值為 false 時隱藏）
        
        // 用戶配置（比外層的 users 優(yōu)先級高）
        config: [userId]: {
          name: string   // 界面上顯示的用戶名稱
          avatar: string // 界面上顯示的用戶頭像
        }
      }
    },
      
    users?: {
      [userId]: {
        name: string   // 界面上顯示的用戶名稱
        avatar: string // 界面上顯示的用戶頭像
      }
    }
  },
    
  controlInfo?: {
    enableCamera?: boolean  // 啟動時是否打開攝像頭
  },

  extraInfo?: {}
}

rtc 接口

// 引入插件
const { rtc } = requirePlugin('rtc');

rtc.disableCamera() // 關(guān)閉攝像頭
rtc.enableCamera() // 開啟攝像頭
rtc.hangup() // 掛斷
rtc.mute() // 靜音
rtc.unmute() // 取消靜音
rtc.setFullScreen(true/false) // 切換全畫面顯示
rtc.snapshot() // 截屏
rtc.startScreenCapture() // 開始投屏
rtc.stopScreenCapture() // 結(jié)束投屏
rtc.switchCamera() //切換前后攝像頭