HarmonyOS
目录:
- CrossDeviceFlow
- DeviceDiscovery
- DevicePicker
- DistributedData
- HarmonyNLP
- HarmonyScan
- HarmonyVisionAI
- HarmonyVoice
- OnDeviceAI
- ScreenCast
- ServiceWidget
跨设备流转(CrossDeviceFlow)
跨设备流转组件 - 实现应用在鸿蒙设备间的无缝迁移。 鸿蒙独有组件,基于 Mission continuation/DistributedMissionManager API。
使用指导保存页面状态、选择目标并发起流转的完整案例与运行前提查看 →
属性
- 可用目标数(AvailableTargetCount)
- 可用目标设备数量(只读)
- 正在流转(IsFlowing)
- 是否正在流转(只读)
- 本机设备ID(LocalDeviceId)
- 本地设备ID(只读)
- 已选目标(SelectedTarget)
- 选中的目标设备(只读)
事件
- 可用目标变化时(AvailableTargetsChanged)()
- 可用目标设备列表变化时触发
- 出错时(Error)(错误信息)
- 发生错误时触发
- 流转完成时(FlowCompleted)(目标设备)
- 流转完成时触发
- 流转失败时(FlowFailed)(目标设备,错误信息)
- 流转失败时触发
- 流转开始时(FlowStarted)(目标设备)
- 流转开始时触发
- 状态已恢复时(StateRestored)(状态JSON)
- 状态恢复完成时触发
- 状态已保存时(StateSaved)()
- 状态保存完成时触发
方法
- 获取可用目标(GetAvailableTargets)()
- 获取可用的流转目标设备列表
- 获取本机设备信息(GetLocalDeviceInfo)()
- 获取本地设备信息
- 恢复状态(RestoreState)()
- 恢复应用状态
- 保存状态(SaveState)(状态JSON)
- 保存当前应用状态
- 选择目标(SelectTarget)(目标设备ID)
- 选择流转目标设备
- 开始接续(StartContinuation)()
- 开始跨设备流转
设备发现(DeviceDiscovery)
设备发现组件 - 发现局域网内的鸿蒙设备,支持设备绑定与状态监听。 鸿蒙独有组件,基于 DistributedHardware DeviceDiscovery API。
使用指导初始化并扫描设备、停止扫描并查看当前列表的完整案例与运行前提查看 →
属性
- 已发现设备数(DiscoveredDeviceCount)
- 已发现的设备数量(只读)
- 正在发现(IsDiscovering)
- 是否正在发现设备(只读)
- 本机设备ID(LocalDeviceId)
- 本地设备ID(只读)
- 本机设备名(LocalDeviceName)
- 本地设备名称(只读)
- 本机设备类型(LocalDeviceType)
- 本地设备类型(只读)
- 本机网络ID(LocalNetworkId)
- 本地网络ID(只读)
事件
- 设备已绑定时(DeviceBound)(设备ID)
- 设备绑定成功时触发
- 发现设备时(DeviceDiscovered)(设备JSON)
- 发现新设备时触发
- 设备名改变时(DeviceNameChanged)(新名称)
- 本地设备名称变化时触发
- 设备状态改变时(DeviceStateChanged)(设备JSON,动作)
- 设备状态变化时触发
- 设备已解绑时(DeviceUnbound)(设备ID)
- 设备解绑成功时触发
- 发现失败时(DiscoveryFailed)(原因)
- 发现失败时触发
- 出错时(Error)(错误信息)
- 发生错误时触发
- 已初始化时(Initialized)()
- 初始化完成时触发
方法
- 绑定设备(BindDevice)(设备ID)
- 绑定设备
- 获取设备信息(GetDeviceInfo)(索引)
- 获取指定索引的设备信息
- 获取已发现设备(GetDiscoveredDevices)()
- 获取已发现的设备列表
- 获取远端设备名(GetRemoteDeviceName)(设备ID)
- 获取远程设备名称
- 初始化(Initialize)()
- 初始化设备发现服务
- 开始发现(StartDiscovery)()
- 开始发现周围设备
- 停止发现(StopDiscovery)()
- 停止发现设备
- 解绑设备(UnbindDevice)(设备ID)
- 解绑设备
设备选择器(DevicePicker)
设备选择器组件 - 弹出鸿蒙系统级设备选择器UI。 鸿蒙独有组件,基于 DevicePicker API。
使用指导显示系统设备选择器、释放选择器的完整案例与运行前提查看 →
属性
- 业务描述(BusinessDesc)
- 业务描述文案
- 已选设备ID(SelectedDeviceId)
- 选中的设备ID(只读)
- 已选设备名(SelectedDeviceName)
- 选中的设备名称(只读)
事件
- 设备已选择时(DeviceSelected)(设备信息JSON)
- 用户选择设备时触发
- 设备已取消选择时(DeviceUnselected)(设备信息JSON)
- 用户取消选择设备时触发
- 出错时(Error)(错误信息)
- 发生错误时触发
- 选择器已显示时(PickerShown)()
- 选择器显示时触发
- 已选设备离线时(SelectedDeviceOffline)(设备信息JSON)
- 选中的设备离线时触发
- 状态已更新时(StateUpdated)(状态JSON)
- 设备状态更新完成时触发
方法
- 释放(Release)()
- 释放设备选择器资源
- 显示选择器(ShowPicker)()
- 显示设备选择器
- 更新状态(UpdateState)(网络ID,状态,描述)
- 更新设备状态
分布式数据(DistributedData)
分布式数据组件 - 跨设备数据同步与存储。 鸿蒙独有组件,基于 DistributedDataManager API。
使用指导写入并读取键值、创建同步对象的完整案例与运行前提查看 →
属性
- 自动同步(AutoSync)
- 是否自动同步
- 已连接设备数(ConnectedDeviceCount)
- 已连接的设备数量(只读)
- 本机设备ID(LocalDeviceId)
- 本地设备ID(只读)
- 存储ID(StoreId)
- 数据存储ID
- 启用同步(SyncEnabled)
- 是否启用数据同步
事件
- 数据改变时(DataChanged)(键,值)
- 数据变化时触发
- 出错时(Error)(错误信息)
- 发生错误时触发
- 对象变化时(ObjectChanged)(键,值)
- 同步对象值变化时触发
- 存储已打开时(StoreOpened)()
- 数据存储打开成功时触发
- 同步完成时(SyncComplete)(结果)
- 同步完成时触发
- 同步状态变化时(SyncStatusChanged)(状态)
- 同步状态变化时触发
方法
- 创建同步对象(CreateSyncObject)(键,值)
- 创建同步对象
- 删除(Delete)(键)
- 删除指定键的数据
- 执行GET请求(Get)(键)
- 获取指定键的值
- 获取数据(GetEntries)()
- 获取所有数据条目
- 获取对象值(GetObjectValue)(键)
- 获取同步对象的值
- 初始化(Initialize)(存储ID)
- 初始化分布式数据存储
- 加入会话(JoinSession)(会话ID)
- 加入同步会话
- 离开会话(LeaveSession)()
- 离开同步会话
- 写入(Put)(键,值)
- 存储键值对数据
- 设置对象值(SetObjectValue)(键,值)
- 设置同步对象的值
- 同步到设备(SyncToDevice)(设备ID)
- 将数据同步到指定设备
自然语言处理(HarmonyNLP)
自然语言处理组件 - 鸿蒙端侧中文分词与命名实体识别。 鸿蒙独有组件,基于 Core NLP Kit (中文分词 + NER)。
属性
- 是否初始化(IsInitialized)
- 是否已初始化(只读)
事件
- 实体提取完成时(EntitiesExtracted)(结果JSON)
- 实体识别完成时触发
- 出错时(Error)(错误信息)
- 发生错误时触发
- 已初始化时(Initialized)()
- 初始化完成时触发
- 分词完成时(WordsSegmented)(结果JSON)
- 分词完成时触发
方法
- 提取实体(ExtractEntities)(文本)
- 命名实体识别
- 获取实体类型名(GetEntityTypeName)(类别)
- 获取实体类型名称
- 初始化(Initialize)()
- 初始化NLP引擎
- 分词(SegmentWords)(文本)
- 中文分词
扫码(HarmonyScan)
扫码组件 - 鸿蒙ScanKit扫码与二维码生成。 鸿蒙独有组件,基于 ScanKit API。
使用指导启动系统扫码、识别项目图片的完整案例与运行前提查看 →
属性
- 允许相册(EnableAlbum)
- 是否允许从相册扫码
- 多码模式(EnableMultiMode)
- 是否启用多码模式
- 扫码类型(ScanTypes)
- 扫码类型
事件
- 出错时(Error)(错误信息)
- 发生错误时触发
- 二维码生成时(QRCodeGenerated)(结果JSON)
- 二维码生成完成时触发
- 取消扫码时(ScanCancelled)()
- 扫码被取消时触发
- 获得扫码结果时(ScanResult)(结果JSON)
- 扫码结果返回时触发
- 开始扫码时(ScanStarted)()
- 扫码界面启动时触发
方法
- 从图片识别(DetectFromImage)(图片地址)
- 从图片检测码
- 生成二维码(GenerateQRCode)(内容,宽度,高度)
- 生成二维码
- 开始扫码(StartScan)()
- 启动扫码界面
视觉AI(HarmonyVisionAI)
视觉AI组件 - 鸿蒙端侧视觉智能识别。 鸿蒙独有组件,基于 Core Vision Kit (OCR/目标检测/人脸/骨架/分割)。
属性
- 是否初始化(IsInitialized)
- 是否已初始化(只读)
事件
- 出错时(Error)(错误信息)
- 发生错误时触发
- 人脸对比完成时(FacesCompared)(结果JSON)
- 人脸比对完成时触发
- 人脸检测完成时(FacesDetected)(结果JSON)
- 人脸检测完成时触发
- 已初始化时(Initialized)()
- 初始化完成时触发
- 收到语言列表时(LanguagesReceived)(语言列表JSON)
- 语言列表获取完成时触发
- 物体检测完成时(ObjectsDetected)(结果JSON)
- 目标检测完成时触发
- 骨骼检测完成时(SkeletonDetected)(结果JSON)
- 骨骼检测完成时触发
- 主体提取完成时(SubjectExtracted)(结果JSON)
- 主体提取完成时触发
- 文字识别完成时(TextRecognized)(结果JSON)
- 文字识别完成时触发
方法
- 人脸对比(CompareFaces)(图片路径1,图片路径2)
- 人脸比对
- 人脸检测(DetectFaces)(图片地址)
- 人脸检测
- 物体检测(DetectObjects)(图片地址)
- 目标检测
- 骨骼检测(DetectSkeleton)(图片地址)
- 骨骼检测
- 主体提取(ExtractSubject)(图片地址,最大主体数)
- 图像主体提取
- 获取物体类型名(GetObjectTypeName)(类型ID)
- 获取目标类型名称
- 获取支持的OCR语言(GetSupportedOCRLanguages)()
- 获取OCR支持的语言列表
- 初始化(Initialize)()
- 初始化视觉AI引擎
- 文字识别(RecognizeText)(图片地址)
- 文字识别(OCR)
语音(HarmonyVoice)
语音组件 - 鸿蒙端侧语音合成(TTS)与语音识别(ASR)。 鸿蒙独有组件,基于 HMS Core TTS + ASR API。
属性
- 正在聆听(IsListening)
- 是否正在监听(只读)
- 正在朗读(IsSpeaking)
- 是否正在朗读(只读)
- 语言(Language)
- 语音语言
- 在线(Online)
- 是否使用在线模式(1=在线, 0=离线)
- 发音人(Person)
- 发音人编号
- 倾斜角(Pitch)
- 音调
- 语速(SpeechRate)
- 语速
- 音量(Volume)
- 音量
事件
- 出错时(Error)(错误信息)
- 发生错误时触发
- 聆听开始时(ListeningStarted)()
- 语音识别开始时触发
- 产生部分结果时(PartialResult)(文本)
- 识别到部分结果时触发
- 识别完成时(RecognitionComplete)(结果文本)
- 语音识别完成时触发
- 朗读完成时(SpeakCompleted)()
- 朗读完成时触发
- 朗读开始时(SpeakStarted)()
- 开始朗读时触发
- 朗读停止时(SpeakStopped)()
- 朗读被停止时触发
- 收到音色列表时(VoiceListReceived)(音色列表JSON)
- 语音列表获取完成时触发
方法
- 取消聆听(CancelListening)()
- 取消语音识别
- 获取音色列表(ListVoices)()
- 获取可用语音列表
- 念读(Speak)(文本)
- 朗读文本
- 开始聆听(StartListening)()
- 开始语音识别
- 停止聆听(StopListening)()
- 停止语音识别
- 停止朗读(StopSpeaking)()
- 停止朗读
端侧AI(OnDeviceAI)
端侧AI推理组件 - 在设备端运行机器学习模型推理。 鸿蒙独有组件,基于 MindSpore Lite / Neural Network Runtime API。
使用指导加载模型并检查输入、运行模型推理的完整案例与运行前提查看 →
属性
- 输入数量(InputCount)
- 模型输入数量(只读)
- 模型已加载(IsModelLoaded)
- 模型是否已加载(只读)
- 模型路径(ModelPath)
- 模型文件路径
事件
- 出错时(Error)(错误信息)
- 发生错误时触发
- 模型导出时(ModelExported)(输出路径)
- 模型导出完成时触发
- 模型加载时(ModelLoaded)(输入信息JSON)
- 模型加载完成时触发
- 预测完成时(PredictionComplete)(输出JSON)
- 推理完成时触发
- 训练步完成时(TrainingStepComplete)(损失值)
- 训练步骤完成时触发
方法
- 导出模型(ExportModel)(输出路径)
- 导出模型
- 获取输入信息(GetInputInfo)(索引)
- 获取模型输入信息
- 加载模型(LoadModel)(模型路径)
- 加载模型
- 预测(Predict)(输入Base64)
- 执行模型推理
- 调整输入尺寸(ResizeInput)(索引,宽度,高度)
- 调整模型输入尺寸
- 执行训练步(RunTrainingStep)(输入Base64,目标Base64)
- 执行一步训练
投屏(ScreenCast)
投屏会话组件 - 管理鸿蒙设备的投屏与媒体播放控制。 鸿蒙独有组件,基于 AVSession / Cast API。
使用指导创建并激活投屏会话、播放媒体并停止的完整案例与运行前提查看 →
属性
- 投屏设备名(CastDeviceName)
- 投屏设备名称(只读)
- 播放状态(PlaybackState)
- 播放状态(只读)
- 会话激活(SessionActive)
- 会话是否活跃(只读)
事件
- 投屏设备变化时(CastDeviceChanged)(设备信息)
- 投屏设备变化时触发
- 投屏出错时(CastError)(错误信息)
- 投屏发生错误时触发
- 媒体信息变化时(MediaMetadataChanged)()
- 媒体元数据变化时触发
- 播放状态变化时(PlaybackStateChanged)(状态)
- 播放状态变化时触发
- 会话已激活时(SessionActivated)()
- 会话激活完成时触发
- 会话已创建时(SessionCreated)()
- 会话创建完成时触发
- 会话已销毁时(SessionDestroyed)()
- 会话销毁时触发
方法
- 激活会话(ActivateSession)()
- 激活投屏会话
- 创建会话(CreateSession)()
- 创建投屏会话
- 获取输出设备(GetOutputDevice)()
- 获取输出设备信息
- 发送投屏指令(SendCastCommand)(命令)
- 发送投屏控制命令
- 设置媒体信息(SetMediaMetadata)(标题,艺术家,媒体地址)
- 设置媒体元数据
- 开始投屏播放(StartCastPlayback)()
- 开始投屏播放
- 停止投屏播放(StopCastPlayback)()
- 停止投屏播放
服务卡片(ServiceWidget)
服务卡片组件 - 管理鸿蒙桌面服务卡片(Widget)。 鸿蒙独有组件,基于 FormExtension Ability API。
使用指导登记并更新卡片、查看与取消登记的完整案例与运行前提查看 →
属性
- 卡片尺寸(Dimension)
- 卡片尺寸规格
- 是否动态(IsDynamic)
- 是否为动态卡片
- 已注册卡片数(RegisteredWidgetCount)
- 已注册的卡片数量(只读)
- 定时更新时间(ScheduledUpdateTime)
- 定时更新时间
- 允许更新(UpdateEnabled)
- 是否启用定时更新
- 卡片名(WidgetName)
- 卡片名称
事件
- 出错时(Error)(错误信息)
- 发生错误时触发
- 卡片被点击时(WidgetClicked)(卡片ID,消息)
- 卡片被点击时触发
- 卡片更新时(WidgetUpdated)(卡片ID)
- 卡片数据更新完成时触发
方法
- 获取全部卡片信息(GetAllWidgetInfo)()
- 获取所有卡片信息
- 获取已注册卡片ID(GetRegisteredFormIds)()
- 获取所有已注册的表单ID
- 按模块获取卡片(GetWidgetsByModule)(模块名)
- 按模块获取卡片信息
- 注册卡片ID(RegisterFormId)(卡片ID)
- 注册卡片表单ID
- 设置刷新时间(SetRefreshTime)(时间)
- 设置卡片刷新时间
- 注销卡片ID(UnregisterFormId)(卡片ID)
- 取消注册卡片表单ID
- 更新卡片(UpdateWidget)(数据JSON)
- 更新卡片数据
- 更新全部卡片(UpdateWidgets)(卡片ID列表JSON,数据JSON)
- 批量更新多个卡片
扫码添加客服咨询