Browse Source

更新版本到 1.3.10

ChangeLog
1. 允许用户自定义混流录制时输出的视频的带高
2. snapshot 文档完善
kevin.song 6 years ago
parent
commit
96bc79850f
3 changed files with 18 additions and 12 deletions
  1. 15 9
      README.md
  2. 2 2
      lib/index.js
  3. 1 1
      package.json

+ 15 - 9
README.md

@@ -395,8 +395,8 @@ client.startRecording(RecordOptions, onSuccess, onFailure)
 {
   bucket: string  // 必传,存储的 bucket, URTC 使用 UCloud 的 UFile 产品进行在存储,相关信息见控制台操作文档
   region: string  // 必传,存储服务所在的地域
-  waterMark: WaterMarkOptions // 选传,水印的相关配置,不需要添加水印时,不用填写
-  mixStream: MixStreamOptions // 选传,混流的相关配置,无混流时,不用填写
+  waterMark?: WaterMarkOptions // 选传,水印的相关配置,不需要添加水印时,不用填写
+  mixStream?: MixStreamOptions // 选传,混流的相关配置,无混流时,不用填写
 }
 ```
 
@@ -404,9 +404,9 @@ WaterMarkOptions: object 类型,选传,添加的水印相关配置,类型
 
 ```
 {
-  position: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom' // 选传,指定水印的位置,前面四种类型分别对应 左上,左下,右上,右下,默认 'left-top'
-  type: 'time' | 'image' | 'text' // 选传,水印类型,分别对应时间水印、图片水印、文字水印,默认为 'time'
-  remarks:  string,   // 选传,水印备注,当为时间水印时,传空字符串,当为图片水印时,此处需为图片的 URL(此时必传),当为文字水印时,此处需为水印文字
+  position?: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom' // 选传,指定水印的位置,前面四种类型分别对应 左上,左下,右上,右下,默认 'left-top'
+  type?: 'time' | 'image' | 'text' // 选传,水印类型,分别对应时间水印、图片水印、文字水印,默认为 'time'
+  remarks?:  string,   // 选传,水印备注,当为时间水印时,传空字符串,当为图片水印时,此处需为图片的 URL(此时必传),当为文字水印时,此处需为水印文字
 }
 ```
 
@@ -414,10 +414,12 @@ MixStreamOptions: object 类型,选传,混流相关配置,类型说明如
 
 ```
 {
-  uid: string,        // 选传,指定某用户的流作为主画面,不传时,默认为当前开启录制的用户的流作为主画面
-  type: 'desktop' | 'camera',   // 选传,指定主画面使用的流的媒体类型(当同一用户推多路流时),不传时,默认使用 camera
-  template: number,   // 选传,指定混流布局模板,可使用 1-9 对应的模板,默认为 1
-  isAverage: boolean, // 选传,是否均分,均分对应平铺风格,不均分对应垂直风格,默认为 true
+  uid?: string,        // 选传,指定某用户的流作为主画面,不传时,默认为当前开启录制的用户的流作为主画面
+  type?: 'desktop' | 'camera',   // 选传,指定主画面使用的流的媒体类型(当同一用户推多路流时),不传时,默认使用 camera
+  width?: number,      // 选传,设置混流后视频的宽度,不传时,默认为 1280
+  height?: number,     // 选传,设置混流后视频的高度,不传时,默认为 720
+  template?: number,   // 选传,指定混流布局模板,可使用 1-9 对应的模板,默认为 1
+  isAverage?: boolean, // 选传,是否均分,均分对应平铺风格,不均分对应垂直风格,默认为 true
 }
 ```
 
@@ -1113,6 +1115,10 @@ const image = client.snapshot(VideoElement, Download);
 
 - Download: boolean 类型,选传,传 true 时,可将截屏保存为本地图片,默认为不保存图片到本地
 
+#### 返回值说明
+
+- image: string 类型,是图片转化的 base64 编码的 [Data URLs](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/data_URIs),可将其赋值给 Image 元素 - 详见 [HTMLImageElement](https://developer.mozilla.org/zh-CN/docs/Web/API/HTMLImageElement) 的 src 属性
+
 ----
 
 <a name='getdevices'></a>

File diff suppressed because it is too large
+ 2 - 2
lib/index.js


+ 1 - 1
package.json

@@ -1,6 +1,6 @@
 {
   "name": "urtc-sdk",
-  "version": "1.3.9",
+  "version": "1.3.10",
   "description": "UCloud RTC javascript SDK",
   "main": "lib/index.js",
   "repository": {