# liveViewManager

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

## 模块概述

> phone | 2in1 | tablet

Live View Kit（实况窗服务）是HarmonyOS提供的一种实时活动展示服务，支持应用将订单或者服务的实时状态信息呈现在设备关键界面（如通知中心、状态栏、横幅卡片、锁屏），帮助用户快速查看和即时处理正在进行的任务。

本模块提供的基础能力包括：

* 基础生命周期管理：提供创建、更新、结束实况通知接口（对应startLiveView、updateLiveView、stopLiveView接口），支持应用调用接口创建、更新和结束实况通知，在熄屏、锁屏、横幅、通知中心和状态栏等位置，展示用户关注事件（如外卖即时配送，出行打车订单）的实时进展。

* 基于条件的生命周期管理：基于地理位置的实况窗提醒是从6.1.0(23)开始支持的高级功能。该功能允许开发者注册地理围栏条件，当设备进入或离开地理围栏后，自动触发实况窗的创建或结束，实现基于地理位置的实况窗提醒服务。

* 实况窗信息查询：提供getActiveLiveView、isLiveViewEnabled、isGeofenceTriggerEnabled接口，支持应用在创建或更新实况窗之前查询实况相关信息和开关状态。

* 模板管理：提供基于模板定义实况窗卡片、胶囊、小外屏等展示内容的能力，在锁屏、通知中心、状态栏等位置展示，建立开发者和用户的连接。

* 提醒方式管理：支持配置实况通知是否响铃振动、状态栏胶囊动效、展开横幅提醒。

### 基本概念

> phone | 2in1 | tablet

* 应用场景event：是实况窗对象LiveView中用于标识应用场景类型的关键字段。该字段决定了实况窗的适用场景，开发者需根据实际业务选择对应的场景值。

* 实况窗id：是实况窗对象LiveView中用于唯一标识一个实况窗的关键字段。由开发者自行生成，用于创建、更新、结束和查询实况窗。

* 实况窗布局：实况窗在展示形态上分为卡片态和胶囊态两种。卡片态又分为固定区、辅助区和扩展区三个部分。

* 固定区是用于显示实时活动的核心信息和用户最关注的动态内容，位于卡片顶部左侧和中间区域。

* 辅助区用于显示实时活动的次要信息，位于卡片上固定区的右侧区域，若选择展示辅助区，则会挤占固定区宽度。

* 扩展区用于显示实时活动的详细信息，位于卡片固定区和辅助区下方区域，支持进度可视化、强调文本、左右文本、赛事比分、导航定制样式。

* 胶囊是实况窗在状态栏的展示形式，点击胶囊可展开实况窗横幅卡片查看详情。

* 扩展区模板类型layoutType：是定义实况窗扩展区模板类型的枚举。扩展区是实况窗卡片中展示详细信息和进度的重要内容区域，不同的模板类型适用于不同的业务场景。

* 存档时间keepTime：是用于控制实况窗结束后的存档时间。即在调用stopLiveView结束实况窗后，实况窗仍在通知中心保留展示的时长。

### 关键Class/Interface介绍

> phone | 2in1 | tablet

```yaml
  LiveView:  实况窗对象参数
    ├── id
    ├── event
    ├── 其他参数......
    └── LiveViewData: 实况窗详细信息
        ├── PrimaryData: 卡片形态内容
            ├── LayoutData: 扩展区数据
                ├── ProgressLayout: 进度可视化模板扩展区参数
                ├── FlightLayout: 左右文本模板扩展区参数
                ├── ScoreLayout: 赛事比分模板扩展区参数
                ├── PickupLayout: 强调文本模板扩展区参数
                ├── NavigationLayout: 导航模板扩展区参数
                └── CustomLayout: 自定义模板扩展区参数
            └── ExtensionData: 辅助区内容
        ├── CapsuleData: 实况胶囊形态内容
            ├── TextCapsule: 文本胶囊参数
            ├── TimerCapsule: 计时器胶囊参数
            └── ProgressCapsule: 进度胶囊参数
        └── ExternalData: 外屏形态模板参数
```

### API组合使用关系

> phone | 2in1 | tablet

* 本地实况窗创建、更新和结束流程

```yaml
  1. 前置检查
     isLiveViewEnabled()  检查应用实况窗开关是否开启，如开启则继续下一步。
                                                   
  2. 创建实况窗
     startLiveView(liveView)  创建一个liveView实况窗实例。
                                                  
  3. 更新实况窗（可多次调用）
     updateLiveView(liveView)  更新实况窗为liveView实例中的内容。
                                                   
  4. 结束实况窗
     stopLiveView(liveView)  结束一个liveView实况窗实例。
```

* 通过条件触发创建实况窗的流程

```yaml
  1. 前置检查
     isGeofenceTriggerEnabled()  查询基于地理位置的实况窗提醒开关，如果开关使能，则继续下一步。
                                                   
  2. 注册一个由条件触发创建的实况窗
     startLiveViewByTrigger(liveView，trigger)注册一个由条件trigger触发创建的liveView实况窗实例。
                                                   
  3. 等待条件满足
     设备进入/离开指定地理围栏。
                                                   
  4. 条件触发
     系统自动创建并展示实况（无需开发者调用接口创建）。
                                                  
  5. 实况窗结束
     实况窗展示liveViewManager.Trigger.displayTime时长后自动结束。
```

* 通过条件触发结束实况窗的流程

```yaml
  1. 前置检查
     isLiveViewEnabled()  检查应用实况窗开关是否开启，如开启则继续下一步。
                                                    
  2. 创建实况窗
     startLiveView(liveView)  创建一个liveView实况窗实例。
                                                   
  3. 更新实况窗（可选，可多次调用）
     updateLiveView(liveView)  更新实况窗为liveView实例中的内容。
 
  4. 前置检查
     isGeofenceTriggerEnabled()  查询基于地理位置的实况窗提醒开关, 如果开关使能，则继续下一步。
 
  5. 注册一个由条件触发结束的实况窗
     stopLiveViewByTrigger(liveView, trigger)  注册一个由条件trigger触发结束的liveView实况窗实例。
                                                 
  6. 等待条件满足
     设备进入/离开指定地理围栏。
                                                  
  7. 条件触发
     系统自动结束实况窗（无需开发者调用接口结束）。
```

**起始版本：** 4.1.0(11)

## 导入模块

> phone | 2in1 | tablet

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
```

**设备行为差异：** 该模块在Phone、Tablet中可正常调用，在其他设备类型中无效果。

## liveViewManager.isLiveViewEnabled

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

isLiveViewEnabled(): Promise<boolean>

查看应用实况窗开关，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

**返回值：**

|类型|说明|
|:---------------|:-------------------------------------------------------------------|
|Promise<boolean>|以Promise形式返回当前应用实况窗的开关状态。 **●** true表示实况窗开关开启。 **●** false表示实况窗开关关闭。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  liveViewManager.isLiveViewEnabled().then((isEnabled: boolean) => {
    hilog.info(0x0000, 'testTag', 'Succeeded in checking whether liveView is enabled, liveView is : %{public}s', isEnabled);
  }).catch((err: BusinessError) => {
    hilog.error(0x0000, 'testTag', 'Failed to check whether liveView is enabled: %{public}d %{public}s', err.code, err.message);
  });
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, 'testTag', 'Failed to check whether liveView is enabled: %{public}d %{public}s', e.code, e.message);
}
```

## liveViewManager.startLiveView

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

startLiveView(liveView: LiveView): Promise<LiveViewResult>

创建实况窗，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

**参数：**

