提交 913e3672 编写于 作者: X xu-rui-w

示例参数说明

Signed-off-by: Nxu-rui-w <xurui101@huawei.com>
上级 59c3b30b
...@@ -33,6 +33,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise\<Pi ...@@ -33,6 +33,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise\<Pi
```js ```js
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts) image.createPixelMap(color, opts)
.then((pixelmap) => { .then((pixelmap) => {
...@@ -59,6 +60,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: As ...@@ -59,6 +60,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: As
```js ```js
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => { image.createPixelMap(color, opts, (pixelmap) => {
}) })
...@@ -181,6 +183,8 @@ readPixels(area: PositionArea, callback: AsyncCallback\<void>): void ...@@ -181,6 +183,8 @@ readPixels(area: PositionArea, callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (err, pixelmap) => { image.createPixelMap(color, opts, (err, pixelmap) => {
if(pixelmap == undefined){ if(pixelmap == undefined){
...@@ -221,6 +225,7 @@ writePixels(area: PositionArea): Promise\<void> ...@@ -221,6 +225,7 @@ writePixels(area: PositionArea): Promise\<void>
```js ```js
const color = new ArrayBuffer(96); const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts) image.createPixelMap(color, opts)
.then( pixelmap => { .then( pixelmap => {
...@@ -263,7 +268,7 @@ writePixels(area: PositionArea, callback: AsyncCallback\<void>): void ...@@ -263,7 +268,7 @@ writePixels(area: PositionArea, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------ | ---- | ------------------------------ | | --------- | ------------------------------ | ---- | ------------------------------ |
| area | [PositionArea](#positionarea7) | 是 | 区域,根据区域写入。 | | area | [PositionArea](#positionarea7) | 是 | 区域,根据区域写入。 |
| callback: | AsyncCallback\<void> | 是 | 获取回调,失败时error会返回错误信息。 | | callback: | AsyncCallback\<void> | 是 | 获取回调,失败时返回错误信息。 |
**示例:** **示例:**
...@@ -305,6 +310,8 @@ writeBufferToPixels(src: ArrayBuffer): Promise\<void> ...@@ -305,6 +310,8 @@ writeBufferToPixels(src: ArrayBuffer): Promise\<void>
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
PixelMap.writeBufferToPixels(color).then(() => { PixelMap.writeBufferToPixels(color).then(() => {
console.log("Succeeded in writing data from a buffer to a PixelMap."); console.log("Succeeded in writing data from a buffer to a PixelMap.");
}).catch((err) => { }).catch((err) => {
...@@ -330,6 +337,8 @@ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void ...@@ -330,6 +337,8 @@ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
PixelMap.writeBufferToPixels(color, function(err) { PixelMap.writeBufferToPixels(color, function(err) {
if (err) { if (err) {
console.error("Failed to write data from a buffer to a PixelMap."); console.error("Failed to write data from a buffer to a PixelMap.");
...@@ -405,6 +414,9 @@ getBytesNumberPerRow(): number ...@@ -405,6 +414,9 @@ getBytesNumberPerRow(): number
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(clolr, opts, (err,pixelmap) => { image.createPixelMap(clolr, opts, (err,pixelmap) => {
let rowCount = pixelmap.getBytesNumberPerRow(); let rowCount = pixelmap.getBytesNumberPerRow();
}) })
...@@ -447,6 +459,9 @@ release():Promise\<void> ...@@ -447,6 +459,9 @@ release():Promise\<void>
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => { image.createPixelMap(color, opts, (pixelmap) => {
pixelmap.release().then(() => { pixelmap.release().then(() => {
console.log('release succeeded.'); console.log('release succeeded.');
...@@ -473,6 +488,9 @@ release(callback: AsyncCallback\<void>): void ...@@ -473,6 +488,9 @@ release(callback: AsyncCallback\<void>): void
**示例:** **示例:**
```js ```js
const color = new ArrayBuffer(96);
let bufferArr = new Unit8Array(color);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => { image.createPixelMap(color, opts, (pixelmap) => {
pixelmap.release().then(() => { pixelmap.release().then(() => {
console.log('release succeeded.'); console.log('release succeeded.');
...@@ -922,7 +940,7 @@ packing(source: ImageSource, option: PackingOption): Promise\<ArrayBuffer> ...@@ -922,7 +940,7 @@ packing(source: ImageSource, option: PackingOption): Promise\<ArrayBuffer>
**示例:** **示例:**
```js ```js
let packOpts = { format:["image/jpeg"], quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(ImageSourceApi, packOpts) imagePackerApi.packing(ImageSourceApi, packOpts)
.then( data => { .then( data => {
console.log('packing succeeded.'); console.log('packing succeeded.');
...@@ -950,7 +968,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayB ...@@ -950,7 +968,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayB
**示例:** **示例:**
```js ```js
let packOpts = { format:["image/jpeg"], quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(PixelMapApi, packOpts, data => { imagePackerApi.packing(PixelMapApi, packOpts, data => {
console.log('packing succeeded.'); console.log('packing succeeded.');
}).catch(error => { }).catch(error => {
...@@ -982,7 +1000,7 @@ packing(source: PixelMap, option: PackingOption): Promise\<ArrayBuffer> ...@@ -982,7 +1000,7 @@ packing(source: PixelMap, option: PackingOption): Promise\<ArrayBuffer>
**示例:** **示例:**
```js ```js
let packOpts = { format:["image/jpeg"], quality:98 } let packOpts = { format:"image/jpeg", quality:98 }
imagePackerApi.packing(PixelMapApi, packOpts) imagePackerApi.packing(PixelMapApi, packOpts)
.then( data => { .then( data => {
console.log('packing succeeded.'); console.log('packing succeeded.');
...@@ -1101,7 +1119,7 @@ getReceivingSurfaceId(callback: AsyncCallback\<string>): void ...@@ -1101,7 +1119,7 @@ getReceivingSurfaceId(callback: AsyncCallback\<string>): void
**示例:** **示例:**
```js ```js
receiver.getReceivingSurfaceId((err, id) => { receiver.getReceivingSurfaceId((err, id) => {
if(err) { if(err) {
console.log('getReceivingSurfaceId failed.'); console.log('getReceivingSurfaceId failed.');
} else { } else {
...@@ -1516,7 +1534,7 @@ PixelMap的初始化选项。 ...@@ -1516,7 +1534,7 @@ PixelMap的初始化选项。
| desiredSize | [Size](#size) | 是 | 是 | 期望输出大小。 | | desiredSize | [Size](#size) | 是 | 是 | 期望输出大小。 |
| desiredRegion | [Region](#region7) | 是 | 是 | 解码区域。 | | desiredRegion | [Region](#region7) | 是 | 是 | 解码区域。 |
| desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 解码的像素格式。 | | desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 解码的像素格式。 |
| index | number | 是 | 是 | 解码图片序号 | | index | number | 是 | 是 | 解码图片序号。 |
## Region<sup>7+</sup> ## Region<sup>7+</sup>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册