From 93bafe68e37f569ce70a924bd420cfd554e3d4e1 Mon Sep 17 00:00:00 2001 From: mali Date: Wed, 7 Dec 2022 09:36:32 +0800 Subject: [PATCH] Document consistency problem modification Signed-off-by: mali --- .../reference/apis/js-apis-camera.md | 294 +++++++++--------- 1 file changed, 150 insertions(+), 144 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-camera.md b/zh-cn/application-dev/reference/apis/js-apis-camera.md index da15dbe2db..5ab0579c6d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-camera.md +++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md @@ -20,7 +20,7 @@ getCameraManager(context: Context, callback: AsyncCallback): voi **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ---------------------------- | | context | [Context](../../ability/context-userguide.md) | 是 | 应用上下文。 | | callback | AsyncCallback<[CameraManager](#cameramanager)\> | 是 | 回调函数，用于获取相机管理器实例。 | @@ -47,7 +47,7 @@ getCameraManager(context: Context): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | ------------ | | context | [Context](../../ability/context-userguide.md) | 是 | 应用上下文。 | @@ -84,7 +84,7 @@ camera.getCameraManager(context).then((cameraManager) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 只读 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ----------------------------- |---- | ------------- | | format | [CameraFormat](#cameraformat) | 是 | 输出格式。 | | size | [Size](#size) | 是 | 分辨率。 | @@ -95,7 +95,7 @@ camera.getCameraManager(context).then((cameraManager) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 只读 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ----------------------------- |---- | ------------- | | min | number | 是 | 最小帧率。 | | max | number | 是 | 最大帧率。 | @@ -106,7 +106,7 @@ camera.getCameraManager(context).then((cameraManager) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 只读 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------------------------- | ----------------------------------------- | --- |----------- | | frameRateRange | [FrameRateRange](#frameraterange) | 是 | 帧率范围。 | @@ -116,7 +116,7 @@ camera.getCameraManager(context).then((cameraManager) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 只读 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------------------------- | -------------------------------------------------- | --- |------------------- | | previewProfiles | Array<[Profile](#profile)\> | 是 | 支持的预览配置信息。 | | photoProfiles | Array<[Profile](#profile)\> | 是 | 支持的拍照配置信息。 | @@ -137,7 +137,7 @@ getSupportedCameras(callback: AsyncCallback\>): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ------------------------------- | | callback | AsyncCallback\> | 是 | 使用callback方式获取支持的相机列表。 | @@ -186,7 +186,7 @@ getSupportedOutputCapability(camera:CameraDevice, callback: AsyncCallback | 是 | 使用callback方式获取相机输出能力。 | @@ -213,7 +213,7 @@ getSupportedOutputCapability(camera:CameraDevice): Promise): 使用CameraDevice对象异步创建CameraInput实例，通过注册回调函数获取结果。 -此接口为系统接口。 +此接口为公开接口。 **需要权限：** ohos.permission.CAMERA @@ -307,7 +311,7 @@ createCameraInput(camera: CameraDevice, callback: AsyncCallback): **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | --------------------------------- | | camera | [CameraDevice](#cameradevice) | 是 | CameraDevice对象。 | | callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 | @@ -330,7 +334,7 @@ createCameraInput(camera: CameraDevice): Promise 使用CameraDevice对象异步创建CameraInput实例，通过Promise获取结果。 -此接口为系统接口。 +此接口为公开接口。 **需要权限：** ohos.permission.CAMERA @@ -338,7 +342,7 @@ createCameraInput(camera: CameraDevice): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------- | ---- | ---------- | | camera | [CameraDevice](#cameradevice) | 是 | CameraDevice对象。 | @@ -362,7 +366,7 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal 根据相机位置和类型创建CameraInput实例，通过注册回调函数获取结果。 -此接口为系统接口。 +此接口为公开接口。 **需要权限：** ohos.permission.CAMERA @@ -370,7 +374,7 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | --------------------------------- | | position | [CameraPosition](#cameraposition) | 是 | 相机位置。 | | type | [CameraType](#cameratype) | 是 | 相机类型。 | @@ -394,7 +398,7 @@ createCameraInput(position: CameraPosition, type:CameraType ): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------| ---- | ----------- | | profile | [Profile](#profile) | 是 | 支持的拍照配置信息，通过getSupportedOutputCapability接口获取。 | | surfaceId| string | 是 | 从[ImageReceiver](js-apis-image.md#imagereceiver9)获取的surfaceId。| @@ -545,7 +549,7 @@ createVideoOutput(profile: VideoProfile, surfaceId: string, callback: AsyncCallb **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | ------------------------------ | | profile | [VideoProfile](#videoprofile) | 是 | 支持的录像配置信息，通过getSupportedOutputCapability接口获取。 | | surfaceId| string | 是 | 从[VideoRecorder](js-apis-media.md#videorecorder9)获取的surfaceId。| @@ -573,7 +577,7 @@ createVideoOutput(profile: VideoProfile, surfaceId: string): Promise, callback: A **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------------------------------------------- | --- | ---------------------------- | | metadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | 是 | metadata流类型信息。 | | callback | AsyncCallback<[MetadataOutput](#metadataoutput)\> | 是 | 回调函数，用于获取MetadataOutput实例。 | @@ -629,7 +633,7 @@ createMetadataOutput(metadataObjectTypes:Array): Promise | 是 | metadata流类型信息。 | @@ -657,7 +661,7 @@ createCaptureSession(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------------- | ----------------------------------------- | ----------- | ---------------------------- | | callback | AsyncCallback<[CaptureSession](#capturesession)\> | 是 | 回调函数，用于获取拍照会话实例。 | @@ -705,7 +709,7 @@ on(type: 'cameraStatus', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | --------- | | type | string | 是 | 监听事件，固定为'cameraStatus'，即镜头状态变化事件。 | | callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取镜头状态变化信息。 | @@ -729,11 +733,13 @@ on(type: 'cameraMute', callback: AsyncCallback): void 禁用回调，通过注册回调函数获取相机禁用状态变化。 +此接口为公开接口。 + **系统能力：** SystemCapability.Multimedia.Camera.Core **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------- | ---- | --------- | | type | string | 是 | 监听事件，固定为'cameraMute'，即禁用状态变化事件。 | | callback | AsyncCallback | 是 | 回调函数，用于获取禁用状态变化信息。 | @@ -755,10 +761,10 @@ cameraManager.on('cameraMute', (err, curMuetd) => { **系统能力：** SystemCapability.Multimedia.Camera.Core。 -| 名称 | 类型 | 说明 | -| ------ | ----------------------------- | ---------- | -| camera | [CameraDevice](#cameradevice) | 相机信息。 | -| status | [CameraStatus](#camerastatus) | 相机状态。 | +| 名称 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | -------------- | ---------- | +| camera | [CameraDevice](#cameradevice) | 是 | 相机信息。 | +| status | [CameraStatus](#camerastatus) | 是 | 相机状态。 | ## CameraPosition @@ -804,7 +810,7 @@ cameraManager.on('cameraMute', (err, curMuetd) => { **系统能力：** SystemCapability.Multimedia.Camera.Core。 -| 名称 | 类型 | 只读 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------------- | --------------------------------- | ---- | ---------- | | cameraId | string | 是 | CameraDevice对象| | cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 | @@ -853,7 +859,7 @@ async function getCameraInfo("cameraId") { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 默认值 | 说明 | +| 名称 | 值 | 说明 | | ----------------------- | --------- | ------------ | | CAMERA_FORMAT_RGBA_8888 | 3 | RGB格式的图片。 | | CAMERA_FORMAT_YUV_420_SP| 1003 | YUV 420 SP格式的图片。 | @@ -873,7 +879,7 @@ open\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -921,7 +927,7 @@ close\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -969,7 +975,7 @@ release\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1017,7 +1023,7 @@ on(type: 'error', camera:CameraDevice, callback: ErrorCallback { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | --------------------------------------------- | --------------------- | -| code | [CameraInputErrorCode](#camerainputerrorcode) | CameraInput中的错误码。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | --------------------------------------------- | ------------ |--------------------- | +| code | [CameraInputErrorCode](#camerainputerrorcode) | 是 |CameraInput中的错误码。 | ## FlashMode @@ -1135,7 +1141,7 @@ beginConfig\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1184,7 +1190,7 @@ commitConfig\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1232,7 +1238,7 @@ addInput\(cameraInput: CameraInput, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | --------------------------- | ---- | ------------------------ | | cameraInput | [CameraInput](#camerainput) | 是 | 需要添加的CameraInput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1259,7 +1265,7 @@ addInput\(cameraInput: CameraInput\): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | --------------------------- | ---- | ------------------------ | | cameraInput | [CameraInput](#camerainput) | 是 | 需要添加的CameraInput实例。 | @@ -1287,7 +1293,7 @@ removeInput\(cameraInput: CameraInput, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | --------------------------- | ---- | ------------------------ | | cameraInput | [CameraInput](#camerainput) | 是 | 需要移除的CameraInput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1314,7 +1320,7 @@ removeInput\(cameraInput: CameraInput\): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | --------------------------- | ---- | ------------------------ | | cameraInput | [CameraInput](#camerainput) | 是 | 需要移除的CameraInput实例。 | @@ -1342,7 +1348,7 @@ addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | | cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1369,7 +1375,7 @@ addOutput\(cameraOutput: CameraOutput\): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------- | | cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要添加的CameraOutput实例。 | @@ -1397,7 +1403,7 @@ removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------ | | cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1424,7 +1430,7 @@ removeOutput(cameraOutput: CameraOutput): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------- | ---- | ------------------------- | | cameraOutput | [CameraOutput](#cameraoutput) | 是 | 需要移除的CameraOutput实例。 | @@ -1454,7 +1460,7 @@ start\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1502,7 +1508,7 @@ stop\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1550,7 +1556,7 @@ release\(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1598,7 +1604,7 @@ hasFlash(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | -------------------------------- | | callback | AsyncCallback | 是 | 回调函数，返回true表示设备支持闪光灯。 | @@ -1646,7 +1652,7 @@ isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback): v **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------- | ---- | --------------------------------- | | flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 | | callback | AsyncCallback | 是 | 回调函数，返回true表示支持该闪光灯模式。 | @@ -1673,7 +1679,7 @@ isFlashModeSupported(flashMode: FlashMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------- | ---- | ------------- | | flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 | @@ -1706,7 +1712,7 @@ setFlashMode(flashMode: FlashMode, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------- | ---- | --------------------- | | flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -1738,7 +1744,7 @@ setFlashMode(flashMode: FlashMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------- | ---- | ------------- | | flashMode | [FlashMode](#flashmode) | 是 | 指定闪光灯模式。 | @@ -1766,7 +1772,7 @@ getFlashMode(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | --------------------------------- | | callback | AsyncCallback<[FlashMode](#flashmode)\> | 是 | 回调函数，用于获取当前设备的闪光灯模式。 | @@ -1814,7 +1820,7 @@ isExposureModeSupported(aeMode: ExposureMode, callback: AsyncCallback) **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ----------------------------- | | aeMode | [ExposureMode](#exposuremode) | 是 | 曝光模式。 | | callback | AsyncCallback | 是 | 回调函数，用于获取是否支持曝光模式。 | @@ -1841,7 +1847,7 @@ isExposureModeSupported(aeMode: ExposureMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ----------------------------- | | aeMode | [ExposureMode](#exposuremode) | 是 | 曝光模式。 | @@ -1869,7 +1875,7 @@ getExposureMode(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ---------------------------------------- | | callback | AsyncCallback<[ExposureMode](#exposuremode)\> | 是 | 回调函数，用于获取当前曝光模式。 | @@ -1917,7 +1923,7 @@ setExposureMode(aeMode: ExposureMode, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ----------------------- | | aeMode | [ExposureMode](#exposuremode) | 是 | 曝光模式。 | | callback | AsyncCallback | 是 | 回调函数，用于获取设置结果。 | @@ -1966,7 +1972,7 @@ getMeteringPoint(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ------------------------ | | callback | AsyncCallback<[Point](#point)\>| 是 | 回调函数，用于获取当前曝光点。 | @@ -2014,7 +2020,7 @@ setMeteringPoint(point: Point, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | -------------------------------| ---- | ------------------- | | exposurePoint | [Point](#point) | 是 | 曝光点。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2043,7 +2049,7 @@ setMeteringPoint(point: Point): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------------- | -------------------------------| ---- | ------------------- | | exposurePoint | [Point](#point) | 是 | 曝光点。 | @@ -2073,7 +2079,7 @@ getExposureBiasRange(callback: AsyncCallback\>): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ----------------------------- | | callback | AsyncCallback\> | 是 | 回调函数，用于获取补偿范围的数组。 | @@ -2123,7 +2129,7 @@ setExposureBias(exposureBias: number, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------| ---- | ------------------- | | exposureBias | number | 是 | 曝光补偿,getExposureBiasRange查询支持的范围 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2152,7 +2158,7 @@ setExposureBias(exposureBias: number): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------- | --------- | ---- | --------- | | exposureBias | number | 是 | 曝光补偿,getExposureBiasRange查询支持的范围 | @@ -2180,7 +2186,7 @@ getExposureValue(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------| ---- | --------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取曝光值。 | @@ -2228,7 +2234,7 @@ isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | -------------------------------- | | afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 | | callback | AsyncCallback | 是 | 回调函数，返回true表示支持该焦距模式。 | @@ -2255,7 +2261,7 @@ isFocusModeSupported(afMode: FocusMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------- | ---- | ------------- | | afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 | @@ -2285,7 +2291,7 @@ setFocusMode(afMode: FocusMode, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ------------------- | | afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2314,7 +2320,7 @@ setFocusMode(afMode: FocusMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ----------------------- | ---- | ------------- | | afMode | [FocusMode](#focusmode) | 是 | 指定的焦距模式。 | @@ -2342,7 +2348,7 @@ getFocusMode(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------- | ---- | ------------------------------- | | callback | AsyncCallback<[FocusMode](#focusmode)\> | 是 | 回调函数，用于获取当前设备的焦距模式。 | @@ -2390,7 +2396,7 @@ setFocusPoint(point: Point, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ------------------- | | point | [Point](#point) | 是 | 焦点。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2419,7 +2425,7 @@ setFocusPoint(point: Point): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ------------------- | | point | [Point](#point) | 是 | 焦点。 | @@ -2449,7 +2455,7 @@ getFocusPoint(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------- | ---- | ----------------------- | | callback | AsyncCallback<[Point](#point)\> | 是 | 回调函数，用于获取当前焦点。 | @@ -2497,7 +2503,7 @@ getFocalLength(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取当前焦距。 | @@ -2545,7 +2551,7 @@ getZoomRatioRange\(callback: AsyncCallback\>\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------ | ---- | ------------------- | | callback | AsyncCallback\> | 是 | 回调函数，用于获取可变焦距比范围，返回的数组包括其最小值和最大值。 | @@ -2593,7 +2599,7 @@ setZoomRatio(zoomRatio: number, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | -------------------- | ---- | ------------------- | | zoomRatio | number | 是 | 可变焦距比,通过getZoomRatioRange获取支持的变焦范围 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2620,7 +2626,7 @@ setZoomRatio(zoomRatio: number): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | --------- | | zoomRatio | number | 是 | 可变焦距比，通过getZoomRatioRange获取支持的变焦范围| @@ -2648,7 +2654,7 @@ getZoomRatio(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2696,7 +2702,7 @@ isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode, callback: Asyn **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------- | ---- | ------------------------------ | | vsMode | [VideoStabilizationMode](#videostabilizationmode) | 是 | 视频防抖模式。 | | callback | AsyncCallback | 是 | 回调函数，返回视频防抖模式是否支持。 | @@ -2745,7 +2751,7 @@ getActiveVideoStabilizationMode(callback: AsyncCallback **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------- | ---- | ------------------------------ | | callback | AsyncCallback | 是 | 回调函数，返回视频防抖是否正在使用。 | @@ -2793,7 +2799,7 @@ setVideoStabilizationMode(mode: VideoStabilizationMode, callback: AsyncCallback< **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------- | ---- | --------------------- | | mode | [VideoStabilizationMode](#videostabilizationmode) | 是 | 需要设置的视频防抖模式。 | | callback | AsyncCallback | 是 | 回调函数。 | @@ -2820,7 +2826,7 @@ setVideoStabilizationMode(mode: VideoStabilizationMode): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------- | ---- | --------------------- | | mode | [VideoStabilizationMode](#videostabilizationmode) | 是 | 需要设置的视频防抖模式。 | @@ -2848,7 +2854,7 @@ on(type: 'focusStateChange', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------- | ---- | ------------------------ | | type | string | 是 | 监听事件，固定为'focusStateChange'，即焦距状态变化事件。 | | callback | AsyncCallback<[FocusState](#focusstate)\> | 是 | 回调函数，用于获取焦距状态。 | @@ -2871,7 +2877,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 监听事件，固定为'error'，即拍照会话错误事件。 | | callback | ErrorCallback<[CaptureSessionError](#capturesessionerror)\> | 是 | 回调函数，用于获取错误信息。 | @@ -2902,9 +2908,9 @@ captureSession.on('error', (captureSessionError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | ------------------------------------------- | -------------------------- | -| code | [CaptureSessionError](#capturesessionerror) | CaptureSession中的错误码。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------------------------------- | -------------------------- |-------------------------- | +| code | [CaptureSessionError](#capturesessionerror) | 是 |CaptureSession中的错误码。 | ## CameraOutput @@ -2920,7 +2926,7 @@ release(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -2972,7 +2978,7 @@ start(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3020,7 +3026,7 @@ stop(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3068,7 +3074,7 @@ on(type: 'frameStart', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | --------------------------------------- | | type | string | 是 | 监听事件，固定为'frameStart'，即帧启动事件。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3091,7 +3097,7 @@ on(type: 'frameEnd', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------- | | type | string | 是 | 监听事件，固定为'frameEnd'，即帧结束事件。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3114,7 +3120,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------------- | ---- | ------------------------ | | type | string | 是 | 监听事件，固定为'error'，即预览输出错误事件。| | callback | ErrorCallback<[PreviewOutputErrorCode](#previewoutputerrorcode)\> | 是 | 回调函数，用于获取错误信息。 | @@ -3143,9 +3149,9 @@ previewOutput.on('error', (previewOutputError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | ------------------------------------------------- | ---------------------- | -| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | PreviewOutput中的错误码。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------------------------------------- | ---------------- |---------------------- | +| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | 是 |PreviewOutput中的错误码。 | ## ImageRotation @@ -3191,12 +3197,12 @@ previewOutput.on('error', (previewOutputError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 必填 | 默认值 | 说明 | -| -------- | ------------------------------- | ---- | ----------------- | -----------------| -| quality | [QualityLevel](#qualitylevel) | 否 | QUALITY_LEVEL_HIGH| 图片质量。 | -| rotation | [ImageRotation](#imagerotation) | 否 | ROTATION_0 | 图片旋转角度。 | -| location | [Location](#location) | 否 | (0,0,0) | 图片地理位置信息。 | -| mirror | boolean | 否 | false |镜像使能开关(默认关)。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | -----------------| +| quality | [QualityLevel](#qualitylevel) | 否 | 图片质量。 | +| rotation | [ImageRotation](#imagerotation) | 否 | 图片旋转角度。 | +| location | [Location](#location) | 否 | 图片地理位置信息。 | +| mirror | boolean | 否 |镜像使能开关(默认关)。 | ## PhotoOutput @@ -3212,7 +3218,7 @@ capture(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3238,7 +3244,7 @@ capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------- | ---- | -------------------- | | setting | [PhotoCaptureSetting](#photocapturesetting) | 是 | 拍照设置。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3269,7 +3275,7 @@ capture(setting?: PhotoCaptureSetting): Promise **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------------------------------- | ---- | -------- | | setting | [PhotoCaptureSetting](#photocapturesetting) | 否 | 拍照设置。 | @@ -3298,7 +3304,7 @@ isMirrorSupported(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------- | ---- | -------------------------- | | callback | AsyncCallback | 是 | 回调函数,返回是否支持镜像拍照。 | @@ -3346,7 +3352,7 @@ on(type: 'captureStart', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------ | | type | string | 是 | 监听事件，固定为'captureStart'，即拍照启动事件。 | | callback | AsyncCallback | 是 | 使用callback的方式获取Capture ID。 | @@ -3369,7 +3375,7 @@ on(type: 'frameShutter', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | --- | ------------------------------------ | | type | string | 是 | 监听事件，固定为'frameShutter'，即帧刷新事件。 | | callback | AsyncCallback<[FrameShutterInfo](#frameshutterinfo)\> | 是 | 回调函数，用于获取相关信息。 | @@ -3393,7 +3399,7 @@ on(type: 'captureEnd', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------- | ---- | ---------------------------------------- | | type | string | 是 | 监听事件，固定为'captureEnd'，即拍照停止事件。 | | callback | AsyncCallback<[CaptureEndInfo](#captureendinfo)\> | 是 | 回调函数，用于获取相关信息。 | @@ -3417,7 +3423,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------- | ---- | ----------------------------------- | | type | string | 是 | 监听事件，固定为'error'，即拍照错误事件。 | | callback | ErrorCallback<[PhotoOutputError](#photooutputerror)\> | 是 | 回调函数，用于获取错误信息。 | @@ -3471,9 +3477,9 @@ photoOutput.on('error', (err, photoOutputError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | ------------------------------------- | ----------------------- | -| code | [PhotoOutputErrorCode](#photooutputerrorcode) | PhotoOutput中的错误码。 | +| 名称 | 类型 | 必填 |说明 | +| ---- | ------------------------------------- | --------- | ----------------------- | +| code | [PhotoOutputErrorCode](#photooutputerrorcode) | 是 | PhotoOutput中的错误码。 | ## VideoOutput @@ -3489,7 +3495,7 @@ start(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | -------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3538,7 +3544,7 @@ stop(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3586,7 +3592,7 @@ on(type: 'frameStart', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ----------------------------------------- | | type | string | 是 | 监听事件，固定为'frameStart'，即视频帧开启事件。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3609,7 +3615,7 @@ on(type: 'frameEnd', callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------------ | | type | string | 是 | 监听事件，固定为'frameEnd'，即视频帧结束事件 。 | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3632,7 +3638,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------ | ---- | -------------------------------------- | | type | string | 是 | 监听事件，固定为'error'，即视频输出错误事件。 | | callback | Callback<[VideoOutputError](#videooutputerror)\> | 是 | 回调函数，用于获取错误信息。 | @@ -3662,9 +3668,9 @@ videoOutput.on('error', (VideoOutputError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | ------------------------------------- | ----------------------- | -| code | [PhotoOutputErrorCode](#photooutputerrorcode) | VideoOutput中的错误码。 | +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------------------------- | ----------------- | ----------------------- | +| code | [PhotoOutputErrorCode](#photooutputerrorcode) | 是 | VideoOutput中的错误码。 | ## MetadataObjectType @@ -3682,12 +3688,12 @@ videoOutput.on('error', (VideoOutputError) => { **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| -------- | ------ | -------------------- | -| topLeftX | number | 矩形区域左上角x坐标。 | -| topLeftY | number | 矩形区域左上角y坐标。 | -| width | number | 矩形宽。 | -| height | number | 矩形高。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------ | --------------- | -------------------- | +| topLeftX | number | 是 | 矩形区域左上角x坐标。 | +| topLeftY | number | 是 | 矩形区域左上角y坐标。 | +| width | number | 是 | 矩形宽。 | +| height | number | 是 |矩形高。 | ## MetadataObject @@ -3703,7 +3709,7 @@ getType(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------------- | --- | -------------------- | | callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | 是 | 回调函数，用于获取结果。 | @@ -3751,7 +3757,7 @@ getTimestamp(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | ------------------------ | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3799,7 +3805,7 @@ getBoundingBox(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | ------------------------ | | callback | AsyncCallback<[Rect](#rect)\> | 是 | 回调函数，用于获取结果。 | @@ -3855,7 +3861,7 @@ start(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3903,7 +3909,7 @@ stop(callback: AsyncCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------- | ---- | ------------------- | | callback | AsyncCallback | 是 | 回调函数，用于获取结果。 | @@ -3951,7 +3957,7 @@ on(type: 'metadataObjectsAvailable', callback: AsyncCallback\> | 是 | 回调函数，用于获取错误信息。 | @@ -3974,7 +3980,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------ | ---- | --------------------------------------- | | type | string | 是 | 监听事件，固定为'error'，即metadata流的错误。 | | callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | 是 | 回调函数，用于获取错误信息。 | @@ -4004,6 +4010,6 @@ metadata输出错误码。 **系统能力：** SystemCapability.Multimedia.Camera.Core -| 名称 | 类型 | 说明 | -| ---- | ------------------------------------- | ----------------------- | -| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | MetadataOutput中的错误码。 | \ No newline at end of file +| 名称 | 类型 | 必填 | 说明 | +| ---- | ------------------------------------- | ----------------- | ----------------------- | +| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | 是 | MetadataOutput中的错误码。 | \ No newline at end of file -- GitLab