1# Interfaces (其他) 2<!--Kit: Camera Kit--> 3<!--Subsystem: Multimedia--> 4<!--Owner: @qano--> 5<!--Designer: @leo_ysl--> 6<!--Tester: @xchaosioda--> 7<!--Adviser: @zengyawen--> 8 9> **说明：** 10> 11> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 12 13## CameraDevice 14 15相机设备信息。 16 17**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 18 19**系统能力：** SystemCapability.Multimedia.Camera.Core 20 21| 名称 | 类型 | 只读 | 可选 | 说明 | 22|---------------------------------|-------------------------------------| ---- |----|---------- | 23| cameraId | string | 是 | 否 | 相机ID。| 24| cameraPosition | [CameraPosition](arkts-apis-camera-e.md#cameraposition) | 是 | 否 | 相机位置。 | 25| cameraType | [CameraType](arkts-apis-camera-e.md#cameratype) | 是 | 否 | 相机类型。 | 26| connectionType | [ConnectionType](arkts-apis-camera-e.md#connectiontype) | 是 | 否 | 相机连接类型。 | 27| cameraOrientation<sup>12+</sup> | number | 是 | 否 | 相机安装角度，不会随着屏幕旋转而改变，取值范围为0°-360°，单位：度。 | 28| hostDeviceName<sup>15+</sup> | string | 是 | 否 | 远端设备名称。若当前无远端设备，返回为空。 | 29| hostDeviceType<sup>15+</sup> | [HostDeviceType](arkts-apis-camera-e.md#hostdevicetype15) | 是 | 否 | 远端设备类型。 | 30 31## CameraStatusInfo 32 33相机管理器回调返回的接口实例，该实例表示相机状态信息。 34 35**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 36 37**系统能力：** SystemCapability.Multimedia.Camera.Core 38 39| 名称 | 类型 | 只读 | 可选 | 说明 | 40| ------ | ----------------------------- | --------- |------------ | ---------- | 41| camera | [CameraDevice](arkts-apis-camera-i.md#cameradevice) | 否 | 否 | 相机信息。 | 42| status | [CameraStatus](arkts-apis-camera-e.md#camerastatus) | 否 | 否 | 相机状态。 | 43 44## FoldStatusInfo<sup>12+</sup> 45 46相机管理器回调返回的接口实例，表示折叠机折叠状态信息。 47 48**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 49 50**系统能力：** SystemCapability.Multimedia.Camera.Core 51 52| 名称 | 类型 | 只读 | 可选 | 说明 | 53| ------ | ----------------------------- | --------- |------------ | ---------- | 54| supportedCameras | [Array<CameraDevice\>](arkts-apis-camera-i.md#cameradevice) | 是 | 否 | 当前折叠状态所支持的相机信息列表。 | 55| foldStatus | [FoldStatus](arkts-apis-camera-e.md#foldstatus12) | 是 | 否 | 折叠屏折叠状态。 | 56 57## Profile 58 59相机配置信息项。 60 61**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 62 63**系统能力：** SystemCapability.Multimedia.Camera.Core 64 65| 名称 | 类型 | 只读 | 可选 | 说明 | 66| -------- | ----------------------------- |---- | ---- | ------------- | 67| format | [CameraFormat](arkts-apis-camera-e.md#cameraformat) | 是 | 否 | 输出格式。 | 68| size | [Size](#size) | 是 | 否 | 分辨率。<br>设置的是相机的分辨率宽度和高度，而非实际输出图像的宽度和高度。 | 69 70## FrameRateRange 71 72帧率范围。 73 74**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 75 76**系统能力：** SystemCapability.Multimedia.Camera.Core 77 78| 名称 | 类型 | 只读 | 可选 | 说明 | 79| -------- | ----------------------------- |----- |---| -------------- | 80| min | number | 是 | 否 | 最小帧率，单位：fps。 | 81| max | number | 是 | 否 | 最大帧率，单位：fps。 | 82 83## VideoProfile 84 85视频配置信息项，继承[Profile](#profile)。 86 87**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 88 89**系统能力：** SystemCapability.Multimedia.Camera.Core 90 91| 名称 | 类型 | 只读 | 可选 | 说明 | 92| ------------------------- | ----------------------------------------- | --- | ---- |----------- | 93| frameRateRange | [FrameRateRange](arkts-apis-camera-i.md#frameraterange) | 是 | 否 | 帧率范围，单位：fps(frames per second)。 | 94 95## CameraOutputCapability 96 97相机输出能力项。 98 99**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 100 101**系统能力：** SystemCapability.Multimedia.Camera.Core 102 103| 名称 | 类型 | 只读 | 可选 | 说明 | 104| ----------------------------- | --------------------------------------------------- | ---- | ---- |-------------------| 105| previewProfiles | Array\<[Profile](#profile)\> | 是 | 否 | 支持的预览配置信息集合。 | 106| photoProfiles | Array\<[Profile](#profile)\> | 是 | 否 | 支持的拍照配置信息集合。 | 107| videoProfiles | Array\<[VideoProfile](#videoprofile)\> | 是 | 否 | 支持的录像配置信息集合。 | 108| supportedMetadataObjectTypes | Array\<[MetadataObjectType](arkts-apis-camera-e.md#metadataobjecttype)\> | 是 | 否 | 支持的metadata流类型信息集合。 | 109 110## TorchStatusInfo<sup>11+</sup> 111 112手电筒回调返回的接口实例，表示手电筒状态信息。 113 114**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 115 116**系统能力：** SystemCapability.Multimedia.Camera.Core 117 118| 名称 | 类型 | 只读 | 可选 | 说明 | 119| ---------------- | ---------- | ---- | ---- | ----------- | 120| isTorchAvailable | boolean | 是 | 否 | 手电筒是否可用。true表示手电筒可用，false表示手电筒不可用。| 121| isTorchActive | boolean | 是 | 否 | 手电筒是否被激活。true表示手电筒被激活，false表示手电筒未被激活。 | 122| torchLevel | number | 是 | 否 | 手电筒亮度等级，取值范围为[0,1]，越靠近1，亮度越大。 | 123 124## Size 125 126尺寸参数。 127 128**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 129 130**系统能力：** SystemCapability.Multimedia.Camera.Core 131 132| 名称 | 类型 | 只读 | 可选 | 说明 | 133| ------ | ------ | ---- |-----| ------------ | 134| height | number | 否 | 否 | 图像尺寸高(像素)。 | 135| width | number | 否 | 否 | 图像尺寸宽(像素)。 | 136 137## Point 138 139点坐标用于对焦和曝光配置。 140 141**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 142 143**系统能力：** SystemCapability.Multimedia.Camera.Core 144 145| 名称 | 类型 | 只读 | 可选 | 说明 | 146| ------ | ------ | ------ | ------ | ------------ | 147| x | number | 否 | 否 | 点的x坐标。 | 148| y | number | 否 | 否 | 点的y坐标。 | 149 150## CameraConcurrentInfo<sup>18+</sup> 151 152相机的输出并发能力信息。 153 154**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 155 156**系统能力：** SystemCapability.Multimedia.Camera.Core 157 158| 名称 | 类型 | 只读 | 可选 | 说明 | 159| ------ | ------ |----|-----| ------------ | 160| device | [CameraDevice](arkts-apis-camera-i.md#cameradevice) | 是 | 否 | 相机并发设备。 | 161| type | [CameraConcurrentType](arkts-apis-camera-e.md#cameraconcurrenttype18) | 是 | 否 | 镜头并发类型。 | 162| modes | Array\<[SceneMode](arkts-apis-camera-e.md#scenemode11) \> | 是 | 否 | 相机支持的模式。 | 163| outputCapabilities | Array\<[CameraOutputCapability](#cameraoutputcapability) \> | 是 | 否 | 相机对应模式的输出能力集。 | 164 165## Location 166 167图片地理位置信息。 168 169**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 170 171**系统能力：** SystemCapability.Multimedia.Camera.Core 172 173| 名称 | 类型 | 只读 | 可选 |说明 | 174| ------------ | ------ | ---- |-----|------------ | 175| latitude | number | 否 | 否 |纬度（度）。取值范围：[-90, 90]。 | 176| longitude | number | 否 | 否 |经度（度）。取值范围：[-180, 180]。 | 177| altitude | number | 否 | 否 |海拔（米）。 | 178 179## PhotoCaptureSetting 180 181拍摄照片的设置。 182 183**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 184 185**系统能力：** SystemCapability.Multimedia.Camera.Core 186 187| 名称 | 类型 | 只读 | 可选 | 说明 | 188| -------- | ------------------------------- | ---- | ---- |----------------------------------------------------------------------| 189| quality | [QualityLevel](arkts-apis-camera-e.md#qualitylevel) | 否 | 是 | 图片质量（默认低）。 | 190| rotation | [ImageRotation](arkts-apis-camera-e.md#imagerotation) | 否 | 是 | 图片旋转角度（默认0度，顺时针旋转）。 | 191| location | [Location](#location) | 否 | 是 | 图片地理位置信息（默认以设备硬件信息为准）。 | 192| mirror | boolean | 否 | 是 | 镜像使能开关（默认关）。使用之前需要使用[isMirrorSupported](arkts-apis-camera-PhotoOutput.md#ismirrorsupported)进行判断是否支持。true表示使能，false表示不使能。 | 193 194## FrameShutterInfo 195 196拍照帧输出信息。 197 198**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 199 200**系统能力：** SystemCapability.Multimedia.Camera.Core 201 202| 名称 | 类型 | 只读 | 可选 | 说明 | 203| --------- | ------ | ---- | ---- | ---------- | 204| captureId | number | 否 | 否 | 拍照的ID。| 205| timestamp | number | 否 | 否 | 快门时间戳，单位毫秒。| 206 207## FrameShutterEndInfo<sup>12+</sup> 208 209拍照曝光结束信息。 210 211**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 212 213**系统能力：** SystemCapability.Multimedia.Camera.Core 214 215| 名称 | 类型 | 只读 | 可选 | 说明 | 216| --------- | ------ | ---- | ---- | ---------- | 217| captureId | number | 否 | 否 | 拍照的ID。| 218 219## CaptureStartInfo<sup>11+</sup> 220 221拍照开始信息。 222 223**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 224 225**系统能力：** SystemCapability.Multimedia.Camera.Core 226 227| 名称 | 类型 | 只读 | 可选 | 说明 | 228| ---------- | ------ | ---- | ---- | --------- | 229| captureId | number | 否 | 否 | 拍照的ID。| 230| time | number | 否 | 否 | 预估的单次拍照底层出sensor采集帧时间，如果上报-1，代表没有预估时间。 | 231 232## CaptureEndInfo 233 234拍照停止信息。 235 236**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 237 238**系统能力：** SystemCapability.Multimedia.Camera.Core 239 240| 名称 | 类型 | 只读 | 可选 | 说明 | 241| ---------- | ------ | ---- | ---- | ---------| 242| captureId | number | 否 | 否 | 拍照的ID。| 243| frameCount | number | 否 | 否 | 帧数。| 244 245## AutoDeviceSwitchStatus<sup>13+</sup> 246 247自动切换镜头状态信息。 248 249**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 250 251**系统能力：** SystemCapability.Multimedia.Camera.Core 252 253| 名称 | 类型 | 只读 | 可选 | 说明 | 254| ---------- |---------| ---- | ---- |-------------------------| 255| isDeviceSwitched | boolean | 是 | 否 | 自动切换镜头是否成功。true表示成功，false表示失败。 | 256| isDeviceCapabilityChanged | boolean | 是 | 否 | 自动切换镜头成功后，其镜头能力值是否发生改变。true表示发生变化，false表示未发生变化。 | 257 258## Rect 259 260矩形定义，返回的检测点坐标系以设备充电口在右侧时的横向设备方向为基准。该坐标系左上角为（0，0），右下角为（1，1），其中（topLeftX，topLeftY）表示矩形区域的左上角坐标，width和height分别表示矩形区域的宽和高。因此在实际使用中根据业务诉求需要裁剪或者选择人脸区域时，必须将矩形区域的x坐标和y坐标分别乘以实际相机输出流的宽和高，即可得到裁剪后的人脸矩形区域。 261 262**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 263 264**系统能力：** SystemCapability.Multimedia.Camera.Core 265 266| 名称 | 类型 | 只读 | 可选 | 说明 | 267| -------- | ------ | ------ |-----| --------------------- | 268| topLeftX | number | 否 | 否 | 矩形区域左上角x坐标。 | 269| topLeftY | number | 否 | 否 | 矩形区域左上角y坐标。 | 270| width | number | 否 | 否 | 矩形宽，相对值，范围[0, 1]。 | 271| height | number | 否 | 否 | 矩形高，相对值，范围[0, 1]。 | 272 273## MetadataObject 274 275相机元能力信息，[CameraInput](arkts-apis-camera-CameraInput.md)相机信息中的数据来源，通过metadataOutput.on('metadataObjectsAvailable')接口获取。 276 277**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 278 279**系统能力：** SystemCapability.Multimedia.Camera.Core 280 281| 名称 | 类型 | 只读 | 可选 |说明 | 282| ----------- | ------------------------------------------- | ---- | ---- | ----------------- | 283| type | [MetadataObjectType](arkts-apis-camera-e.md#metadataobjecttype) | 是 | 否 | metadata 类型。 | 284| timestamp | number | 是 | 否 | 当前时间戳，单位毫秒。| 285| boundingBox | [Rect](#rect) | 是 | 否 | metadata 区域框。 | 286 287## SmoothZoomInfo<sup>11+</sup> 288 289平滑变焦参数信息。 290 291**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 292 293**系统能力：** SystemCapability.Multimedia.Camera.Core 294 295| 名称 | 类型 | 只读 | 可选 | 说明 | 296| -------- | ---------- | -------- | -------- | ---------- | 297| duration | number | 否 | 否 | 平滑变焦总时长，单位ms。 | 298 299## ControlCenterStatusInfo<sup>20+</sup> 300 301相机控制器效果激活状态信息。 302 303**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 304 305**系统能力：** SystemCapability.Multimedia.Camera.Core 306 307| 名称 | 类型 | 只读 | 可选 | 说明 | 308| -------- | ---------- | -------- | -------- | ---------- | 309| effectType | [ControlCenterEffectType](arkts-apis-camera-e.md#controlcentereffecttype20) | 是 | 否 | 相机控制器效果类型。 | 310| isActive | boolean | 是| 否| 相机控制器效果激活状态。true表示已激活，false表示未激活。 |