---
name: "getLightLibrariesData"
mode: "kit"
versionRequirements:
  - { name: "@tuya-miniapp/cloud-api", version: "1.0.5" }
  - { name: "小程序基础库", version: "2.18.1" }
---

## getLightLibrariesData

> [VERSION] @tuya-miniapp/cloud-api >= 1.0.5 | 小程序基础库 >= 2.18.1

> 💡 该接口为云能力，需开通授权后使用，关于云能力可[查看文档](/cn/miniapp/common/desc/tech-stack/api)目前云能力在开发者工具环境无法使用，需要打包后或真机调试使用。
> [照明情景库](https://developer.tuya.com/cn/docs/iot/scene_library?id=Kbn3oiww4klzq) 需要在 涂鸦开发者平台产品功能定义页面开通高级能力后方可使用，否则调用云能力会出现失败的情况

### 描述

获取设备或群组所绑定的照明（情景/音乐等）库，然后将库中的数据输出。例如，情景库中的情景参数信息。

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `data` | `GetLightLibrariesDataParams` | 是 | - | 请求参数：bizId（业务 ID）、bizType（业务类型，0：设备 1：群组）、libType（库类型。SCENE_LIB：情景库。MUSIC_LIB：音乐库。SCENE_IMAGE_LIB：情景图像库。）、libDataType（库数据类型。0：所有。如果为 0，那么任意一个数据类型有更新，则认为库是可更新的。1：基础数据，此类数据是涂鸦提供的绑定在面板 uiId 层面的数据。2：高级数据，此类数据是用户在微应用后台维护的数据。） |

### 引用对象

##### `interface` GetLightLibrariesDataParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `bizId` | `string` | 业务 ID |
| `bizType` | `0 \| 1` | 业务类型 0：设备 1：群组 |
| `libType` | `"SCENE_LIB" \| "MUSIC_LIB" \| "SCENE_IMAGE_LIB"` | 库类型。SCENE_LIB：情景库。MUSIC_LIB：音乐库。SCENE_IMAGE_LIB：情景图像库。 |
| `libDataType` | `0 \| 1 \| 2` | 库数据类型。0：所有。如果为 0，那么任意一个数据类型有更新，则认为库是可更新的。1：基础数据，此类数据是涂鸦提供的绑定在面板 uiId 层面的数据。2：高级数据，此类数据是用户在微应用后台维护的数据。 |

##### `interface` DataItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `iconDisplayType` | `number` | 数据的图标展示类型 1：A 类 2：B 类 3：C 类 4：D 类 |
| `iconDisplaySize` | `string` | 数据的图标展示大小（例如 "343*100"） |
| `items` | `SceneLibraryItem[]` | 具体数据 |

##### `type` SceneLibraryItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `sceneId` | `number` | 情景 ID |
| `sceneName` | `string` | 情景名称 |
| `sort` | `number` | 排序值 |
| `dpCode` | `string` | DP code |
| `icon` | `string` | 情景图标 |
| `sceneData` | `string` | 情景参数 |
| `sceneDesc` | `string` | 情景描述 |


### 示例代码

#### 请求示例

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

getLightLibrariesData({
  bizId: 'vdevo167504******003',
  bizType: 0,
  libType: 'SCENE_LIB',
  libDataType: 0,
})
  .then((response) => {
    console.log(response);
  })
  .catch();
```

#### 返回示例

```json
[
  {
    "plateIconDisplayType": 0,
    "plateId": 2774,
    "data": [
      {
        "iconDisplayType": 3,
        "iconDisplaySize": "166*102",
        "items": [
          {
            "sceneName": "晚安",
            "icon": "https://images.tuyacn.com/light/library/icon/bixc94box***.png",
            "sort": 0,
            "sceneDesc": "50",
            "dpCode": "sceneData",
            "sceneId": 3537,
            "sceneData": "000e0d0000000000000000c80000"
          }
        ]
      }
    ],
    "plateName": "温馨生活",
    "plateIcon": ""
  },
  {
    "plateIconDisplayType": 0,
    "plateId": 2775,
    "data": [
      {
        "iconDisplayType": 3,
        "iconDisplaySize": "166*102",
        "items": [
          {
            "sceneName": "海洋",
            "icon": "https://images.tuyacn.com/light/library/icon/bixbr00rh***.png",
            "sort": 4,
            "sceneDesc": "0",
            "dpCode": "sceneData",
            "sceneId": 3543,
            "sceneData": "1746460200f003e803e80000000046460200dc02bc03e800000000"
          }
        ]
      }
    ],
    "plateName": "主题心情",
    "plateIcon": ""
  }
]
```