visionBase作为一个基础的视觉能力库，封装了基本资源对象、数据结构、常用方法等视觉能力场景中的常用元素。减少冗余代码书写，简化功能接口使用，而不必重复“造轮子”。可以将visionBase理解为一个“工具箱”，里面装着一些常用的“工具”，利用visionBase基类，会更高效、更标准地实现各自的功能。visionBase提供了Core Vision Kit AI能力所需的基础设施，如数据结构、接口模型、生命周期管理等。

起始版本： 5.0.0(12)

导入模块

import { visionBase } from '@kit.CoreVisionKit';

SceneMode

场景模式的枚举类。用于指示该请求对应的业务场景模式，引擎服务端将根据此模式设置任务优先级。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	值	说明
FOREGROUND	1	（默认）前台模式。
BACKGROUND	2	后台模式。

ImageData

待识别的视觉信息对象。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
pixelMap	image.PixelMap	否	否	待识别的图片。

InputData

type InputData = ImageData | ImageData[]

多个图像数据组成的数组。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

类型	说明
ImageData \| ImageData[]	待识别的图片数组。可输入一个或多个图片。

BoundingBox

视觉AI能力的内切框。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
left	number	否	否	边界框左上角的x坐标。
top	number	否	否	边界框左上角的y坐标。
height	number	否	否	边界框高度，单位：px。
width	number	否	否	边界框宽度，单位：px。

Point

二维平面上的点。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
x	number	否	否	点的横坐标。
y	number	否	否	点的纵坐标。

Orientation

表示三维平面上的朝向。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
yaw	number	否	否	表示绕垂直轴（Y轴）旋转的角度，也称为“偏航角”，决定了物体在水平面上的朝向。取值范围[-180,180]。
pitch	number	否	否	表示绕水平轴（X轴）旋转的角度，也称为“俯仰角”，决定了物体在垂直平面上的朝向。取值范围[-180,180]。
roll	number	否	否	表示绕前后轴（Z轴）旋转的角度，也称为“翻滚角”，决定了物体在前后方向上的朝向。取值范围[-180,180]。

DownloadStartData

下载开始事件的数据结构，当AI模型开始下载时触发，告知开发者哪个资源开始下载。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	类型	只读	可选	说明
resId	string	否	否	资源标识符，用于标识正在下载的模型。

DownloadCompleteData

模型下载完成时触发的下载完成事件的数据结构。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	类型	只读	可选	说明
resId	string	否	否	资源标识符。
resVersion	string	否	否	资源版本号。

DownloadCancelData

下载过程被取消时触发的下载取消事件的数据结构。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	类型	只读	可选	说明
resId	string	否	否	资源标识符。

DownloadStatusData

下载状态事件的数据结构，用于报告下载过程中的各种状态，比如网络错误、参数无效等。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	类型	只读	可选	说明
resId	string	否	否	资源标识符。
statusCode	downloadStatusCode	否	否	状态码。
message	string	否	否	状态描述信息。无固定描述。

DownloadProgressData

下载进度事件的数据结构，用于报告下载进度，让开发者能够实时显示下载进度。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	类型	只读	可选	说明
resId	string	否	否	资源标识符。
progressInfo	string	否	否	进度信息。

downloadStatusCode

下载状态的枚举类。该字段为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

名称	值	说明
PARAMETER_INVALID	0	传入的下载参数有误，比如资源ID格式错误，建议检查传入参数的格式和有效性。
NO_NETWORK_STATUS	1	设备离线或网络不可用，建议提示用户检查网络连接。
NO_MODEL	2	服务器上找不到对应的模型文件，建议验证模型资源ID是否正确，确认服务器上模型文件是否存在。
COPY_FILE_FAILED	3	下载后无法将模型文件复制到指定位置，建议检查存储权限和可用空间。
DOWNLOAD_NOT_ALLOWED	4	需要用户确认的场合，用户已选择拒绝。
DOWNLOAD_TIME_OUT	5	网络较慢或服务器响应延迟。
DOWNLOAD_EXCEPTION	6	下载过程中出现错误，任何其他未明确分类的错误。
DOWNLOAD_BACK_TO_DESKTOP	7	用户在下载过程中切换出应用。
TASK_BUSY	8	系统繁忙，正在执行另一个任务。起始版本： 6.0.0(20)

Request

