跳到主要内容
版本:3.x

LivePusherContext

LivePusherContext 实例,可通过 Taro.createLivePusherContext 获取。 LivePusherContext 与页面内唯一的 live-pusher 组件绑定,操作对应的 live-pusher 组件。

支持情况:

参考文档

方法

pause

暂停推流

支持情况:

参考文档

(option?: PauseOption) => void
参数类型
optionPauseOption

pauseBGM

暂停背景音

支持情况:

参考文档

(option?: PauseBGMOption) => void
参数类型
optionPauseBGMOption

playBGM

播放背景音

支持情况:

参考文档

(option: PlayBGMOption) => void
参数类型
optionPlayBGMOption

resume

恢复推流

支持情况:

参考文档

(option?: ResumeOption) => void
参数类型
optionResumeOption

resumeBGM

恢复背景音

支持情况:

参考文档

(option?: ResumeBGMOption) => void
参数类型
optionResumeBGMOption

sendMessage

发送SEI消息

支持情况:

参考文档

(option?: SendMessageOption) => void
参数类型
optionSendMessageOption

setBGMVolume

设置背景音音量

支持情况:

参考文档

(option: SetBGMVolumeOption) => void
参数类型
optionSetBGMVolumeOption

setMICVolume

设置麦克风音量

支持情况:

参考文档

(option: SetMICVolumeOption) => void
参数类型
optionSetMICVolumeOption

snapshot

快照

支持情况:

参考文档

(option?: SnapshotOption) => void
参数类型
optionSnapshotOption

start

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

支持情况:

参考文档

(option?: StartOption) => void
参数类型
optionStartOption

startPreview

开启摄像头预览

支持情况:

参考文档

(option?: StartPreviewOption) => void
参数类型
optionStartPreviewOption

stop

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

支持情况:

参考文档

(option?: StopOption) => void
参数类型
optionStopOption

stopBGM

停止背景音

支持情况:

参考文档

(option?: StopBGMOption) => void
参数类型
optionStopBGMOption

stopPreview

关闭摄像头预览

支持情况:

参考文档

(option?: StopPreviewOption) => void
参数类型
optionStopPreviewOption

switchCamera

切换前后摄像头

支持情况:

参考文档

(option?: SwitchCameraOption) => void
参数类型
optionSwitchCameraOption

toggleTorch

切换手电筒

支持情况:

参考文档

(option?: ToggleTorchOption) => void
参数类型
optionToggleTorchOption

参数

PauseOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

PauseBGMOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

PlayBGMOption

参数类型必填说明
urlstring加入背景混音的资源地址
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

ResumeOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

ResumeBGMOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

SendMessageOption

参数类型必填说明
msgstringSEI消息
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

SetBGMVolumeOption

参数类型必填说明
volumenumber音量大小,范围是 0-1
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

SetMICVolumeOption

参数类型必填说明
volumenumber音量大小,范围是 0-1
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

SnapshotOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

StartOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

StartPreviewOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

StopOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

StopBGMOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

StopPreviewOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

SwitchCameraOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

ToggleTorchOption

参数类型必填说明
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

API 支持度

API微信小程序H5React NativeHarmony
LivePusherContext✔️
LivePusherContext.pause✔️
LivePusherContext.pauseBGM✔️
LivePusherContext.playBGM✔️
LivePusherContext.resume✔️
LivePusherContext.resumeBGM✔️
LivePusherContext.sendMessage✔️
LivePusherContext.setBGMVolume✔️
LivePusherContext.setMICVolume✔️
LivePusherContext.snapshot✔️
LivePusherContext.start✔️
LivePusherContext.startPreview✔️
LivePusherContext.stop✔️
LivePusherContext.stopBGM✔️
LivePusherContext.stopPreview✔️
LivePusherContext.switchCamera✔️
LivePusherContext.toggleTorch✔️