# uni直播 [uni直播](https://doc.dcloud.net.cn/uniCloud/uni-live/intro.html)是DCloud与七牛云合作推出的直播服务,七牛云直播依托云边一体化架构和海量节点资源,构建高效的流媒体服务。通过多维度的节点监控与弹性的节点调度管理,确保高质量服务与成本效益的完美平衡。 `live-pusher` 组件是[uni直播](https://doc.dcloud.net.cn/uniCloud/uni-live/intro.html)服务中的推流组件,在 Android/iOS 平台使用需要申请绑定包名/Bundle ID(AppID),详情[咨询](https://im.dcloud.net.cn/#/?joinGroup=68622a2ba99ae56f95028db1) ::: sourceCode ## live-pusher > issues: https://issues.dcloud.net.cn/?mid=component.media.live-pusher ::: 实时音视频录制 ### 兼容性 ### 属性 | 名称 | 类型 | 默认值 | 兼容性 | 描述 | | :- | :- | :- | :-: | :- | | url | string([string.VideoURIString](/uts/data-type.md#ide-string)) | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 推流地址,支持 rtmp 协议 | | mode | string | "SD" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | SD(标清), HD(高清), FHD(超清), RTC(实时通话) | | autopush | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x | 自动推流 | | muted | boolean | false | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 是否静音 | | enable-camera | boolean | true | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 开启摄像头 | | auto-focus | boolean | true | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 自动获取焦点 | | orientation | string | "vertical" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 画面方向,可选值有 vertical,horizontal | | beauty | number | 0 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 美颜,取值范围 0-9(iOS取值范围为1) ,0 表示关闭 | | aspect | string | "3:4" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 视频宽高比例 | | min-bitrate | number | 200 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 最小码率 | | max-bitrate | number | 1000 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 最大码率 | | waiting-image | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 进入后台时推流的等待画面 | | waiting-image-md5 | string | | Web: x; 微信小程序: x; 支付宝小程序: x; Android: x; iOS: x | 等待画面资源的MD5值 | | background-mute | boolean | false | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 进入后台时是否静音 | | enableVideoCustomRender | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
自定义渲染,允许开发者自行处理所采集的视频帧,详见[LivePusherContext]((LivePusherContext)) | | whiteness | number | 0 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(number)*
美白,取值范围 0-9(iOS取值范围为1) ,0 表示关闭 | | audio-quality | string | "high" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(string)*
高音质(48KHz)或低音质(16KHz),值为`high`, `low` | | waiting-image-hash | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(string)*
等待画面资源的MD5值 | | zoom | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
调整焦距 | | zoom | number | 1 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 调整焦距 | | device-position | string | "front" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(string)*
前置或后置,值为`front`, `back` | | mirror | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
设置推流画面是否镜像,产生的效果在 live-player 反应到 | | remote-mirror | boolean | false | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(boolean)*
同 mirror 属性,后续 mirror 将废弃 | | local-mirror | string | "auto" | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(string)*
控制本地预览画面是否镜像 | | audio-reverb-type | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
音频混响类型 | | enable-mic | boolean | true | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(boolean)*
开启或关闭麦克风 | | enable-agc | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
是否开启音频自动增益 | | enable-ans | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
是否开启音频噪声抑制 | | audio-volume-type | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(string)*
音量类型 | | video-width | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(number)*
上推的视频流的分辨率宽度 | | video-height | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | *(number)*
上推的视频流的分辨率高度 | | beauty-style | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(string)*
设置美颜类型 | | filter | string | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(string)*
设置色彩滤镜 | | picture-in-picture-mode | string/Array | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(string/Array)*
设置小窗模式: push, pop,空字符串或通过数组形式设置多种模式(如: \["push", "pop"]) | | voice-changer-type | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
0:关闭变声;1:熊孩子;2:萝莉;3:大叔;4:重金属;6:外国人;7:困兽;8:死肥仔;9:强电流;10:重机械;11:空灵 | | custom-effect | boolean | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(boolean)*
是否启动自定义特效,设定后不能更改 | | skin-whiteness | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
自定义特效美白效果,取值 0~1。需要开启 `custom-effect` | | skin-smoothness | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
自定义特效磨皮效果,取值 0~1。需要开启 `custom-effect` | | face-thinness | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
自定义特效瘦脸效果,取值 0~1。需要开启 `custom-effect` | | eye-bigness | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
自定义特效大眼效果,取值 0~1。需要开启 `custom-effect` | | fps | number | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(number)*
帧率,有效值为 1~30 | | @statechange | (event: [UniLivePusherStatechangeEvent](#unilivepusherstatechangeevent)) => void | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 播放状态变化事件,event.detail = {code, message} | | @error | (event: [UniLivePusherErrorEvent](#unilivepushererrorevent)) => void | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 错误事件,event.detail = {errCode, errMsg} | | @netstatus | (event: [UniLivePusherNetstatusEvent](#unilivepushernetstatusevent)) => void | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81 | 网络状态通知,event.detail = {videoBitrate, audioBitrate, videoFPS, videoGOP, netSpeed, videoWidth, videoHeight} | | @bgmstart | eventhandle | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandle)*
背景音开始播放时触发 | | @bgmprogress | eventhandle | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandle)*
背景音进度变化时触发,detail = {progress, duration} | | @bgmcomplete | eventhandle | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandle)*
背景音播放完成时触发 | | @audiovolumenotify | eventhandle | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandle)*
返回麦克风采集的音量大小 | | @enterpictureinpicture | eventhandler | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandler)*
进入小窗 | | @leavepictureinpicture | eventhandler | | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | *(eventhandler)*
退出小窗 | #### mode 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | RTC | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | | | SD | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | | | HD | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | | | FHD | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | | | QVGA | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | Quarter VGA | | HVGA | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | Half-size VGA | #### orientation 的属性描述 | 合法值 | 兼容性 | | :- | :-: | | vertical | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | | horizontal | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | #### local-mirror 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | auto | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 前置摄像头镜像,后置摄像头不镜像 | | enable | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 前后置摄像头均镜像 | | disable | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 前后置摄像头均不镜像 | #### audio-reverb-type 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | 0 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 关闭 | | 1 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | KTV | | 2 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 小房间 | | 3 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 大会堂 | | 4 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 低沉 | | 5 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 洪亮 | | 6 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 金属声 | | 7 | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 磁性 | #### audio-volume-type 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | auto | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 自动 | | media | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 媒体音量 | | voicecall | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 通话音量 | #### beauty-style 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | smooth | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 光滑美颜 | | nature | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 自然美颜 | #### filter 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | standard | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 标准 | | pink | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 粉嫩 | | nostalgia | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 怀旧 | | blues | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 蓝调 | | romantic | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 浪漫 | | cool | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 清凉 | | fresher | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 清新 | | solor | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 日系 | | aestheticism | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 唯美 | | whitening | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 美白 | | cerisered | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 樱红 | #### picture-in-picture-mode 的属性描述 | 合法值 | 兼容性 | 描述 | | :- | :-: | :- | | [] | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 取消小窗 | | push | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 路由 push 时触发小窗 | | pop | Web: x; 微信小程序: 4.41; 支付宝小程序: x; Android: x; iOS: x; HarmonyOS: x | 路由 pop 时触发小窗 | ### 事件 #### UniLivePusherStatechangeEvent 推流状态变化事件 ##### UniLivePusherStatechangeEvent 的属性值 | 名称 | 类型 | 必填 | | :- | :- | :- | | detail | **UniLivePusherStatechangeEventDetail** | 是 | | bubbles | boolean | 是 | | cancelable | boolean | 是 | | type | string | 是 | | target | [UniElement](/api/dom/unielement.md) | 否 | | currentTarget | [UniElement](/api/dom/unielement.md) | 否 | | timeStamp | Long | 是 | #### detail 的属性描述 | 名称 | 类型 | 必备 | 兼容性 | 描述 | | :- | :- | :- | :-: | :- | | code | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 状态码 | | message | string | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 状态信息 | ##### code 的属性描述 | 合法值 | 描述 | | :- | :- | | 1001 | 连接中 | | 1002 | 已连接 | | 3004 | 连接断开 | ##### UniLivePusherStatechangeEvent 的方法 | 名称 | 类型 | 必填 | | :- | :- | :- | | stopPropagation | () => void | 是 | | preventDefault | () => void | 是 | #### UniLivePusherErrorEvent 错误事件 ##### UniLivePusherErrorEvent 的属性值 | 名称 | 类型 | 必填 | | :- | :- | :- | | detail | **UniLivePusherError** | 是 | | bubbles | boolean | 是 | | cancelable | boolean | 是 | | type | string | 是 | | target | [UniElement](/api/dom/unielement.md) | 否 | | currentTarget | [UniElement](/api/dom/unielement.md) | 否 | | timeStamp | Long | 是 | #### detail 的属性描述 | 名称 | 类型 | 必备 | 描述 | | :- | :- | :- | :- | | errCode | number | 是 | | | errSubject | string | 是 | 统一错误主题(模块)名称 | | data | any | 否 | 错误信息中包含的数据 | | cause | [Error](/err-spec.md#unierror) | 否 | 源错误信息,可以包含多个错误,详见SourceError | | errMsg | string | 是 | | ##### errCode 的属性描述 | 合法值 | 描述 | | :- | :- | | 3005 | 网络问题 | | 3006 | 推流地址错误 | | 3007 | 推流地址未授权 | | 3008 | 包未授权 | | 4001 | 音频录制错误(android) | | 4002 | 打开摄像头错误(android) | | 4003 | 没有 nv21 预览格式(android) | | 4004 | 开启视频编码错误(android) | | 4005 | 视频编码错误(android) | | 4006 | 开启音频编码错误(android) | | 4007 | 音频编码错误(android) | | 5001 | 编码器编码错误(iOS) | | 5002 | TLS 连接失败(iOS) | | 5003 | 没有 SSL 或者 TLS(iOS) | | 5004 | DNS 解析失败(iOS) | | 5005 | rtmp 发布失败(iOS) | | -1 | | ##### UniLivePusherErrorEvent 的方法 | 名称 | 类型 | 必填 | | :- | :- | :- | | stopPropagation | () => void | 是 | | preventDefault | () => void | 是 | #### UniLivePusherNetstatusEvent 推流网络状态事件 ##### UniLivePusherNetstatusEvent 的属性值 | 名称 | 类型 | 必填 | | :- | :- | :- | | detail | **UniLivePusherNetstatusEventDetail** | 是 | | bubbles | boolean | 是 | | cancelable | boolean | 是 | | type | string | 是 | | target | [UniElement](/api/dom/unielement.md) | 否 | | currentTarget | [UniElement](/api/dom/unielement.md) | 否 | | timeStamp | Long | 是 | #### detail 的属性描述 | 名称 | 类型 | 必备 | 兼容性 | 描述 | | :- | :- | :- | :-: | :- | | videoBitrate | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 当前视频编/码器输出的比特率,单位 kbps | | audioBitrate | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 当前音频编/码器输出的比特率,单位 kbps | | videoFPS | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 当前视频帧率 | | videoGOP | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 当前视频 GOP,也就是每两个关键帧(I帧)间隔时长,单位 s | | netSpeed | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 当前的发送/接收速度 | | videoWidth | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 视频画面的宽度 | | videoHeight | number | 是 | Web: x; 微信小程序: x; 支付宝小程序: x; Android: 4.81; iOS: 4.81; HarmonyOS: x | 视频画面的高度 | ##### UniLivePusherNetstatusEvent 的方法 | 名称 | 类型 | 必填 | | :- | :- | :- | | stopPropagation | () => void | 是 | | preventDefault | () => void | 是 | ### 音视频协议 - 支持 rtmp 协议格式。 ### 上下文对象API [uni.createLivePusherContext()](../api/create-live-pusher-context.md) ### 示例 示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/component/live-pusher/live-pusher.uvue),与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/component/live-pusher/live-pusher.uvue) > > 该 API 不支持 Web,请运行 hello uni-app x 到 App 平台体验 ::: preview > appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/component/live-pusher/live-pusher ```uvue ``` ::: ### 参见 - [参见uni-app相关文档](https://uniapp.dcloud.io/component/live-pusher.html)