入参变量的基类。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
inputData	InputData	否	否	待识别的图片。可以是单个对象或多个对象的数组。
scene	SceneMode	否	是	请求的场景模式。默认值为SceneMode.FOREGROUND（前台模式）。该参数为预留字段，暂未实现。
requestId	string	否	是	请求的标识。用于开发者跟踪和管理自己的请求。默认值为空字符串。该参数为预留字段，暂未实现。

名称

类型

只读

可选

说明

inputData

InputData

否

待识别的图片。可以是单个对象或多个对象的数组。

scene

SceneMode

否

是

请求的场景模式。默认值为SceneMode.FOREGROUND（前台模式）。

该参数为预留字段，暂未实现。

requestId

string

否

是

请求的标识。用于开发者跟踪和管理自己的请求。默认值为空字符串。

该参数为预留字段，暂未实现。

Response

响应基类，作为能力请求的返回结果。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

名称	类型	只读	可选	说明
requestId	string	否	是	请求的唯一标识，用于开发者跟踪和管理自己的请求，与Request请求一一对应。默认值为空字符串。

Analyzer

Analyzer基类，充当能力引擎。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

[h2]destroy

destroy(): Promise<void>

用于销毁多种视觉能力的进程。使用Promise异步回调。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

示例：

请参见ObjectDetection.destroy

on('downloadStart')

on(type: 'downloadStart', callback: Callback<DownloadStartData>): void

订阅模型下载开始事件。当模型开始下载时触发。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，值为'downloadStart'，表示模型开始下载事件。
callback	Callback<DownloadStartData>	是	回调函数，当模型开始下载时触发，返回开始下载的资源标识信息。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

visionBase.on('downloadStart', (data) => {
    console.info(`资源 ${data.resId} 开始下载`);
});

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发下载开始事件的业务逻辑
      })
    }
  }
}

on('downloadComplete')

on(type: 'downloadComplete', callback: Callback<DownloadCompleteData>): void

订阅模型下载完成事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，值为'downloadComplete'，表示模型下载完成事件。
callback	Callback<DownloadCompleteData>	是	回调函数，当模型下载完成时触发，返回完成下载的资源标识符及版本号。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

visionBase.on('downloadComplete', (data) => {
    console.info(`资源 ${data.resId} 下载完成，版本：${data.resVersion}`);
});

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发下载完成事件的业务逻辑
      })
    }
  }
}

on('downloadCancel')

on(type: 'downloadCancel', callback: Callback<DownloadCancelData>): void

订阅模型下载取消事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，值为'downloadCancel'，表示模型下载取消事件。
callback	Callback<DownloadCancelData>	是	回调函数，当模型下载被取消时触发，返回取消下载的资源标识信息。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

visionBase.on('downloadCancel', (data) => {
    console.info(`资源 ${data.resId} 下载已取消`);
});

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发下载取消事件的业务逻辑
      })
    }
  }
}

on('downloadStatus')

on(type: 'downloadStatus', callback: Callback<DownloadStatusData>): void

订阅模型下载状态事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，值为'downloadStatus'，表示模型下载状态事件。
callback	Callback<DownloadStatusData>	是	回调函数，当模型下载状态发生变化时触发，返回当前下载状态信息。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

visionBase.on('downloadStatus', (data) => {
    console.info(`资源 ${data.resId} 下载状态：${data.statusCode}, ${data.message}`);
});

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发下载状态事件的业务逻辑
      })
    }
  }
}

on('downloadProgress')

on(type: 'downloadProgress', callback: Callback<DownloadProgressData>): void

订阅模型下载进度事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，值为'downloadProgress'，表示模型下载进度事件。
callback	Callback<DownloadProgressData>	是	回调函数，当模型下载进度更新时触发，返回当前下载进度信息。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

visionBase.on('downloadProgress', (data) => {
    console.info(`资源 ${data.resId} 下载进度：${data.progressInfo}`);
});

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发下载进度事件的业务逻辑
      })
    }
  }
}

off('downloadStart')

off(type: 'downloadStart', callback?: Callback<DownloadStartData>): void

取消订阅模型下载开始事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，固定字符串'downloadStart'，表示取消订阅模型开始下载事件。
callback	Callback<DownloadStartData>	否	需要取消注册的回调函数，需与订阅时传入的回调函数是同一个。若无此参数，则取消注册所有的回调函数。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

