live-pusher

live-pusher

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

小程序插件 ：支持，需要小程序基础库版本不低于 2.3.0

微信 Windows 版 ：支持

微信 Mac 版 ：支持

微信 鸿蒙 OS 版 ：支持

相关文档: wx.createLivePusherContext

渲染框架支持情况：Skyline （使用最新 Nighly 工具调试）、WebView

功能描述

实时音视频录制（v2.9.1 起支持同层渲染）。需要用户授权 scope.camera、scope.record。

申请开通

暂只针对国内主体如下类目的小程序开放，需要先通过类目审核，再在小程序管理后台，「开发」-「接口设置」中自助开通该组件权限。

通用属性

| 属性| 类型| 默认值| 必填| 说明| 最低版本 ---|---|---|---|---|---|--- | url| string| | 否| 推流地址。目前仅支持 rtmp 格式| 1.7.0 | mode| string| RTC| 否| 模式| 1.7.0 | | 合法值| 说明| 最低版本 ---|---|--- QVGA| Quarter VGA| 3.5.0 HVGA| Half-size VGA| 3.5.0 SD| 标清| 1.7.0 HD| 高清| 1.7.0 FHD| 超清| 1.7.0 RTC| 实时通话| 1.7.0 | autopush| boolean| false| 否| 自动推流| 1.7.0 | enableVideoCustomRender| boolean| false| 否| 自定义渲染，允许开发者自行处理所采集的视频帧，详见LivePusherContext| 2.29.0 | muted| boolean| false| 否| 是否静音。即将废弃，可用 enable-mic 替代| 1.7.0 | enable-camera| boolean| true| 否| 开启摄像头| 1.7.0 | auto-focus| boolean| true| 否| 自动聚集| 1.7.0 | orientation| string| vertical| 否| 画面方向| 1.7.0 | | 合法值| 说明 ---|--- vertical| 竖直 horizontal| 水平 | beauty| number| 0| 否| 美颜，取值范围 0-9 ，0 表示关闭。鸿蒙 OS 暂不支持| 1.7.0 | whiteness| number| 0| 否| 美白，取值范围 0-9 ，0 表示关闭| 1.7.0 | aspect| string| 9:16| 否| 宽高比，可选值有 3:4, 9:16| 1.7.0 | min-bitrate| number| 200| 否| 最小码率| 1.7.0 | max-bitrate| number| 1000| 否| 最大码率| 1.7.0 | audio-quality| string| high| 否| 高音质(48KHz)或低音质(16KHz)，值为high, low| 1.7.0 | waiting-image| string| | 否| 进入后台时推流的等待画面| 1.7.0 | waiting-image-hash| string| | 否| 等待画面资源的MD5值| 1.7.0 | zoom| boolean| false| 否| 调整焦距| 2.1.0 | device-position| string| front| 否| 前置或后置，值为front, back| 2.3.0 | background-mute| boolean| false| 否| 进入后台时是否静音（已废弃，默认退后台静音）| 1.7.0 | mirror| boolean| false| 否| 设置推流画面是否镜像，产生的效果在 live-player 反应到| 2.7.0 | remote-mirror| boolean| false| 否| 同 mirror 属性，后续 mirror 将废弃| 2.10.0 | local-mirror| string| auto| 否| 控制本地预览画面是否镜像| 2.10.0 | | 合法值| 说明 ---|--- auto| 前置摄像头镜像，后置摄像头不镜像 enable| 前后置摄像头均镜像 disable| 前后置摄像头均不镜像 | audio-reverb-type| number| 0| 否| 音频混响类型| 2.10.0 | | 合法值| 说明 ---|--- 0| 关闭 1| KTV 2| 小房间 3| 大会堂 4| 低沉 5| 洪亮 6| 金属声 7| 磁性 | enable-mic| boolean| true| 否| 开启或关闭麦克风| 2.10.0 | enable-agc| boolean| false| 否| 是否开启音频自动增益| 2.10.0 | enable-ans| boolean| false| 否| 是否开启音频噪声抑制| 2.10.0 | audio-volume-type| string| auto| 否| 音量类型| 2.10.0 | | 合法值| 说明 ---|--- auto| 自动 media| 媒体音量 voicecall| 通话音量 | video-width| number| 360| 否| 上推的视频流的分辨率宽度| 2.10.0 | video-height| number| 640| 否| 上推的视频流的分辨率高度| 2.10.0 | beauty-style| string| smooth| 否| 设置美颜类型。鸿蒙 OS 暂不支持| 2.12.0 | | 合法值| 说明 ---|--- smooth| 光滑美颜 nature| 自然美颜 | filter| string| standard| 否| 设置色彩滤镜| 2.12.0 | | 合法值| 说明 ---|--- standard| 标准 pink| 粉嫩 nostalgia| 怀旧 blues| 蓝调 romantic| 浪漫 cool| 清凉 fresher| 清新 solor| 日系 aestheticism| 唯美 whitening| 美白 cerisered| 樱红 | picture-in-picture-mode| string/Array| | 否| 设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： [“push”, ”pop“]）| 2.25.0 | | 合法值| 说明 ---|--- []| 取消小窗 push| 路由 push 时触发小窗 pop| 路由 pop 时触发小窗 | voice-changer-type| number| 0| 否| 0：关闭变声；1：熊孩子；2：萝莉；3：大叔；4：重金属；6：外国人；7：困兽；8：死肥仔；9：强电流；10：重机械；11：空灵| 2.31.0 | custom-effect| boolean| false| 否| 是否启动自定义特效，设定后不能更改| 2.29.1 | skin-whiteness| number| 0| 否| 自定义特效美白效果，取值 0~1。需要开启 custom-effect| 2.29.1 | skin-smoothness| number| 0| 否| 自定义特效磨皮效果，取值 0~1。需要开启 custom-effect| 2.29.1 | face-thinness| number| 0| 否| 自定义特效瘦脸效果，取值 0~1。需要开启 custom-effect| 2.29.1 | eye-bigness| number| 0| 否| 自定义特效大眼效果，取值 0~1。需要开启 custom-effect| 2.29.1 | fps| number| 15| 否| 帧率，有效值为 1~30| 2.31.0 | bindstatechange| eventhandle| | 否| 状态变化事件，detail = {code}| 1.7.0 | bindnetstatus| eventhandle| | 否| 网络状态通知，detail = {info}| 1.9.0 | binderror| eventhandle| | 否| 渲染错误事件，detail = {errMsg, errCode}| 1.7.4 | bindbgmstart| eventhandle| | 否| 背景音开始播放时触发| 2.4.0 | bindbgmprogress| eventhandle| | 否| 背景音进度变化时触发，detail = {progress, duration}| 2.4.0 | bindbgmcomplete| eventhandle| | 否| 背景音播放完成时触发| 2.4.0 | bindaudiovolumenotify| eventhandle| | 否| 返回麦克风采集的音量大小| 2.12.0 | bindenterpictureinpicture| eventhandler| | 否| 进入小窗| 2.25.0 | bindleavepictureinpicture| eventhandler| | 否| 退出小窗| 2.25.0

Bug & Tip

1. tip：开发者工具上暂不支持。
2. tip：live-pusher 默认宽度为100%、无默认高度，请通过wxss设置宽高。
3. tip：waiting-image 属性在 2.3.0 起完整支持网络路径、临时文件和包内路径。
4. tip：请注意原生组件使用限制。
5. tip: 相关介绍和原理可参考此文章

错误码（errCode）

状态码（code）

网络状态数据（info）

示例代码

在开发者工具中预览效果

  <live-pusher url="https://domain/push_stream" mode="RTC" autopush bindstatechange="statechange" style="width: 300px; height: 225px;" />
``` ```
Page({
  statechange(e) {
    console.log('live-pusher code:', e.detail.code)
  }
})