---
name: "predictLightScenes"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "1.7.60" }
platform:
  - "iOS"
  - "Android"
async: true
title: "predictLightScenes - 预测灯光场景"
---

## predictLightScenes

> [VERSION] AIKit >= 2.0.1 | @ray-js/ray >= 1.7.60

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

预测灯光场景

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `roomId` | `number` | 是 | - | `2.0.1` | 房间id |
| `generateSceneStyles` | `SceneStyleInfo[]` | 是 | - | `2.0.1` | 场景风格列表,开灯比例百分比 |
| `sceneType` | `number` | 是 | - | `2.0.1` | 场景类型 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: LightSceneGenerateLightSceneInfo[]) => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 引用对象

##### `interface` SceneStyleInfo

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `name` | `string` | `2.0.1` | 风格名称 |
| `turnOnPercent` | `number` | `2.0.1` | 开灯比例百分比 |
| `sceneDataList` | `SceneData[]` | `2.0.1` | 情景库数据列表,以此参数是否存在数据区分是情景库还是生成式风格 |
| `nameRosettaKey` | `string` | `2.0.1` | 生成风格名称key,唯一标识 |

##### `interface` LightSceneGenerateLightSceneInfo

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `parentRegionId` | `string` | `2.0.1` | 父区域ID |
| `sceneType` | `number` | `2.0.1` | 场景类型 |
| `name` | `string` | `2.0.1` | 场景名称 |
| `icon` | `string` | `2.0.1` | 场景图标 |
| `matchType` | `number` | `2.0.1` | 匹配类型 |
| `actions` | `LightSceneGenerateLightSceneAction[]` | `2.0.1` | 场景动作列表 |

##### `type` SceneData

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `productId` | `string` | `2.0.1` | 产品id |
| `sceneData` | `string` | `2.0.1` | 情景库数据 |
| `sceneCellBackground` | `string` | `2.0.1` | 情景图 |
| `sceneId` | `string` | `2.0.1` | 情景id |
| `dpCode` | `string` | `2.0.1` | 情景dpCode |

##### `type` LightSceneGenerateLightSceneAction

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `actionExecutor` | `string` | `2.0.1` | 动作执行器 |
| `entityId` | `string` | `2.0.1` | 设备或群组ID |
| `entityName` | `string` | `2.0.1` | 设备或群组名称 |
| `executorProperty` | `Record<string, any>` | `2.0.1` | 执行器属性 |
| `extraProperty` | `Record<string, any>` | `2.0.1` | 扩展属性 |


### 示例代码

#### 基础调用

```tsx
import { ai } from '@ray-js/ray'

const { predictLightScenes } = ai;

predictLightScenes({
  roomId: 0,
  generateSceneStyles: [{ name: 'example' }],
  sceneType: 0,
  success: (result) => {
    console.log('predictLightScenes success', result);
  },
  fail: (error) => {
    console.log('predictLightScenes fail', error.errorMsg);
  },
});
```