// 定义回调函数
const startCallback = (data: visionBase.DownloadStartData) => {
  console.info(`资源 ${data.resId} 开始下载`);
};
// 注册监听器
visionBase.on('downloadStart', startCallback);
// 移除特定的监听器
visionBase.off('downloadStart', startCallback);

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发取消订阅下载开始事件的业务逻辑
      })
    }
  }
}

off('downloadComplete')

off(type: 'downloadComplete', callback?: Callback<DownloadCompleteData>): void

取消注册模型下载完成事件的监听器。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，固定字符串'downloadComplete'，表示取消订阅模型下载完成事件。
callback	Callback<DownloadCompleteData>	否	需要取消注册的回调函数，需与订阅时传入的回调函数是同一个。若无此参数，则取消注册所有的回调函数。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

// 定义回调函数
const callback = (data: visionBase.DownloadCompleteData) => {
  console.info(`资源 ${data.resId} 下载完成`);
};
// 注册监听器
visionBase.on('downloadComplete', callback);
// 移除特定的监听器
visionBase.off('downloadComplete', callback);

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发取消订阅下载完成事件的业务逻辑
      })
    }
  }
}

off('downloadCancel')

off(type: 'downloadCancel', callback?: Callback<DownloadCancelData>): void

取消订阅模型下载取消事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，固定字符串'downloadCancel'，表示取消订阅模型下载取消事件。
callback	Callback<DownloadCancelData>	否	需要取消注册的回调函数，需与订阅时传入的回调函数是同一个。若无此参数，则取消注册所有的回调函数。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

// 定义回调函数
const callback = (data: visionBase.DownloadCancelData) => {
  console.info(`资源 ${data.resId} 下载取消`);
};
// 注册监听器
visionBase.on('downloadCancel', callback);
// 移除特定的监听器
visionBase.off('downloadCancel', callback);

@Entry
@Component
struct Page {
  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发取消订阅下载取消事件的业务逻辑
      })
    }
  }
}

off('downloadStatus')

off(type: 'downloadStatus', callback?: Callback<DownloadStatusData>): void

取消订阅模型下载状态事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，固定字符串'downloadStatus'，表示取消订阅模型下载状态事件。
callback	Callback<DownloadStatusData>	否	需要取消注册的回调函数，需与订阅时传入的回调函数是同一个。若无此参数，则取消注册所有的回调函数。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

// 定义回调函数
const callback = (data: visionBase.DownloadStatusData) => {
  console.info(`资源 ${data.resId} 下载状态`);
};
// 注册监听器
visionBase.on('downloadStatus', callback);
// 移除特定的监听器
visionBase.off('downloadStatus', callback);

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发取消订阅下载状态事件的业务逻辑
      })
    }
  }
}

off('downloadProgress')

off(type: 'downloadProgress', callback?: Callback<DownloadProgressData>): void

取消订阅模型下载进度事件。该方法为预留接口，当前版本暂不支持。

系统能力： SystemCapability.AI.Vision.VisionBase

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.2(14)

参数：

参数名	类型	必填	说明
type	string	是	事件类型，固定字符串'downloadProgress'，表示取消订阅模型下载进度事件。
callback	Callback<DownloadProgressData>	否	需要取消注册的回调函数，需与订阅时传入的回调函数是同一个。若无此参数，则取消注册所有的回调函数。

错误码：

以下错误码的详细介绍请参见Core Vision Kit错误码。

错误码ID	错误信息
401	The parameter check failed.

示例：

import { visionBase } from '@kit.CoreVisionKit';

// 定义回调函数
const callback = (data: visionBase.DownloadProgressData) => {
  console.info(`资源 ${data.resId} 下载进度`);
};
// 注册监听器
visionBase.on('downloadProgress', callback);
// 移除特定的监听器
visionBase.off('downloadProgress', callback);

@Entry
@Component
struct Page {

  build() {
    Column(){
      Button('Button').onClick(() => {
        // 触发取消订阅下载进度事件的业务逻辑
      })
    }
  }
}

目录

visionBase（Core Vision Kit基类）

导入模块

SceneMode

ImageData

InputData

BoundingBox

Point

Orientation

DownloadStartData

DownloadCompleteData

DownloadCancelData

DownloadStatusData

DownloadProgressData

downloadStatusCode

Request

Response

Analyzer

[h2]destroy

on('downloadStart')

on('downloadComplete')

on('downloadCancel')

on('downloadStatus')

on('downloadProgress')

off('downloadStart')

off('downloadComplete')

off('downloadCancel')

off('downloadStatus')

off('downloadProgress')