Skip to content

Commit

Permalink
docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
zhetengbiji committed Oct 19, 2019
1 parent caeb12d commit b12d147
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 70 deletions.
192 changes: 126 additions & 66 deletions docs/api/media/live-pusher-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,81 +8,141 @@
|见下|x||x|x|x|


**参数说明**

**参数说明**

设置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 表示关闭。

**注意:**
- app-nvue 平台 2.2.5(alpha)+ 支持 uni.createLivePusherContext(livePusherId, this)
- app-nvue 平台 2.2.5(alpha)- 需要同时设置组件属性id和ref ``<live-pusher id="livepusher1" ref="livepusher1"></live-pusher>``,或者直接使用 ref,例如 ``this.$refs.livepusher1``

### 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 表示关闭。

**注意:**
- app-nvue 平台 2.2.5+ 支持 uni.createLivePusherContext(livePusherId, this)
- app-nvue 平台 2.2.5- 需要同时设置组件属性id和ref ``<live-pusher id="livepusher1" ref="livepusher1"></live-pusher>``,或者直接使用 ref,例如 ``this.$refs.livepusher1``


### 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|
4 changes: 2 additions & 2 deletions docs/collocation/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@
|modules|Object|权限模块,[详见](/collocation/manifest?id=modules)||
|distribute|Object|5+App 发布信息,[详见](/collocation/manifest?id=distribute)||
|usingComponents|Boolean|是否启用自定义组件模式,默认为false,[编译模式区别详情](https://ask.dcloud.net.cn/article/35843)|1.9.0|
|nvueCompiler|String|切换 nvue 编译模式,可选值,`weex` :老编译模式,`uni-app`: 新编译模式,默认为 `weex`[编译模式区别详情](http://ask.dcloud.net.cn/article/36074)|2.0.3 Alpha|
|nvueCompiler|String|切换 nvue 编译模式,可选值,`weex` :老编译模式,`uni-app`: 新编译模式,默认为 `weex`[编译模式区别详情](http://ask.dcloud.net.cn/article/36074)|2.0.3|
|renderer|String|可不加载基于 webview 的运行框架,减少包体积、提升启动速度。可选值 `native`| App-nvue 2.2.0+|
|nvue|Object|nvue 页面布局初始配置,[详见](/collocation/manifest?id=nvue)|2.0.3 Alpha|
|nvue|Object|nvue 页面布局初始配置,[详见](/collocation/manifest?id=nvue)|2.0.3|
PS:这里只列出了核心部分,更多内容请参考 [完整的 manifest.json](/collocation/manifest?id=完整-manifestjson)

**Tips**
Expand Down
2 changes: 1 addition & 1 deletion docs/collocation/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Tips:
- `UNI_PLATFORM`仅支持填写`uni-app`默认支持的基准平台,目前仅限如下枚举值:`app-plus``h5``mp-weixin``mp-alipay``mp-baidu``mp-toutiao``mp-qq`
- `BROWSER` 仅在`UNI_PLATFORM``h5`时有效,目前仅限如下枚举值:`Chrome``Firefox``IE``Edge``Safari``HBuilderX`
- `package.json`文件中不允许出现注释,否则扩展配置无效
- `vue-cli`需更新到最新版,HBuilderX需升级到Alpha 2.1.6+ 版本
- `vue-cli`需更新到最新版,HBuilderX需升级到 2.1.6+ 版本

#### 示例:钉钉小程序

Expand Down
2 changes: 1 addition & 1 deletion docs/frame.md
Original file line number Diff line number Diff line change
Expand Up @@ -1165,7 +1165,7 @@ export default {
- 在微信自定义组件中`wxcomponents`也可以使用wxs
- `nvue`页面暂不支持wxs、sjs、filter.js
- 各个`script`标签会分别被打包至对应支持平台,不需要额外写条件编译
-`HBuilderX 2.2.5-alpha`开始,不推荐使用各个小程序自有的引入方式,推荐使用`script`标签引入
-`HBuilderX 2.2.5`开始,不推荐使用各个小程序自有的引入方式,推荐使用`script`标签引入


## 致谢
Expand Down

0 comments on commit b12d147

Please sign in to comment.