微信小程序API 實(shí)時(shí)音視頻·LivePusherContext實(shí)例

LivePusherContext 實(shí)例，可通過 wx.createLivePusherContext 獲取。

LivePusherContext 與頁面內(nèi)唯一的 live-pusher 組件綁定，操作對(duì)應(yīng)的 live-pusher 組件。

---

方法:

LivePusherContext.pause(Object object)

暫停推流

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.pauseBGM(Object object)

基礎(chǔ)庫 2.4.0 開始支持，低版本需做兼容處理。

暫停背景音

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.playBGM(Object object)

基礎(chǔ)庫 2.4.0 開始支持，低版本需做兼容處理。

播放背景音

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
url	string		是	加入背景混音的資源地址
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.resume(Object object)

恢復(fù)推流

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.resumeBGM(Object object)

基礎(chǔ)庫 2.4.0 開始支持，低版本需做兼容處理。

恢復(fù)背景音

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.setBGMVolume(Object object)

基礎(chǔ)庫 2.4.0 開始支持，低版本需做兼容處理。

設(shè)置背景音音量

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
volume	string		是	音量大小，范圍是 0-1
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.setMICVolume(Object object)

基礎(chǔ)庫 2.10.0 開始支持，低版本需做兼容處理。

設(shè)置麥克風(fēng)音量

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
volume	number		是	音量大小，范圍是 0.0-1.0
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.snapshot(string quality)

基礎(chǔ)庫 1.9.90 開始支持，低版本需做兼容處理。

快照

參數(shù)

string quality

基礎(chǔ)庫 2.10.0 開始支持，低版本需做兼容處理。

圖片的質(zhì)量，默認(rèn)原圖。有效值為 raw、compressed

LivePusherContext.start(Object object)

開始推流，同時(shí)開啟攝像頭預(yù)覽

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.startPreview(Object object)

基礎(chǔ)庫 2.7.0 開始支持，低版本需做兼容處理。

開啟攝像頭預(yù)覽

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.stop(Object object)

停止推流，同時(shí)停止攝像頭預(yù)覽

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.stopBGM(Object object)

基礎(chǔ)庫 2.4.0 開始支持，低版本需做兼容處理。

停止背景音

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.stopPreview(Object object)

基礎(chǔ)庫 2.7.0 開始支持，低版本需做兼容處理。

關(guān)閉攝像頭預(yù)覽

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.switchCamera(Object object)

切換前后攝像頭

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）

LivePusherContext.toggleTorch(Object object)

基礎(chǔ)庫 2.1.0 開始支持，低版本需做兼容處理。

切換手電筒

參數(shù)

Object object

屬性	類型	默認(rèn)值	必填	說明
success	function		否	接口調(diào)用成功的回調(diào)函數(shù)
fail	function		否	接口調(diào)用失敗的回調(diào)函數(shù)
complete	function		否	接口調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）