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 6dd49fcf3af91575ef8bcd0da5de7d09edcc4b77..2ae0461c83d2fb93ea767452c9c600fd057b63f5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -1059,384 +1059,6 @@ imagePackerApi.release().then(()=>{ }) ``` -## image.createImageReceiver9+ - -createImageReceiver(width: number, height: number, format: number, capacity: number): ImageReceiver - -通过宽、高、图片格式、容量创建ImageReceiver实例。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ---------------------- | -| width | number | 是 | 图像的默认宽度。 | -| height | number | 是 | 图像的默认高度。 | -| format | number | 是 | 图像格式。 | -| capacity | number | 是 | 同时访问的最大图像数。 | - -**返回值：** - -| 类型 | 说明 | -| -------------------------------- | --------------------------------------- | -| [ImageReceiver](#imagereceiver9) | 如果操作成功，则返回ImageReceiver实例。 | - -**示例：** - -```js -var receiver = image.createImageReceiver(8192, 8, 4, 8); -``` - -## ImageReceiver9+ - -图像接收类，用于获取组件surface id，接收最新的图片和读取下一张图片，以及释放ImageReceiver实例。 - -在调用以下方法前需要先创建ImageReceiver实例。 - -### 属性 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | ---------------------------- | ---- | ---- | ------------------ | -| size9+ | [Size](#size) | 是 | 否 | 图片大小。 | -| capacity9+ | number | 是 | 否 | 同时访问的图像数。 | -| format9+ | [ImageFormat](#imageformat9) | 是 | 否 | 图像格式。 | - -### getReceivingSurfaceId9+ - -getReceivingSurfaceId(callback: AsyncCallback\): void - -用于获取一个surface id供Camera或其他组件使用。使用callback返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | -------------------------- | -| callback | AsyncCallback\ | 是 | 回调函数，返回surface id。 | - -**示例:** - -```js -receiver.getReceivingSurfaceId((err, id) => { - if(err) { - console.log('getReceivingSurfaceId failed.'); - } else { - console.log('getReceivingSurfaceId succeeded.'); - } -}); -``` - -### getReceivingSurfaceId9+ - -getReceivingSurfaceId(): Promise\ - -用于获取一个surface id供Camera或其他组件使用。使用promise返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**返回值：** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 异步返回surface id。 | - -**示例：** - -```js -receiver.getReceivingSurfaceId().then( id => { - console.log('getReceivingSurfaceId succeeded.'); -}).catch(error => { - console.log('getReceivingSurfaceId failed.'); -}) -``` - -### readLatestImage9+ - -readLatestImage(callback: AsyncCallback\): void - -从ImageReceiver读取最新的图片，并使用callback返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback<[Image](#image9)> | 是 | 回调函数，返回最新图像。 | - -**示例：** - -```js -receiver.readLatestImage((err, img) => { - if(err) { - console.log('readLatestImage failed.'); - } else { - console.log('readLatestImage succeeded.'); - } -}); -``` - -### readLatestImage9+ - -readLatestImage(): Promise\ - -从ImageReceiver读取最新的图片，并使用promise返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**返回值：** - -| 类型 | 说明 | -| ------------------------- | ------------------ | -| Promise<[Image](#image8)> | 异步返回最新图片。 | - -**示例：** - -```js -receiver.readLatestImage().then(img => { - console.log('readLatestImage succeeded.'); -}).catch(error => { - console.log('readLatestImage failed.'); -}) -``` - -### readNextImage9+ - -readNextImage(callback: AsyncCallback\): void - -从ImageReceiver读取下一张图片，并使用callback返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------------------------------- | ---- | -------------------------- | -| callback | AsyncCallback<[Image](#image9)> | 是 | 回调函数，返回下一张图片。 | - -**示例：** - -```js -receiver.readNextImage((err, img) => { - if(err) { - console.log('readNextImage failed.'); - } else { - console.log('readNextImage succeeded.'); - } -}); -``` - -### readNextImage9+ - -readNextImage(): Promise\ - -从ImageReceiver读取下一张图片，并使用promise返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**返回值：** - -| 类型 | 说明 | -| ------------------------- | -------------------- | -| Promise<[Image](#image9)> | 异步返回下一张图片。 | - -**示例：** - -```js -receiver.readNextImage().then(img => { - console.log('readNextImage succeeded.'); -}).catch(error => { - console.log('readNextImage failed.'); -}) -``` - -### on('imageArrival')9+ - -on(type: 'imageArrival', callback: AsyncCallback\): void - -接收图片时注册回调。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------------------------------------------ | -| type | string | 是 | 注册事件的类型，固定为'imageArrival'，接收图片时触发。 | -| callback | AsyncCallback\ | 是 | 注册的事件回调。 | - -**示例：** - -```js -receiver.on('imageArrival', () => {}) -``` - -### release9+ - -release(callback: AsyncCallback\): void - -释放ImageReceiver实例并使用回调返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数，返回操作结果。 | - -**示例：** - -```js -receiver.release(() => {}) -``` - -### release9+ - -release(): Promise\ - -释放ImageReceiver实例并使用promise返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.ImageReceiver - -**返回值：** - -| 类型 | 说明 | -| -------------- | ------------------ | -| Promise\ | 异步返回操作结果。 | - -**示例：** - -```js -receiver.release().then(() => { - console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); -}) -``` - -## Image9+ - -提供基本的图像操作，包括获取图像信息、读写图像数据。调用[readNextImage](#readnextimage9)和[readLatestImage](#readlatestimage9)接口时会返回image。 - -### 属性 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | ------------------ | ---- | ---- | -------------------------------------------------- | -| clipRect9+ | [Region](#region7) | 是 | 是 | 要裁剪的图像区域。 | -| size9+ | [Size](#size) | 是 | 否 | 图像大小。 | -| format9+ | number | 是 | 否 | 图像格式，参考[PixelMapFormat](#pixelmapformat7)。 | - -### getComponent9+ - -getComponent(componentType: ComponentType, callback: AsyncCallback\): void - -根据图像的组件类型从图像中获取组件缓存并使用callback返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.Core - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| ------------- | --------------------------------------- | ---- | -------------------- | -| componentType | [ComponentType](#componenttype9) | 是 | 图像的组件类型。 | -| callback | AsyncCallback<[Component](#component9)> | 是 | 用于返回组件缓冲区。 | - -**示例：** - -```js -img.getComponent(4, (err, component) => { - if(err) { - console.log('getComponent failed.'); - } else { - console.log('getComponent succeeded.'); - } -}) -``` - -### getComponent9+ - -getComponent(componentType: ComponentType): Promise\ - -根据图像的组件类型从图像中获取组件缓存并使用Promise方式返回结果。 - -**系统能力：** SystemCapability.Multimedia.Image.Core - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| ------------- | -------------------------------- | ---- | ---------------- | -| componentType | [ComponentType](#componenttype9) | 是 | 图像的组件类型。 | - -**返回值：** - -| 类型 | 说明 | -| --------------------------------- | --------------------------------- | -| Promise<[Component](#component9)> | 用于返回组件缓冲区的promise实例。 | - -**示例：** - -```js -img.getComponent(4).then(component => { }) -``` - -### release9+ - -release(callback: AsyncCallback\): void - -释放当前图像并使用callback返回结果。 - -在接收另一个图像前必须先释放对应资源。 - -**系统能力：** SystemCapability.Multimedia.Image.Core - -**参数：** - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------- | -| callback | AsyncCallback\ | 是 | 返回操作结果。 | - -**示例：** - -```js -img.release(() =>{ - console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); -}) -``` - -### release9+ - -release(): Promise\ - -释放当前图像并使用Promise方式返回结果。 - -在接收另一个图像前必须先释放对应资源。 - -**系统能力：** SystemCapability.Multimedia.Image.Core - -**返回值：** - -| 类型 | 说明 | -| -------------- | --------------------- | -| Promise\ | promise返回操作结果。 | - -**示例：** - -```js -img.release().then(() =>{ - console.log('release succeeded.'); -}).catch(error => { - console.log('release failed.'); -}) -``` ## PositionArea7+ @@ -1484,29 +1106,7 @@ img.release().then(() =>{ | RGBA_8888 | 3 | 格式为RGBA_8888。 | | RGB_565 | 2 | 格式为RGB_565。 | -## AlphaType9+ - -枚举，图像的透明度类型。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core - -| 名称 | 默认值 | 描述 | -| -------- | ------ | ----------------------- | -| UNKNOWN | 0 | 未知透明度。 | -| OPAQUE | 1 | 没有alpha或图片全透明。 | -| PREMUL | 2 | RGB前乘alpha。 | -| UNPREMUL | 3 | RGB不前乘alpha。 | - -## ScaleMode9+ -枚举，图像的缩放模式。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core - -| 名称 | 默认值 | 描述 | -| --------------- | ------ | -------------------------------------------------- | -| CENTER_CROP | 1 | 缩放图像以填充目标图像区域并居中裁剪区域外的效果。 | -| FIT_TARGET_SIZE | 2 | 图像适合目标尺寸的效果。 | ## InitializationOptions8+ @@ -1516,10 +1116,8 @@ PixelMap的初始化选项。 | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------------------- | ---------------------------------- | ---- | ---- | -------------- | -| alphaType9+ | [AlphaType](#alphatype9) | 是 | 是 | 透明度。 | | editable | boolean | 是 | 是 | 是否可编辑。 | | pixelFormat | [PixelMapFormat](#pixelmapformat7) | 是 | 是 | 像素格式。 | -| scaleMode9+ | [ScaleMode](#scalemode9) | 是 | 是 | 缩略值。 | | size | [Size](#size) | 是 | 是 | 创建图片大小。 | ## DecodingOptions7+ @@ -1589,42 +1187,6 @@ PixelMap的初始化选项。 | GPS_LATITUDE_REF | "GPSLatitudeRef" | 纬度引用，例如N或S。| | GPS_LONGITUDE_REF | "GPSLongitudeRef" | 经度引用，例如W或E。| -## ImageFormat9+ - -枚举，图片格式。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core - -| 名称 | 默认值 | 描述 | -| ------------ | ------ | -------------------- | -| YCBCR_422_SP | 1000 | YCBCR422半平面格式。 | -| JPEG | 2000 | JPEG编码格式。 | - -## ComponentType9+ - -枚举，图像的组件类型。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.ImageReceiver - -| 名称 | 默认值 | 描述 | -| ----- | ------ | ----------- | -| YUV_Y | 1 | 亮度信息。 | -| YUV_U | 2 | 色度信息。 | -| YUV_V | 3 | 色度信息。 | -| JPEG | 4 | Jpeg 类型。 | - -## Component9+ - -描述图像颜色分量。 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.Image.Core - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------- | -------------------------------- | ---- | ---- | ------------ | -| componentType | [ComponentType](#componenttype9) | 是 | 否 | 组件类型。 | -| rowStride | number | 是 | 否 | 行距。 | -| pixelStride | number | 是 | 否 | 像素间距。 | -| byteBuffer | ArrayBuffer | 是 | 否 | 组件缓冲区。 | ## ResponseCode