微信小程序API 实时音视频·LivePusherContext实例

2022-05-11 16:32 更新

LivePusherContext 实例,可通过 wx.createLivePusherContext 获取。

LivePusherContext 与页面内唯一的 live-pusher 组件绑定,操作对应的 live-pusher 组件。



方法:


LivePusherContext.pause(Object object)

暂停推流

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.pauseBGM(Object object)

基础库 2.4.0 开始支持,低版本需做兼容处理。

暂停背景音

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.playBGM(Object object)

基础库 2.4.0 开始支持,低版本需做兼容处理。

播放背景音

参数

Object object

属性 类型 默认值 必填 说明
url string 是 加入背景混音的资源地址
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.resume(Object object)

恢复推流

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.resumeBGM(Object object)

基础库 2.4.0 开始支持,低版本需做兼容处理。

恢复背景音

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.setBGMVolume(Object object)

基础库 2.4.0 开始支持,低版本需做兼容处理。

设置背景音音量

参数

Object object

属性 类型 默认值 必填 说明
volume string 是 音量大小,范围是 0-1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.setMICVolume(Object object)

基础库 2.10.0 开始支持,低版本需做兼容处理。

设置麦克风音量

参数

Object object

属性 类型 默认值 必填 说明
volume number 是 音量大小,范围是 0.0-1.0
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.snapshot(string quality)

基础库 1.9.90 开始支持,低版本需做兼容处理。

快照

参数

string quality

基础库 2.10.0 开始支持,低版本需做兼容处理。

图片的质量,默认原图。有效值为 raw、compressed


LivePusherContext.start(Object object)

开始推流,同时开启摄像头预览

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.startPreview(Object object)

基础库 2.7.0 开始支持,低版本需做兼容处理。

开启摄像头预览

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.stop(Object object)

停止推流,同时停止摄像头预览

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.stopBGM(Object object)

基础库 2.4.0 开始支持,低版本需做兼容处理。

停止背景音

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.stopPreview(Object object)

基础库 2.7.0 开始支持,低版本需做兼容处理。

关闭摄像头预览

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.switchCamera(Object object)

切换前后摄像头

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


LivePusherContext.toggleTorch(Object object)

基础库 2.1.0 开始支持,低版本需做兼容处理。

切换手电筒

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号