Interfaces (其他)

说明:

本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

CameraDevice

相机设备信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
cameraId string 相机ID。
cameraPosition CameraPosition 相机位置。
cameraType CameraType 相机类型。
connectionType ConnectionType 相机连接类型。
cameraOrientation12+ number 相机安装角度,不会随着屏幕旋转而改变,取值范围为0°-360°,单位:度。
hostDeviceName15+ string 远端设备名称。若当前无远端设备,返回为空。
hostDeviceType15+ HostDeviceType 远端设备类型。

CameraStatusInfo

相机管理器回调返回的接口实例,该实例表示相机状态信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
camera CameraDevice 相机信息。
status CameraStatus 相机状态。

FoldStatusInfo12+

相机管理器回调返回的接口实例,表示折叠机折叠状态信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
supportedCameras Array<CameraDevice> 当前折叠状态所支持的相机信息列表。
foldStatus FoldStatus 折叠屏折叠状态。

Profile

相机配置信息项。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
format CameraFormat 输出格式。
size Size 分辨率。
设置的是相机的分辨率宽度和高度,而非实际输出图像的宽度和高度。

FrameRateRange

帧率范围。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
min number 最小帧率,单位:fps。
max number 最大帧率,单位:fps。

VideoProfile

视频配置信息项,继承Profile

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
frameRateRange FrameRateRange 帧率范围,单位:fps(frames per second)。

CameraOutputCapability

相机输出能力项。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
previewProfiles Array<Profile> 支持的预览配置信息集合。
photoProfiles Array<Profile> 支持的拍照配置信息集合。
videoProfiles Array<VideoProfile> 支持的录像配置信息集合。
supportedMetadataObjectTypes Array<MetadataObjectType> 支持的metadata流类型信息集合。

TorchStatusInfo11+

手电筒回调返回的接口实例,表示手电筒状态信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
isTorchAvailable boolean 手电筒是否可用。true表示手电筒可用,false表示手电筒不可用。
isTorchActive boolean 手电筒是否被激活。true表示手电筒被激活,false表示手电筒未被激活。
torchLevel number 手电筒亮度等级,取值范围为[0,1],越靠近1,亮度越大。

Size

尺寸参数。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
height number 图像尺寸高(像素)。
width number 图像尺寸宽(像素)。

Point

点坐标用于对焦和曝光配置。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
x number 点的x坐标。
y number 点的y坐标。

CameraConcurrentInfo18+

相机的输出并发能力信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
device CameraDevice 相机并发设备。
type CameraConcurrentType 镜头并发类型。
modes Array<SceneMode > 相机支持的模式。
outputCapabilities Array<CameraOutputCapability > 相机对应模式的输出能力集。

Location

图片地理位置信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
latitude number 纬度(度)。取值范围:[-90, 90]。
longitude number 经度(度)。取值范围:[-180, 180]。
altitude number 海拔(米)。

PhotoCaptureSetting

拍摄照片的设置。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
quality QualityLevel 图片质量(默认低)。
rotation ImageRotation 图片旋转角度(默认0度,顺时针旋转)。
location Location 图片地理位置信息(默认以设备硬件信息为准)。
mirror boolean 镜像使能开关(默认关)。使用之前需要使用isMirrorSupported进行判断是否支持。true表示使能,false表示不使能。

FrameShutterInfo

拍照帧输出信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
captureId number 拍照的ID。
timestamp number 快门时间戳,单位毫秒。

FrameShutterEndInfo12+

拍照曝光结束信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
captureId number 拍照的ID。

CaptureStartInfo11+

拍照开始信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
captureId number 拍照的ID。
time number 预估的单次拍照底层出sensor采集帧时间,如果上报-1,代表没有预估时间。

CaptureEndInfo

拍照停止信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
captureId number 拍照的ID。
frameCount number 帧数。

AutoDeviceSwitchStatus13+

自动切换镜头状态信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
isDeviceSwitched boolean 自动切换镜头是否成功。true表示成功,false表示失败。
isDeviceCapabilityChanged boolean 自动切换镜头成功后,其镜头能力值是否发生改变。true表示发生变化,false表示未发生变化。

Rect

矩形定义,返回的检测点坐标系以设备充电口在右侧时的横向设备方向为基准。该坐标系左上角为(0,0),右下角为(1,1),其中(topLeftX,topLeftY)表示矩形区域的左上角坐标,width和height分别表示矩形区域的宽和高。因此在实际使用中根据业务诉求需要裁剪或者选择人脸区域时,必须将矩形区域的x坐标和y坐标分别乘以实际相机预览输出流的宽和高,即可得到裁剪后的人脸矩形区域。 实际预览流的宽高指的是相机输出流的分辨率,请参考profile中的size。 预览流的数据获取请参考双路预览(ArkTs)

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
topLeftX number 矩形区域左上角x坐标,范围[0, 1]。
topLeftY number 矩形区域左上角y坐标,范围[0, 1]。
width number 矩形宽,范围[0, 1]。
height number 矩形高,范围[0, 1]。

MetadataObject

相机元能力信息,CameraInput相机信息中的数据来源,通过metadataOutput.on('metadataObjectsAvailable')接口获取。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
type MetadataObjectType metadata 类型。
timestamp number 当前时间戳,单位为纳秒(ns)。
boundingBox Rect metadata 区域框。

SmoothZoomInfo11+

平滑变焦参数信息。

原子化服务API: 从API version 19开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
duration number 平滑变焦总时长,单位ms。

ControlCenterStatusInfo20+

相机控制器效果激活状态信息。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Camera.Core

名称 类型 只读 可选 说明
effectType ControlCenterEffectType 相机控制器效果类型。
isActive boolean 相机控制器效果激活状态。true表示已激活,false表示未激活。