> 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.

# chooseImage

选择图片。

## 扫码预览

![扫码预览 chooseImage](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fmedia%252Fchoose-image%252Findex)

## 使用限制

> \[!WARNING]
> **Android、iOS**：选择结果不受 sizeType 影响；调用方无法控制返回图片尺寸。
> **Android、iOS**：仅当数组只包含 camera 时打开相机；其他组合均打开相册，user 和 environment 不生效；传入多个来源或 user、environment 时实际入口与配置不一致。

## 支持版本

前端库版本不低于 `0.0.26`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>不支持</td></tr>
</tbody>
</table>

## 接入准备

### 权限要求

<table>
<thead>
<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td>系统权限</td><td>相册访问权限</td><td>按条件</td><td>Android、iOS</td><td>从相册选择图片时，系统或豆包图片选择器可能按系统版本请求访问权限</td></tr>
<tr><td>系统权限</td><td>相机权限</td><td>按条件</td><td>Android、iOS</td><td>sourceType 只传 camera 时需要使用相机</td></tr>
</tbody>
</table>

### 授权行为

- **Android**：API 直接打开豆包图片选择器或相机。系统需要权限时会由对应选择器发起申请；拒绝或撤销后选择失败，请在系统设置中开启相册或相机权限后重试。
- **iOS**：API 直接打开豆包相册选择器或系统相机。首次需要时系统会请求相册或相机权限；拒绝或撤销后选择失败，请在系统设置中开启后重试。

### 前置条件

- 在可展示图片选择器的前台页面中，由用户操作触发调用

## 使用说明

- 图片属于用户数据，仅在业务必需时选择，并及时释放不再使用的临时文件。

## 调用方式

### 异步 API

```typescript
chooseImage(params?: ChooseImageParams): Promise<ChooseImageResult>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>count</code></td><td><code>number</code></td><td>否</td><td><code>9</code></td><td>正整数</td><td>最多可选图片张数。使用相机时固定返回一张图片。</td></tr>
<tr><td><code>imageId</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>H5 场景下可复用的 input 元素 ID。</td></tr>
<tr><td><code>sizeType</code></td><td><code>ChooseImageSizeType[]</code></td><td>否</td><td><code>-</code></td><td>-</td><td>允许返回的图片尺寸类型。Android、iOS：选择结果不受 sizeType 影响。</td></tr>
<tr><td><code>sourceType</code></td><td><code>ChooseImageSourceType[]</code></td><td>否</td><td><code>[&quot;album&quot;]</code></td><td>-</td><td>允许选择的图片来源。Android、iOS：仅当数组只包含 camera 时打开相机；其他组合均打开相册，user 和 environment 不生效。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import { chooseImage } from '@doubao-dev/framework/api';

const { tempFilePaths } = await chooseImage({
  count: 1,
  sourceType: ['album']
});

console.log(tempFilePaths);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>tempFilePaths</code></td><td><code>string[]</code></td><td>是</td><td>图片临时文件路径列表。</td></tr>
<tr><td><code>tempFiles</code></td><td><code>ChooseImageFile[]</code></td><td>是</td><td>图片临时文件信息列表。</td></tr>
<tr><td><code>tempFiles[].originalFileObj</code></td><td><code>File</code></td><td>否</td><td>原始浏览器 File 对象。</td></tr>
<tr><td><code>tempFiles[].path</code></td><td><code>string</code></td><td>是</td><td>本地临时文件路径。</td></tr>
<tr><td><code>tempFiles[].size</code></td><td><code>number</code></td><td>是</td><td>文件大小，单位 B。</td></tr>
<tr><td><code>tempFiles[].type</code></td><td><code>string</code></td><td>否</td><td>文件 MIME 类型。</td></tr>
</tbody>
</table>

### 返回示例

```json
{
  "tempFilePaths": ["appletfile://temp/example.jpg"],
  "tempFiles": [
    {
      "path": "appletfile://temp/example.jpg",
      "size": 245760,
      "type": "image/jpeg"
    }
  ]
}
```

## 平台差异

- 使用相机时固定返回一张图片。
