diff --git a/docs/api/media/live-player-context.md b/docs/api/media/live-player-context.md index ae08cef2a9ec6053f92549808f8e532361b9106d..4f54615e7c6a1a7e66db73178c593f79b6f91a73 100644 --- a/docs/api/media/live-player-context.md +++ b/docs/api/media/live-player-context.md @@ -56,8 +56,8 @@ App平台的直播播放,不使用此API,而直接使用video的API。 |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |见下|x|√|x|x|x|x| -- app-nvue 平台 2.2.5(alpha)+ 支持 uni.createLivePusherContext(livePusherId, this) -- app-nvue 平台 2.2.5(alpha)- 需要同时设置组件属性id和ref ````,或者直接使用 ref,例如 ``this.$refs.livepusher1`` +- app-nvue 平台 2.2.5+ 支持 uni.createLivePusherContext(livePusherId, this) +- app-nvue 平台 2.2.5以下,需要同时设置组件属性id和ref ````,或者直接使用 ref,例如 ``this.$refs.livepusher1`` - app-vue 平台,需要编写条件编译代码,使用 `plus.video.LivePusher`,[业务指南](https://ask.dcloud.net.cn/article/13416)、[规范文档](http://www.html5plus.org/doc/zh_cn/video.html#plus.video.LivePusher) 使用nvue做直播,比使用vue的优势有: @@ -66,77 +66,137 @@ App平台的直播播放,不使用此API,而直接使用video的API。 3. 若需要视频内嵌在swiper里上下滑动(类抖音、映客首页模式),App端只有nvue才能实现 当然nvue相比vue的坏处是css写法受限,如果只开发微信小程序,不考虑App,那么使用vue页面也是一样的。 -**参数说明** - +**参数说明** + 设置live-pusher组件的推流地址,推流视频模式等。 - -属性|类型 |默认值|必填|说明 :--|:--|:--|:--|:--| -url|string| |是|推流地址,支持RTMP协议。 -mode |string| |否|推流视频模式,可取值:SD(标清), HD(高清), FHD(超清)。 -muted|Boolean|false|否|是否静音。 -enable-camera|Boolean|true|否|开启摄像头。 -auto-focus|Boolean|true|否|自动聚集。 -beauty|Number|0|否|美颜,取值范围 0-9(iOS取值范围为1) ,0 表示关闭。 -whiteness|Number|0|否|美白,取值范围 0-9(iOS取值范围为1) ,0 表示关闭。 - - #### API #### start(callback) -> 开始推流 - -##### callback 返回 Object 参数说明 -属性|类型 |说明 :--|:--|:--| -type | String | "success" 表示成功, "fail" 表示失败 #### pause(callback) > 暂停推流 - -##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - -#### resume(callback) > 恢复推流 - ##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - - -#### stop(callback) > 停止推流 - ##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - -#### switchCamera(callback) > 切换前后摄像头 - ##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - -#### snapshot(callback) > 快照 - -##### callback 返回 Object 参数说明 -##### 成功时的回调 参数|类型 |说明 :--|:--|:--| type|string|"success" 表示成功, "fail" 表示失败 + +属性|类型 |默认值|必填|说明 +:--|:--|:--|:--|:--| +url|string| |是|推流地址,支持RTMP协议。 +mode |string| |否|推流视频模式,可取值:SD(标清), HD(高清), FHD(超清)。 +muted|Boolean|false|否|是否静音。 +enable-camera|Boolean|true|否|开启摄像头。 +auto-focus|Boolean|true|否|自动聚集。 +beauty|Number|0|否|美颜,取值范围 0-9(iOS取值范围为1) ,0 表示关闭。 +whiteness|Number|0|否|美白,取值范围 0-9(iOS取值范围为1) ,0 表示关闭。 + + +#### API +#### start(callback) +> 开始推流 + +##### callback 返回 Object 参数说明 +属性|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### pause(callback) +> 暂停推流 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### resume(callback) +> 恢复推流 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + + +#### stop(callback) +> 停止推流 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### switchCamera(callback) +> 切换前后摄像头 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### snapshot(callback) +> 快照 + +##### callback 返回 Object 参数说明 +##### 成功时的回调 +参数|类型 |说明 +:--|:--|:--| +type|string|"success" 表示成功, "fail" 表示失败 code|Number| 对应code码 -message|object|{width:"快照图片宽度",height:"快照图片高度",tempImagePath:"快照图片路径"}。 - -##### 失败的回调 参数|类型 |说明 :--|:--|:--| type|string|"fail" 表示失败 +message|object|{width:"快照图片宽度",height:"快照图片高度",tempImagePath:"快照图片路径"}。 + +##### 失败的回调 +参数|类型 |说明 +:--|:--|:--| +type|string|"fail" 表示失败 +code|Number| +message|object| + + +#### startPreview(callback) +> 开启摄像头预览 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### stopPreview(callback) +> 关闭摄像头预览 + +##### callback 返回 Object 参数说明 +参数|类型 |说明 +:--|:--|:--| +type | String | "success" 表示成功, "fail" 表示失败 + +#### 事件 + +#### statechange +> 状态变化事件 + +##### 返回参数(detail)的详细说明 +参数|类型|说明 +:--|:--|:--| code|Number| -message|object| - - -#### startPreview(callback) > 开启摄像头预览 - ##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - -#### stopPreview(callback) > 关闭摄像头预览 - ##### callback 返回 Object 参数说明 参数|类型 |说明 :--|:--|:--| type | String | "success" 表示成功, "fail" 表示失败 - -#### 事件 - #### statechange -> 状态变化事件 ##### 返回参数(detail)的详细说明 参数|类型|说明 :--|:--|:--| -code|Number| message|string| - - #### netstatus -> 网络状态通知事件 ##### 安卓 返回参数(detail)的详细说明 键名|说明 :--|:--| + + +#### netstatus +> 网络状态通知事件 + +##### 安卓 返回参数(detail)的详细说明 +键名|说明 +:--|:--| videoBitrate | 当前视频编/码器输出的比特率,单位 kbps audioBitrate | 当前音频编/码器输出的比特率,单位 kbps videoFPS | 当前视频帧率 videoGOP | 当前视频 GOP,也就是每两个关键帧(I帧)间隔时长,单位 s netSpeed | 当前的发送/接收速度 netJitter | 网络抖动情况,抖动越大,网络越不稳定 -videoWidth | 视频画面的宽度 -videoHeight | 视频画面的高度 - -##### iOS 返回参数(detail)的详细说明 参数|类型 |说明 :--|:--|:--| +videoWidth | 视频画面的宽度 +videoHeight | 视频画面的高度 + +##### iOS 返回参数(detail)的详细说明 +参数|类型 |说明 +:--|:--|:--| code|Number| code码 -message|string| 具体的网络状态信息 - - #### error > 渲染错误事件 ##### 返回参数(detail)的详细说明 参数|类型 |说明 :--|:--|:--| +message|string| 具体的网络状态信息 + + +#### error +> 渲染错误事件 + +##### 返回参数(detail)的详细说明 +参数|类型 |说明 +:--|:--|:--| errCode|Number| -errMsg|string| +errMsg|string|