@doubao-apps/create 0.0.25 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/07-/345/252/222/344/275/223.md

@@ -0,0 +1,346 @@
+# Open API: 媒体
+
+图片选择、预览、保存、压缩和信息读取。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [saveImageToPhotosAlbum](#saveimagetophotosalbum) | 保存图片到系统相册。 |
+| [previewImage](#previewimage) | 预览图片。 |
+| [getImageInfo](#getimageinfo) | 获取图片信息。 |
+| [chooseImage](#chooseimage) | 选择图片。 |
+| [compressImage](#compressimage) | 压缩图片。 |
+
+## API 详情
+
+<a id="saveimagetophotosalbum"></a>
+### saveImageToPhotosAlbum()
+
+> **saveImageToPhotosAlbum**(`params`): `Promise`\<`object`\>
+
+保存图片到系统相册。
+
+需要先确保应用已具备写入系统相册的权限。
+
+#### Parameters
+
+• **params**: [`SaveImageToPhotosAlbumParams`](#saveimagetophotosalbumparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Example
+
+```typescript
+import { saveImageToPhotosAlbum } from '@doubao-apps/framework/api';
+
+await saveImageToPhotosAlbum({
+  filePath: '/path/to/image.png'
+});
+```
+
+<a id="previewimage"></a>
+### previewImage()
+
+> **previewImage**(`params`): `Promise`\<`object`\>
+
+预览图片。
+
+#### Parameters
+
+• **params**: [`PreviewImageParams`](#previewimageparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getimageinfo"></a>
+### getImageInfo()
+
+> **getImageInfo**(`params`): `Promise`\<[`GetImageInfoResult`](#getimageinforesult)\>
+
+获取图片信息。
+
+#### Parameters
+
+• **params**: [`GetImageInfoParams`](#getimageinfoparams)
+
+#### Returns
+
+`Promise`\<[`GetImageInfoResult`](#getimageinforesult)\>
+
+<a id="chooseimage"></a>
+### chooseImage()
+
+> **chooseImage**(`params`?): `Promise`\<[`ChooseImageResult`](#chooseimageresult)\>
+
+选择图片。
+
+#### Parameters
+
+• **params?**: [`ChooseImageParams`](#chooseimageparams)
+
+#### Returns
+
+`Promise`\<[`ChooseImageResult`](#chooseimageresult)\>
+
+<a id="compressimage"></a>
+### compressImage()
+
+> **compressImage**(`params`): `Promise`\<[`CompressImageResult`](#compressimageresult)\>
+
+压缩图片。
+
+#### Parameters
+
+• **params**: [`CompressImageParams`](#compressimageparams)
+
+#### Returns
+
+`Promise`\<[`CompressImageResult`](#compressimageresult)\>
+
+## 相关类型
+
+<a id="saveimagetophotosalbumparams"></a>
+### SaveImageToPhotosAlbumParams
+
+保存图片到系统相册的请求参数。
+
+#### Properties
+
+##### filePath
+
+> **filePath**: `string`
+
+需要保存的图片文件路径。支持临时文件路径或持久文件路径，不支持网络图片路径。
+
+<a id="previewimageparams"></a>
+### PreviewImageParams
+
+预览图片的请求参数。
+
+#### Properties
+
+##### current?
+
+> `optional` **current**: `string` \| `number`
+
+当前显示图片的链接，或当前显示图片的下标，不填则默认为 urls 中的第一张
+
+##### referrerPolicy?
+
+> `optional` **referrerPolicy**: `string`
+
+预览页使用的 Referrer 策略。
+
+##### showmenu?
+
+> `optional` **showmenu**: `boolean`
+
+是否显示长按菜单，菜单支持保存图片至本地相册
+
+##### urls
+
+> **urls**: `string`[]
+
+需要预览的图片链接列表。
+
+<a id="getimageinfoparams"></a>
+### GetImageInfoParams
+
+获取图片信息的请求参数。
+
+#### Properties
+
+##### src
+
+> **src**: `string`
+
+图片路径，可以是相对路径、临时文件路径、存储文件路径或网络图片路径。
+
+<a id="getimageinforesult"></a>
+### GetImageInfoResult
+
+图片信息结果。
+
+#### Properties
+
+##### height
+
+> **height**: `number`
+
+图片原始高度，单位 px，不考虑旋转。
+
+##### orientation
+
+> **orientation**: [`ImageOrientation`](#imageorientation)
+
+图片方向。
+
+##### path
+
+> **path**: `string`
+
+图片的本地路径。
+
+##### type
+
+> **type**: `string`
+
+图片格式。
+
+##### width
+
+> **width**: `number`
+
+图片原始宽度，单位 px，不考虑旋转。
+
+<a id="imageorientation"></a>
+### ImageOrientation
+
+> **ImageOrientation**: `"up"` \| `"up-mirrored"` \| `"down"` \| `"down-mirrored"` \| `"left-mirrored"` \| `"right"` \| `"right-mirrored"` \| `"left"`
+
+图片方向枚举。
+
+<a id="chooseimageparams"></a>
+### ChooseImageParams
+
+选择图片的请求参数。
+
+#### Properties
+
+##### count?
+
+> `optional` **count**: `number`
+
+最多可选图片张数。
+
+##### imageId?
+
+> `optional` **imageId**: `string`
+
+H5 场景下可复用的 input 元素 ID。
+
+##### sizeType?
+
+> `optional` **sizeType**: [`ChooseImageSizeType`](#chooseimagesizetype)[]
+
+允许返回的图片尺寸类型。
+
+##### sourceType?
+
+> `optional` **sourceType**: [`ChooseImageSourceType`](#chooseimagesourcetype)[]
+
+允许选择的图片来源。
+
+<a id="chooseimageresult"></a>
+### ChooseImageResult
+
+选择图片结果。
+
+#### Properties
+
+##### tempFilePaths
+
+> **tempFilePaths**: `string`[]
+
+图片临时文件路径列表。
+
+##### tempFiles
+
+> **tempFiles**: [`ChooseImageFile`](#chooseimagefile)[]
+
+图片临时文件信息列表。
+
+<a id="chooseimagesizetype"></a>
+### ChooseImageSizeType
+
+> **ChooseImageSizeType**: `"original"` \| `"compressed"`
+
+可选的图片尺寸类型。
+
+<a id="chooseimagesourcetype"></a>
+### ChooseImageSourceType
+
+> **ChooseImageSourceType**: `"album"` \| `"camera"` \| `"user"` \| `"environment"`
+
+可选的图片来源类型。
+
+<a id="chooseimagefile"></a>
+### ChooseImageFile
+
+选择图片返回的单个文件信息。
+
+#### Properties
+
+##### originalFileObj?
+
+> `optional` **originalFileObj**: `File`
+
+原始浏览器 File 对象。
+
+##### path
+
+> **path**: `string`
+
+本地临时文件路径。
+
+##### size
+
+> **size**: `number`
+
+文件大小，单位 B。
+
+##### type?
+
+> `optional` **type**: `string`
+
+文件 MIME 类型。
+
+<a id="compressimageparams"></a>
+### CompressImageParams
+
+压缩图片的请求参数。
+
+#### Properties
+
+##### compressedHeight?
+
+> `optional` **compressedHeight**: `number`
+
+压缩后图片高度，单位 px。
+
+##### compressedWidth?
+
+> `optional` **compressedWidth**: `number`
+
+压缩后图片宽度，单位 px。
+
+##### quality?
+
+> `optional` **quality**: `number`
+
+压缩质量，范围 0 - 100，仅对 jpg 生效。
+
+##### src
+
+> **src**: `string`
+
+图片路径。
+
+<a id="compressimageresult"></a>
+### CompressImageResult
+
+压缩图片结果。
+
+#### Properties
+
+##### tempFilePath
+
+> **tempFilePath**: `string`
+
+压缩后图片的临时文件路径。