For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/media/getImageInfo.md.

getImageInfo

获取图片信息。

扫码预览

扫码预览 getImageInfo

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片不支持

接入准备

前置条件

  • src 为豆包应用插件可访问的本地图片路径,或可直接下载的 HTTP、HTTPS 图片地址

使用说明

  • 网络图片会产生下载流量;如需重复读取,建议先下载为本地临时文件。

调用方式

异步 API

getImageInfo(params: GetImageInfoParams): Promise<GetImageInfoResult>

入参

名称类型必填默认值约束说明
srcstring是--图片路径,可以是相对路径、临时文件路径、存储文件路径或网络图片路径。

调用示例

import { getImageInfo } from '@doubao-dev/framework/api';

const { width, height, path } = await getImageInfo({
  src: '/tmp/image.png'
});

console.log(width, height, path);

成功返回

名称类型必返说明
heightnumber是图片原始高度,单位 px,不考虑旋转。
orientationImageOrientation是图片方向。
pathstring是图片路径;网络图片返回原始网络地址,本地图片返回可访问的本地路径。
typestring是图片格式。
widthnumber是图片原始宽度,单位 px,不考虑旋转。

返回示例

{
  "height": 1080,
  "orientation": "up",
  "path": "appletfile://temp/example.jpg",
  "type": "jpeg",
  "width": 1920
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 104,
  "errMsg": "src cannot be empty"
}

错误码

errNoerrMsg平台触发条件处理建议
104src cannot be emptyAndroidsrc 为空字符串传入非空的本地图片路径或 HTTP、HTTPS 地址。
104src must not be emptyiOSsrc 为空字符串传入非空的本地图片路径或 HTTP、HTTPS 地址。
203file does not existAndroid本地图片文件不存在检查路径仍在有效期内并重新获取文件。
203file not foundiOS本地图片文件不存在检查路径仍在有效期内并重新获取文件。

平台差异

  • iOS:网络图片下载到临时目录时不保留扩展名,type 可能返回 unknown;如需稳定识别格式,请以图片内容自行判断。