aodNaviManager (熄屏导航服务)

导入模块

import { aodNaviManager } from '@kit.AODNavigationKit';

aodNaviManager.isAodNaviSupported

isAodNaviSupported(): boolean

检查设备是否支持熄屏导航功能。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { abilityAccessCtrl, common } from '@kit.AbilityKit';
import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

let supported: boolean = aodNaviManager.isAodNaviSupported();
hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in checking whether AOD navigation is supported, supported: %{public}s', supported);

aodNaviManager.isAodNaviSwitchEnabled

isAodNaviSwitchEnabled(): Promise<boolean>

检查熄屏导航开关是否已启用，使用Promise异步回调。只有在设置页面中启用开关后，应用才能接入熄屏导航功能。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

aodNaviManager.isAodNaviSwitchEnabled().then((enabled: boolean) => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in checking whether AOD navigation switch is enabled, enabled: %{public}s', enabled);
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to check whether AOD navigation switch is enabled: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.getAodNaviExtendCapabilities

getAodNaviExtendCapabilities(): AodNaviExtendDataType[]

获取熄屏导航服务的扩展能力集，使用Promise异步回调。不同设备可能支持不同的扩展能力，用户可以使用此接口检查支持的能力。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

返回值：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

let capabilities: aodNaviManager.AodNaviExtendDataType[] = aodNaviManager.getAodNaviExtendCapabilities();
hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in getting AOD navigation extend capabilities, capabilities: %{public}s', JSON.stringify(capabilities));

aodNaviManager.setupAodNaviConfig

setupAodNaviConfig(config: AodNaviConfig): Promise<void>

熄屏导航配置初始化。使用Promise异步回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持熄屏导航功能的Phone设备上可正常调用，在不支持熄屏导航功能的Phone设备上返回801错误码，可调用isAodNaviSupported接口调用当前设备是否支持。

起始版本： 26.0.0

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

let config: aodNaviManager.AodNaviConfig = {
  aliveStrategy: aodNaviManager.AodNaviAliveStrategy.KEEP_ALIVE,
  aodViewDataConfig: {
    aodViewDataCount: 4,
    aodViewDataTypes: [
      aodNaviManager.AodNaviBasicDataType.DISTANCE,
      aodNaviManager.AodNaviBasicDataType.STEPS,
      aodNaviManager.AodNaviBasicDataType.CURRENT_SPEED,
      aodNaviManager.AodNaviBasicDataType.OVERALL_ELAPSED_TIME
    ]
  },
  aodVoiceBroadcastConfig: {
    distance: 1000,
    timeInterval: 60,
    enableGpsBroadcast: true
  },
  aodProxyDataTypes: [
    aodNaviManager.AodNaviBasicDataType.DISTANCE,
    aodNaviManager.AodNaviBasicDataType.STEPS,
    aodNaviManager.AodNaviBasicDataType.CURRENT_SPEED
  ]
};

aodNaviManager.setupAodNaviConfig(config).then(() => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in setting up AOD navigation config.');
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to set up AOD navigation config: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.onAodNaviEvent

onAodNaviEvent(callback: Callback<AodNaviEventInfo>): void

注册熄屏导航事件监听。只允许注册一个回调，新回调将覆盖之前的回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

aodNaviManager.onAodNaviEvent((eventInfo: aodNaviManager.AodNaviEventInfo) => {
  hilog.info(0x0000, 'aodnavigationSample', 'Received AOD navigation event: eventType: %{public}d, eventId: %{public}s', eventInfo.eventType, eventInfo.eventId);
  
  switch (eventInfo.eventType) {
    case aodNaviManager.AodNaviEventType.AOD_NAVI_ENTER:
      hilog.info(0x0000, 'aodnavigationSample', 'AOD navigation enter event handled.');
      break;
    case aodNaviManager.AodNaviEventType.AOD_NAVI_EXIT:
      hilog.info(0x0000, 'aodnavigationSample', 'AOD navigation exit event handled.');
      break;
    case aodNaviManager.AodNaviEventType.AOD_NAVI_DATA_CACHE:
      hilog.info(0x0000, 'aodnavigationSample', 'AOD navigation data cache event handled.');
      break;
    case aodNaviManager.AodNaviEventType.AOD_NAVI_VOICE_BROADCAST:
      hilog.info(0x0000, 'aodnavigationSample', 'AOD navigation voice broadcast event handled.');
      break;
  }
});

aodNaviManager.offAodNaviEvent

offAodNaviEvent(callback?: Callback<AodNaviEventInfo>): void

解注册熄屏导航事件监听。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  aodNaviManager.offAodNaviEvent();
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in stopping AOD navigation event listener.');
  } catch (error) {
    hilog.error(0x0000, 'aodNavigationSample', 'Failed to stop AOD navigation event listener:  %{public}d %{public}s', error.code, error.message);
}

aodNaviManager.setPlanRouteToAod

setPlanRouteToAod(planRoutes: PlanRoute[], markPoints?: MarkPoint[]): Promise<void>

设置熄屏导航规划路线至AOD Navigation Kit，熄屏导航界面进行导航规划路线绘制，使用Promise异步回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持熄屏导航功能的Phone设备上可正常调用，在不支持熄屏导航功能的Phone设备上返回801错误码，可调用isAodNaviSupported接口调用当前设备是否支持。

起始版本： 26.0.0

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

let planRoutes: aodNaviManager.PlanRoute[] = [
  { longitude: 116.404, latitude: 39.915 },
  { longitude: 116.414, latitude: 39.925 },
  { longitude: 116.424, latitude: 39.935 }
];

let markPoints: aodNaviManager.MarkPoint[] = [
  { name: '起点', longitude: 116.404, latitude: 39.915 },
  { name: '终点', longitude: 116.424, latitude: 39.935 }
];

aodNaviManager.setPlanRouteToAod(planRoutes, markPoints).then(() => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in setting plan route to AOD.');
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to set plan route to AOD: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.setNaviDataToAod

setNaviDataToAod(eventId: string, aodNaviInteractData: AodNaviInteractData): Promise<void>

将设备亮屏期间应用产生的轨迹及导航数据同步至AOD Navigation Kit。使用Promise异步回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持熄屏导航功能的Phone设备上可正常调用，在不支持熄屏导航功能的Phone设备上返回801错误码，可调用isAodNaviSupported接口调用当前设备是否支持。

起始版本： 26.0.0

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

let eventId: string = 'event_123456';
let historyRoutes: aodNaviManager.HistoryRoute[] = [
  { timestamp: 1234567890, longitude: 116.404, latitude: 39.915 },
  { timestamp: 1234567891, longitude: 116.405, latitude: 39.916 }
];

let aodNaviData: aodNaviManager.AodNaviData = {
  timestamp: Date.now() / 1000,
  distance: 1000,
  steps: 1500,
  currentSpeed: 5.5
};

let aodNaviInteractData: aodNaviManager.AodNaviInteractData = {
  historyRoutes: historyRoutes,
  aodNaviData: aodNaviData
};

aodNaviManager.setNaviDataToAod(eventId, aodNaviInteractData).then(() => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in setting navigation data to AOD.');
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to set navigation data to AOD: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.updateAodViewData

updateAodViewData(aodViewData: AodViewData): Promise<void>

更新熄屏导航界面视图数据。使用Promise异步回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持熄屏导航功能的Phone设备上可正常调用，在不支持熄屏导航功能的Phone设备上返回801错误码，可调用isAodNaviSupported接口调用当前设备是否支持。

起始版本： 26.0.0

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

let aodViewData: aodNaviManager.AodViewData = {
  "distance": 1500,
  "steps": 2000,
  "currentSpeed": 6.0
};

aodNaviManager.updateAodViewData(aodViewData).then(() => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in updating AOD view data.');
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to update AOD view data: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.updateAppRecordStatus

updateAppRecordStatus(recordStatus: AppRecordStatus): Promise<void>

更新应用导航记录状态。使用Promise异步回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持熄屏导航功能的Phone设备上可正常调用，在不支持熄屏导航功能的Phone设备上返回801错误码，可调用isAodNaviSupported接口调用当前设备是否支持。

起始版本： 26.0.0

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

aodNaviManager.updateAppRecordStatus(aodNaviManager.AppRecordStatus.RECORDING).then(() => {
  hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in updating app record status.');
}).catch((err: BusinessError) => {
  hilog.error(0x0000, 'aodnavigationSample', 'Failed to update app record status: %{public}d %{public}s', err.code, err.message);
});

aodNaviManager.onAltitudeClimbChange

onAltitudeClimbChange(callback: Callback<AltitudeClimbInfo>): void

注册累计爬升变化监听。只允许注册一个回调，新回调将覆盖之前的回调。

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

系统能力： SystemCapability.PhoneService.AodNaviService

设备行为差异： 在支持累计爬升功能的Phone设备上可正常调用，在不支持累计爬升功能的Phone设备上返回801错误码，可调用getAodNaviExtendCapabilities接口获取设备是否支持累计爬升能力。

起始版本： 26.0.0

参数：

错误码：

以下错误码的详细介绍请参见通用错误码和ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
try {
  aodNaviManager.onAltitudeClimbChange((info: aodNaviManager.AltitudeClimbInfo) => {
    hilog.info(0x0000, 'aodnavigationSample', 'Altitude climb change - climbUp: %{public}d, climbDown: %{public}d', info.accumulateClimbUp, info.accumulateClimbDown);
  });
} catch (error) {
    hilog.error(0x0000, 'aodNavigationSample', 'Failed to subscribe altitude climb change: %{public}d %{public}s', error.code, error.message);
}

aodNaviManager.offAltitudeClimbChange

offAltitudeClimbChange(callback?: Callback<AltitudeClimbInfo>): void

解注册累计爬升变化监听。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { aodNaviManager } from '@kit.AODNavigationKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

aodNaviManager.offAltitudeClimbChange();
hilog.info(0x0000, 'aodnavigationSample', 'Succeeded in unsubscribing from altitude climb change.');

AodNaviConfig

熄屏导航配置项。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviInteractData

应用与AOD Navigation Kit之间的交互数据。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AltitudeClimbInfo

海拔爬升信息。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviData

熄屏导航数据，包括距离、步数及步频等数据。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodVoiceBroadcastConfig

熄屏导航语音播报配置项。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodViewDataConfig

熄屏导航视图数据配置项。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

PlanRoute

规划路线信息，包括经度和纬度。采用GCJ02坐标系标准。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

HistoryRoute

历史轨迹信息。采用GCJ02坐标系标准。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

MarkPoint

标记点信息。采用GCJ02坐标系标准。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviEventInfo

熄屏导航事件信息。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

VoiceBroadcastData

语音播报数据。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviDataType

type AodNaviDataType = AodNaviBasicDataType | AodNaviExtendDataType

熄屏导航服务数据类型，主要包括基础数据类型和扩展数据类型。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodViewData

type AodViewData = Partial<Record<AodNaviDataType, number>>

熄屏导航视图数据，用于更新熄屏导航显示数据项。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

MarkPointIndexToDistance

type MarkPointIndexToDistance = Record<number, number>

标记点索引到距离的映射。用于熄屏导航语音播报。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviBasicDataType

熄屏导航基本数据类型枚举。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviExtendDataType

熄屏导航扩展数据类型枚举。扩展数据类型依赖于设备硬件支持。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviEventType

熄屏导航事件回调类型。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

VoiceBroadcastEvent

语音播报事件类型枚举。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AodNaviAliveStrategy

熄屏导航应用保活策略：应用休眠或保活。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

GPSStatus

GPS状态枚举。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0

AppRecordStatus

应用导航记录状态枚举。

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

系统能力： SystemCapability.PhoneService.AodNaviService

起始版本： 26.0.0