實时音視頻

createLivePusherContext

TIP

該API使用方法為： LivePusherContext wx.createLivePusherContext()

TIP

基礎庫1.4.96開始支持，低版本需做相容處理

• 功能說明： 創建。 live-pusher 上下文 LivePusherContext 對象
• 返回值： LivePusherContext

LivePusherContext

LivePusherContext實例，可通過 wx.createLivePusherContext

LivePusherContext與頁面內唯一的 live-pusher 組件綁定，操作對應的 live-pusher 組件

.start

TIP

該API使用方法為： LivePusherContext.start(Object object)

• 功能說明： 開始推流，同時開啟監視器預覽

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.stop

TIP

該API使用方法為： LivePusherContext.stop(Object object)

• 功能說明： 停止推流，同時停止監視器預覽

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.pause

TIP

該API使用方法為： LivePlayerContext.pause(Object object)

• 功能說明： 暫停推流

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.resume

TIP

該API使用方法為： LivePusherContext.resume(Object object)

• 功能說明： 恢復推流

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.switchCamera

TIP

該API使用方法為： LivePusherContext.switchCamera(Object object)

• 功能說明： 切換前後監視器

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.snapshot

TIP

該API使用方法為： LivePusherContext.snapshot(Object object)

• 功能說明： 快照

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： 參數 Object res

  内容	類型	說明
  tempImagePath	string	圖片文件的臨時路徑
  width	string	圖片的寬度
  height	string	圖片的高度

.toggleTorch

TIP

該API使用方法為： LivePusherContext.toggleTorch(Object object)

• 功能說明： 切換手電筒

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.playBGM

TIP

該API使用方法為： LivePusherContext.playBGM(Object object)

• 功能說明： 播放背景音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  url	String	-	是	加入背景混音的資源地址
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.stopBGM

TIP

該API使用方法為： LivePusherContext.stopBGM(Object object)

• 功能說明： 停止背景音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.pauseBGM

TIP

該API使用方法為： LivePusherContext.pauseBGM(Object object)

• 功能說明： 暫停背景音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.resumeBGM

TIP

該API使用方法為： LivePusherContext.resumeBGM(Object object)

• 功能說明： 恢復背景音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.setBGMPosition

TIP

該API使用方法為： LivePusherContext.setBGMPosition(Object object)

• 功能說明： 設定背景音進度

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  position	Number	-	是	背景音進度，單位：秒
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.setMICVolume

TIP

該API使用方法為： LivePusherContext.setMICVolume(Object object)

• 功能說明： 設定麥克風音量

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  volume	Number	-	是	音量大小，範圍是0.0-1.0
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.setBGMVolume

TIP

該API使用方法為： LivePusherContext.setBGMVolume(Object object)

• 功能說明： 設定背景音音量

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  volume	Number	-	是	音量大小，範圍是0.0-1.0
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.setAudioReverbType

TIP

該API使用方法為： LivePusherContext.setAudioReverbType(Object object)

• 功能說明： 設定混音類型

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  audioReverbType	Number	-	是	混音類型，0～6分別對應'關閉混響'， 'KTV', '小房間'，'大會堂'，'低沉'，'洪亮'，'磁性'
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.startPreview

TIP

該API使用方法為： LivePusherContext.startPreview(Object object)

• 功能說明： 開啟監視器預覽

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.stopPreview

TIP

該API使用方法為： LivePusherContext.stopPreview(Object object)

• 功能說明： 關閉監視器預覽

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.startAudioRecord

TIP

該API使用方法為： LivePusherContext.startAudioRecord(Object object)

• 功能說明： 開始錄音，當主動調用LivePusherContext.stopAudioRecord時，或者錄音超過1分鐘時自動結束錄音。

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.stopAudioRecord

TIP

該API使用方法為： LivePusherContext.stopAudioRecord(Object object)

• 功能說明： 結束錄音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  tempFilePath	String	錄音文件的臨時路徑（本地路徑）

createLivePlayerContext

TIP

該API使用方法為： LivePlayerContext wx.createLivePlayerContext(string id, Object this)

TIP

基礎庫1.4.96開始支持，低版本需做相容處理

• 功能說明： 創建live-pusher上下文LivePusherContext對象
• • 參數及說明：
  • string id，live-player 組件的id
  • Object this，在自定義組件下，當前組件實例的this，以操作組件內 live-player 組件
• 返回值： LivePlayerContext

LivePlayerContext

.exitfullscreen

TIP

該API使用方法為： LivePlayerContext.exitFullScreen(Object object)

• 功能說明： 退出全屏

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.mute

TIP

該API使用方法為： LivePlayerContext.mute(Object object)

• 功能說明： 靜音

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.pause

TIP

該API使用方法為： LivePlayerContext.pause(Object object)

• 功能說明： 暫停

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.play

TIP

該API使用方法為： LivePlayerContext.play(Object object)

• 功能說明： 播放

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.requestFullScreen

TIP

該API使用方法為： LivePlayerContext.requestFullScreen(Object object)

• 功能說明： 進入全屏

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  direction	Number	0	否	設定全屏時的方向
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

  • object.direction的合法值

  值	說明
  0	正常豎向
  90	荧幕逆時針90度
  -90	荧幕順時針90度

.resume

TIP

該API使用方法為： LivePlayerContext.resume(Object object)

• 功能說明： 恢復

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

.snapshot

TIP

該API使用方法為： LivePlayerContext.snapshot(Object object)

• 功能說明： 截圖

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  tempFilePath	String	圖片文件的臨時路徑
  width	String	圖片的寬度
  height	String	圖片的高度

.stop

TIP

該API使用方法為： LivePlayerContext.stop(Object object)

• 功能說明： 停止

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）