实时音视频 – 第 2 页 – 微信小程序开发指南

LivePusherContext.setBGMVolume(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档：live-pusher 组件

功能描述

设置背景音的音量

参数

Object object

属性	类型	必填	说明
volume	string	是	音量大小，取值范围为 0-1
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功或失败都会执行）

LivePusherContext.sendMessage(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

发送 SEI 消息

参数

Object object

属性	类型	必填	说明
msg	string	是	SEI 消息
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.resumeBGM(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档：live-pusher 组件

功能描述

恢复背景音

参数

Object object

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

LivePusherContext.resume(Object object)

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

恢复推流

参数

Object object

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

LivePusherContext.playBGM(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

播放背景音

参数

Object object

属性	类型	默认值	必填	说明	最低版本
url	string		是	加入背景混音的资源地址
startTimeMs	number	0	否	背景音开始播放的时间点，单位为 ms；如果传入的值为负数或超过文件长度，则默认从文件开头开始播放	2.31.0
endTimeMs	number	0	否	背景音结束播放的时间点，单位为 ms；0 表示播放到文件结尾，如果传入的值为负数或超过文件长度，则默认播放到文件结尾	2.31.0
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

LivePusherContext.pauseBGM(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

暂停背景音

参数

Object object

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

LivePusherContext.pause(Object object)

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

暂停推流

参数

Object object

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

LivePusherContext.onCustomRendererEvent(string event, function|function callback)

从基础库 2.29.0 开始支持，低版本需要做兼容处理。

微信小程序插件：支持

相关文档：live-pusher 组件

功能描述

开启自定义渲染后，开发者可以通过这个方法订阅相关事件，客户端 8.0.31 版本开始支持。

参数

string event

事件类型，后订阅的监听器会取消之前的监听器

event 的合法值

值	说明	最低版本
frame	采集到视频帧后触发
update	推流尺寸变更时触发

function|function callback

自定义渲染事件处理的回调函数

参数

Object res

属性	类型	说明
width	number	推流宽度
height	number	推流高度

LivePusherContext.getMaxZoom(Object object)

从基础库 2.31.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：不支持

微信小程序插件：支持

相关文档: live-pusher 组件

功能描述

获取最大缩放级别

参数

Object object

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

object.success 回调函数

参数

Object res

属性	类型	说明
maxZoom	string	最大缩放级别

LivePusherContext.exitPictureInPicture(Object object)

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

以 Promise 风格调用：不支持

微信小程序插件：支持

功能描述

退出小窗，该方法可在任意页面调用

参数

Object object

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