diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md index 37385a4c6fba5dc3b840e82a4de9ab2a36bfc62a..300eb2c90baaa01a638f3c5e629fc187aeee2998 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -33,6 +33,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise\ { @@ -59,6 +60,7 @@ createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: As ```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) => { }) @@ -99,10 +101,11 @@ readPixelsToBuffer(dst: ArrayBuffer): Promise\ **示例：** ```js -pixelmap.readPixelsToBuffer(ReadBuffer).then(() => { - console.log('readPixelsToBuffer succeeded.'); //符合条件则进入 +const readBuffer = new ArrayBuffer(400); +pixelmap.readPixelsToBuffer(readBuffer).then(() => { + console.log('Succeeded in reading image pixel data.'); //符合条件则进入 }).catch(error => { - console.log('readPixelsToBuffer failed.'); //不符合条件则进入 + console.log('Failed to read image pixel data.'); //不符合条件则进入 }) ``` @@ -124,11 +127,12 @@ readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\): void **示例：** ```js -pixelmap.readPixelsToBuffer(ReadBuffer, (err, res) => { +const readBuffer = new ArrayBuffer(400); +pixelmap.readPixelsToBuffer(readBuffer, (err, res) => { if(err) { - console.log('readPixelsToBuffer failed.'); //不符合条件则进入 + console.log('Failed to read image pixel data.'); //不符合条件则进入 } else { - console.log('readPixelsToBuffer succeeded.'); //符合条件则进入 + console.log('Succeeded in reading image pixel data.'); //符合条件则进入 } }) ``` @@ -156,10 +160,11 @@ readPixels(area: PositionArea): Promise\ **示例：** ```js -pixelmap.readPixels(Area).then((data) => { - console.log('readPixels succeeded.'); //符合条件则进入 +const area = new ArrayBuffer(400); +pixelmap.readPixels(area).then(() => { + console.log('Succeeded in reading the image data in the area.'); //符合条件则进入 }).catch(error => { - console.log('readPixels failed.'); //不符合条件则进入 + console.log('Failed to read the image data in the area.'); //不符合条件则进入 }) ``` @@ -181,6 +186,8 @@ readPixels(area: PositionArea, callback: AsyncCallback\): void **示例：** ```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, (err, pixelmap) => { if(pixelmap == undefined){ @@ -221,6 +228,7 @@ writePixels(area: PositionArea): Promise\ ```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) .then( pixelmap => { @@ -263,14 +271,15 @@ writePixels(area: PositionArea, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | --------- | ------------------------------ | ---- | ------------------------------ | | area | [PositionArea](#positionarea7) | 是 | 区域，根据区域写入。 | -| callback: | AsyncCallback\ | 是 | 获取回调，失败时error会返回错误信息。 | +| callback: | AsyncCallback\ | 是 | 获取回调，失败时返回错误信息。 | **示例：** ```js -pixelmap.writePixels(Area, (error) => { +const area = new ArrayBuffer(400); +pixelmap.writePixels(area, (error) => { if (error!=undefined) { - console.info('writePixels failed.'); + console.info('Failed to write pixelmap into the specified area.'); } else { const readArea = { pixels: new ArrayBuffer(20), @@ -305,7 +314,10 @@ writeBufferToPixels(src: ArrayBuffer): Promise\ **示例：** ```js -PixelMap.writeBufferToPixels(color).then(() => { +const color = new ArrayBuffer(96); +const pixelMap = new ArrayBuffer(400); +let bufferArr = new Unit8Array(color); +pixelMap.writeBufferToPixels(color).then(() => { console.log("Succeeded in writing data from a buffer to a PixelMap."); }).catch((err) => { console.error("Failed to write data from a buffer to a PixelMap."); @@ -330,7 +342,10 @@ writeBufferToPixels(src: ArrayBuffer, callback: AsyncCallback\): void **示例：** ```js -PixelMap.writeBufferToPixels(color, function(err) { +const color = new ArrayBuffer(96);\ +const pixelMap = new ArrayBuffer(400); +let bufferArr = new Unit8Array(color); +pixelMap.writeBufferToPixels(color, function(err) { if (err) { console.error("Failed to write data from a buffer to a PixelMap."); return; @@ -357,7 +372,8 @@ getImageInfo(): Promise\ **示例：** ```js -PixelMap.getImageInfo().then(function(info) { +const pixelMap = new ArrayBuffer(400); +pixelMap.getImageInfo().then(function(info) { console.log("Succeeded in obtaining the image pixel map information."); }).catch((err) => { console.error("Failed to obtain the image pixel map information."); @@ -382,9 +398,7 @@ getImageInfo(callback: AsyncCallback\): void ```js pixelmap.getImageInfo((imageInfo) => { - console.log("getImageInfo succeeded."); -}).catch((err) => { - console.error("getImageInfo failed."); + console.log("Succeeded in obtaining the image pixel map information.."); }) ``` @@ -405,7 +419,10 @@ getBytesNumberPerRow(): number **示例：** ```js -image.createPixelMap(clolr, opts, (err,pixelmap) => { +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, (err,pixelmap) => { let rowCount = pixelmap.getBytesNumberPerRow(); }) ``` @@ -447,11 +464,14 @@ release():Promise\ **示例：** ```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) => { pixelmap.release().then(() => { - console.log('release succeeded.'); + console.log('Succeeded in releasing pixelmap object.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release pixelmap object.'); }) }) ``` @@ -473,11 +493,14 @@ release(callback: AsyncCallback\): void **示例：** ```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) => { pixelmap.release().then(() => { - console.log('release succeeded.'); + console.log('Succeeded in releasing pixelmap object.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release pixelmap object.'); }) }) ``` @@ -535,6 +558,34 @@ createImageSource(fd: number): ImageSource const imageSourceApi = image.createImageSource(0); ``` +## image.createIncrementalSource7+ + +function createIncrementalSource(buf: ArrayBuffer, options: SourceOptions): ImageSource + +创建增量图片源。 + +**系统能力：** SystemCapability.Multimedia.Image + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------------- | ---- | ------------------------------------ | +| buf | ArrayBuffer | 是 | 数组 | +| options | [SourceOptions](#SourceOptions) | 是 | 图片属性，包括图片序号与默认属性值。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------- | --------------------------------- | +| [ImageSource](#imagesource) | 返回图片源，失败时返回undefined。 | + +**示例：** + +```js +const buf = new ArrayBuffer(96); +const imageSourceApi = image.createIncrementalSource(buf); +``` + ## ImageSource 图片源类，用于获取图片相关信息。在调用ImageSource的方法前，需要先通过createImageSource构建一个ImageSource实例。 @@ -592,9 +643,7 @@ getImageInfo(callback: AsyncCallback\): void ```js imageSourceApi.getImageInfo(imageInfo => { - console.log('getImageInfo succeeded.'); -}).catch(error => { - console.log('getImageInfo failed.'); + console.log('Succeeded in obtaining the image information.'); }) ``` @@ -623,9 +672,9 @@ getImageInfo(index?: number): Promise\ ```js imageSourceApi.getImageInfo(0) .then(imageInfo => { - console.log('getImageInfo succeeded.'); + console.log('Succeeded in obtaining the image information.'); }).catch(error => { - console.log('getImageInfo failed.'); + console.log('Failed to obtain the image information.'); }) ``` @@ -655,9 +704,7 @@ getImageProperty(key:string, options?: GetImagePropertyOptions): Promise\ { - console.log('getImageProperty succeeded.'); - }).catch(error => { - console.log('getImageProperty failed.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); }) ``` @@ -681,9 +728,9 @@ getImageProperty(key:string, callback: AsyncCallback\): void ```js imageSourceApi.getImageProperty("BitsPerSample",(error,data) => { if(error) { - console.log('getImageProperty failed.'); + console.log('Failed to get the value of the specified attribute key of the image.'); } else { - console.log('getImageProperty succeeded.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); } }) ``` @@ -707,15 +754,136 @@ getImageProperty(key:string, options: GetImagePropertyOptions, callback: AsyncCa **示例：** ```js -imageSourceApi.getImageProperty("BitsPerSample",Property,(error,data) => { +const property = new ArrayBuffer(400); +imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => { if(error) { - console.log('getImageProperty failed.'); + console.log('Failed to get the value of the specified attribute key of the image.'); } else { - console.log('getImageProperty succeeded.'); + console.log('Succeeded in getting the value of the specified attribute key of the image.'); } }) ``` +### modifyImageProperty7+ + +modifyImageProperty(key: string, value: string): Promise + +修改属性的值。 + +**系统能力：** SystemCapability.Multimedia.Image + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ------------ | +| key | string | 是 | 图片属性名。 | +| value | string | 是 | 属性值。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | ------------------------ | +| Promise<[void](#void)> | 返回修改后的图片属性值。 | + +**示例：** + +```js +imageSourceApi.modifyImageProperty("ImageWidth", "abc") + .then(() => { + const w = imageSourceApi.getImageProperty("ImageWidth") + console.info('w', w); + expect(w == 'abc').assertTrue(); + done(); + }) +``` + +### modifyImageProperty7+ + +modifyImageProperty(key: string, value: string, callback: AsyncCallback): void + +修改属性的值，callback形式返回结果。 + +**系统能力：** SystemCapability.Multimedia.Image + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------- | ---- | ------------------------------ | +| key | string | 是 | 图片属性名。 | +| value | string | 是 | 属性值。 | +| callback | AsyncCallback | 是 | 修改属性值，callback返回结果。 | + +**示例：** + +```js +imageSourceApi.modifyImageProperty("ImageWidth", "abc",() => {}) +``` + +### updateData7+ + +updateData(buf: ArrayBuffer, isFinished: boolean, value: number, length: number): Promise + +更新增量数据。 + +**系统能力：** SystemCapability.Multimedia.Image + +**参数：** + +| 名称 | 类型 | 必填 | 说明 | +| ---------- | ----------- | ---- | ------------ | +| buf | ArrayBuffer | 是 | 增量数据。 | +| isFinished | boolean | 是 | 是否更新完。 | +| value | number | 否 | 偏移量。 | +| length | number | 否 | 数组长。 | + +**返回值：** + +| 类型 | 说明 | +| ---------------------- | ---------------------- | +| Promise<[void](#void)> | 返回更新后的增量数据。 | + +**示例：** + +```js +const array = new ArrayBuffer(100); +imageSourceIncrementalSApi.updateData(array, false, 0, 10).then(data => { + expect(data).assertTrue(); + console.info('Succeeded in updating data.'); + done(); + }) +``` + + +### updateData7+ + +updateData(buf: ArrayBuffer, isFinished: boolean, value: number, length: number, callback: AsyncCallback): void + +更新增量数据。 + +**系统能力：** SystemCapability.Multimedia.Image + +**参数：** + +| 名称 | 类型 | 必填 | 说明 | +| ---------- | ------------------- | ---- | -------------------- | +| buf | ArrayBuffer | 是 | 增量数据。 | +| isFinished | boolean | 是 | 是否更新完。 | +| value | number | 否 | 偏移量。 | +| length | number | 否 | 数组长。 | +| callback | AsyncCallback | 是 | 回调表示成功或失败。 | + +**示例：** + +```js +const array = new ArrayBuffer(100); +imageSourceIncrementalSApi.updateData(array, false, 0, 10,(error,data )=> { + if(data !== undefined){ + expect(data).assertTrue(); + console.info('TC_053-1 success'); + done(); + } +``` + ### createPixelMap7+ createPixelMap(options?: DecodingOptions): Promise\ @@ -740,9 +908,9 @@ createPixelMap(options?: DecodingOptions): Promise\ ```js imageSourceApi.createPixelMap().then(pixelmap => { - console.log('createPixelMap succeeded.'); + console.log('Succeeded in creating pixelmap object through image decoding parameters.'); }).catch(error => { - console.log('createPixelMap failed.'); + console.log('Failed to create pixelmap object through image decoding parameters.'); }) ``` @@ -764,9 +932,9 @@ createPixelMap(callback: AsyncCallback\): void ```js imageSourceApi.createPixelMap(pixelmap => { - console.log('createPixelMap succeeded.'); + console.log('Succeeded in creating pixelmap object.'); }).catch(error => { - console.log('createPixelMap failed.'); + console.log('Failed to create pixelmap object.'); }) ``` @@ -788,11 +956,10 @@ createPixelMap(options: DecodingOptions, callback: AsyncCallback\): vo **示例：** ```js +const decodingOptions = new ArrayBuffer(400); imageSourceApi.createPixelMap(decodingOptions, pixelmap => { - console.log('createPixelMap succeeded.'); -}).catch(error => { - console.log('createPixelMap failed.'); -}) + console.log('Succeeded in creating pixelmap object.'); +}) ``` ### release @@ -814,8 +981,6 @@ release(callback: AsyncCallback\): void ```js imageSourceApi.release(() => { console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); }) ``` @@ -837,9 +1002,9 @@ release(): Promise\ ```js imageSourceApi.release().then(()=>{ - console.log('release succeeded.'); + console.log('Succeeded in releasing the image source instance.'); }).catch(error => { - console.log('release failed.'); + console.log('Failed to release the image source instance.'); }) ``` @@ -895,7 +1060,8 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback\ {}) +const imageSourceApi = new ArrayBuffer(400); +imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ``` ### packing @@ -922,8 +1088,9 @@ packing(source: ImageSource, option: PackingOption): Promise\ **示例：** ```js -let packOpts = { format:["image/jpeg"], quality:98 } -imagePackerApi.packing(ImageSourceApi, packOpts) +let packOpts = { format:"image/jpeg", quality:98 } +const imageSourceApi = new ArrayBuffer(400); +imagePackerApi.packing(imageSourceApi, packOpts) .then( data => { console.log('packing succeeded.'); }).catch(error => { @@ -950,11 +1117,12 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\ { - console.log('packing succeeded.'); +let packOpts = { format:"image/jpeg", quality:98 } +const pixelMapApi = new ArrayBuffer(400); +imagePackerApi.packing(pixelMapApi, packOpts, data => { + console.log('Succeeded in packing the image.'); }).catch(error => { - console.log('packing failed.'); + console.log('Failed to pack the image.'); }) ``` @@ -982,12 +1150,13 @@ packing(source: PixelMap, option: PackingOption): Promise\ **示例：** ```js -let packOpts = { format:["image/jpeg"], quality:98 } -imagePackerApi.packing(PixelMapApi, packOpts) +let packOpts = { format:"image/jpeg", quality:98 } +const pixelMapApi = new ArrayBuffer(400); +imagePackerApi.packing(pixelMapApi, packOpts) .then( data => { - console.log('packing succeeded.'); + console.log('Succeeded in packing the image.'); }).catch(error => { - console.log('packing failed.'); + console.log('Failed to pack the image..'); }) ``` @@ -1009,9 +1178,7 @@ release(callback: AsyncCallback\): void ```js imagePackerApi.release(()=>{ - console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); + console.log('Succeeded in releasing image packaging.'); }) ``` @@ -1033,9 +1200,9 @@ release(): Promise\ ```js imagePackerApi.release().then(()=>{ - console.log('release succeeded.'); + console.log('Succeeded in releasing image packaging.'); }).catch((error)=>{ - console.log('release failed.'); + console.log('Failed to release image packaging.'); }) ``` @@ -1101,7 +1268,7 @@ getReceivingSurfaceId(callback: AsyncCallback\): void **示例:** ```js - receiver.getReceivingSurfaceId((err, id) => { +receiver.getReceivingSurfaceId((err, id) => { if(err) { console.log('getReceivingSurfaceId failed.'); } else { @@ -1516,7 +1683,7 @@ PixelMap的初始化选项。 | desiredSize | [Size](#size) | 是 | 是 | 期望输出大小。 | | desiredRegion | [Region](#region7) | 是 | 是 | 解码区域。 | | desiredPixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 解码的像素格式。 | -| index | number | 是 | 是 | 解码图片序号 | +| index | number | 是 | 是 | 解码图片序号。 | ## Region7+