---
name: "albumSettingEdit"
mode: "kit"
versionRequirements:
  - { name: "@tuya-miniapp/cloud-api", version: "1.0.5" }
---

## albumSettingEdit

> [VERSION] @tuya-miniapp/cloud-api >= 1.0.5

### 描述

时光相册配置编辑 api

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `params` | `AlbumSettingEditReq` | 是 | - | 请求体 |

### 引用对象

##### `interface` AlbumSettingEditReq

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `albumId` | `string` | 相册 id |
| `stockId` | `string` | 库存 id |
| `gid` | `string` | 家庭 id |
| `albumName` | `string` | 相册名称 |
| `enableStatus` | `0 \| 1` | 启用状态 |
| `timedCaptureConfig` | `string[]` | 定时拍摄配置 |
| `smartCaptureConfig` | `VisionBoxEvent[]` | 智能拍摄配置 |

##### `enum` VisionEventType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `VisionEventType.PRESET` | `0` | 预置事件 |
| `VisionEventType.CUSTOM` | `1` | 自定义事件 |


### 示例代码

#### 请求示例

```typescript
import { albumSettingEdit } from '@tuya-miniapp/cloud-api';

albumSettingEdit({
  albumId: 'album-1',
  stockId: '1',
  gid: '194137',
  albumName: '宝宝房',
  enableStatus: 1,
  timedCaptureConfig: ['12:00'],
  smartCaptureConfig: [{ eventCode: 'person', eventValue: '1', eventType: 0 }],
})
  .then((ok) => console.log(ok))
  .catch(console.error);
```

#### 返回示例

```json
true
```