小程序
取消
开发
中文
EN
取消
  • 组件

    • # live-pusher

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

    小程序插件：支持，需要小程序基础库版本不低于 2 樱花视频在线，3，0.

    微信 Windows 版：支持

    微信 Mac 版：支持

    微信 鸿蒙 OS 版：支持

    相关文档: wx.createLivePusherContext

    渲染框架支持情况：Skyline （使用最新 Nightly 工具调试）. WebView 樱花视频高清.

    # 功能描述

    实时音视频录制（v2 樱花视频免费观看，9，1 起支持同层渲染）。需要用户授权 scope.camera、scope.record。。

    "樱花视频在线" # 申请开通

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

    一级类目/主体类型二级类目小程序内容场景
    社交直播涉及娱乐性质，如明星直播、生活趣事直播、宠物直播等。选择该类目后首次提交代码审核，需经当地互联网主管机关审核确认，预计审核时长 7 天左右
    教育在线视频课程网课、在线培训、讲座等教育类直播
    医疗互联网医院，公立医疗机构，三级私立医疗机构，其他私立医疗机构问诊、大型健康讲座等直播
    金融银行、信托、公募基金、私募基金、证券/期货、证券、期货投资咨询、保险、企业征信、新三板信息服务平台、股票信息服务平台、股票信息服务平台（港股/美股）、消费金融、融资担保、汽车金融/融资租赁金融产品视频客服理赔、金融产品推广直播等
    汽车汽车预售汽车预售、推广直播
    政府主体账号/政府相关工作推广直播、领导讲话直播等
    IT科技多方通信；音视频设备为多方提供电话会议/视频会议等服务；智能家居场景下控制摄像头
    房地产服务房地产营销房地产营销直播服务、在线音视频带看等
    商业服务公证在线业务办理等

    # 通用属性

    属性类型默认值必填说明最低版本
    urlstring否推流地址。目前仅支持 rtmp 格式1.7.0
    modestringRTC否模式1.7.0
    合法值说明最低版本
    QVGAQuarter VGA3.5.0
    HVGAHalf-size VGA3.5.0
    SD标清1.7.0
    HD高清1.7.0
    FHD超清1.7.0
    RTC实时通话1.7.0
    autopushbooleanfalse否自动推流1.7.0
    enableVideoCustomRenderbooleanfalse否自定义渲染，允许开发者自行处理所采集的视频帧，详见LivePusherContext2.29.0
    mutedbooleanfalse否是否静音。即将废弃，可用 enable-mic 替代1.7.0
    enable-camerabooleantrue否开启摄像头1.7.0
    auto-focusbooleantrue否自动聚集1.7.0
    orientationstringvertical否画面方向1.7.0
    合法值说明
    vertical竖直
    horizontal水平
    beautynumber0否美颜，取值范围 0-9 ，0 表示关闭。鸿蒙 OS 暂不支持1.7.0
    whitenessnumber0否美白，取值范围 0-9 ，0 表示关闭1.7.0
    aspectstring9:16否宽高比，可选值有 3:4, 9:161.7.0
    min-bitratenumber200否最小码率1.7.0
    max-bitratenumber1000否最大码率1.7.0
    audio-qualitystringhigh否高音质(48KHz)或低音质(16KHz)，值为high, low1.7.0
    waiting-imagestring否进入后台时推流的等待画面1.7.0
    waiting-image-hashstring否等待画面资源的MD5值1.7.0
    zoombooleanfalse否调整焦距2.1.0
    device-positionstringfront否前置或后置，值为front, back2.3.0
    background-mutebooleanfalse否进入后台时是否静音（已废弃，默认退后台静音）1.7.0
    mirrorbooleanfalse否设置推流画面是否镜像，产生的效果在 live-player 反应到2.7.0
    remote-mirrorbooleanfalse否同 mirror 属性，后续 mirror 将废弃2.10.0
    local-mirrorstringauto否控制本地预览画面是否镜像2.10.0
    合法值说明
    auto前置摄像头镜像，后置摄像头不镜像
    enable前后置摄像头均镜像
    disable前后置摄像头均不镜像
    audio-reverb-typenumber0否音频混响类型2.10.0
    合法值说明
    0关闭
    1KTV
    2小房间
    3大会堂
    4低沉
    5洪亮
    6金属声
    7磁性
    enable-micbooleantrue否开启或关闭麦克风2.10.0
    enable-agcbooleanfalse否是否开启音频自动增益2.10.0
    enable-ansbooleanfalse否是否开启音频噪声抑制2.10.0
    audio-volume-typestringauto否音量类型2.10.0
    合法值说明
    auto自动
    media媒体音量
    voicecall通话音量
    video-widthnumber360否上推的视频流的分辨率宽度2.10.0
    video-heightnumber640否上推的视频流的分辨率高度2.10.0
    beauty-stylestringsmooth否设置美颜类型。鸿蒙 OS 暂不支持2.12.0
    合法值说明
    smooth光滑美颜
    nature自然美颜
    filterstringstandard否设置色彩滤镜2.12.0
    合法值说明
    standard标准
    pink粉嫩
    nostalgia怀旧
    blues蓝调
    romantic浪漫
    cool清凉
    fresher清新
    solor日系
    aestheticism唯美
    whitening美白
    cerisered樱红
    picture-in-picture-modestring/Array否设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： ["push", "pop"]）2.25.0
    合法值说明
    []取消小窗
    push路由 push 时触发小窗
    pop路由 pop 时触发小窗
    voice-changer-typenumber0否0：关闭变声；1：熊孩子；2：萝莉；3：大叔；4：重金属；6：外国人；7：困兽；8：死肥仔；9：强电流；10：重机械；11：空灵2.31.0
    custom-effectbooleanfalse否是否启动自定义特效，设定后不能更改2.29.1
    skin-whitenessnumber0否自定义特效美白效果，取值 0~1。需要开启 custom-effect2.29.1
    skin-smoothnessnumber0否自定义特效磨皮效果，取值 0~1。需要开启 custom-effect2.29.1
    face-thinnessnumber0否自定义特效瘦脸效果，取值 0~1。需要开启 custom-effect2.29.1
    eye-bignessnumber0否自定义特效大眼效果，取值 0~1。需要开启 custom-effect2.29.1
    fpsnumber15否帧率，有效值为 1~302.31.0
    bindstatechangeeventhandle否状态变化事件，detail = {code}1.7.0
    bindnetstatuseventhandle否网络状态通知，detail = {info}1.9.0
    binderroreventhandle否渲染错误事件，detail = {errMsg, errCode}1.7.4
    bindbgmstarteventhandle否背景音开始播放时触发2.4.0
    bindbgmprogresseventhandle否背景音进度变化时触发，detail = {progress, duration}2.4.0
    bindbgmcompleteeventhandle否背景音播放完成时触发2.4.0
    bindaudiovolumenotifyeventhandle否返回麦克风采集的音量大小2.12.0
    bindenterpictureinpictureeventhandler否进入小窗2.25.0
    bindleavepictureinpictureeventhandler否退出小窗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） (樱花视频网站)

    代码说明
    10001用户禁止使用摄像头
    10002用户禁止使用录音
    10003背景音资源（BGM）加载失败
    10004等待画面资源（waiting-image）加载失败

    # 状态码（code）

    代码说明
    1001推流：已经连接推流服务器
    1002推流：已经与服务器握手完毕，开始推流
    1003推流：打开摄像头成功
    1004推流：录屏启动成功
    1005推流：推流动态调整分辨率
    1006推流：推流动态调整码率
    1007推流：首帧画面采集完成
    1008推流：编码器启动
    1018推流：进房成功（ROOM协议特有）
    1019推流：退房成功（ROOM协议特有有）
    1020推流：远端主播列表变化（ROOM协议特有）
    1021推流：网络变更时重进房，WiFi 切换到4G 会触发断线重连（ROOM协议特有）
    1022推流：进入房间失败（ROOM协议特有）
    1031推流：远端主播进房通知（ROOM协议特有）
    1032推流：远端主播退房通知（ROOM协议特有）
    1033推流：远端主播视频状态位变化（ROOM协议特有）
    1034推流：远端主播音频状态位变化（ROOM协议特有）
    1101推流：网络状况不佳：上行带宽太小，上传数据受阻
    1102推流：网络断连, 已启动自动重连
    1103推流：硬编码启动失败, 采用软编码
    1104推流：视频编码失败, 内部会重启编码器
    3001推流：RTMP DNS解析失败
    3002推流：RTMP服务器连接失败
    3003推流：RTMP服务器握手失败
    3004推流：RTMP服务器主动断开，请检查推流地址的合法性或防盗链有效期
    3005推流：RTMP 读/写失败
    4998Mic状态切换的时候，enable-mic触发(iOS特有)
    4999mute状态切换的时候，muted 触发(iOS特有)
    5001系统电话打断或者微信音视频电话打断
    10001用户禁止使用摄像头
    10002用户禁止使用录音
    10003背景音资源（BGM）加载失败
    10004等待画面资源（waiting-image）加载失败
    -1301推流：打开摄像头失败
    -1302推流：打开麦克风失败
    -1303推流：视频编码失败
    -1304推流：音频编码失败
    -1305推流：不支持的视频分辨率
    -1306推流：不支持的音频采样率
    -1307推流：网络断连，且经多次重连抢救无效，更多重试请自行重启推流
    -1308推流：开始录屏失败，可能是被用户拒绝
    -1309推流：录屏失败，不支持的Android系统版本，需要5.0以上的系统
    -1310推流：录屏被其他应用打断了
    -1311推流：Android Mic打开成功，但是录不到音频数据
    -1312推流：录屏动态切横竖屏失败
    0无错误

    # 网络状态数据（info）

    键名说明
    videoBitrate当前视频编/码器输出的比特率，单位 kbps
    audioBitrate当前音频编/码器输出的比特率，单位 kbps
    videoFPS当前视频帧率
    videoGOP当前视频 GOP,也就是每两个关键帧(I帧)间隔时长，单位 s
    netSpeed当前的发送/接收速度
    netJitter网络抖动情况，抖动越大，网络越不稳定
    netQualityLevel网络质量：0：未定义 1：最好 2：好 3：一般 4：差 5：很差 6：不可用
    videoWidth视频画面的宽度
    videoHeight视频画面的高度
    videoCache主播端堆积的视频帧数
    audioCache主播端堆积的音频帧数

    # 示例代码

    在开发者工具中预览效果

    ___JX5_PROTECTED_code_22___
    ___JX5_PROTECTED_code_23___