Version: 下个版本
LivePusherContext
LivePusherContext
实例,可通过 Taro.createLivePusherContext
获取。
LivePusherContext
与页面内唯一的 live-pusher
组件绑定,操作对应的 live-pusher
组件。
#
方法#
pause暂停推流
参数 | 类型 |
---|---|
option | PauseOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.pause | ✔️ |
#
pauseBGM暂停背景音
参数 | 类型 |
---|---|
option | PauseBGMOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.pauseBGM | ✔️ |
#
playBGM播放背景音
参数 | 类型 |
---|---|
option | PlayBGMOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.playBGM | ✔️ |
#
resume恢复推流
参数 | 类型 |
---|---|
option | ResumeOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.resume | ✔️ |
#
resumeBGM恢复背景音
参数 | 类型 |
---|---|
option | ResumeBGMOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.resumeBGM | ✔️ |
#
setBGMVolume设置背景音音量
参数 | 类型 |
---|---|
option | SetBGMVolumeOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.setBGMVolume | ✔️ |
#
snapshot快照
参数 | 类型 |
---|---|
option | SnapshotOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.snapshot | ✔️ |
#
start开始推流,同时开启摄像头预览
参数 | 类型 |
---|---|
option | StartOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.start | ✔️ |
#
startPreview开启摄像头预览
参数 | 类型 |
---|---|
option | StartPreviewOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.startPreview | ✔️ |
#
stop停止推流,同时停止摄像头预览
参数 | 类型 |
---|---|
option | StopOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.stop | ✔️ |
#
stopBGM停止背景音
参数 | 类型 |
---|---|
option | StopBGMOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.stopBGM | ✔️ |
#
stopPreview关闭摄像头预览
参数 | 类型 |
---|---|
option | StopPreviewOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.stopPreview | ✔️ |
#
switchCamera切换前后摄像头
参数 | 类型 |
---|---|
option | SwitchCameraOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.switchCamera | ✔️ |
#
toggleTorch切换手电筒
参数 | 类型 |
---|---|
option | ToggleTorchOption |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.toggleTorch | ✔️ |
#
参数#
PauseOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
PauseBGMOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
PlayBGMOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 加入背景混音的资源地址 |
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
ResumeOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
ResumeBGMOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
SetBGMVolumeOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
volume | string | 是 | 音量大小,范围是 0-1 |
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
SnapshotOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
StartOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
StartPreviewOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
StopOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
StopBGMOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
StopPreviewOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
SwitchCameraOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
ToggleTorchOption参数 | 类型 | 必填 | 说明 |
---|---|---|---|
complete | (res: CallbackResult) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
fail | (res: CallbackResult) => void | 否 | 接口调用失败的回调函数 |
success | (res: CallbackResult) => void | 否 | 接口调用成功的回调函数 |
#
API 支持度API | 微信小程序 | H5 | React Native |
---|---|---|---|
LivePusherContext.pause | ✔️ | ||
LivePusherContext.pauseBGM | ✔️ | ||
LivePusherContext.playBGM | ✔️ | ||
LivePusherContext.resume | ✔️ | ||
LivePusherContext.resumeBGM | ✔️ | ||
LivePusherContext.setBGMVolume | ✔️ | ||
LivePusherContext.snapshot | ✔️ | ||
LivePusherContext.start | ✔️ | ||
LivePusherContext.startPreview | ✔️ | ||
LivePusherContext.stop | ✔️ | ||
LivePusherContext.stopBGM | ✔️ | ||
LivePusherContext.stopPreview | ✔️ | ||
LivePusherContext.switchCamera | ✔️ | ||
LivePusherContext.toggleTorch | ✔️ |