LivePusherContext

wx.createLivePusherContext()

1.7.0 新版功能: 低版本需做 兼容处理 。

Label

创建 live-pusher 上下文 LivePusherContext() 对象。

返回

LivePusherContext

class LivePusherContext()

LivePusherContext 实例，可通过 wx.createLivePusherContext() 获取。

livePusherContext 与页面内唯一的 <live-pusher> 组件绑定，操作对应的 <live-pusher> 组件。

方法

LivePusherContext.start({[success][, fail][, complete]})

Label

播放推流

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.stop({[success][, fail][, complete]})

Label

停止推流

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.pause({[success][, fail][, complete]})

Label

暂停推流

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.resume({[success][, fail][, complete]})

Label

恢复推流

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.switchCamera({[success][, fail][, complete]})

Label

切换前后摄像头

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.snapshot({[success][, fail][, complete]})

1.9.90 新版功能: 低版本需做 兼容处理 。

Label

快照

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.toggleTorch({[success][, fail][, complete]})

2.1.0 新版功能: 低版本需做 兼容处理 。

Label

切换

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.playBGM(url[, success][, fail][, complete]})

2.4.0 新版功能: 低版本需做 兼容处理 。

Label

播放背景音

参数

• url (string()) – 加入背景混音的资源地址

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.stopBGM({[success][, fail][, complete]})

2.4.0 新版功能: 低版本需做 兼容处理 。

Label

停止背景音

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.pauseBGM({[success][, fail][, complete]})

2.4.0 新版功能: 低版本需做 兼容处理 。

Label

暂停背景音

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.resumeBGM({[success][, fail][, complete]})

2.4.0 新版功能: 低版本需做 兼容处理 。

Label

恢复背景音

参数

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.setBGMVolume({string[, success][, fail][, complete]})

2.4.0 新版功能: 低版本需做 兼容处理 。

Label

设置背景音音量

参数

• volume (string()) – 音量大小，范围是 0-1

• success (function()) – 接口调用成功的回调函数

• fail (function()) – 接口调用失败的回调函数

• complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

在开发者工具中预览效果