|参数名|类型|必填|说明|
|:-------|:--------------------|:-|:-------|
|liveView|[LiveView](#liveview)|是|一个实况窗实例。|

**返回值：**

|类型|说明|
|:-----------------------------------------|:--------------------|
|Promise<[LiveViewResult](#liveviewresult)>|Promise对象，返回创建实况窗的结果。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500004](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500004-实况窗开关关闭)|LiveView is not enabled.|
|[1003500005](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500005-实况窗权益未申请)|The right of liveView is not enabled.|
|[1003500006](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500006-实况窗已存在)|The liveView already exists.|
|[1003500007](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500007-无法连接服务器)|Couldn't connect to server.|
|[1003500008](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500008-实况窗频度超过限制)|Over max number liveViews per second.|
|[1003500021](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500021-系统无法找到实况窗卡片自定义扩展区的extensionability)|The system failed to find the ExtensionAbility instance for the custom Live View widget template. 适用版本：26.0.0+|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Want, wantAgent } from '@kit.AbilityKit';

async function startLiveView(): Promise<void> {
  try {
    // 定义创建的liveView
    let liveView: liveViewManager.LiveView = {
      id: 123,
      event: 'PICK_UP',
      sequence: 1,
      isMute: false,
      liveViewData: {
        primary: {
          title: '餐品已备好',
          content: [
            { text: '请前往' },
            { text: '一号窗口', textColor: '#FFFF0000' }
          ],
          keepTime: 1,
          clickAction: await buildWantAgent(), // 用于构建点击动作的跳转代理
          extensionData: {
            text: '待取餐',
            type: liveViewManager.ExtensionType.EXTENSION_TYPE_COMMON_TEXT
          },
          layoutData: {
            layoutType: liveViewManager.LayoutType.LAYOUT_TYPE_PICKUP,
            title: '取餐码',
            content: '72988',
            underlineColor: '#FFFF0000',
            descPic: 'coffee.jpg'
          }
        },
        capsule: {
          type: liveViewManager.CapsuleType.CAPSULE_TYPE_TEXT,
          status: 1,
          icon: 'coffee.jpg',
          title: '待取餐',
          content: '取餐码：72988',
          backgroundColor: '#FF308977'
        }
      }
    };

    liveViewManager.startLiveView(liveView).then((liveViewResult: liveViewManager.LiveViewResult) => {
      hilog.info(0x0000, 'testTag', 'Succeeded in starting liveView, result: %{public}s', JSON.stringify(liveViewResult));
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', 'Failed to start liveView: %{public}d %{public}s', err.code, err.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to start liveView: %{public}d %{public}s', e.code, e.message);
  }
}

async function buildWantAgent(): Promise<Want> {
  const wantAgentInfo: wantAgent.WantAgentInfo = {
    wants: [
      {
        bundleName: 'xxx.xxx.xxx',
        abilityName: 'EntryAbility'
      } as Want
    ],
    actionType: wantAgent.OperationType.START_ABILITIES,
    requestCode: 0,
    actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  try {
    const agent = await wantAgent.getWantAgent(wantAgentInfo);
    return agent;
  } catch (e) {
    const err: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get wantAgent: %{public}s', err.message);
    throw e as Error;
  }
}
```

## liveViewManager.updateLiveView

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

updateLiveView(liveView: LiveView): Promise<LiveViewResult>

更新实况窗，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

**参数：**

|参数名|类型|必填|说明|
|:-------|:--------------------|:-|:--------------------------------------|
|liveView|[LiveView](#liveview)|是|一个实况窗实例。对于非必填字段，若无特殊说明，则不携带时默认继承上一次的状态。|

**返回值：**

|类型|说明|
|:-----------------------------------------|:--------------------|
|Promise<[LiveViewResult](#liveviewresult)>|Promise对象，返回更新实况窗的结果。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500004](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500004-实况窗开关关闭)|LiveView is not enabled.|
|[1003500008](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500008-实况窗频度超过限制)|Over max number liveViews per second.|
|[1003500009](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500009-实况窗id不存在)|The liveView does not exist.|
|[1003500010](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500010-实况窗已结束)|The liveView has ended.|
|[1003500011](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500011-实况窗顺序不正确)|The liveView sequence is incorrect.|
|[1003500021](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500021-系统无法找到实况窗卡片自定义扩展区的extensionability)|The system failed to find the ExtensionAbility instance for the custom Live View widget template. 适用版本：26.0.0+|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Want, wantAgent } from '@kit.AbilityKit';

async function updateLiveView(): Promise<void> {
  try {
    // 定义更新的liveView
    let liveView: liveViewManager.LiveView = {
      id: 123,
      event: 'PICK_UP',
      sequence: 2,
      isMute: false,
      liveViewData: {
        primary: {
          title: '餐品已备好',
          content: [
            { text: '请前往' },
            { text: '一号窗口', textColor: '#FFFF0000' }
          ],
          keepTime: 1,
          clickAction: await buildWantAgent(), // 用于构建点击动作的跳转代理
          extensionData: {
            text: '待取餐',
            type: liveViewManager.ExtensionType.EXTENSION_TYPE_COMMON_TEXT
          },
          layoutData: {
            layoutType: liveViewManager.LayoutType.LAYOUT_TYPE_PICKUP,
            title: '取餐码',
            content: '72988',
            underlineColor: '#FFFF0000',
            descPic: 'coffee.jpg'
          }
        },
        capsule: {
          type: liveViewManager.CapsuleType.CAPSULE_TYPE_TEXT,
          status: 1,
          icon: 'coffee.jpg',
          title: '待取餐',
          content: '取餐码：72988',
          backgroundColor: '#FF308977'
        }
      }
    };

    liveViewManager.updateLiveView(liveView).then((liveViewResult: liveViewManager.LiveViewResult) => {
      hilog.info(0x0000, 'testTag', 'Succeeded in updating liveView, result: %{public}s', JSON.stringify(liveViewResult));
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', 'Failed to update liveView: %{public}d %{public}s', err.code, err.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to update liveView: %{public}d %{public}s', e.code, e.message);
  }
}

async function buildWantAgent(): Promise<Want> {
  const wantAgentInfo: wantAgent.WantAgentInfo = {
    wants: [
      {
        bundleName: 'xxx.xxx.xxx',
        abilityName: 'EntryAbility'
      } as Want
    ],
    actionType: wantAgent.OperationType.START_ABILITIES,
    requestCode: 0,
    actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  try {
    const agent = await wantAgent.getWantAgent(wantAgentInfo);
    return agent;
  } catch (e) {
    const err: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get wantAgent: %{public}s', err.message);
    throw e as Error;
  }
}
```

## liveViewManager.stopLiveView

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

stopLiveView(liveView: LiveView): Promise<LiveViewResult>

结束实况窗，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

**参数：**

|参数名|类型|必填|说明|
|:-------|:--------------------|:-|:--------------------------------------|
|liveView|[LiveView](#liveview)|是|一个实况窗实例。对于非必填字段，若无特殊说明，则不携带时默认继承上一次的状态。|

**返回值：**

|类型|说明|
|:-----------------------------------------|:--------------------|
|Promise<[LiveViewResult](#liveviewresult)>|Promise对象，返回结束实况窗的结果。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500004](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500004-实况窗开关关闭)|LiveView is not enabled.|
|[1003500008](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500008-实况窗频度超过限制)|Over max number liveViews per second.|
|[1003500009](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500009-实况窗id不存在)|The liveView does not exist.|
|[1003500010](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500010-实况窗已结束)|The liveView has ended.|
|[1003500011](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500011-实况窗顺序不正确)|The liveView sequence is incorrect.|
|[1003500021](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500021-系统无法找到实况窗卡片自定义扩展区的extensionability)|The system failed to find the ExtensionAbility instance for the custom Live View widget template. 适用版本：26.0.0+|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Want, wantAgent } from '@kit.AbilityKit';

async function stopLiveView(): Promise<void> {
  try {
    // 定义要结束的liveView
    let liveView: liveViewManager.LiveView = {
      id: 123,
      event: 'PICK_UP',
      sequence: 3,
      isMute: false,
      liveViewData: {
        primary: {
          title: '餐品已备好',
          content: [
            { text: '请前往' },
            { text: '一号窗口', textColor: '#FFFF0000' }
          ],
          keepTime: 1,
          clickAction: await buildWantAgent(), // 用于构建点击动作的跳转代理
          extensionData: {
            text: '待取餐',
            type: liveViewManager.ExtensionType.EXTENSION_TYPE_COMMON_TEXT
          },
          layoutData: {
            layoutType: liveViewManager.LayoutType.LAYOUT_TYPE_PICKUP,
            title: '取餐码',
            content: '72988',
            underlineColor: '#FFFF0000',
            descPic: 'coffee.jpg'
          }
        },
        capsule: {
          type: liveViewManager.CapsuleType.CAPSULE_TYPE_TEXT,
          status: 1,
          icon: 'coffee.jpg',
          title: '待取餐',
          content: '取餐码：72988',
          backgroundColor: '#FF308977'
        }
      }
    };

    liveViewManager.stopLiveView(liveView).then((liveViewResult: liveViewManager.LiveViewResult) => {
      hilog.info(0x0000, 'testTag', 'Succeeded in stopping liveView, result: %{public}s', JSON.stringify(liveViewResult));
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', 'Failed to stop liveView: %{public}d %{public}s', err.code, err.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to stop liveView: %{public}d %{public}s', e.code, e.message);
  }
}

async function buildWantAgent(): Promise<Want> {
  const wantAgentInfo: wantAgent.WantAgentInfo = {
    wants: [
      {
        bundleName: 'xxx.xxx.xxx',
        abilityName: 'EntryAbility'
      } as Want
    ],
    actionType: wantAgent.OperationType.START_ABILITIES,
    requestCode: 0,
    actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  try {
    const agent = await wantAgent.getWantAgent(wantAgentInfo);
    return agent;
  } catch (e) {
    const err: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get wantAgent: %{public}s', err.message);
    throw e as Error;
  }
}
```

## liveViewManager.getActiveLiveView

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

getActiveLiveView(id: number): Promise<LiveView>

获取活动的liveView，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

**参数：**

|参数名|类型|必填|说明|
|:--|:-----|:-|:-------------------------------------|
|id|number|是|实况窗的id，取值范围为[-2147483648, 2147483647]。|

**返回值：**

|类型|说明|
|:-----------------------------|:--------------------|
|Promise<[LiveView](#liveview)>|Promise对象，返回活动的实况窗实例。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500009](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500009-实况窗id不存在)|The liveView does not exist.|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 定义需要查询的实况窗id
const id = 1;
try {
  liveViewManager.getActiveLiveView(id).then((liveView: liveViewManager.LiveView) => {
    hilog.info(0x0000, 'testTag', 'Succeeded in getting active liveView, liveView is : %{public}s', JSON.stringify(liveView));
  }).catch((err: BusinessError) => {
    hilog.error(0x0000, 'testTag', 'Failed to get active liveView: %{public}d %{public}s', err.code, err.message);
  });
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, 'testTag', 'Failed to get active liveView: %{public}d %{public}s', e.code, e.message);
}
```

## liveViewManager.isGeofenceTriggerEnabled

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

isGeofenceTriggerEnabled(): Promise<boolean>

查询基于地理位置的实况窗提醒开关，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

**返回值：**

|类型|说明|
|:---------------|:--------------------------------------------------------------------------------------------|
|Promise<boolean>|以Promise形式返回当前基于地理位置的实况窗提醒的开关状态。 **●** true表示基于地理位置的实况窗提醒开关开启。 **●** false表示基于地理位置的实况窗提醒开关关闭。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  liveViewManager.isGeofenceTriggerEnabled().then((isEnabled: boolean) => {
    hilog.info(0x0000, 'testTag', 'Succeeded in checking whether geofence trigger is enabled, geofence trigger is : %{public}s', isEnabled);
  }).catch((err: BusinessError) => {
    hilog.error(0x0000, 'testTag', 'Failed to check whether geofence trigger is enabled: %{public}d %{public}s', err.code, err.message);
  });
} catch (err) {
  let e: BusinessError = err as BusinessError;
  hilog.error(0x0000, 'testTag', 'Failed to check whether geofence trigger is enabled: %{public}d %{public}s', e.code, e.message);
}
```

## liveViewManager.startLiveViewByTrigger

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

startLiveViewByTrigger(liveView: LiveView, trigger:Trigger): Promise<LiveViewResult>

注册一个由条件触发创建的实况窗。调用startLiveViewByTrigger后，系统会记录trigger条件，但不会立即创建实况窗。当条件满足时，系统会自动创建实况窗，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

**参数：**

|参数名|类型|必填|说明|
|:-------|:--------------------|:-|:----------|
|liveView|[LiveView](#liveview)|是|一个实况窗实例。|
|trigger|[Trigger](#trigger)|是|触发实况窗的条件对象。|

**返回值：**

|类型|说明|
|:-----------------------------------------|:---------------------------|
|Promise<[LiveViewResult](#liveviewresult)>|Promise对象，返回由条件触发创建的实况窗注册结果。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[801](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section801-该设备不支持此api)|Capability not supported. The device model does not support geofencing.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500004](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500004-实况窗开关关闭)|LiveView is not enabled.|
|[1003500005](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500005-实况窗权益未申请)|The right of liveView is not enabled.|
|[1003500006](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500006-实况窗已存在)|The liveView already exists.|
|[1003500007](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500007-无法连接服务器)|Couldn't connect to server.|
|[1003500008](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500008-实况窗频度超过限制)|Over max number liveViews per second.|
|[1003500017](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500017-超过条件实况窗次数限制)|Over max number liveViews by trigger.|
|[1003500018](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500018-基于地理位置的实况窗提醒开关关闭)|Geofencing-based liveView is not enabled.|
|[1003500019](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500019-位置功能的开关关闭)|The location switch is off.|
|[1003500020](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500020-感知与提醒的开关关闭)|The "Awareness & suggestions" switch of the location-based service is turned off.|
|[1003500021](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500021-系统无法找到实况窗卡片自定义扩展区的extensionability)|The system failed to find the ExtensionAbility instance for the custom Live View widget template. 适用版本：26.0.0+|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Want, wantAgent } from '@kit.AbilityKit';

async function startLiveViewByTrigger(): Promise<void> {
  try {
    // 定义创建的liveView
    let liveView: liveViewManager.LiveView = {
      id: 0, // 实况窗ID，开发者生成。
      event: 'EXPRESS', // 实况窗的应用场景。EXPRESS：快递。
      liveViewData: {
        primary: {
          title: '快递已送达',
          content: [
            { text: '请前往' },
            { text: ' XXX店 ', textColor: '#FF0A59F7' },
            { text: '取快递' }
          ],
          keepTime: 15,
          clickAction: await buildWantAgent(), // 用于构建点击动作的跳转代理
          layoutData: {
            layoutType: liveViewManager.LayoutType.LAYOUT_TYPE_PICKUP,
            title: '快递码',
            content: '72988',
            underlineColor: '#FF0A59F7',
            descPic: 'express.png' // 扩展区右侧产品描述图，取值为"/resources/rawfile"路径下的文件名或image.PixelMap
          }
        },
        capsule: {
          type: liveViewManager.CapsuleType.CAPSULE_TYPE_TEXT,
          status: 1,
          icon: 'express.jpg',
          title: '快递码',
          content: '快递码：72988',
          backgroundColor: '#FF308977'
        }
      }
    };
    let trigger: liveViewManager.Trigger = {
      type: liveViewManager.TriggerType.TRIGGER_TYPE_GEOFENCE,
      displayTime: 15,
      condition: {
        longitude: 116.3971356415625,
        latitude: 39.91800603311188,
        coordinateSystemType: liveViewManager.CoordinateSystemType.COORDINATE_TYPE_GCJ02,
        monitorEvent: liveViewManager.MonitorEvent.MONITOR_TYPE_ENTRY,
        radius: 2000,
        delayTime: 0
      }
    };

    liveViewManager.startLiveViewByTrigger(liveView, trigger).then((liveViewResult: liveViewManager.LiveViewResult) => {
      hilog.info(0x0000, 'testTag', 'Succeeded in starting liveView by trigger, result: %{public}s', JSON.stringify(liveViewResult));
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', 'Failed to start liveView by trigger: %{public}d %{public}s', err.code, err.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to start liveView by trigger: %{public}d %{public}s', e.code, e.message);
  }
}

async function buildWantAgent(): Promise<Want> {
  const wantAgentInfo: wantAgent.WantAgentInfo = {
    wants: [
      {
        bundleName: 'xxx.xxx.xxx',
        abilityName: 'EntryAbility'
      } as Want
    ],
    actionType: wantAgent.OperationType.START_ABILITIES,
    requestCode: 0,
    actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  try {
    const agent = await wantAgent.getWantAgent(wantAgentInfo);
    return agent;
  } catch (e) {
    const err: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get wantAgent: %{public}s', err.message);
    throw e as Error;
  }
}
```

## liveViewManager.stopLiveViewByTrigger

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

stopLiveViewByTrigger(liveView: LiveView, trigger:Trigger): Promise<LiveViewResult>

注册一个由条件触发结束的实况窗。调用stopLiveViewByTrigger后，系统会记录trigger条件，但不会立即结束实况窗。当条件满足时，系统会自动结束实况窗，使用Promise异步回调。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

**参数：**

|参数名|类型|必填|说明|
|:-------|:--------------------|:-|:----------|
|liveView|[LiveView](#liveview)|是|一个实况窗实例。|
|trigger|[Trigger](#trigger)|是|触发实况窗的条件对象。|

**返回值：**

|类型|说明|
|:-----------------------------------------|:---------------------------|
|Promise<[LiveViewResult](#liveviewresult)>|Promise对象，返回注册由条件触发结束实况窗的结果。|

**错误码：**

以下错误码的详细介绍请参见[ArkTS API错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code)。

|错误码ID|错误信息|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|[401](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section401-参数检查失败)|Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.|
|[801](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-universal#section801-该设备不支持此api)|Capability not supported. The device model does not support geofencing.|
|[1003500001](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500001-系统错误)|Internal error.|
|[1003500002](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500002-序列化或反序列化失败)|Marshalling or unmarshalling error.|
|[1003500003](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500003-连接服务失败)|Failed to connect service.|
|[1003500004](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500004-实况窗开关关闭)|LiveView is not enabled.|
|[1003500008](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500008-实况窗频度超过限制)|Over max number liveViews per second.|
|[1003500009](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500009-实况窗id不存在)|The liveView does not exist.|
|[1003500010](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500010-实况窗已结束)|The liveView has ended.|
|[1003500011](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500011-实况窗顺序不正确)|The liveView sequence is incorrect.|
|[1003500017](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500017-超过条件实况窗次数限制)|Over max number liveViews by trigger.|
|[1003500018](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500018-基于地理位置的实况窗提醒开关关闭)|Geofencing-based liveView is not enabled.|
|[1003500019](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500019-位置功能的开关关闭)|The location switch is off.|
|[1003500020](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500020-感知与提醒的开关关闭)|The "Awareness & suggestions" switch of the location-based service is turned off.|
|[1003500021](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-error-code#section1003500021-系统无法找到实况窗卡片自定义扩展区的extensionability)|The system failed to find the ExtensionAbility instance for the custom Live View widget template. 适用版本：26.0.0+|

**示例：**

```typescript
import { liveViewManager } from '@kit.LiveViewKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { Want, wantAgent } from '@kit.AbilityKit';

async function stopLiveViewByTrigger(): Promise<void> {
  try {
    // 定义要结束的liveView
    let liveView: liveViewManager.LiveView = {
      id: 0, // 实况窗ID，开发者生成。
      event: 'EXPRESS', // 实况窗的应用场景。EXPRESS：快递。
      liveViewData: {
        primary: {
          title: '快递已送达',
          content: [
            { text: '请前往' },
            { text: ' XXX店 ', textColor: '#FF0A59F7' },
            { text: '取快递' }
          ],
          keepTime: 15,
          clickAction: await buildWantAgent(), // 用于构建点击动作的跳转代理
          layoutData: {
            layoutType: liveViewManager.LayoutType.LAYOUT_TYPE_PICKUP,
            title: '快递码',
            content: '72988',
            underlineColor: '#FF0A59F7',
            descPic: 'express.png' // 扩展区右侧产品描述图，取值为"/resources/rawfile"路径下的文件名或image.PixelMap
          }
        },
        capsule: {
          type: liveViewManager.CapsuleType.CAPSULE_TYPE_TEXT,
          status: 1,
          icon: 'express.jpg',
          title: '快递码',
          content: '快递码：72988',
          backgroundColor: '#FF308977'
        }
      }
    };
    let trigger: liveViewManager.Trigger = {
      type: liveViewManager.TriggerType.TRIGGER_TYPE_GEOFENCE,
      displayTime: 15,
      condition: {
        longitude: 116.3971356415625,
        latitude: 39.91800603311188,
        coordinateSystemType: liveViewManager.CoordinateSystemType.COORDINATE_TYPE_GCJ02,
        monitorEvent: liveViewManager.MonitorEvent.MONITOR_TYPE_LEAVE,
        radius: 2000,
        delayTime: 0
      }
    };

    liveViewManager.stopLiveViewByTrigger(liveView, trigger).then((liveViewResult: liveViewManager.LiveViewResult) => {
      hilog.info(0x0000, 'testTag', 'Succeeded in stopping liveView by trigger, result: %{public}s', JSON.stringify(liveViewResult));
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', 'Failed to stop liveView by trigger: %{public}d %{public}s', err.code, err.message);
    });
  } catch (err) {
    let e: BusinessError = err as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to stop liveView by trigger: %{public}d %{public}s', e.code, e.message);
  }
}

async function buildWantAgent(): Promise<Want> {
  const wantAgentInfo: wantAgent.WantAgentInfo = {
    wants: [
      {
        bundleName: 'xxx.xxx.xxx',
        abilityName: 'EntryAbility'
      } as Want
    ],
    actionType: wantAgent.OperationType.START_ABILITIES,
    requestCode: 0,
    actionFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
  };
  try {
    const agent = await wantAgent.getWantAgent(wantAgentInfo);
    return agent;
  } catch (e) {
    const err: BusinessError = e as BusinessError;
    hilog.error(0x0000, 'testTag', 'Failed to get wantAgent: %{public}s', err.message);
    throw e as Error;
  }
}
```

## Trigger

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

触发创建或结束实况窗的条件对象参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

|名称|类型|只读|可选|说明|
|:----------|:--------------------------|:-|:-|:----------------------------------------|
|type|[TriggerType](#triggertype)|否|否|触发创建或结束实况窗的条件类型|
|condition|[Geofence](#geofence)|否|否|触发创建或结束实况窗的条件具体描述|
|displayTime|number|否|是|条件触发实况的展示持续时间，取值范围为[15，1800]，默认值为900，单位：s|

## Geofence

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

地理围栏对象参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

|名称|类型|只读|可选|说明|
|:-------------------|:--------------------------------------------|:-|:-|:--------------------------------------------------|
|longitude|number|否|否|地理围栏中心点经度，取值范围为[-180，180]|
|latitude|number|否|否|地理围栏中心点纬度，取值范围为[-90，90]|
|coordinateSystemType|[CoordinateSystemType](#coordinatesystemtype)|否|否|地理围栏中心点的坐标系类型|
|radius|number|否|否|地理围栏半径，取值范围为[200，2000] ，单位：m|
|monitorEvent|[MonitorEvent](#monitorevent)|否|否|触发地理围栏的事件类型|
|delayTime|number|否|是|延迟触发时间，即：进入/离开围栏后持续多长时间触发围栏，取值范围为[0，300]，默认值为0，单位：s|

> 说明
>
> * 经、纬度传入值不允许同时为0。
> * 当[coordinateSystemType](#coordinatesystemtype)为COORDINATE_TYPE_GCJ02时，经度传入值不允许为-180或180，纬度传入值不允许为-90或90。

## TriggerType

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

触发创建或结束实况窗的条件类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

|名称|值|说明|
|:--------------------|:-|:-------|
|TRIGGER_TYPE_GEOFENCE|1|地理围栏条件类型|

## CoordinateSystemType

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

地理围栏中心点坐标系类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

|名称|值|说明|
|:--------------------|:-|:-------|
|COORDINATE_TYPE_WGS84|1|WGS84坐标系|
|COORDINATE_TYPE_GCJ02|2|GCJ02坐标系|

## MonitorEvent

> phone 6.1.0(23)+ | 2in1 6.1.0(23)+ | tablet 6.1.0(23)+

触发地理围栏的事件类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.0(23)

|名称|值|说明|
|:-----------------|:-|:---|
|MONITOR_TYPE_ENTRY|1|进入围栏|
|MONITOR_TYPE_LEAVE|2|退出围栏|

## LiveView

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

实况窗对象参数，具体示例请见[构建本地实况窗](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/liveview-create-locally#创建实况窗)。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------|:------------------------------|:-|:-|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|id|number|否|否|实况窗唯一标识，取值范围为[-2147483648, 2147483647]，由开发者自行生成。如果通过Push Kit REST API创建、更新和结束实况窗，对应Push Kit REST API中LiveViewPayload的[activityId](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/push-scenariozed-api-request-param#liveviewpayload-实况窗消息)字段。|
|event|string|否|否|实况窗的应用场景。 **●** TAXI：出行打车。 **●** DELIVERY：即时配送（外卖、生鲜）。 **●** FLIGHT：航班。 **●** TRAIN：高铁/火车。 **●** QUEUE：排队。 **●** PICK_UP：取餐。 **●** SCORE：赛事比分。 **●** RENT：共享租赁。 **●** TIMER：计时。 **●** WORKOUT：运动锻炼。 **●** NAVIGATION：导航。 **●** CHECK_IN：打卡。 **●** EXPRESS：快递。 **●** PROGRESS：进度类型。 **●** TRADE：金融交易。 使用对应场景需要申请权益，详情请参见[实况窗权益说明](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/liveview-rights)。|
|subEvent|string|否|是|实况窗的应用子场景。主要用于统计子业务场景的实况窗数量，使用对应子场景无需额外申请权益。 **●** 即时配送（外卖、生鲜）场景(event为"DELIVERY") FOOD：美食、GOODS：商超、MEDICINE：买药、BACHELOR：跑腿、GROUPBUY：拼团 **●** 导航场景(event为"NAVIGATION") DRIVING：驾车、WALKING：步行、CYCLING：骑行、BUS：公交、METRO：地铁 **●** 出行打车场景(event为"TAXI") STANDARD：普通即时打车、SPECIAL：专车、HITCHHIKING：顺风车、CARPOOLING：拼车 **●** 排队场景(event为"QUEUE") RESTAURANT：餐饮排号、HOSPITAL：就诊排号、BANK：银行排号、GOVERNMENT：政务中心排号、ATTRACTION：景区排号 **●** 共享租赁场景(event为"RENT") BICYCLE：共享单车、EBIKE：共享电动车或助力车、POWERBANK：共享充电宝、CAR：共享汽车 **●** 运动锻炼场景(event为"WORKOUT") RUNNING：跑步、CYCLING：骑行、WALKING：步行 **●** 进度类型场景(event为"PROGRESS") UPLOAD：文件上传、DOWNLOAD：文件下载、IMPORT：资源导入、EXPORT：资源导出、BACKUP：备份、RECOVER：恢复 **起始版本：** 26.0.0|
|sequence|number|否|是|支持实况窗消息更新和结束保序能力，取值范围为[0, 2147483647]，新的实况窗版本号需大于当前展示实况窗版本号，否则更新和结束会失败。若不传入参数值，Live View Kit不会自动生成（此时，调用getActiveLiveView接口查询实况信息，返回结果中sequence：4294967295为无效值，该无效值不允许用来更新实况），也不会校验实况窗版本号。对应Push Kit中的[version](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/push-scenariozed-api-request-param#liveviewpayload-实况窗消息)字段。|
|isMute|boolean|否|是|消息提醒方式。若您在创建或更改实况窗状态时不传入此字段，则始终默认静默提醒。 **●** true：静默提醒。 **●** false：铃声震动提醒。|
|timer|[LiveViewTimer](#liveviewtimer)|否|是|实况窗计时器，展示时每秒刷新一次。 配置了计时器后，可以在部分字段中使用占位符：**${placeholder.timer}**，系统会将占位符替换为计时器。 当前支持使用占位符的字段： **●** liveViewData.primary.[title](#primarydata) **●** liveViewData.primary.[content](#primarydata) **●** liveViewData.primary.layoutData.[content](#pickuplayout) **●** liveViewData.primary.layoutData.[competitionTime](#scorelayout) **起始版本：** 5.0.0(12)|
|lifeCycleMode|[LifeCycleMode](#lifecyclemode)|否|是|实况窗生命周期模式，控制实况窗是否随应用进程结束自动结束。默认为常规生命周期，需要由开发者主动调用API结束实况窗，不跟随应用进程结束而自动结束。 仅在创建实况时生效，并且在以下场景中传入该字段不生效： **●** 当event为导航场景/运动锻炼场景 **●** 当调用startLiveViewByTrigger注册由条件触发创建的实况窗 **说明：** 不传lifeCycleMode与传入lifeCycleMode为STOP_BY_APP时效果一样。 **起始版本：** 26.0.0|
|shareUrl|string|否|是|用于查看实时活动进展的网页链接，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，仅支持HTTPS协议的网页链接，即只支持以"https://"开头的网页链接，长度小于128，若不满足以上条件，则shareUrl字段不生效且不支持实况分享。 **说明：** 分享实况窗到HarmonyOS 7.0.0及以上设备时，用户点击由分享创建的实况窗卡片后，会直接跳转至该链接。若分享到旧版本系统或非HarmonyOS设备时，用户直接点击社交分享消息中的该链接查看实时活动进展。 **起始版本：** 26.0.0|
|liveViewData|[LiveViewData](#liveviewdata)|否|否|实况窗详细信息。|

## LiveViewTimer

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

实况窗计时器参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.0.0(12)

|名称|类型|只读|可选|说明|
|:---------------------|:----------------------------------|:-|:-|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|time|number|否|是|计时器初始值，单位：ms，默认为0，取值范围为[0,9223372036854775807]。每秒刷新一次。|
|isCountdown|boolean|否|是|计时器是否为倒计时，默认为false。 **●** true：计时器为倒计时类型 **●** false：计时器为正计时类型|
|isPaused|boolean|否|是|计时器是否暂停，默认false。计时器暂停时，会显示暂停的那一秒。 **●** true：暂停。 **●** false：不暂停（默认值）。|
|countdownPreset|[CountdownPreset](#countdownpreset)|否|是|当倒计时到0时，系统将自动更新实况窗卡片模板扩展区标题（title）和扩展区内容（content）字段为卡片预置结构体（countdownPreset）中的标题（presetTitle）和内容（presetContent）。 仅当满足以下条件时，上述功能生效： **●** [layoutType](#layouttype)为LAYOUT_TYPE_PICKUP强调文本模板； **●** liveViewData.primary.layoutData.[content](#pickuplayout)中使用占位符${placeholder.timer}。 **起始版本：** 6.0.0(20)|
|capsuleCountdownPreset|[CountdownPreset](#countdownpreset)|否|是|当倒计时到0时，系统将自动更新计时器类型实况胶囊主文本（time）和实况胶囊副文本（content）为实况胶囊预设结构体（capsuleCountdownPreset）中的主文本（presetTitle）和副文本（presetContent）。仅当满足以下条件时，上述功能生效： **●** [capsuleType](#capsuletype)为CAPSULE_TYPE_TIMER计时器类型实况胶囊。 **起始版本：** 6.0.0(20)|

## CountdownPreset

> phone 6.0.0(20)+ | 2in1 6.0.0(20)+ | tablet 6.0.0(20)+

实况窗计时器预置参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.0.0(20)

|名称|类型|只读|可选|说明|
|:------------|:-----|:-|:-|:-------------------------------------------------------------|
|presetTitle|string|否|是|自动更新扩展区标题或实况胶囊主文本为预设主文本。该参数值不可为：null/undefined/空字符串，长度小于128。|
|presetContent|string|否|是|自动更新扩展区文本内容或实况胶囊副文本为预设副文本。该参数值不可为：null/undefined/空字符串，长度小于128。|

## LiveViewData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

实况窗详细信息。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:-------|:------------------------------------------------------------------------------------------------|:-|:-|:---------|
|primary|[PrimaryData](#primarydata)|否|否|卡片形态内容。|
|capsule|[TextCapsule](#textcapsule) | [TimerCapsule](#timercapsule) | [ProgressCapsule](#progresscapsule)|否|是|实况胶囊形态内容。|
|external|[ExternalData](#externaldata)|否|是|小折叠外屏形态内容。|

## PrimaryData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

卡片形态参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|title|string|否|创建：否 更新或结束：是|固定区标题，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于1024。|
|content|Array<[RichText](#richtext)>|否|创建：否 更新或结束：是|固定区内容，若传入数组对象，对象中text字段参数值不能为以下值：null/undefined/空字符串/全为空格的字符串。 **●** 数组中所有对象的text字段字符串长度总和需小于1024。 **●** 数组中对象不设置textColor字段时，文本颜色默认为#99000000；设置textColor字段时，所有拥有textColor字段的对象仅能设置同一种颜色。|
|keepTime|number|否|是|实况窗存档时间，在结束实况窗后，通知仍保留在通知中心的时长，取值范围[0,3600]，单位：s。**传入值为0，表示实况窗在通知中心直接结束，不保留显示。**|
|clickAction|[WantAgent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent)|否|创建：否 更新或结束：是|点击实况窗默认动作，请调用wantAgent.[getWantAgent()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent#wantagentgetwantagent-1)来构造。|
|extensionData|[ExtensionData](#extensiondata)|否|是|辅助区内容。|
|[layoutData](#layoutdata)|[ProgressLayout](#progresslayout) | [PickupLayout](#pickuplayout) | [FlightLayout](#flightlayout) | [ScoreLayout](#scorelayout) | [NavigationLayout](#navigationlayout) | [CustomLayout](#customlayout)|否|创建：否 更新或结束：是|扩展区数据。 **说明：** 从5.0.0(12)版本开始，新增支持参数类型NavigationLayout。 从26.0.0版本开始，新增支持参数类型CustomLayout。|
|liveViewLockScreenPicture|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|是|锁屏沉浸实况窗大图样式在指定路径下的文件名。传入实际存在的图片时，用户在锁屏下点击实况胶囊中的应用图标、长按实况胶囊内容或长按卡片内容，会进入沉浸态，展示大图。不传入或传入图片不存在时，用户点击行为不会进入沉浸态。 **●** string类型的取值为在"/resources/rawfile"路径下的文件名，长度小于256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 建议使用大小约为1000*1000的图片，不支持GIF格式的图片文件。 **起始版本：** 5.0.0(12)|
|liveViewLockScreenAbilityName|string|否|是|[LiveViewLockScreenExtensionAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-lock-screen-ability)（锁屏沉浸实况窗扩展Ability）的名称，仅创建实况窗时生效，传入时值不可为空，长度最大为128。若在创建实况窗时与liveViewLockScreenPicture同时传入，则仅本字段生效。 **起始版本：** 5.0.0(12)|
|liveViewLockScreenAbilityParameters|Record<string, string>|否|是|用户自定义向[LiveViewLockScreenExtensionAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-lock-screen-ability)（锁屏沉浸实况窗扩展Ability）传入的参数，填值时不能为空，key-value键值对最多50个，传入后可在ability的onSessionCreate()中，通过want.parameters获取。 **起始版本：** 5.0.0(12)|
|backgroundType|[BackgroundType](#backgroundtype)|否|是|表示实况窗卡片的背景氛围类型，仅支持左右文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_FLIGHT）展示背景。 当传入实况窗卡片的背景氛围类型参数backgroundType值为赏月航班或夕阳航班时，且同时传入天气类型（[WeatherInfo](#weatherinfo)）为雨、雪特殊天气，卡片上优先展示天气背景，其余非特殊天气在卡片上展示赏月航班或夕阳航班背景氛围。 **起始版本：** 6.0.0(20)|
|aliveTime|number|否|是|实况窗最长存活时间，范围[15,28800]，传入值小于15时默认取值为15，传入值大于28800时默认取值为28800，单位：s。 **起始版本：** 6.1.1(24)|

## BackgroundType

> phone 6.0.0(20)+ | 2in1 6.0.0(20)+ | tablet 6.0.0(20)+

实况窗卡片的背景氛围类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.0.0(20)

|名称|值|说明|
|:---------------------------|:--|:--------------------|
|SYS_BACKGROUND_UNDEFINED|0|未定义，表示在卡片上不展示背景氛围。|
|SYS_BACKGROUND_FLIGHT_MOON|100|赏月航班，表示在卡片上展示赏月的背景氛围。|
|SYS_BACKGROUND_FLIGHT_SUNSET|101|夕阳航班，表示在卡片上展示夕阳的背景氛围。|

## ExtensionData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

辅助区参数。

**辅助区元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/92/v3/UwFlP1JFRYucwvQm8ygUSA/zh-cn_image_0000002794413623.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=9968D0179310C9E4F6DF5E2E326C5871ED7E71436ABA7A8D7CA0FDFFAF1E9F7F)

* 1 实况卡片辅助区类型，对应type字段:
  * 当辅助区类型为ExtensionType.EXTENSION_TYPE_COMMON_TEXT时，辅助区显示普通文本，使用API字段text传入文本内容。
  * 当辅助区类型为ExtensionType.EXTENSION_TYPE_CAPSULE_TEXT时，辅助区显示实况胶囊文本，使用API字段text传入文本内容。
  * 当辅助区类型为ExtensionType.EXTENSION_TYPE_PIC时，辅助区显示图片，使用API字段pic传入图片资源。
  * 当辅助区类型为ExtensionType.EXTENSION_TYPE_ICON时，辅助区显示图标，使用API字段pic传入图标资源。
  * 当辅助区类型为ExtensionType.EXTENSION_TYPE_PROGRESS时，辅助区显示进度环，使用API字段progress传入进度百分比。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:----------|:---------------------------------------------------------------------------------------------------------------------|:-|:--------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|type|[ExtensionType](#extensiontype)|否|是|辅助区显示类型，默认为[EXTENSION_TYPE_DEFAULT](#extensiontype)不显示辅助区。|
|text|string|否|创建：否（仅当type值为ExtensionType.EXTENSION_TYPE_COMMON_TEXT或ExtensionType.EXTENSION_TYPE_CAPSULE_TEXT时） 更新或结束：是|辅助区显示的文本信息，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|pic|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建：否（仅当type值为ExtensionType.EXTENSION_TYPE_PIC或ExtensionType.EXTENSION_TYPE_ICON时） 更新或结束：是|辅助区显示的图片，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|clickAction|[WantAgent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent)|否|是|点击辅助区的跳转动作，请调用wantAgent.[getWantAgent()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent#wantagentgetwantagent-1)来构造。|
|actionType|[ActionType](#actiontype)|否|是|点击辅助区的行为。 **起始版本：** 6.1.1(24)|
|progress|number|否|是|进度百分比，值范围：[0,100]。 当type值为ExtensionType.EXTENSION_TYPE_PROGRESS时创建必填，更新时不填或格式错误时会导致辅助区更新失败。 **起始版本：** 26.0.0|

## LayoutData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

定义扩展区模板类型及公共参数。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_DEFAULT时，使用此类型。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------------------|:-------------------------------------|:-|:-|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|layoutType|[LayoutType](#layouttype)|否|否|模板类型。|
|serviceButtons|Array<[ServiceButton](#servicebutton)>|否|是|传入连续服务按钮结构体数组。 更新连续服务按钮时，需要同时更新辅助区[ExtensionData](#extensiondata)的clickAction字段和连续服务按钮。 **起始版本：** 5.1.1(19)|
|isServiceButtonsDisplayed|boolean|否|是|是否显示连续服务按钮，默认false。 **●** true：显示按钮 **●** false：不显示按钮 **起始版本：** 5.1.1(19)|
|weatherInfo|[WeatherInfo](#weatherinfo)|否|是|传入天气信息结构体。 目的地天气类型仅支持左右文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_FLIGHT）； 本地天气类型仅支持基础模板、进度可视化模板和强调文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_DEFAULT/LAYOUT_TYPE_PROGRESS/LAYOUT_TYPE_PICKUP）。 当传入天气信息，且同时传入实况窗卡片的背景氛围类型参数[backgroundType](#backgroundtype)值为赏月航班（SYS_BACKGROUND_FLIGHT_MOON）或夕阳航班（SYS_BACKGROUND_FLIGHT_SUNSET）时，若天气类型为雨、雪特殊天气，卡片上优先展示天气背景，其余非特殊天气在卡片上优先展示赏月航班或夕阳航班背景氛围。 **说明：** 从6.0.0(20)开始支持展示目的地天气效果； 从6.0.2(22)开始支持展示本地天气效果。|

## WeatherInfo

> phone 6.0.0(20)+ | 2in1 6.0.0(20)+ | tablet 6.0.0(20)+

应用传入天气信息的基类。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.0.0(20)

|名称|类型|只读|可选|说明|
|:--------------|:------------------------------------------|:-|:-|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
|weatherType|[WeatherType](#weathertype)|否|是|天气类型。创建实况窗时，若不传入weatherType或传入值为undefined、[WeatherType](#weathertype).WEATHER_TYPE_UNDEFINED、未定义的枚举值，则不展示天气效果。|
|locationType|[WeatherLocationType](#weatherlocationtype)|否|是|天气位置类型。创建实况窗时，若locationType不传入或传入值为undefined、未定义的枚举值，则不展示天气效果。|
|highTemperature|number|否|是|天气最高温度，当前仅支持摄氏度，需小于等于58℃且大于传入的最低温度值（lowTemperature）。仅支持左右文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_FLIGHT）展示温度信息。创建实况窗时，若不传入或传入值为undefined、超出取值范围，则不展示温度信息。|
|lowTemperature|number|否|是|天气最低温度，当前仅支持摄氏度，需大于等于-95℃且小于传入的最高温度值（highTemperature）。仅支持左右文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_FLIGHT）展示温度信息。创建实况窗时，若不传入或传入值为undefined、超出取值范围，则不展示温度信息。|

## WeatherType

> phone 6.0.0(20)+ | 2in1 6.0.0(20)+ | tablet 6.0.0(20)+

天气类型，为枚举值，雨、雪天气支持在实况卡片上展示天气动效背景，其余天气类型（WEATHER_TYPE_UNDEFINED除外）仅支持在实况卡片上展示天气图标和温度，不支持在实况卡片上展示天气动效背景。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.0.0(20)

|名称|值|说明|
|:-----------------------------------|:-|:--------------------------------------------------------------|
|WEATHER_TYPE_UNDEFINED|0|表示不展示天气效果。|
|WEATHER_TYPE_SUNNY|1|晴天气类型，展示天晴天气效果。|
|WEATHER_TYPE_HAZY|5|霾天气类型，展示霾天气效果。|
|WEATHER_TYPE_CLOUDY|7|多云天气类型，展示多云天气效果。|
|WEATHER_TYPE_OVERCAST|8|阴天气类型，展示阴天气效果。|
|WEATHER_TYPE_FOG|11|雾天气类型，展示雾天气效果。|
|WEATHER_TYPE_SHOWERS|12|阵雨天气类型，展示阵雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_T_STORMS|15|雷阵雨天气类型，展示雷阵雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_RAIN|18|雨天气类型，展示雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_SNOW|22|雪天气类型，展示雪天气效果。实况卡片支持雪动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_RAIN_AND_SNOW|29|雨夹雪天气类型，展示雨夹雪天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_HOT|30|高温天气类型，展示高温天气效果。|
|WEATHER_TYPE_COLD|31|低温天气类型，展示低温天气效果。|
|WEATHER_TYPE_WINDY|32|大风天气类型，展示大风天气效果。|
|WEATHER_TYPE_THUNDERSHOWER_WITH_HAIL|45|冰雹天气类型，展示冰雹天气效果。|
|WEATHER_TYPE_LIGHT_RAIN|46|小雨天气类型，展示小雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_MODERATE_RAIN|47|中雨天气类型，展示中雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_HEAVY_RAIN|48|大雨天气类型，展示大雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_STORM|49|暴雨天气类型，展示暴雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_SEVERE_STORM|51|特大暴雨天气类型，展示特大暴雨天气效果。实况卡片支持雨动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_LIGHT_SNOW|52|小雪天气类型，展示小雪天气效果。实况卡片支持雪动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_MODERATE_SNOW|53|中雪天气类型，展示中雪天气效果。实况卡片支持雪动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_HEAVY_SNOW|54|大雪天气类型，展示大雪天气效果。实况卡片支持雪动效背景。 **说明：** 从6.0.0(20)开始支持展示天气动效背景|
|WEATHER_TYPE_SNOW_STORM|55|暴雪天气类型，展示暴雪天气效果。实况卡片支持雪动效背景。 **说明：** 从6.0.2(22)开始支持展示天气动效背景|
|WEATHER_TYPE_DUST_STORM|56|沙尘暴天气类型，展示沙尘暴天气效果。|
|WEATHER_TYPE_DUST|65|浮尘天气类型，展示浮尘天气效果。|
|WEATHER_TYPE_SAND|66|扬沙天气类型，展示扬沙天气效果。|
|WEATHER_TYPE_SAND_STORM|67|强沙尘暴天气类型，展示强沙尘暴天气效果。|

## WeatherLocationType

> phone 6.0.0(20)+ | 2in1 6.0.0(20)+ | tablet 6.0.0(20)+

天气位置类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.0.0(20)

|名称|值|说明|
|:------------------------|:-|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|LOCATION_TYPE_LOCAL|1|表示展示本地天气效果，仅支持基础模板、进度可视化模板和强调文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_DEFAULT/LAYOUT_TYPE_PROGRESS/LAYOUT_TYPE_PICKUP）。天气图标将展示在固定区标题右侧，不支持显示温度。 **说明：** 从6.0.2(22)开始支持展示本地天气效果。|
|LOCATION_TYPE_DESTINATION|2|表示展示目的地天气效果，仅支持左右文本模板（即[layoutType](#layouttype)为LAYOUT_TYPE_FLIGHT）。天气图标及温度信息将展示在左右文本模板扩展区右侧，扩展区右侧标题及右侧内容的左侧。 **说明：** 从6.0.0(20)开始支持展示目的地天气效果；|

## ServiceButton

> phone 5.1.1(19)+ | 2in1 5.1.1(19)+ | tablet 5.1.1(19)+

应用传入连续服务按钮的基类。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.1.1(19)

|名称|类型|只读|可选|说明|
|:----------|:-----------------------------------------------------------------------------------------------------------|:-|:-|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|name|string|否|是|连续服务按钮名字，长度小于128，超过该长度的字符将被截断。|
|clickAction|[WantAgent](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent)|否|是|点击连续服务按钮时触发的跳转动作，请调用wantAgent.[getWantAgent()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-app-ability-wantagent#wantagentgetwantagent-1)来构造。|

## ProgressLayout

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

进度可视化模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_PROGRESS时，使用此类型。

**卡片元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/f4/v3/YV18OudjQk-k2NJUmH63Jw/zh-cn_image_0000002764974906.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=AFF32CB9B49F7F7BDF3D4D2A13BBFE5C2BDACC42EE23F0F404A163F0423A3B20)

* 1 进度百分比，对应progress字段。
* 2 进度条进度的颜色，对应color字段。
* 3 进度条背景颜色，对应backgroundColor字段。
* 4 进度条指示器图标，对应indicatorIcon字段。
* 5 进度条节点图标，对应nodeIcons字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:--------------|:----------------------------------------------------------------------------------------------------------------------------|:-|:--------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|progress|number|否|否|进度百分比，决定指示器在进度条中的位置，值范围：[0,100]。|
|color|string|否|是|进度条颜色，"#ARGB"16进制格式，长度为9。默认颜色为#FF317AF7。|
|backgroundColor|string|否|是|进度条背景颜色，"#ARGB"16进制格式，长度为9。默认颜色为#19000000，深色模式默认颜色#19FFFFFF。|
|indicatorType|[IndicatorType](#indicatortype)|否|是|扩展区指示器小图标显示类型，默认不显示指示器小图标。|
|indicatorIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：否（仅当indicatorType值为IndicatorType.INDICATOR_TYPE_UP或IndicatorType.INDICATOR_TYPE_OVERLAY时） 更新或结束：是|进度条指示器图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|lineType|[LineType](#linetype)|否|是|扩展区进度条显示类型，默认为虚线进度。|
|nodeIcons|Array<string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)>|否|创建或模板切换：否 更新或结束：是|进度条每个节点图标，数组长度范围为[2, 5]，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|

## PickupLayout

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

强调文本模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_PICKUP时，使用此类型。

**卡片元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/f4/v3/A_71pB6-Q5y_Dybl3MuwCQ/zh-cn_image_0000002765134826.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=BB32C51B94C5D81816D60B40D89309CF971E696B7FAE6D829E2D4541105D9BAF)

* 1 扩展区标题，对应title字段。
* 2 扩展区内容，对应content字段。
* 3 扩展区内容下划线颜色，对应underlineColor字段。
* 4 扩展区右侧产品描述图，对应descPic字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:-------------|:---------------------------------------------------------------------------------------------------------------------|:-|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|title|string|否|创建或模板切换：否 更新或结束：是|扩展区标题，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|content|string|否|创建或模板切换：否 更新或结束：是|扩展区内容，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|underlineColor|string|否|是|扩展区内容下划线颜色，"#ARGB"16进制格式，长度为9，默认不显示下划线。|
|descPic|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：否 更新或结束：是|扩展区右侧产品描述图，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|

## FlightLayout

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

左右文本模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_FLIGHT时，使用此类型。

**卡片元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/4f/v3/r7PveWz5Q36Vx7gVV3mjzg/zh-cn_image_0000002794493401.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=2BE23C4F03ED9F2E324F93B8D626A5B0432B26E918B551BD04D4502729BC8F8F)

* 1 左侧文本标题，对应firstTitle字段。
* 2 左侧文本内容，对应firstContent字段。
* 3 右侧文本标题，对应lastTitle字段。
* 4 右侧文本内容，对应lastContent字段。
* 5 右侧标题的右上角展示内容，对应lastTitleSuperscript字段。
* 6 右侧内容的右上角展示内容，对应lastContentSuperscript字段。
* 7 中间间隔图标，对应spaceIcon字段。
* 8 中间间隔文本，对应spaceText字段。
* 9 是否展示扩展区分割线，由isHorizontalLineDisplayed字段控制。
* 10 扩展区底部内容，对应additionalText字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------------------|:---------------------------------------------------------------------------------------------------------------------|:-|:---------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|style|[FlightLayoutStyle](#flightlayoutstyle)|否|是|左右文本模板子样式类型，若未填默认为强调型子样式。 **●** 0：强调型子样式类型。 **●** 1：均衡型子样式类型。 **起始版本：** 5.0.2(14)|
|firstTitle|string|否|创建或模板切换：否 更新或结束：是|扩展区左侧标题，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|firstContent|string|否|创建或模板切换：否 更新或结束：是|扩展区左侧内容，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|lastTitle|string|否|创建或模板切换：否 更新或结束：是|扩展区右侧标题，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|lastContent|string|否|创建或模板切换：否 更新或结束：是|扩展区右侧内容，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|lastTitleSuperscript|string|否|是|扩展区右侧标题的右上角展示内容，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。若用于表示到达时间跨天，传入值长度等于2，格式为"+X", 其中X为数字，例如"+1", "+2"等。 **起始版本：** 5.0.2(14)|
|lastContentSuperscript|string|否|是|扩展区右侧内容的右上角展示内容，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。若用于表示到达时间跨天，传入值长度等于2，格式为"+X", 其中X为数字，例如"+1", "+2"等。 **起始版本：** 5.0.2(14)|
|spaceType|[SpaceType](#spacetype)|否|是|左右文本模板扩展区中间的显示类型。 **●** 未携带该字段或0：显示spaceIcon指定的中间间隔图标。 **●** 1：显示由spaceText指定的中间间隔文本。 **起始版本：** 5.0.2(14)|
|spaceIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：未填spaceType或spaceType为SpaceType.SPACE_TYPE_ICON时必填|扩展区中间间隔图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|spaceText|string|否|创建或模板切换：spaceType为SpaceType.SPACE_TYPE_TEXT时必填|扩展区中间间隔文本，用于展示日期，例如10/28 周六、2025/09/15等。 限制为6个中文字符长度或12个英文字符长度，若超长则截断展示。 更新或结束不携带时显示上次的文本。 **说明：** 起始版本：5.0.2(14)。|
|isHorizontalLineDisplayed|boolean|否|是|是否显示扩展区分割线，默认显示分割线。 **●** true：显示。 **●** false：不显示。|
|additionalText|string|否|是|扩展区底部内容，长度小于1024。 **起始版本：** 5.0.0(12)|

## ScoreLayout

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

赛事比分模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_SCORE时，使用此类型。

**卡片元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/a9/v3/0hAbm12wRH27OaJzUwJCxg/zh-cn_image_0000002794413625.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=02F5351865F99B4E929BCD6EB62EA2C8DC1464D97E28DE4E0F07499411B908F1)

* 1 左侧主队名称，对应hostName字段。
* 2 左侧主队图标，对应hostIcon字段。
* 3 左侧主队比分，对应hostScore字段。
* 4 右侧客队名称，对应guestName字段。
* 5 右侧客队图标，对应guestIcon字段。
* 6 右侧客队比分，对应guestScore字段。
* 7 中间上方描述，对应competitionDesc字段。
* 8 中间下方比赛时间，对应competitionTime字段。
* 9 是否展示扩展区分割线，由isHorizontalLineDisplayed字段控制。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------------------|:---------------------------------------------------------------------------------------------------------------------|:-|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|hostName|string|否|创建或模板切换：否 更新或结束：是|扩展区左侧名称，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|hostIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：否 更新或结束：是|扩展区左侧图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|hostScore|string|否|创建或模板切换：否 更新或结束：是|扩展区左侧比分，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|guestName|string|否|创建或模板切换：否 更新或结束：是|扩展区右侧名称，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|guestIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：否 更新或结束：是|扩展区右侧图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|guestScore|string|否|创建或模板切换：否 更新或结束：是|扩展区右侧比分，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|competitionDesc|string | Array<[RichText](#richtext)>|否|创建或模板切换：否 更新或结束：是|扩展区中间上方描述文本，比赛介绍，若传入数组对象，对象中text字段参数值不能为以下值：null/undefined/空字符串/全为空格的字符串。 **●** 填string时，字符串长度需小于128。 **●** 填Array<[RichText](#richtext)>时： 数组中所有对象的text字段字符串长度总和需小于128。 数组中对象不设置textColor字段时，文本颜色默认为#99000000；设置textColor字段时，所有拥有textColor字段的对象仅能设置同一种颜色。 **说明：** 从5.0.0(12)版本开始，新增支持入参类型Array<[RichText](#richtext)>。|
|competitionTime|string|否|创建或模板切换：否 更新或结束：是|扩展区中间下方比赛时间，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|isHorizontalLineDisplayed|boolean|否|是|是否显示扩展区分割线，默认显示分割线。 **●** true：显示。 **●** false：不显示。|

## NavigationLayout

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

导航模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_NAVIGATION时，使用此类型。

**卡片元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/c1/v3/IHJ7hF9uTLSgqQOafPtCcg/zh-cn_image_0000002764974908.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=5CA183A9D1E6B1F13C6B2B293F3F4DF3B0C68EBA2FB974561CD447867F034388)

* 1 当前导航方向，对应currentNavigationIcon字段。
* 2 导航方向的箭头集合图片，对应navigationIcons字段。
* 3 是否展示扩展区导航方向的箭头集合图片，由isNavigationIconsDisplayed字段控制。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.0.0(12)

|名称|类型|只读|可选|说明|
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------|:-|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|currentNavigationIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建或模板切换：否 更新或结束：是|当前导航方向。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为128。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 若本地资源不存在，创建时失败，更新或结束时导航模板扩展区不更新。 **说明：** 为确保图片在系统深浅模式下的显示效果，系统将对png、svg格式图片做赋色处理，其他格式图片保留原样显示不支持赋色。具体参考 [卡片模板](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-live-view-0000001955186861#section1511241615274) 的 "导航定制模板"说明。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|navigationIcons|Array<string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)>|否|是|导航方向的箭头集合图片，支持1-11个。创建时不传，则不展示扩展区。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为128。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 若本地资源不存在，创建时失败，更新或结束时导航模板扩展区不更新。 **说明：** 为确保在系统深浅模式下的显示效果，系统将对png、svg格式图片做赋色处理，其他格式图片保留原样显示不支持赋色。具体参考 [卡片模板](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-live-view-0000001955186861#section1511241615274) 的 "导航定制模板"说明。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|isNavigationIconsDisplayed|boolean|否|是|控制导航方向的箭头集合图片是否展示。更新或结束未填时，继承上一次状态变更时的值。其他情况不传值时默认为展示。 **●** true：展示 **●** false：不展示 **起始版本**：5.0.3(15)|

## CustomLayout

> phone 26.0.0+ | 2in1 26.0.0+ | tablet 26.0.0+

自定义模板扩展区参数，继承[LayoutData](#layoutdata)。当[layoutType](#layouttype)为LayoutType.LAYOUT_TYPE_CUSTOM时，使用此类型。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 26.0.0

|名称|类型|只读|可选|说明|
|:----------------|:---------------------|:-|:-|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|abilityName|string|否|否|[LiveViewCardExtensionAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-card-ability)（实况窗卡片自定义扩展区的扩展Ability）的名称。若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|abilityParameters|Record<string, string>|否|是|[LiveViewCardExtensionAbility](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-card-ability)（实况窗卡片自定义扩展区的扩展Ability）传入的自定义参数。填值时不能为空，key-value键值对最多50个，传入后可在LiveViewCardExtensionAbility的onRender()中，通过param获取。|

## CapsuleData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

定义实况胶囊基本属性的基类。

**胶囊元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/d7/v3/esBvWELoS3iV0_axq5DaQA/zh-cn_image_0000002765134828.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=D8B5B5C0EE58D4C6F93E94D67C4A57ECB0F15081D816DF1767105FD98586BB07)

* 1 实况胶囊类型，对应type字段。
* 2 实况胶囊的图标，对应icon字段。
* 3 实况胶囊的尾部图标，对应tailIcon字段。
* 4 实况胶囊副文本是否展示，由isContentDisplayed字段控制。
* 5 实况胶囊尾部图标是否展示，由isTailIconDisplayed字段控制。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------------|:---------------------------------------------------------------------------------------------------------------------|:-|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|type|[CapsuleType](#capsuletype)|否|否|实况胶囊的类型。|
|status|number|否|否|实况胶囊的显示状态。 **●** 1：显示实况胶囊。 **●** -1：结束显示实况胶囊。|
|icon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建：否 更新或结束：是|实况胶囊的图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为255。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。|
|tailIcon|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|是|实况胶囊的尾部图标，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为255。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。 **起始版本：** 6.0.0(20)|
|backgroundColor|string|否|创建：否 更新或结束：是|实况胶囊的背景颜色，"#ARGB"16进制格式，长度为9。更新或结束未填时，继承上一次状态变更时的颜色。 不建议使用以下颜色： **●** #FF000000 **●** #FFFFFFFF **●** #FFF1F3F5|
|isContentDisplayed|boolean|否|是|实况胶囊的副文本是否展示。该参数未填时，继承上一次创建或更新实况窗时传入的值。其他情况不传值时默认为展示。 **●** true：展示 **●** false：不展示 isContentDisplayed与isTailIconDisplayed均为false时，实况胶囊的副文本及尾部图标区域不展示。 **起始版本：** 5.0.3(15)|
|isTailIconDisplayed|boolean|否|是|实况胶囊的尾部图标是否展示。该参数未填时，继承上一次创建或更新实况窗时传入的值。其他情况不传值时默认不展示。 **●** true：展示 **●** false：不展示 isContentDisplayed与isTailIconDisplayed均为false时，实况胶囊的副文本及尾部图标区域不展示。 **起始版本：** 6.0.0(20)|

## TextCapsule

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

文本实况胶囊参数，继承[CapsuleData](#capsuledata)。当[type](#capsuledata)为CapsuleType.CAPSULE_TYPE_TEXT时，使用此类型。

**胶囊元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/d6/v3/-kLxI4HVRJyTg5T9y6TD7w/zh-cn_image_0000002794493403.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=426FB4382FA330B31641028C28B17A2953C16EEA8D17ABFB4BABE57E70950F68)

* 1 实况胶囊主文本，对应title字段。
* 2 实况胶囊副文本，对应content字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------|:-----|:-|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|title|string|否|创建或模板切换：否 更新或结束：是|实况胶囊的主文本，长度小于128，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串。 **说明：** 从6.0.0(20)版本开始，支持当传入值为"数值:数值"，且[layoutType](#layouttype)为赛事类型LAYOUT_TYPE_SCORE时，系统将自动提取实况卡片扩展区两侧图片和比分，更新实况胶囊样式，显示为赛事队伍图标及比分情况。|
|content|string|否|是|实况胶囊的副文本，长度小于128，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串。|

## TimerCapsule

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

计时器实况胶囊参数，继承[CapsuleData](#capsuledata)。当[type](#capsuledata)为CapsuleType.CAPSULE_TYPE_TIMER时，使用此类型。

**胶囊元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/15/v3/EVaCBoTnQUeJkpFyXWHgeA/zh-cn_image_0000002794413627.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=D59CAE46BA71D560E25E81A0906054E88ED232F2D38AB463256B3E32EAB39DCA)

* 1 实况胶囊副文本，对应content字段。
* 2 实况胶囊计时器初始值，对应time字段。计时器正计时或倒计时，由isCountdown字段控制。计时器是否暂停，由isPaused字段控制。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:----------|:------|:-|:-|:---------------------------------------------------------------------|
|content|string|否|是|实况胶囊的副文本，长度小于128，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串。|
|time|number|否|是|实况胶囊计时器初始值，每秒刷新一次，单位：ms，默认为0。|
|isCountdown|boolean|否|是|是否显示倒计时器。 **●** true：倒计时。 **●** false：正计时（默认值）。|
|isPaused|boolean|否|是|实况胶囊计时器是否暂停，计时器暂停时，实况胶囊会显示暂停的那一秒。 **●** true：暂停。 **●** false：不暂停（默认值）。|

## ProgressCapsule

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

进度实况胶囊参数，继承[CapsuleData](#capsuledata)。当[type](#capsuledata)为CapsuleType.CAPSULE_TYPE_PROGRESS时，使用此类型。

**胶囊元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/95/v3/ZbLAyoL6RJ6SdNc6Q75tvw/zh-cn_image_0000002764974910.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=60BC710F4D4863EB5D34B0994AF843D4913D456015FDDB09BB1E8153BAA1156A)

* 1 进度值显示数值占比或百分比，由indeterminate字段控制：
  * indeterminate为false：展示数值占比，格式为x/y（x对应progress字段，y对应max字段）。
  * indeterminate为true：展示百分比，格式为(x/y)*100% （x对应progress字段，y对应max字段）。
* 2 实况胶囊的副文本，对应字段content字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:------------|:------|:-|:-|:---------------------------------------------------------------------------------|
|max|number|否|是|进度条最大进度值，默认为1，范围为[1, 2147483647]。|
|progress|number|否|是|进度条当前进度值，默认为0，范围为[0, 2147483647]。进度的值为progress/max的比值。|
|indeterminate|boolean|否|是|进度显示类型，默认显示为数值占比。 **●** true：百分比。 **●** false：数值占比（默认）。|
|content|string|否|是|实况胶囊的副文本，长度小于128，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串。 **起始版本：** 6.0.0(20)|

## ExternalData

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

外屏形态模板参数。

**外屏元素对应的API字段：**

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/bf/v3/9X7OLeCOQHCN5awOlXGP9A/zh-cn_image_0000002765134830.png?HW-CC-KV=V1&HW-CC-Date=20261015T104545Z&HW-CC-Expire=31536000000&HW-CC-Sign=846A63FD48A4699C200E94E5A35BCF3A795C113268B42307DDB9ACEBCE68F401)

* 1 外屏标题，对应title字段。
* 2 外屏内容，对应content字段。
* 3 外屏背景颜色，对应backgroundColor字段。
* 4 外屏背景图片，对应字段backgroundPicture字段。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:----------------|:---------------------------------------------------------------------------------------------------------------------|:-|:--------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|title|string|否|创建：否 更新或结束：是|外屏标题，若传入该参数，其值不能为以下值：null/undefined/空字符串/全为空格的字符串，长度小于128。|
|content|Array<[RichText](#richtext)>|否|创建：否 更新或结束：是|外屏内容，应用可以设置字符串中部分文本的颜色，若传入数组对象，对象中text字段参数值不能为以下值：null/undefined/空字符串/全为空格的字符串。 **●** 数组中所有对象的text字段字符串长度总和需小于128。 **●** 数组中对象不设置textColor字段时，文本颜色默认为#99000000；设置textColor字段时，所有拥有textColor字段的对象仅能设置同一种颜色。|
|type|[ExternalType](#externaltype)|否|是|外屏背景样式类型，默认为背景色。 **起始版本：** 5.0.0(12)|
|backgroundColor|string|否|是|外屏背景颜色，"#RGB"16进制格式， 长度为7，默认颜色为#F1F3F5。|
|backgroundPicture|string | image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)|否|创建：否（仅当type为ExternalType.BACKGROUND_PICTURE时） 更新或结束：是（当type为ExternalType.BACKGROUND_PICTURE时，此参数生效）|外屏背景图片，更新或结束不携带时显示上次的图片。 **●** 当此参数类型为string时，取值为在"/resources/rawfile"路径下的本地资源文件名，长度最大为256。 示例：图片文件"icon.png"存放在应用的"/resources/rawfile"路径下，则取值为"icon.png"。 **●** 当此参数类型为image.[PixelMap](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/arkts-apis-image-pixelmap)时，传入图片的PixelMap实例大小有如下限制： 对于26.0.0之前版本，不大于30KB；从26.0.0开始，不大于192KB。 **起始版本：** 5.0.0(12)|

## RichText

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

富文本参数。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|只读|可选|说明|
|:--------|:-----|:-|:-|:------------------------------------------------------------------------------------|
|text|string|否|否|文本内容，长度小于128。|
|textColor|string|否|是|文本颜色，"#ARGB"16进制格式，长度为9。不设置textColor时，文本颜色默认为#99000000；设置textColor时，数组中的所有对象仅能设置一种颜色。|

## LiveViewResult

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

实况窗结果。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|类型|说明|
|:---------|:-----|:----------------------------------------------------------------------------------------------------------------------|
|resultCode|number|实况窗结果码。 **●** 0：成功。 **●** 1：固定区更新或结束失败。 **●** 2：辅助区更新或结束失败。 **●** 3：扩展区更新或结束失败。 **●** 4：实况胶囊更新或结束失败。 **●** 5：外屏更新或结束失败。|
|message|String|实况窗结果信息。|

## LayoutType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

扩展区类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|值|说明|
|:---------------------|:--|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|LAYOUT_TYPE_DEFAULT|-1|不显示扩展区。|
|LAYOUT_TYPE_PROGRESS|3|进度可视化类型。适用于需要展示进度节点的场景，如即时配送和出行打车，用于展示实况活动进度。|
|LAYOUT_TYPE_PICKUP|4|强调文本类型。适用于取餐、出行打车等场景，用于展示取餐码、车牌号等关键信息。|
|LAYOUT_TYPE_FLIGHT|5|左右文本类型。适用于火车、航班出行场景，用于显示行程信息，包括出发地、目的地与时间。|
|LAYOUT_TYPE_SCORE|7|赛事类型。适用于体育赛事和电竞赛事比分场景，用于展示队伍比分。|
|LAYOUT_TYPE_NAVIGATION|8|导航类型。适用于导航出行场景，用于展示导航信息。 **起始版本：** 5.0.0(12)|
|LAYOUT_TYPE_CUSTOM|100|自定义类型。适用于需要在扩展区展示自定义丰富内容的实时活动场景，仅在已有模板都不适用的情况下才允许使用。 **起始版本：** 26.0.0 **说明：** 当API版本小于26.0.0且LayoutType='LAYOUT_TYPE_CUSTOM'时，创建和更新实况窗失败，需要开发者针对新旧版本进行适配处理，请参考[ArkTS API兼容性保护](https://developer.huawei.com/consumer/cn/doc/harmonyos-releases/arkts-api-compatibility-warning-elim)。|

## ExtensionType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

辅助区类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|值|说明|
|:--------------------------|:-|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|EXTENSION_TYPE_DEFAULT|0|不显示辅助区。|
|EXTENSION_TYPE_COMMON_TEXT|1|辅助区显示普通文本。|
|EXTENSION_TYPE_CAPSULE_TEXT|2|辅助区显示实况胶囊文本。|
|EXTENSION_TYPE_PIC|3|辅助区显示图片。|
|EXTENSION_TYPE_ICON|4|辅助区显示图标。|
|EXTENSION_TYPE_PROGRESS|5|辅助区显示进度环。 **起始版本：** 26.0.0 **说明：** 当API版本小于26.0.0且ExtensionType='EXTENSION_TYPE_PROGRESS'值时，创建和更新实况窗失败，需要开发者针对新旧版本进行适配处理，请参考[ArkTS API兼容性保护](https://developer.huawei.com/consumer/cn/doc/harmonyos-releases/arkts-api-compatibility-warning-elim)。|

## ActionType

> phone 6.1.1(24)+ | 2in1 6.1.1(24)+ | tablet 6.1.1(24)+

点击辅助区之后的行为类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 6.1.1(24)

|名称|值|说明|
|:------------------------|:-|:--------|
|ACTION_TYPE_OPEN_APP_PAGE|1|打开应用自定义页面|
|ACTION_TYPE_STOP_LIVEVIEW|3|结束实况通知|

## LifeCycleMode

> phone 26.0.0+ | 2in1 26.0.0+ | tablet 26.0.0+

实况窗生命周期模式，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 26.0.0

|名称|值|说明|
|:---------------------------|:-|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|STOP_BY_APP|0|常规生命周期，不跟随应用进程结束而自动结束，需要由开发者主动调用[liveViewManager.stopLiveView](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/liveview-liveviewmanager#liveviewmanagerstopliveview)方法结束实况窗。|
|AUTO_STOP_WHEN_APP_TERMINATE|1|实况窗随应用进程结束而消失，适用于实况窗的创建、更新和结束都由端侧应用APP控制的场景。|

## IndicatorType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

指示器类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|值|说明|
|:-------------------------|:-|:---------|
|INDICATOR_TYPE_UNDISPLAYED|0|不显示指示器小图标。|
|INDICATOR_TYPE_UP|1|显示在进度线上方。|
|INDICATOR_TYPE_OVERLAY|2|显示覆盖在进度线上。|

## LineType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

扩展区进度条类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|值|说明|
|:--------------------------|:-|:-----|
|LINE_TYPE_DOTTED_LINE|0|虚线进度。|
|LINE_TYPE_NORMAL_SOLID_LINE|1|实线进度。|
|LINE_TYPE_THICK_SOLID_LINE|2|粗实线进度。|

## CapsuleType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

实况胶囊类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 4.1.0(11)

|名称|值|说明|
|:--------------------|:-|:-------|
|CAPSULE_TYPE_TEXT|1|文本实况胶囊。|
|CAPSULE_TYPE_TIMER|2|计时器实况胶囊。|
|CAPSULE_TYPE_PROGRESS|3|进度实况胶囊。|

## ExternalType

> phone 5.0.0(12)+ | 2in1 5.0.1(13)+ | tablet 5.0.0(12)+

外屏背景样式类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.0.0(12)

|名称|值|说明|
|:-----------------|:-|:------|
|BACKGROUND_COLOR|0|显示背景色。|
|BACKGROUND_PICTURE|1|显示背景图片。|

## FlightLayoutStyle

> phone 5.0.2(14)+ | 2in1 5.0.4(16)+ | tablet 5.0.2(14)+

左右文本模板子样式类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.0.2(14)

|名称|值|说明|
|:--------------------|:-|:--------|
|STYLE_FLIGHT_EMPHASIS|0|强调型子样式类型。|
|STYLE_FLIGHT_BALANCE|1|均衡型子样式类型。|

> 说明
>
> 扩展区支持强调型和均衡型两种子样式，两种子样式区别在于左右文本标题和内容字号大小不同，均衡型左右文本标题字号缩小，内容字号增大，展示效果更均衡。详细模板设计样式请参考：[实况窗设计指南>通用卡片模板>模板类型>左右文本模板](https://developer.huawei.com/consumer/cn/doc/design-guides/system-features-live-view-0000001955186861#section1511241615274)。

## SpaceType

> phone 5.0.2(14)+ | 2in1 5.0.4(16)+ | tablet 5.0.2(14)+

左右文本模板扩展区中间的显示类型，为枚举值。

**模型约束：** 此接口仅可在Stage模型下使用。

**系统能力：** SystemCapability.LiveView.LiveViewService

**设备行为差异：** 该接口在Phone、Tablet中可正常调用，在其他设备类型中无效果。

**起始版本：** 5.0.2(14)

|名称|值|说明|
|:--------------|:-|:---------|
|SPACE_TYPE_ICON|0|扩展区中间显示图标。|
|SPACE_TYPE_TEXT|1|扩展区中间显示文本。|