harmony 鸿蒙@ohos.multimedia.camera (相机管理)
@ohos.multimedia.camera (相机管理)
说明：
本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import camera from '@ohos.multimedia.camera';
camera.getCameraManager
getCameraManager(context: BaseContext): CameraManager
获取相机管理器实例，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | BaseContext | 是 | 应用上下文。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraManager | 相机管理器。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400201 | Camera service fatal error. |
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
function getCameraManager(context: common.BaseContext): camera.CameraManager|undefined {
let cameraManager: camera.CameraManager|undefined = undefined;
try {
cameraManager = camera.getCameraManager(context);
} catch (error) {
let err = error as BusinessError;
console.error(`The getCameraManager call failed. error code: ${err.code}`);
}
return cameraManager;
}
camera.getModeManager
getModeManager(context: BaseContext): ModeManager
获取模式化管理器实例，同步返回结果。
模式化管理是对于cameraManager功能的增强与扩充，主要用于一些高级功能的管理（如人像模式）。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | BaseContext | 是 | 应用上下文。 |
返回值：
| 类型 | 说明 |
|---|---|
| ModeManager | 模式化管理器。 |
错误码：
以下错误码的详细介绍请参见Camera错误码
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400201 | Camera service fatal error. |
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
function getModeManager(context: common.BaseContext): camera.ModeManager|undefined {
let modeManager: camera.ModeManager|undefined = undefined;
try {
modeManager = camera.getModeManager(context);
} catch (error) {
let err = error as BusinessError;
console.error(`The getModeManager call failed. error code: ${err.code}`);
}
return modeManager;
}
CameraStatus
枚举，相机状态。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CAMERA_STATUS_APPEAR | 0 | 新的相机出现。 |
| CAMERA_STATUS_DISAPPEAR | 1 | 相机被移除。 |
| CAMERA_STATUS_AVAILABLE | 2 | 相机可用。 |
| CAMERA_STATUS_UNAVAILABLE | 3 | 相机不可用。 |
Profile
相机配置信息项。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| format | CameraFormat | 是 | 输出格式。 |
| size | Size | 是 | 分辨率。 |
FrameRateRange
帧率范围。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| min | number | 是 | 最小帧率。 |
| max | number | 是 | 最大帧率。 |
VideoProfile
视频配置信息项。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| frameRateRange | FrameRateRange | 是 | 帧率范围，fps(frames per second)。 |
CameraOutputCapability
相机输出能力项。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| previewProfiles | Array<Profile> | 是 | 支持的预览配置信息。 |
| photoProfiles | Array<Profile> | 是 | 支持的拍照配置信息。 |
| videoProfiles | Array<VideoProfile> | 是 | 支持的录像配置信息。 |
| supportedMetadataObjectTypes | Array<MetadataObjectType> | 是 | 支持的metadata流类型信息。 |
CameraErrorCode
相机错误码。接口使用不正确以及on接口监听error状态返回。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| INVALID_ARGUMENT | 7400101 | 参数缺失或者参数类型不对。 |
| OPERATION_NOT_ALLOWED | 7400102 | 操作流程不对，不允许。 |
| SESSION_NOT_CONFIG | 7400103 | session 未配置返回。 |
| SESSION_NOT_RUNNING | 7400104 | session 未运行返回。 |
| SESSION_CONFIG_LOCKED | 7400105 | session 配置已锁定返回。 |
| DEVICE_SETTING_LOCKED | 7400106 | 设备设置已锁定返回。 |
| CONFLICT_CAMERA | 7400107 | 设备重复打开返回。 |
| DEVICE_DISABLED | 7400108 | 安全原因摄像头被禁用。 |
| DEVICE_PREEMPTED | 7400109 | 相机被抢占导致无法使用 |
| SERVICE_FATAL_ERROR | 7400201 | 相机服务错误返回。 |
CameraMode
相机模式。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| PORTRAIT | 1 | 人像模式 |
FilterType
滤镜类型。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| NONE | 0 | 原图。 |
| CLASSIC | 1 | 经典。 |
| DAWN | 2 | 晨光。 |
| PURE | 3 | 清纯。 |
| GREY | 4 | 灰调。 |
| NATURAL | 5 | 自然。 |
| MORI | 6 | 森系。 |
| FAIR | 7 | 白皙。 |
| PINK | 8 | 粉调。 |
PortraitEffect
人像效果类型。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| OFF | 0 | 关闭。 |
| CIRCLES | 1 | 圆形。 |
BeautyType
美颜类型。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| AUTO | 0 | 自动。 |
| SKIN_SMOOTH | 1 | 光滑。 |
| FACE_SLENDER | 2 | 瘦脸。 |
| SKIN_TONE | 3 | 肤色。 |
CameraManager
相机管理器类，使用前需要通过getCameraManager获取相机管理实例。
getSupportedCameras
getSupportedCameras(): Array<CameraDevice>
获取支持指定的相机设备对象，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<CameraDevice> | 相机设备列表。 |
示例：
import { BusinessError } from '@ohos.base';
function getSupportedCameras(cameraManager: camera.CameraManager): Array<camera.CameraDevice> {
let cameras: Array<camera.CameraDevice> = [];
try {
cameras = cameraManager.getSupportedCameras();
} catch (error) {
let err = error as BusinessError;
console.error(`The getSupportedCameras call failed. error code: ${err.code}`);
}
return cameras;
}
getSupportedOutputCapability
getSupportedOutputCapability(camera:CameraDevice): CameraOutputCapability
查询相机设备在模式下支持的输出能力，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
|参数名 |类型 |必填|说明 | |————|—————————————————————|–|————————–| |cameraDevice|CameraDevice |是|相机设备，通过 getSupportedCameras 接口获取 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraOutputCapability | 相机输出能力。 |
示例：
function getSupportedOutputCapability(cameraDevice: camera.CameraDevice, cameraManager: camera.CameraManager): camera.CameraOutputCapability {
let cameraOutputCapability: camera.CameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraDevice);
return cameraOutputCapability;
}
isCameraMuted
isCameraMuted(): boolean
查询相机当前的禁用状态（禁用/未禁用）。
在此之前，需要通过isCameraMuteSupported确认当前设备支持禁用相机。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示相机被禁用，返回false表示相机未被禁用。 |
示例：
function isCameraMuted(cameraManager: camera.CameraManager): boolean {
let isMuted: boolean = cameraManager.isCameraMuted();
return isMuted;
}
isCameraMuteSupported
isCameraMuteSupported(): boolean
查询当前设备是否支持禁用相机，通过返回值返回结果。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示相机可以被禁用，返回false表示相机不能被禁用。 |
示例：
function isCameraMuteSupported(cameraManager: camera.CameraManager): boolean {
let isMuteSupported: boolean = cameraManager.isCameraMuteSupported();
return isMuteSupported;
}
muteCamera
muteCamera(mute: boolean): void
禁用相机。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mute | boolean | 是 | 禁用相机。 |
示例：
function muteCamera(cameraManager: camera.CameraManager): void {
let mute: boolean = true;
cameraManager.muteCamera(mute);
}
createCameraInput
createCameraInput(camera: CameraDevice): CameraInput
使用CameraDevice对象创建CameraInput实例，同步返回结果。
需要权限： ohos.permission.CAMERA
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraDevice | CameraDevice | 是 | CameraDevice对象，通过 getSupportedCameras 接口获取 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraInput | CameraInput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createCameraInput(cameraDevice: camera.CameraDevice, cameraManager: camera.CameraManager): camera.CameraInput|undefined {
let cameraInput: camera.CameraInput|undefined = undefined;
try {
cameraInput = cameraManager.createCameraInput(cameraDevice);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The createCameraInput call failed. error code: ${err.code}`);
}
return cameraInput;
}
createCameraInput
createCameraInput(position: CameraPosition, type: CameraType): CameraInput
根据相机位置和类型创建CameraInput实例，同步返回结果。
需要权限： ohos.permission.CAMERA
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| position | CameraPosition | 是 | 相机位置，通过 getSupportedCameras 接口获取设备，然后获取设备位置信息 |
| type | CameraType | 是 | 相机类型，通过 getSupportedCameras 接口获取设备，然后获取设备类型信息 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraInput | CameraInput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createCameraInput(cameraDevice: camera.CameraDevice, cameraManager: camera.CameraManager): camera.CameraInput|undefined {
let position: camera.CameraPosition = cameraDevice.cameraPosition;
let type: camera.CameraType = cameraDevice.cameraType;
let cameraInput: camera.CameraInput|undefined = undefined;
try {
cameraInput = cameraManager.createCameraInput(position, type);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The createCameraInput call failed. error code: ${err.code}`);
}
return cameraInput;
}
createPreviewOutput
createPreviewOutput(profile: Profile, surfaceId: string): PreviewOutput
创建预览输出对象，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| profile | Profile | 是 | 支持的预览配置信息,通过getSupportedOutputCapability接口获取。 |
| surfaceId | string | 是 | 从XComponent或者ImageReceiver组件获取的surfaceId。 |
返回值：
| 类型 | 说明 |
|---|---|
| PreviewOutput | PreviewOutput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createPreviewOutput(cameraOutputCapability: camera.CameraOutputCapability, cameraManager: camera.CameraManager, surfaceId: string): camera.PreviewOutput|undefined {
let profile: camera.Profile = cameraOutputCapability.previewProfiles[0];
let previewOutput: camera.PreviewOutput|undefined = undefined;
try {
previewOutput = cameraManager.createPreviewOutput(profile, surfaceId);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The createPreviewOutput call failed. error code: ${err.code}`);
}
return previewOutput;
}
createPhotoOutput
createPhotoOutput(profile: Profile, surfaceId: string): PhotoOutput
创建拍照输出对象，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| profile | Profile | 是 | 支持的拍照配置信息，通过getSupportedOutputCapability接口获取。 |
| surfaceId | string | 是 | 从ImageReceiver获取的surfaceId。 |
返回值：
| 类型 | 说明 |
|---|---|
| PhotoOutput | PhotoOutput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createPhotoOutput(cameraOutputCapability: camera.CameraOutputCapability, cameraManager: camera.CameraManager, surfaceId: string): camera.PhotoOutput|undefined {
let profile: camera.Profile = cameraOutputCapability.photoProfiles[0];
let photoOutput: camera.PhotoOutput|undefined = undefined;
try {
photoOutput = cameraManager.createPhotoOutput(profile, surfaceId);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The createPhotoOutput call failed. error code: ${err.code}`);
}
return photoOutput;
}
createVideoOutput
createVideoOutput(profile: VideoProfile, surfaceId: string): VideoOutput
创建录像输出对象，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| profile | VideoProfile | 是 | 支持的录像配置信息，通过getSupportedOutputCapability接口获取。 |
| surfaceId | string | 是 | 从VideoRecorder获取的surfaceId。 |
返回值：
| 类型 | 说明 |
|---|---|
| VideoOutput | VideoOutput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createVideoOutput(cameraOutputCapability: camera.CameraOutputCapability, cameraManager: camera.CameraManager, surfaceId: string): camera.VideoOutput|undefined {
let profile: camera.VideoProfile = cameraOutputCapability.videoProfiles[0];
let videoOutput: camera.VideoOutput|undefined = undefined;
try {
videoOutput = cameraManager.createVideoOutput(profile, surfaceId);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The createPhotoOutput call failed. error code: ${err.code}`);
}
return videoOutput;
}
createMetadataOutput
createMetadataOutput(metadataObjectTypes:Array<MetadataObjectType>): MetadataOutput
创建metadata流输出对象，同步返回结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| metadataObjectTypes | Array<MetadataObjectType> | 是 | metadata流类型信息，通过getSupportedOutputCapability接口获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| MetadataOutput | MetadataOutput实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import { BusinessError } from '@ohos.base';
function createMetadataOutput(cameraManager: camera.CameraManager, cameraOutputCapability: camera.CameraOutputCapability): void {
let metadataObjectTypes: Array<camera.MetadataObjectType> = cameraOutputCapability.supportedMetadataObjectTypes;
let metadataOutput: camera.MetadataOutput|undefined = undefined;
try {
metadataOutput = cameraManager.createMetadataOutput(metadataObjectTypes);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`createMetadataOutput error. error code: ${err.code}`);
}
}
createCaptureSession
createCaptureSession(): CaptureSession
创建CaptureSession实例，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| CaptureSession | CaptureSession实例。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function createCaptureSession(cameraManager: camera.CameraManager): camera.CaptureSession|undefined {
let captureSession: camera.CaptureSession|undefined = undefined;
try {
captureSession = cameraManager.createCaptureSession();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`createCaptureSession error. error code: ${err.code}`);
}
return captureSession;
}
on(‘cameraStatus’)
on(type: ‘cameraStatus’, callback: AsyncCallback<CameraStatusInfo>): void
相机设备状态回调，通过注册回调函数获取相机的状态变化。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’cameraStatus’。cameraManager对象获取成功后可监听。目前只支持对设备打开或者关闭会触发该事件并返回对应信息 |
| callback | AsyncCallback<CameraStatusInfo> | 是 | 回调函数，用于获取镜头状态变化信息。 |
示例：
import { BusinessError } from '@ohos.base';
function registerCameraStatus(cameraManager: camera.CameraManager): void {
cameraManager.on('cameraStatus', (err: BusinessError, cameraStatusInfo: camera.CameraStatusInfo) => {
console.log(`camera : ${cameraStatusInfo.camera.cameraId}`);
console.log(`status: ${cameraStatusInfo.status}`);
});
}
off(‘cameraStatus’)
off(type: ‘cameraStatus’, callback?: AsyncCallback<CameraStatusInfo>): void
相机设备状态注销回调，通过注销回调函数取消获取相机的状态变化。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’cameraStatus’。cameraManager对象获取成功后可监听。 |
| callback | AsyncCallback<CameraStatusInfo> | 否 | 可选参数，有表明匹配on接口callback。 |
示例：
function unregisterCameraStatus(cameraManager: camera.CameraManager): void {
cameraManager.off('cameraStatus');
}
on(‘cameraMute’)
on(type: ‘cameraMute’, callback: AsyncCallback<boolean>): void
禁用回调，通过注册回调函数获取相机禁用状态变化。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’cameraMute’，系统相机摄像头开关，cameraManager对象获取成功后可监听。系统设置打开或禁用相机会触发该事件并返回状态 |
| callback | AsyncCallback<boolean> | 是 | 回调函数，用于获取禁用状态变化信息，返回true是开启状态，返回false是禁用状态。 |
示例：
import { BusinessError } from '@ohos.base';
function registerCameraMute(cameraManager: camera.CameraManager): void {
cameraManager.on('cameraMute', (err: BusinessError, curMuted: boolean) => {
let isMuted: boolean = curMuted;
console.log(`cameraMute status: ${isMuted}`);
})
}
off(‘cameraMute’)
off(type: ‘cameraMute’, callback?: AsyncCallback<boolean>): void
禁用回调，通过注销注册回调函数获取相机禁用状态变化。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’cameraMute’，系统相机摄像头开关，cameraManager对象获取成功后可监听。 |
| callback | AsyncCallback<boolean> | 否 | 回调函数，可选参数，有表明匹配on接口callback。 |
示例：
import { BusinessError } from '@ohos.base';
function callback(err: BusinessError, curMuetd: boolean): void {
let isMuted: boolean = curMuetd;
}
function unregisterCameraMute(cameraManager: camera.CameraManager): void {
cameraManager.on('cameraMute', callback);
cameraManager.off('cameraMute', callback);
}
isPrelaunchSupported
isPrelaunchSupported(camera: CameraDevice): boolean
检查指定cameraDevice是否支持预热启动。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| camera | CameraDevice | 是 | 相机信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回指定cameraDevice是否支持预热启动。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect. |
示例：
import common from '@ohos.app.ability.common';
function isPreLaunchSupported(context: common.BaseContext): boolean {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
let isSupported: boolean = false;
if (cameras && cameras.length >= 1) {
isSupported = cameraManager.isPrelaunchSupported(cameras[0]);
console.log(`PreLaunch supported states: ${isSupported}`);
return isSupported;
}
return isSupported;
}
setPrelaunchConfig
setPrelaunchConfig(prelaunchConfig: PrelaunchConfig): void
在调用setPrelaunchConfig接口前，需要先检查设备是否支持预热启动，使用isPrelaunchSupported判断指定cameraDevice是否支持预热启动。
系统接口： 此接口为系统接口。
需要权限： ohos.permission.CAMERA
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| prelaunchConfig | PrelaunchConfig | 是 | 预启动配置参数。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect. |
| 7400102 | Operation not allow. |
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
function setPrelaunchConfig(context: common.BaseContext): void {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
if (cameras && cameras.length >= 1) {
let cameraDevice: camera.CameraDevice = cameras[0];
if(cameraManager.isPrelaunchSupported(cameraDevice)) {
try {
cameraManager.setPrelaunchConfig({cameraDevice: cameraDevice});
} catch (error) {
let err = error as BusinessError;
console.error(`setPrelaunchConfig error. Code: ${err.code}, message: ${err.message}`);
}
}
}
}
prelaunch
prelaunch(): void
用户点击系统相机图标，拉起相机应用同时调用，下发预热请求，使能相机预热启动。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
function preLaunch(context: common.BaseContext): void {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
try {
cameraManager.prelaunch();
} catch (error) {
let err = error as BusinessError;
console.error(`prelaunch error. Code: ${err.code}, message: ${err.message}`);
}
}
createDeferredPreviewOutput
createDeferredPreviewOutput(profile: Profile): PreviewOutput
创建延迟预览输出对象，在配流时替代普通的预览输出对象加入数据流。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| profile | Profile | 是 | 相机预览流的配置文件。 |
返回值：
| 类型 | 说明 |
|---|---|
| PreviewOutput | 返回预览输出对象。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect. |
示例：
import common from '@ohos.app.ability.common';
function getDeferredPreviewOutput(context: common.BaseContext, previewProfile: camera.Profile): camera.PreviewOutput {
const cameraManager: camera.CameraManager = camera.getCameraManager(context);
const output: camera.PreviewOutput = cameraManager.createDeferredPreviewOutput(previewProfile);
return output;
}
ModeManager
相机模式化管理器类，使用前需要通过getModeManager获取相机模式化管理实例。
getSupportedModes
getSupportedModes(device: CameraDevice): Array<CameraMode>
获取指定相机设备支持的模式列表，同步返回结果。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| device | CameraDevice | 是 | 相机设备实例，通过getSupportedCameras接口获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| Array<CameraMode> | 支持的模式列表。 |
示例：
function getSupportedModes(modeManager: camera.ModeManager, cameraDevice: camera.CameraDevice): Array<camera.CameraMode> {
let cameraModes: Array<camera.CameraMode> = modeManager.getSupportedModes(cameraDevice);
return cameraModes;
}
getSupportedOutputCapability
getSupportedOutputCapability(device:CameraDevice, mode: CameraMode): CameraOutputCapability
获取指定模式下相机设备支持的输出能力，同步返回结果。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
|参数名 |类型 |必填|说明 | |————|—————————————————————|–|————————–| |device |CameraDevice |是|相机设备，通过getSupportedCameras接口获取。 | |mode |CameraMode |是|指定模式，通过getSupportedModes接口获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraOutputCapability | 相机输出能力。 |
示例：
function getSupportedOutputCapability(cameraManager: camera.CameraManager, modeManager: camera.ModeManager): camera.CameraOutputCapability|undefined {
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
if (cameras == undefined||cameras.length <= 0) {
return undefined;
}
let cameraDevice: camera.CameraDevice = cameras[0];
let cameraModes: Array<camera.CameraMode> = modeManager.getSupportedModes(cameraDevice);
if (cameraModes === undefined||cameraModes.length <= 0) {
return undefined;
}
let mode: camera.CameraMode = cameraModes[0];
let cameraOutputCapability: camera.CameraOutputCapability = modeManager.getSupportedOutputCapability(cameraDevice, mode);
return cameraOutputCapability;
}
createCaptureSession
createCaptureSession(mode: CameraMode): CaptureSession
根据当前的模式名，创建指定模式的会话。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
|参数名 |类型 |必填|说明 | |————|—————————————————————|–|————————–| |mode|CameraMode |是|指定模式，通过getSupportedModes获取。 |
返回值：
| 类型 | 说明 |
|---|---|
| CaptureSession | 指定模式的会话实例。 |
示例：
import { BusinessError } from '@ohos.base';
function createCaptureSession(cameraManager: camera.CameraManager, modeManager: camera.ModeManager): camera.CaptureSession|undefined {
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
if (cameras == undefined||cameras.length <= 0) {
return;
}
let cameraDevice: camera.CameraDevice = cameras[0];
let cameraModes: Array<camera.CameraMode> = modeManager.getSupportedModes(cameraDevice);
if (cameraModes === undefined||cameraModes.length <= 0) {
return;
}
let mode: camera.CameraMode = cameraModes[0];
let captureSession: camera.CaptureSession|undefined = undefined;
try {
captureSession = modeManager.createCaptureSession(mode);
} catch (error) {
let err = error as BusinessError;
console.error(`The createCaptureSession call failed. error code: ${err.code}`);
}
return captureSession;
}
PrelaunchConfig
相机预启动配置参数。
当前sensor级别预热，待扩展流预热参数。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraDevice | CameraDevice | 是 | 相机信息。 |
CameraStatusInfo
相机管理器回调返回的接口实例，表示相机状态信息。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| camera | CameraDevice | 是 | 相机信息。 |
| status | CameraStatus | 是 | 相机状态。 |
CameraPosition
枚举，相机位置。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CAMERA_POSITION_UNSPECIFIED | 0 | 相机位置未指定。 |
| CAMERA_POSITION_BACK | 1 | 后置相机。 |
| CAMERA_POSITION_FRONT | 2 | 前置相机。 |
CameraType
枚举，相机类型。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CAMERA_TYPE_DEFAULT | 0 | 相机类型未指定。 |
| CAMERA_TYPE_WIDE_ANGLE | 1 | 广角相机。 |
| CAMERA_TYPE_ULTRA_WIDE | 2 | 超广角相机。 |
| CAMERA_TYPE_TELEPHOTO | 3 | 长焦相机。 |
| CAMERA_TYPE_TRUE_DEPTH | 4 | 带景深信息的相机。 |
ConnectionType
枚举，相机连接类型。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CAMERA_CONNECTION_BUILT_IN | 0 | 内置相机。 |
| CAMERA_CONNECTION_USB_PLUGIN | 1 | USB连接的相机。 |
| CAMERA_CONNECTION_REMOTE | 2 | 远程连接的相机。 |
HostDeviceType
枚举，远端相机设备类型。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| UNKNOWN_TYPE | 0 | 未知设备类型。 |
| PHONE | 0x0E | 智能手机相机设备类型。 |
| TABLET | 0x11 | 平板电脑相机设备类型。 |
CameraDevice
相机设备信息。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraId | string | 是 | CameraDevice对象 |
| cameraPosition | CameraPosition | 是 | 相机位置。 |
| cameraType | CameraType | 是 | 相机类型。 |
| connectionType | ConnectionType | 是 | 相机连接类型。 |
| hostDeviceName | string | 是 | 远端设备名称，系统接口： 此接口为系统接口。 |
| hostDeviceType | hostDeviceType | 是 | 远端相机设备类型，系统接口： 此接口为系统接口。 |
Size
枚举，输出能力查询。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| height | number | 是 | 是 | 图像尺寸高(像素)。 |
| width | number | 是 | 是 | 图像尺寸宽(像素)。 |
Point
枚举，点坐标用于对焦、曝光配置。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| x | number | 是 | 点的x坐标。 |
| y | number | 是 | 点的y坐标。 |
CameraFormat
枚举，输出格式。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| CAMERA_FORMAT_RGBA_8888 | 3 | RGB格式的图片。 |
| CAMERA_FORMAT_YUV_420_SP | 1003 | YUV 420 SP格式的图片。 |
| CAMERA_FORMAT_JPEG | 2000 | JPEG格式的图片。 |
CameraInput
会话中CaptureSession使用的相机信息。
open
open(callback: AsyncCallback<void>): void
打开相机，通过注册回调函数获取状态。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400107 | Can not use camera cause of conflict. |
| 7400108 | Camera disabled cause of security reason. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function openCameraInput(cameraInput: camera.CameraInput): void {
cameraInput.open((err: BusinessError) => {
if (err) {
console.error(`Failed to open the camera. ${err.code}`);
return;
}
console.log('Callback returned with camera opened.');
});
}
open
open(): Promise<void>
打开相机，通过Promise获取相机的状态。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400107 | Can not use camera cause of conflict. |
| 7400108 | Camera disabled cause of security reason. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function openCameraInput(cameraInput: camera.CameraInput): void {
cameraInput.open().then(() => {
console.log('Promise returned with camera opened.');
}).catch((err: BusinessError) => {
console.error(`Failed to open the camera. ${err.code}`);
});
}
close
close(callback: AsyncCallback<void>): void
关闭相机，通过注册回调函数获取状态。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function closeCameraInput(cameraInput: camera.CameraInput): void {
cameraInput.close((err: BusinessError) => {
if (err) {
console.error(`Failed to close the cameras. ${err.code}`);
return;
}
console.log('Callback returned with camera closed.');
});
}
close
close(): Promise<void>
关闭相机，通过Promise获取状态。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function closeCameraInput(cameraInput: camera.CameraInput): void {
cameraInput.close().then(() => {
console.log('Promise returned with camera closed.');
}).catch((err: BusinessError) => {
console.error(`Failed to close the cameras. ${err.code}`);
});
}
on(‘error’)
on(type: ‘error’, camera:CameraDevice, callback: ErrorCallback): void
监听CameraInput的错误事件，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，CameraInput对象创建成功可监听。相机设备出错情况下可触发该事件并返回结果，比如（设备不可用或者冲突等返回对应错误信息） |
| cameraDevice | CameraDevice | 是 | CameraDevice对象。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取结果。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerCameraInputError(cameraInput: camera.CameraInput, cameraDevice: camera.CameraDevice): void {
cameraInput.on('error', cameraDevice, (error: BusinessError) => {
console.log(`Camera input error code: ${error.code}`);
});
}
off(‘error’)
off(type: ‘error’, camera:CameraDevice, callback?: ErrorCallback): void
注销监听CameraInput的错误事件。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，CameraInput对象创建成功可监听。相机设备出错情况下可触发该事件并返回结果，比如（设备不可用或者冲突等返回对应错误信息） |
| cameraDevice | CameraDevice | 是 | CameraDevice对象。 |
| callback | ErrorCallback | 否 | 回调函数，可选，有就是匹配on(‘error’) callback |
示例：
function unregisterCameraInputError(cameraInput: camera.CameraInput, cameraDevice: camera.CameraDevice): void {
cameraInput.off('error', cameraDevice);
}
FlashMode
枚举，闪光灯模式。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 值 | 说明 |
|---|---|---|
| FLASH_MODE_CLOSE | 0 | 闪光灯关闭。 |
| FLASH_MODE_OPEN | 1 | 闪光灯打开。 |
| FLASH_MODE_AUTO | 2 | 自动闪光灯。 |
| FLASH_MODE_ALWAYS_OPEN | 3 | 闪光灯常亮。 |
ExposureMode
枚举，曝光模式。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 值 | 说明 |
|---|---|---|
| EXPOSURE_MODE_LOCKED | 0 | 锁定曝光模式。不支持曝光区域中心点设置。 |
| EXPOSURE_MODE_AUTO | 1 | 自动曝光模式。支持曝光区域中心点设置，可以使用setMeteringPoint设置曝光区域中心点。 |
| EXPOSURE_MODE_CONTINUOUS_AUTO | 2 | 连续自动曝光。不支持曝光区域中心点设置。 |
FocusMode
枚举，焦距模式。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 值 | 说明 |
|---|---|---|
| FOCUS_MODE_MANUAL | 0 | 手动对焦。通过手动修改相机焦距来改变对焦位置，不支持对焦点设置。 |
| FOCUS_MODE_CONTINUOUS_AUTO | 1 | 连续自动对焦。不支持对焦点设置。 |
| FOCUS_MODE_AUTO | 2 | 自动对焦。支持对焦点设置，可以使用setFocusPoint设置对焦点，根据对焦点执行一次自动对焦。对焦动作完成后（无论对焦成功或是对焦失败），都进入对焦锁定。应用层需要再次调用CONTINUOUS_AUTO后才能再次进入连续自动对焦。 |
| FOCUS_MODE_LOCKED | 3 | 对焦锁定。不支持对焦点设置。 |
FocusState
枚举，焦距状态。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 值 | 说明 |
|---|---|---|
| FOCUS_STATE_SCAN | 0 | 触发对焦。 |
| FOCUS_STATE_FOCUSED | 1 | 对焦成功。 |
| FOCUS_STATE_UNFOCUSED | 2 | 未完成对焦。 |
VideoStabilizationMode
枚举，视频防抖模式。
系统能力： SystemCapability.Multimedia.Camera.Core。
| 名称 | 值 | 说明 |
|---|---|---|
| OFF | 0 | 关闭视频防抖功能。 |
| LOW | 1 | 使用基础防抖算法。 |
| MIDDLE | 2 | 使用防抖效果一般的防抖算法，防抖效果优于LOW类型。 |
| HIGH | 3 | 使用防抖效果最好的防抖算法，防抖效果优于MIDDLE类型。 |
| AUTO | 4 | 自动进行选择。 |
CaptureSession
拍照会话类，保存一次相机运行所需要的所有资源CameraInput、CameraOutput，并向相机设备申请完成相机功能(录像，拍照)。
beginConfig
beginConfig(): void
开始配置会话。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400105 | Session config locked. |
示例：
import { BusinessError } from '@ohos.base';
function beginConfig(captureSession: camera.CaptureSession): void {
try {
captureSession.beginConfig();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The beginConfig call failed. error code: ${err.code}`);
}
}
commitConfig
commitConfig(callback: AsyncCallback<void>): void
提交配置信息，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400102 | Operation not allow. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function commitConfig(captureSession: camera.CaptureSession): void {
captureSession.commitConfig((err: BusinessError) => {
if (err) {
console.error(`The commitConfig call failed. error code: ${err.code}`);
return;
}
console.log('Callback invoked to indicate the commit config success.');
});
}
commitConfig
commitConfig(): Promise<void>
提交配置信息，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400102 | Operation not allow. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function commitConfig(captureSession: camera.CaptureSession): void {
captureSession.commitConfig().then(() => {
console.log('Promise returned to indicate the commit config success.');
}).catch((err: BusinessError) => {
// 失败返回错误码error.code并处理
console.error(`The commitConfig call failed. error code: ${err.code}`);
});
}
addInput
addInput(cameraInput: CameraInput): void
把CameraInput加入到会话。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraInput | CameraInput | 是 | 需要添加的CameraInput实例。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400102 | Operation not allow. |
示例：
import { BusinessError } from '@ohos.base';
function addInput(captureSession: camera.CaptureSession, cameraInput: camera.CameraInput): void {
try {
captureSession.addInput(cameraInput);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The addInput call failed. error code: ${err.code}`);
}
}
removeInput
removeInput(cameraInput: CameraInput): void
移除CameraInput。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraInput | CameraInput | 是 | 需要移除的CameraInput实例。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400102 | Operation not allow. |
示例：
import { BusinessError } from '@ohos.base';
function removeInput(captureSession: camera.CaptureSession, cameraInput: camera.CameraInput): void {
try {
captureSession.removeInput(cameraInput);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The removeInput call failed. error code: ${err.code}`);
}
}
addOutput
addOutput(cameraOutput: CameraOutput): void
把CameraOutput加入到会话。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraOutput | CameraOutput | 是 | 需要添加的CameraOutput实例。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400102 | Operation not allow. |
示例：
import { BusinessError } from '@ohos.base';
function addOutput(captureSession: camera.CaptureSession, cameraOutput: camera.CameraOutput): void {
try {
captureSession.addOutput(cameraOutput);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The addOutput call failed. error code: ${err.code}`);
}
}
removeOutput
removeOutput(cameraOutput: CameraOutput): void
从会话中移除CameraOutput。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cameraOutput | CameraOutput | 是 | 需要移除的CameraOutput实例。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400102 | Operation not allow. |
示例：
import { BusinessError } from '@ohos.base';
function removeOutput(captureSession: camera.CaptureSession, previewOutput: camera.PreviewOutput): void {
try {
captureSession.removeOutput(previewOutput);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.log(`The removeOutput call failed. error code: ${err.code}`);
}
}
start
start(callback: AsyncCallback<void>): void
开始会话工作，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the session ${err.code}`);
return;
}
console.log('Callback invoked to indicate the session start success.');
});
}
start
start(): Promise<void>
开始会话工作，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.start().then(() => {
console.log('Promise returned to indicate the session start success.');
}).catch((err: BusinessError) => {
console.error(`Failed to start the session ${err.code}`);
});
}
stop
stop(callback: AsyncCallback<void>): void
停止会话工作，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function stopCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.stop((err: BusinessError) => {
if (err) {
console.error(`Failed to stop the session ${err.code}`);
return;
}
console.log('Callback invoked to indicate the session stop success.');
});
}
stop
stop(): Promise<void>
停止会话工作，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function stopCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.stop().then(() => {
console.log('Promise returned to indicate the session stop success.');
}).catch((err: BusinessError) => {
console.error(`Failed to stop the session ${err.code}`);
});
}
release
release(callback: AsyncCallback<void>): void
释放会话资源，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releaseCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.release((err: BusinessError) => {
if (err) {
console.error(`Failed to release the CaptureSession instance ${err.code}`);
return;
}
console.log('Callback invoked to indicate that the CaptureSession instance is released successfully.');
});
}
release
release(): Promise<void>
释放会话资源，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releaseCaptureSession(captureSession: camera.CaptureSession): void {
captureSession.release().then(() => {
console.log('Promise returned to indicate that the CaptureSession instance is released successfully.');
}).catch((err: BusinessError) => {
console.error(`Failed to release the CaptureSession instance ${err.code}`);
});
}
hasFlash
hasFlash(): boolean
检测是否有闪光灯，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示设备支持闪光灯。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function hasFlash(captureSession: camera.CaptureSession): boolean {
let status: boolean = false;
try {
status = captureSession.hasFlash();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The hasFlash call failed. error code: ${err.code}`);
}
return status;
}
isFlashModeSupported
isFlashModeSupported(flashMode: FlashMode): boolean
检测闪光灯模式是否支持。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| flashMode | FlashMode | 是 | 指定闪光灯模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示支持该闪光灯模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function isFlashModeSupported(captureSession: camera.CaptureSession): boolean {
let status: boolean = false;
try {
status = captureSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The isFlashModeSupported call failed. error code: ${err.code}`);
}
return status;
}
setFlashMode
setFlashMode(flashMode: FlashMode): void
设置闪光灯模式。
进行设置之前，需要先检查：
- 设备是否支持闪光灯，可使用方法hasFlash。
- 设备是否支持指定的闪光灯模式，可使用方法isFlashModeSupported。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| flashMode | FlashMode | 是 | 指定闪光灯模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setFlashMode(captureSession: camera.CaptureSession): void {
try {
captureSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setFlashMode call failed. error code: ${err.code}`);
}
}
getFlashMode
getFlashMode(): FlashMode
获取当前设备的闪光灯模式。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| FlashMode | 获取当前设备的闪光灯模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getFlashMode(captureSession: camera.CaptureSession): camera.FlashMode|undefined {
let flashMode: camera.FlashMode|undefined = undefined;
try {
flashMode = captureSession.getFlashMode();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getFlashMode call failed.error code: ${err.code}`);
}
return flashMode;
}
isExposureModeSupported
isExposureModeSupported(aeMode: ExposureMode): boolean;
检测曝光模式是否支持。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| aeMode | ExposureMode | 是 | 曝光模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 获取是否支持曝光模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function isExposureModeSupported(captureSession: camera.CaptureSession): boolean {
let isSupported: boolean = false;
try {
isSupported = captureSession.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The isExposureModeSupported call failed. error code: ${err.code}`);
}
return isSupported;
}
getExposureMode
getExposureMode(): ExposureMode
获取当前曝光模式。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| ExposureMode | 获取当前曝光模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getExposureMode(captureSession: camera.CaptureSession): camera.ExposureMode|undefined {
let exposureMode: camera.ExposureMode|undefined = undefined;
try {
exposureMode = captureSession.getExposureMode();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getExposureMode call failed. error code: ${err.code}`);
}
return exposureMode;
}
setExposureMode
setExposureMode(aeMode: ExposureMode): void
设置曝光模式。进行设置之前，需要先检查设备是否支持指定的曝光模式，可使用方法isExposureModeSupported。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| aeMode | ExposureMode | 是 | 曝光模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setExposureMode(captureSession: camera.CaptureSession): void {
try {
captureSession.setExposureMode(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setExposureMode call failed. error code: ${err.code}`);
}
}
getMeteringPoint
getMeteringPoint(): Point
查询曝光区域中心点。（该接口目前为预留，将在3.2版本开放）
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Point | 获取当前曝光点。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getMeteringPoint(captureSession: camera.CaptureSession): camera.Point|undefined {
let exposurePoint: camera.Point|undefined = undefined;
try {
exposurePoint = captureSession.getMeteringPoint();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getMeteringPoint call failed. error code: ${err.code}`);
}
return exposurePoint;
}
setMeteringPoint
setMeteringPoint(point: Point): void
设置曝光区域中心点，曝光点应在0-1坐标系内，该坐标系左上角为{0，0}，右下角为{1，1}。 此坐标系是以设备充电口在右侧时的横向设备方向为基准的，例如应用的预览界面布局以 设备充电口在下侧时的竖向方向为基准，布局宽高为{w，h}，且触碰点为{x，y}， 则转换后的坐标点为{y/h，1-x/w}。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| exposurePoint | Point | 是 | 曝光点，x,y设置范围应在[0,1]之内，超过范围，如果小于0设置0，大于1设置1。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setMeteringPoint(captureSession: camera.CaptureSession): void {
const exposurePoint: camera.Point = {x: 1, y: 1};
try {
captureSession.setMeteringPoint(exposurePoint);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setMeteringPoint call failed. error code: ${err.code}`);
}
}
getExposureBiasRange
getExposureBiasRange(): Array<number>
查询曝光补偿范围。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<number> | 获取补偿范围的数组。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getExposureBiasRange(captureSession: camera.CaptureSession): Array<number> {
let biasRangeArray: Array<number> = [];
try {
biasRangeArray = captureSession.getExposureBiasRange();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getExposureBiasRange call failed. error code: ${err.code}`);
}
return biasRangeArray;
}
setExposureBias
setExposureBias(exposureBias: number): void
设置曝光补偿，曝光补偿值（EV）。
进行设置之前，建议先通过方法getExposureBiasRange查询支持的范围。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| exposureBias | number | 是 | 曝光补偿，getExposureBiasRange查询支持的范围，如果设置超过支持范围的值，自动匹配到就近临界点。曝光补偿存在步长，如步长为0.5。则设置1.2时，获取到实际生效曝光补偿为1.0。接口调用失败会返回相应错误码，错误码类型CameraErrorCode， |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setExposureBias(captureSession: camera.CaptureSession, biasRangeArray: Array<number>): void {
if (biasRangeArray && biasRangeArray.length > 0) {
let exposureBias = biasRangeArray[0];
try {
captureSession.setExposureBias(exposureBias);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setExposureBias call failed. error code: ${err.code}`);
}
}
}
getExposureValue
getExposureValue(): number
查询当前曝光值。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 获取曝光值。曝光补偿存在步长，如步长为0.5。则设置1.2时，获取到实际生效曝光补偿为1.0。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getExposureValue(captureSession: camera.CaptureSession): number {
const invalid_value: number = -1;
let exposureValue: number = invalid_value;
try {
exposureValue = captureSession.getExposureValue();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getExposureValue call failed. error code: ${err.code}`);
}
return exposureValue;
}
isFocusModeSupported
isFocusModeSupported(afMode: FocusMode): boolean
检测对焦模式是否支持。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| afMode | FocusMode | 是 | 指定的焦距模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回true表示支持该焦距模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function isFocusModeSupported(captureSession: camera.CaptureSession): boolean {
let status: boolean = false;
try {
status = captureSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The isFocusModeSupported call failed. error code: ${err.code}`);
}
return status;
}
setFocusMode
setFocusMode(afMode: FocusMode): void
设置对焦模式。
进行设置之前，需要先检查设备是否支持指定的焦距模式，可使用方法isFocusModeSupported。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| afMode | FocusMode | 是 | 指定的焦距模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setFocusMode(captureSession: camera.CaptureSession): void {
try {
captureSession.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setFocusMode call failed. error code: ${err.code}`);
}
}
getFocusMode
getFocusMode(): FocusMode
获取当前的对焦模式。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| FocusMode | 获取当前设备的焦距模式。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getFocusMode(captureSession: camera.CaptureSession): camera.FocusMode|undefined {
let afMode: camera.FocusMode|undefined = undefined;
try {
afMode = captureSession.getFocusMode();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getFocusMode call failed. error code: ${err.code}`);
}
return afMode;
}
setFocusPoint
setFocusPoint(point: Point): void
设置焦点，焦点应在0-1坐标系内，该坐标系左上角为{0，0}，右下角为{1，1}。 此坐标系是以设备充电口在右侧时的横向设备方向为基准的，例如应用的预览界面布局以 设备充电口在下侧时的竖向方向为基准，布局宽高为{w，h}，且触碰点为{x，y}， 则转换后的坐标点为{y/h，1-x/w}。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| Point1 | Point | 是 | 焦点。x,y设置范围应在[0,1]之内，超过范围，如果小于0设置0，大于1设置1。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setFocusPoint(captureSession: camera.CaptureSession): void {
const focusPoint: camera.Point = {x: 1, y: 1};
try {
captureSession.setFocusPoint(focusPoint);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setFocusPoint call failed. error code: ${err.code}`);
}
}
getFocusPoint
getFocusPoint(): Point
查询焦点。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Point | 用于获取当前焦点。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getFocusPoint(captureSession: camera.CaptureSession): camera.Point|undefined {
let point: camera.Point|undefined = undefined;
try {
point = captureSession.getFocusPoint();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getFocusPoint call failed. error code: ${err.code}`);
}
return point;
}
getFocalLength
getFocalLength(): number
查询焦距值。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 用于获取当前焦距。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getFocalLength(captureSession: camera.CaptureSession): number {
const invalid_value: number = -1;
let focalLength: number = invalid_value;
try {
focalLength = captureSession.getFocalLength();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getFocalLength call failed. error code: ${err.code}`);
}
return focalLength;
}
getZoomRatioRange
getZoomRatioRange(): Array<number>
获取支持的变焦范围。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<number> | 用于获取可变焦距比范围，返回的数组包括其最小值和最大值。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getZoomRatioRange(captureSession: camera.CaptureSession): Array<number> {
let zoomRatioRange: Array<number> = [];
try {
zoomRatioRange = captureSession.getZoomRatioRange();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getZoomRatioRange call failed. error code: ${err.code}`);
}
return zoomRatioRange;
}
setZoomRatio
setZoomRatio(zoomRatio: number): void
设置变焦比，变焦精度最高为小数点后两位，超过变焦精度的变焦值系统无法响应。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| zoomRatio | number | 是 | 可变焦距比，通过getZoomRatioRange获取支持的变焦范围，如果设置超过支持范围的值，自动匹配到就近临界点。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setZoomRatio(captureSession: camera.CaptureSession, zoomRatioRange: Array<number>): void {
if (zoomRatioRange === undefined||zoomRatioRange.length <= 0) {
return;
}
let zoomRatio = zoomRatioRange[0];
try {
captureSession.setZoomRatio(zoomRatio);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setZoomRatio call failed. error code: ${err.code}`);
}
}
getZoomRatio
getZoomRatio(): number
获取当前的变焦比。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 获取当前的变焦比结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getZoomRatio(captureSession: camera.CaptureSession): number {
const invalid_value: number = -1;
let zoomRatio: number = invalid_value;
try {
zoomRatio = captureSession.getZoomRatio();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getZoomRatio call failed. error code: ${err.code}`);
}
return zoomRatio;
}
isVideoStabilizationModeSupported
isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode): boolean
查询是否支持指定的视频防抖模式。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| vsMode | VideoStabilizationMode | 是 | 视频防抖模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回视频防抖模式是否支持。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function isVideoStabilizationModeSupported(captureSession: camera.CaptureSession): boolean {
let isSupported: boolean = false;
try {
isSupported = captureSession.isVideoStabilizationModeSupported(camera.VideoStabilizationMode.OFF);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The isVideoStabilizationModeSupported call failed. error code: ${err.code}`);
}
return isSupported;
}
getActiveVideoStabilizationMode
getActiveVideoStabilizationMode(): VideoStabilizationMode
查询当前正在使用的视频防抖模式。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| VideoStabilizationMode | 视频防抖是否正在使用。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function getActiveVideoStabilizationMode(captureSession: camera.CaptureSession): camera.VideoStabilizationMode|undefined {
let vsMode: camera.VideoStabilizationMode|undefined = undefined;
try {
vsMode = captureSession.getActiveVideoStabilizationMode();
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The getActiveVideoStabilizationMode call failed. error code: ${err.code}`);
}
return vsMode;
}
setVideoStabilizationMode
setVideoStabilizationMode(mode: VideoStabilizationMode): void
设置视频防抖模式。需要先检查设备是否支持对应的防抖模式，可以通过isVideoStabilizationModeSupported方法判断所设置的模式是否支持。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | VideoStabilizationMode | 是 | 需要设置的视频防抖模式。 |
返回值：
| 类型 | 说明 |
|---|---|
| CameraErrorCode | 接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setVideoStabilizationMode(captureSession: camera.CaptureSession): void {
try {
captureSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF);
} catch (error) {
// 失败返回错误码error.code并处理
let err = error as BusinessError;
console.error(`The setVideoStabilizationMode call failed. error code: ${err.code}`);
}
}
getSupportedFilters
getSupportedFilters(): Array<number>
获取当前支持的滤镜效果列表。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<FilterType> | 返回支持的滤镜效果列表。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getSupportedFilters(portraitSession: camera.PortraitSession): Array<camera.FilterType> {
let filterTypes: Array<camera.FilterType> = portraitSession.getSupportedFilters();
return filterTypes;
}
setFilter
setFilter(filter: number): void
设置滤镜效果。需要先检查设备是否支持对应的滤镜效果，可以通过getSupportedFilters方法获取所支持的类型。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| filter | number | 是 | 当前用户设置的滤镜类型。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect. |
| 7400103 | Session not config. |
示例：
function setFilter(portraitSession: camera.PortraitSession, filterTypes: Array<camera.FilterType>): void {
if (filterTypes === undefined||filterTypes.length <= 0) {
return;
}
portraitSession.setFilter(filterTypes[0]);
}
getFilter
getFilter(): number
获取当前已设置的滤镜效果。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 已设置的滤镜效果。可查阅FilterType。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getFilter(portraitSession: camera.PortraitSession): number {
let filterType: number = portraitSession.getFilter();
return filterType;
}
getSupportedBeautyTypes
getSupportedBeautyTypes(): Array<BeautyType>
获取当前支持的美颜效果列表。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<BeautyType> | 返回当前支持的美颜效果列表。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getSupportedBeautyTypes(portraitSession: camera.PortraitSession): Array<camera.BeautyType> {
let beautyTypes: Array<camera.BeautyType> = portraitSession.getSupportedBeautyTypes();
return beautyTypes;
}
getSupportedBeautyRange
getSupportedBeautyRange(type: BeautyType): Array<number>
获取指定美颜效果的范围值。在不同设备返回的美颜强度有所不同，下表仅做示例。
| 传入参数 | 示例返回值 | 返回值说明 |
|---|---|---|
| AUTO | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] | 美颜类型为自动时支持的美颜强度，0表明关闭美颜，其余正值表明自动的美颜强度。 |
| SKIN_SMOOTH | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] | 美颜类型为光滑时支持的美颜强度，0表明关闭光滑，其余正值表明光滑的美颜强度。 |
| FACE_SLENDER | [0, 1, 2, 3, 4, 5] | 美颜类型为瘦脸时支持的美颜强度，0表明关闭瘦脸，其余正值表明瘦脸的美颜强度。 |
| SKIN_TONE | [-1, 16242611] | 美颜类型为美肤时支持的美颜强度，-1表明关闭美肤，其余非负值为使用RGB表示的美肤美颜强度， 16242611转化为16进制为0xF7D7B3，F7为R通道值，D7为G通道值，B3位B通道值。 |
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | BeautyType | 是 | 美颜类型。 |
返回值：
| 类型 | 说明 |
|---|---|
| Array<number> | 当前美颜类型所支持的美颜强度。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getSupportedBeautyRange(portraitSession: camera.PortraitSession): Array<number> {
let beautyTypes: Array<camera.BeautyType> = portraitSession.getSupportedBeautyTypes();
if (beautyTypes === undefined||beautyTypes.length <= 0) {
return [];
}
let beautyLevels: Array<number> = portraitSession.getSupportedBeautyRange(beautyTypes[0]);
return beautyLevels;
}
setBeauty
setBeauty(type: BeautyType, value: number): void
设置美颜类型以及对应的美颜强度。将通过getSupportedBeautyTypes获取得到的BeautyType都关闭，表明当前美颜关闭；若有一种美颜类型未关闭，表明当前美颜打开。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | BeautyType | 是 | 美颜类型 |
| value | number | 是 | 美颜强度，通过getSupportedBeautyRange接口获取。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function setBeauty(portraitSession: camera.PortraitSession): void {
let beautyTypes: Array<camera.BeautyType> = portraitSession.getSupportedBeautyTypes();
if (beautyTypes === undefined||beautyTypes.length <= 0) {
return;
}
let beautyLevels: Array<number> = portraitSession.getSupportedBeautyRange(beautyTypes[0]);
if (beautyLevels === undefined||beautyLevels.length <= 0) {
return;
}
portraitSession.setBeauty(beautyTypes[0], beautyLevels[0]);
}
getBeauty
getBeauty(type: BeautyType): number
查询当前已设置的美颜效果对应的美颜强度。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | BeautyType | 是 | 美颜类型 |
返回值： |参数名 |类型 |必填|说明 | |——–|————————————————-|—-|———————| |value |number|是 |美颜强度|
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getBeauty(portraitSession: camera.PortraitSession): number {
const invalid_value: number = -1;
let beautyTypes = portraitSession.getSupportedBeautyTypes();
if (beautyTypes === undefined||beautyTypes.length <= 0) {
return invalid_value;
}
let beautyLevels: Array<number> = portraitSession.getSupportedBeautyRange(beautyTypes[0]);
if (beautyLevels === undefined||beautyLevels.length <= 0) {
return invalid_value;
}
portraitSession.setBeauty(beautyTypes[0], beautyLevels[0]);
let beautyLevel: number = portraitSession.getBeauty(beautyTypes[0]);
return beautyLevel;
}
on(‘focusStateChange’)
on(type: ‘focusStateChange’, callback: AsyncCallback<FocusState>): void
监听相机聚焦的状态变化，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’focusStateChange’，session 创建成功可监听。仅当自动对焦模式时,且相机对焦状态发生改变时可触发该事件 |
| callback | AsyncCallback<FocusState> | 是 | 回调函数，用于获取当前对焦状态。 |
示例：
import { BusinessError } from '@ohos.base';
function registerFocusStateChange(captureSession: camera.CaptureSession): void {
captureSession.on('focusStateChange', (err: BusinessError, focusState: camera.FocusState) => {
console.log(`Focus state: ${focusState}`);
});
}
off(‘focusStateChange’)
off(type: ‘focusStateChange’, callback?: AsyncCallback<FocusState>): void
注销监听相机聚焦的状态变化。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’focusStateChange’，session 创建成功可监听。 |
| callback | AsyncCallback<FocusState> | 否 | 回调函数，可选 |
示例：
function unregisterFocusStateChange(captureSession: camera.CaptureSession): void {
captureSession.off('focusStateChange');
}
on(‘error’)
on(type: ‘error’, callback: ErrorCallback): void
监听拍照会话的错误事件，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，session创建成功之后可监听该接口。session调用相关接口出现错误时会触发该事件，比如调用（beginConfig()，commitConfig()，addInput）等接口发生错误时返回错误信息。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerCaptureSessionError(captureSession: camera.CaptureSession): void {
captureSession.on('error', (error: BusinessError) => {
console.log(`Capture session error code: ${error.code}`);
});
}
off(‘error’)
off(type: ‘error’, callback?: ErrorCallback): void
注销监听拍照会话的错误事件，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，session创建成功之后可监听该接口。 |
| callback | ErrorCallback | 否 | 回调函数，可选 |
示例：
function unregisterCaptureSessionError(captureSession: camera.CaptureSession): void {
captureSession.off('error');
}
PortraitSession
继承自CaptureSession，用于设置人像模式的参数。
getSupportedPortraitEffects
getSupportedPortraitEffects(): Array<PortraitEffect>
获取支持的人像虚化效果列表。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<PortraitEffect > | 支持的人像虚化效果列表。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getSupportedPortraitEffects(portraitSession: camera.PortraitSession): Array<camera.PortraitEffect> {
let portraitEffects: Array<camera.PortraitEffect> = portraitSession.getSupportedPortraitEffects();
return portraitEffects;
}
setPortraitEffect
setPortraitEffect(effect: PortraitEffect): void
设置人像虚化效果。需要先检查设备是否支持人像虚化模式，可以通过getSupportedPortraitEffects获取当前设备所支持的PortraitEffect。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
|参数名 |类型 |必填|说明 | |————|—————————————————————|–|————————–| |effect|PortraitEffect |是|人像虚化效果，通过getSupportedPortraitEffects接口获取。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function setPortraitEffect(portraitSession: camera.PortraitSession, portraitEffects: Array<camera.PortraitEffect>): void {
if (portraitEffects === undefined||portraitEffects.length <= 0) {
return;
}
try {
portraitSession.setPortraitEffect(portraitEffects[0]);
} catch (error) {
let err = error as BusinessError;
console.error(`The setPortraitEffect call failed. error code: ${err.code}`);
}
}
getPortraitEffect
getPortraitEffect(): PortraitEffect
获取当前设置的人像虚化效果。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| PortraitEffect | 当前设置的人像虚化效果。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
function getSupportedPortraitEffects(portraitSession: camera.PortraitSession): Array<camera.PortraitEffect> {
let portraitEffects: Array<camera.PortraitEffect> = portraitSession.getSupportedPortraitEffects();
return portraitEffects;
}
CameraOutput
会话中CaptureSession使用的输出信息，output的基类。
PreviewOutput
预览输出类。继承CameraOutput
start
start(callback: AsyncCallback<void>): void
开始输出预览流，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function startPreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the previewOutput. ${err.code}`);
return;
}
console.log('Callback returned with previewOutput started.');
});
}
start
start(): Promise<void>
开始输出预览流，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
示例：
import { BusinessError } from '@ohos.base';
function startPreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.start().then(() => {
console.log('Promise returned with previewOutput started.');
}).catch((err: BusinessError) => {
console.log('Failed to previewOutput start '+ err.code);
});
}
stop
stop(callback: AsyncCallback<void>): void
停止输出预览流，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopPreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.stop((err: BusinessError) => {
if (err) {
console.error(`Failed to stop the previewOutput. ${err.code}`);
return;
}
console.log('Callback returned with previewOutput stopped.');
})
}
stop
stop(): Promise<void>
停止输出预览流，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopPreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.stop().then(() => {
console.log('Callback returned with previewOutput stopped.');
}).catch((err: BusinessError) => {
console.log('Failed to previewOutput stop '+ err.code);
});
}
release
release(callback: AsyncCallback<void>): void
释放输出资源，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releasePreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.release((err: BusinessError) => {
if (err) {
console.error(`Failed to release the PreviewOutput instance ${err.code}`);
return;
}
console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
});
}
release
release(): Promise<void>
释放输出资源，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releasePreviewOutput(previewOutput: camera.PreviewOutput): void {
previewOutput.release().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}).catch((err: BusinessError) => {
console.log('Failed to previewOutput release '+ err.code);
});
}
on(‘frameStart’)
on(type: ‘frameStart’, callback: AsyncCallback<void>): void
监听预览帧启动，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameStart’，previewOutput创建成功可监听。底层第一次开始曝光时触发该事件并返回 |
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览开始 |
示例：
function registerPreviewOutputFrameStart(previewOutput: camera.PreviewOutput): void {
previewOutput.on('frameStart', () => {
console.log('Preview frame started');
});
}
off(‘frameStart’)
off(type: ‘frameStart’, callback?: AsyncCallback<void>): void
注销监听预览帧启动。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameStart’，previewOutput创建成功可监听。 |
| callback | AsyncCallback<void> | 否 | 回调函数，可选 |
示例：
function unregisterPreviewOutputFrameStart(previewOutput: camera.PreviewOutput): void {
previewOutput.off('frameStart');
}
on(‘frameEnd’)
on(type: ‘frameEnd’, callback: AsyncCallback<void>): void
监听预览帧结束，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameEnd’，previewOutput创建成功可监听。预览完全结束最后一帧时触发该事件并返回， |
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。只要有该事件返回就证明预览结束 |
示例：
function registerPreviewOutputFrameEnd(previewOutput: camera.PreviewOutput): void {
previewOutput.on('frameEnd', () => {
console.log('Preview frame ended');
});
}
off(‘frameEnd’)
off(type: ‘frameEnd’, callback?: AsyncCallback<void>): void
注销监听预览帧结束。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameEnd’，previewOutput创建成功可监听。 |
| callback | AsyncCallback<void> | 否 | 回调函数，可选 |
示例：
function unregisterPreviewOutputFrameEnd(previewOutput: camera.PreviewOutput): void {
previewOutput.off('frameEnd');
}
on(‘error’)
on(type: ‘error’, callback: ErrorCallback): void
监听预览输出的错误事件，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，previewOutput创建成功可监听。预览接口使用错误时触发该事件，比如调用（start（），release（））等接口发生错误时返回对应错误信息。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerPreviewOutputError(previewOutput: camera.PreviewOutput): void {
previewOutput.on('error', (previewOutputError: BusinessError) => {
console.log(`Preview output error code: ${previewOutputError.code}`);
})
}
off(‘error’)
off(type: ‘error’, callback?: ErrorCallback): void
注销监听预览输出的错误事件。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，previewOutput创建成功可监听。 |
| callback | ErrorCallback | 否 | 回调函数，可选 |
示例：
function unregisterPreviewOutputError(previewOutput: camera.PreviewOutput): void {
previewOutput.off('error');
}
addDeferredSurface
addDeferredSurface(surfaceId: string): void
配置延迟预览的Surface，可以在session.commitConfig()配流和session.start()启流之后运行。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| surfaceId | string | 是 | 从XComponent组件获取的surfaceId。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
示例：
import common from '@ohos.app.ability.common';
async function preview(context: common.BaseContext, cameraInfo: camera.CameraDevice, previewProfile: camera.Profile, photoProfile: camera.Profile, photoSurfaceId: string, previewSurfaceId: string): Promise<void> {
const cameraManager: camera.CameraManager = camera.getCameraManager(context);
const cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameraInfo)
const previewOutput: camera.PreviewOutput = cameraManager.createDeferredPreviewOutput(previewProfile);
const photoOutput: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, photoSurfaceId);
const session: camera.CaptureSession = cameraManager.createCaptureSession();
session.beginConfig();
session.addInput(cameraInput);
session.addOutput(previewOutput);
session.addOutput(photoOutput);
await session.commitConfig();
await session.start();
previewOutput.addDeferredSurface(previewSurfaceId);
}
ImageRotation
枚举，图片旋转角度。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| ROTATION_0 | 0 | 图片旋转0度。 |
| ROTATION_90 | 90 | 图片旋转90度。 |
| ROTATION_180 | 180 | 图片旋转180度。 |
| ROTATION_270 | 270 | 图片旋转270度。 |
Location
图片地理位置信息。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| latitude | number | 是 | 纬度(度)。 |
| longitude | number | 是 | 经度(度)。 |
| altitude | number | 是 | 海拔(米)。 |
QualityLevel
枚举，图片质量。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| QUALITY_LEVEL_HIGH | 0 | 图片质量高。 |
| QUALITY_LEVEL_MEDIUM | 1 | 图片质量中等。 |
| QUALITY_LEVEL_LOW | 2 | 图片质量差。 |
PhotoCaptureSetting
拍摄照片的设置。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| quality | QualityLevel | 否 | 图片质量。 |
| rotation | ImageRotation | 否 | 图片旋转角度。 |
| location | Location | 否 | 图片地理位置信息。 |
| mirror | boolean | 否 | 镜像使能开关(默认关)。 |
PhotoOutput
拍照会话中使用的输出信息，继承CameraOutput
capture
capture(callback: AsyncCallback<void>): void
以默认设置触发一次拍照，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400104 | Session not running. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function capture(photoOutput: camera.PhotoOutput): void {
photoOutput.capture((err: BusinessError) => {
if (err) {
console.error(`Failed to capture the photo ${err.code}`);
return;
}
console.log('Callback invoked to indicate the photo capture request success.');
});
}
capture
capture(): Promise<void>
以默认设置触发一次拍照，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400104 | Session not running. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function capture(photoOutput: camera.PhotoOutput): void {
photoOutput.capture().then(() => {
console.log('Promise returned to indicate that photo capture request success.');
}).catch((err: BusinessError) => {
console.log('Failed to photoOutput capture '+ err.code);
});
}
capture
capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void>): void
以指定参数触发一次拍照，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| setting | PhotoCaptureSetting | 是 | 拍照设置。 |
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400104 | Session not running. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function capture(photoOutput: camera.PhotoOutput): void {
let captureLocation: camera.Location = {
latitude: 0,
longitude: 0,
altitude: 0,
}
let settings: camera.PhotoCaptureSetting = {
quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
rotation: camera.ImageRotation.ROTATION_0,
location: captureLocation,
mirror: false
}
photoOutput.capture(settings, (err: BusinessError) => {
if (err) {
console.error(`Failed to capture the photo ${err.code}`);
return;
}
console.log('Callback invoked to indicate the photo capture request success.');
});
}
capture
capture(setting?: PhotoCaptureSetting): Promise<void>
以指定参数触发一次拍照，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| setting | PhotoCaptureSetting | 否 | 拍照设置，传入undefined类型数据按默认无参处理。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400101 | Parameter missing or parameter type incorrect |
| 7400104 | Session not running. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function capture(photoOutput: camera.PhotoOutput): void {
let captureLocation: camera.Location = {
latitude: 0,
longitude: 0,
altitude: 0,
}
let settings: camera.PhotoCaptureSetting = {
quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
rotation: camera.ImageRotation.ROTATION_0,
location: captureLocation,
mirror: false
}
photoOutput.capture(settings).then(() => {
console.log('Promise returned to indicate that photo capture request success.');
}).catch((err: BusinessError) => {
console.log('Failed to photoOutput capture '+ err.code);
});
}
isMirrorSupported
isMirrorSupported(): boolean
查询是否支持镜像拍照。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回是否支持镜像拍照。 |
示例：
function isMirrorSupported(photoOutput: camera.PhotoOutput): boolean {
let isSupported: boolean = photoOutput.isMirrorSupported();
return isSupported;
}
release
release(callback: AsyncCallback<void>): void
释放输出资源，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releasePhotoOutput(photoOutput: camera.PhotoOutput): void {
photoOutput.release((err: BusinessError) => {
if (err) {
console.error(`Failed to release the PreviewOutput instance ${err.code}`);
return;
}
console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
});
}
release
release(): Promise<void>
释放输出资源，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releasePhotoOutput(photoOutput: camera.PhotoOutput): void {
photoOutput.release().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}).catch((err: BusinessError) => {
console.log('Failed to photoOutput release '+ err.code);
});
}
on(‘captureStart’)
on(type: ‘captureStart’, callback: AsyncCallback<number>): void
监听拍照开始，通过注册回调函数获取Capture ID。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’captureStart’，photoOutput创建成功后可监听。每次拍照，底层开始曝光时触发该事件并返回。 |
| callback | AsyncCallback<number> | 是 | 使用callback的方式获取Capture ID。 |
示例：
import { BusinessError } from '@ohos.base';
function registerPhotoOutputCaptureStart(photoOutput: camera.PhotoOutput): void {
photoOutput.on('captureStart', (err: BusinessError, captureId: number) => {
console.log(`photo capture stated, captureId : ${captureId}`);
});
}
off(‘captureStart’)
off(type: ‘captureStart’, callback?: AsyncCallback<number>): void
注销监听拍照开始。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’captureStart’，photoOutput创建成功后可监听 |
| callback | AsyncCallback<number> | 否 | 可选。 |
示例：
function unregisterPhotoOutputCaptureStart(photoOutput: camera.PhotoOutput): void {
photoOutput.off('captureStart');
}
on(‘frameShutter’)
on(type: ‘frameShutter’, callback: AsyncCallback<FrameShutterInfo>): void
监听拍照帧输出捕获，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameShutter’，photoOutput创建成功后可监听。 |
| callback | AsyncCallback<FrameShutterInfo> | 是 | 回调函数，用于获取相关信息。该回调返回意味着可以再次下发拍照请求。 |
示例：
import { BusinessError } from '@ohos.base';
function registerPhotoOutputFrameShutter(photoOutput: camera.PhotoOutput): void {
photoOutput.on('frameShutter', (err: BusinessError, frameShutterInfo: camera.FrameShutterInfo) => {
console.log(`photo capture end, captureId : ${frameShutterInfo.captureId}`);
console.log(`Timestamp for frame : ${frameShutterInfo.timestamp}`);
});
}
off(‘frameShutter’)
off(type: ‘frameShutter’, callback?: AsyncCallback<FrameShutterInfo>): void
注销监听拍照帧输出捕获。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameShutter’，photoOutput创建成功后可监听。 |
| callback | AsyncCallback<FrameShutterInfo> | 否 | 回调函数，可选。 |
示例：
function unregisterPhotoOutputFrameShutter(photoOutput: camera.PhotoOutput): void {
photoOutput.off('frameShutter');
}
on(‘captureEnd’)
on(type: ‘captureEnd’, callback: AsyncCallback<CaptureEndInfo>): void
监听拍照结束，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’captureEnd’，photoOutput创建成功后可监听。拍照完全结束可触发该事件发生并返回相应信息。 |
| callback | AsyncCallback<CaptureEndInfo> | 是 | 回调函数，用于获取相关信息。 |
示例：
import { BusinessError } from '@ohos.base';
function registerPhotoOutputCaptureEnd(photoOutput: camera.PhotoOutput): void {
photoOutput.on('captureEnd', (err: BusinessError, captureEndInfo: camera.CaptureEndInfo) => {
console.log(`photo capture end, captureId : ${captureEndInfo.captureId}`);
console.log(`frameCount : ${captureEndInfo.frameCount}`);
});
}
off(‘captureEnd’)
off(type: ‘captureEnd’, callback?: AsyncCallback<CaptureEndInfo>): void
注销监听拍照结束。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’captureEnd’，photoOutput创建成功后可监听。 |
| callback | AsyncCallback<CaptureEndInfo> | 否 | 回调函数，可选。 |
示例：
function unregisterPhotoOutputCaptureEnd(photoOutput: camera.PhotoOutput): void {
photoOutput.off('captureEnd');
}
on(‘error’)
on(type: ‘error’, callback: ErrorCallback): void
监听拍照输出发生错误，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，photoOutput创建成功后可监听。拍照接口调用时出现错误触发该事件并返回错误信息。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerPhotoOutputError(photoOutput: camera.PhotoOutput): void {
photoOutput.on('error', (error: BusinessError) => {
console.log(`Photo output error code: ${error.code}`);
});
}
off(‘error’)
off(type: ‘error’, callback?: ErrorCallback): void
注销监听拍照输出发生错误。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，photoOutput创建成功后可监听。 |
| callback | ErrorCallback | 否 | 回调函数，可选 |
示例：
function unregisterPhotoOutputError(photoOutput: camera.PhotoOutput): void {
photoOutput.off('error');
}
isQuickThumbnailSupported
isQuickThumbnailSupported(): boolean
是否支持输出快速缩略图。
在CaptureSession.addOutput、CaptureSession.addInput之后，CaptureSession.commitConfig之前生效。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 返回支持情况，如果返回true表示支持，否则不支持。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400104 | session is not running |
示例：
import common from '@ohos.app.ability.common';
async function isQuickThumbnailSupported(context: common.BaseContext, photoProfile: camera.Profile, surfaceId: string): Promise<boolean> {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
// 创建CaptureSession实例
let captureSession: camera.CaptureSession = cameraManager.createCaptureSession();
// 开始配置会话
captureSession.beginConfig();
// 把CameraInput加入到会话
let cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameras[0]);
await cameraInput.open();
captureSession.addInput(cameraInput);
// 把photoOutput加入到会话
let photoOutput: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, surfaceId);
captureSession.addOutput(photoOutput);
let isSupported: boolean = photoOutput.isQuickThumbnailSupported();
return isSupported;
}
enableQuickThumbnail
enableQuickThumbnail(enabled: boolean): void
使能/去使能快速缩略图。
在CaptureSession.addOutput、CaptureSession.addInput之后，CaptureSession.commitConfig之前生效。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | true：使能快速缩略图；false：去使能快速缩略图。 |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400104 | session is not running |
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
async function enableQuickThumbnail(context: common.BaseContext, photoProfile: camera.Profile, surfaceId: string): Promise<void> {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
// 创建CaptureSession实例
let captureSession: camera.CaptureSession = cameraManager.createCaptureSession();
// 开始配置会话
captureSession.beginConfig();
// 把CameraInput加入到会话
let cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameras[0]);
await cameraInput.open();
captureSession.addInput(cameraInput);
// 把PhotoOutPut加入到会话
let photoOutput: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, surfaceId);
captureSession.addOutput(photoOutput);
let isSupported: boolean = photoOutput.isQuickThumbnailSupported();
if (!isSupported) {
console.log('Quick Thumbnail is not supported to be turned on.');
return;
}
try {
photoOutput.enableQuickThumbnail(true);
} catch (error) {
let err = error as BusinessError;
console.error(`The enableQuickThumbnail call failed. error code: ${err.code}`);
}
}
on(‘quickThumbnail’)
on(type: ‘quickThumbnail’, callback: AsyncCallback<image.PixelMap>): void
监听快速缩略图输出事件。
在enableQuickThumbnail(true)使能快速缩略图之后监听生效。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’quickThumbnail’。 |
| callback | AsyncCallback<image.PixelMap> | 是 | 回调返回PixelMap。 |
示例：
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
async function registerQuickThumbnail(context: common.BaseContext, photoProfile: camera.Profile, surfaceId: string): Promise<void> {
let cameraManager: camera.CameraManager = camera.getCameraManager(context);
let cameras: Array<camera.CameraDevice> = cameraManager.getSupportedCameras();
// 创建CaptureSession实例
let captureSession: camera.CaptureSession = cameraManager.createCaptureSession();
// 开始配置会话
captureSession.beginConfig();
// 把CameraInput加入到会话
let cameraInput: camera.CameraInput = cameraManager.createCameraInput(cameras[0]);
await cameraInput.open();
captureSession.addInput(cameraInput);
// 把PhotoOutPut加入到会话
let photoOutput: camera.PhotoOutput = cameraManager.createPhotoOutput(photoProfile, surfaceId);
captureSession.addOutput(photoOutput);
let isSupported: boolean = photoOutput.isQuickThumbnailSupported();
if (!isSupported) {
console.log('Quick Thumbnail is not supported to be turned on.');
return;
}
try {
photoOutput.enableQuickThumbnail(true);
} catch (error) {
let err = error as BusinessError;
console.error(`The enableQuickThumbnail call failed. error code: ${err.code}`);
}
photoOutput.on('quickThumbnail', (err: BusinessError, pixelMap: image.PixelMap) => {
if (err||pixelMap === undefined) {
console.error('photoOutput on thumbnail failed');
return;
}
// 显示或保存pixelMap
// do something
})
}
off(‘quickThumbnail’)
off(type: ‘quickThumbnail’, callback?: AsyncCallback<image.PixelMap>): void
注销监听快速缩略图输出事件。
系统接口： 此接口为系统接口。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’quickThumbnail’。 |
| callback | AsyncCallback<image.PixelMap> | 否 | 可选。 |
示例：
function unregisterQuickThumbnail(photoOutput: camera.PhotoOutput): void {
photoOutput.off('quickThumbnail');
}
FrameShutterInfo
拍照帧输出信息。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| captureId | number | 是 | 拍照的ID。 |
| timestamp | number | 是 | 快门时间戳。 |
CaptureEndInfo
拍照停止信息。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| captureId | number | 是 | 拍照的ID。 |
| frameCount | number | 是 | 帧数。 |
VideoOutput
录像会话中使用的输出信息，继承CameraOutput
start
start(callback: AsyncCallback<void>): void
启动录制，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start the video output ${err.code}`);
return;
}
console.log('Callback invoked to indicate the video output start success.');
});
}
start
start(): Promise<void>
启动录制，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.start().then(() => {
console.log('Promise returned to indicate that start method execution success.');
}).catch((err: BusinessError) => {
console.log('Failed to videoOutput start '+ err.code);
});
}
stop
stop(callback: AsyncCallback<void>): void
结束录制，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.stop((err: BusinessError) => {
if (err) {
console.error(`Failed to stop the video output ${err.code}`);
return;
}
console.log('Callback invoked to indicate the video output stop success.');
});
}
stop
stop(): Promise<void>
结束录制，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.stop().then(() => {
console.log('Promise returned to indicate that stop method execution success.');
}).catch((err: BusinessError) => {
console.log('Failed to videoOutput stop '+ err.code);
});
}
release
release(callback: AsyncCallback<void>): void
释放输出资源，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releaseVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.release((err: BusinessError) => {
if (err) {
console.error(`Failed to release the PreviewOutput instance ${err.code}`);
return;
}
console.log('Callback invoked to indicate that the videoOutput instance is released successfully.');
});
}
release
release(): Promise<void>
释放输出资源，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function releaseVideoOutput(videoOutput: camera.VideoOutput): void {
videoOutput.release().then(() => {
console.log('Promise returned to indicate that the videoOutput instance is released successfully.');
}).catch((err: BusinessError) => {
console.log('Failed to videoOutput release '+ err.code);
});
}
on(‘frameStart’)
on(type: ‘frameStart’, callback: AsyncCallback<void>): void
监听录像开始，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameStart’，videoOutput创建成功后可监听。底层第一次曝光时触发该事件并返回。 |
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像开始 |
示例：
function registerVideoOutputFrameStart(videoOutput: camera.VideoOutput): void {
videoOutput.on('frameStart', () => {
console.log('Video frame started');
});
}
off(‘frameStart’)
off(type: ‘frameStart’, callback?: AsyncCallback<void>): void
注销监听录像开始。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameStart’，videoOutput创建成功后可监听。 |
| callback | AsyncCallback<void> | 否 | 回调函数，可选 |
示例：
function unregisterVideoOutputFrameStart(videoOutput: camera.VideoOutput): void {
videoOutput.off('frameStart');
}
on(‘frameEnd’)
on(type: ‘frameEnd’, callback: AsyncCallback<void>): void
监听录像结束，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameEnd’，videoOutput创建成功后可监听。录像完全结束最后一帧时触发该事件并返回 。 |
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。 只要有该事件返回就证明录像结束 |
示例：
function registerVideoOutputFrameEnd(videoOutput: camera.VideoOutput): void {
videoOutput.on('frameEnd', () => {
console.log('Video frame ended');
});
}
off(‘frameEnd’)
off(type: ‘frameEnd’, callback?: AsyncCallback<void>): void
注销监听录像结束。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’frameEnd’，videoOutput创建成功后可监听 。 |
| callback | AsyncCallback<void> | 否 | 回调函数，可选 |
示例：
function unregisterVideoOutputFrameEnd(videoOutput: camera.VideoOutput): void {
videoOutput.off('frameEnd');
}
on(‘error’)
on(type: ‘error’, callback: ErrorCallback): void
监听录像输出发生错误，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，videoOutput创建成功后可监听。录像接口调用出现错误时触发该事件并返回对应错误码,比如调用（start(),release()）接口时出现错误返回对应错误信息。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerVideoOutputError(videoOutput: camera.VideoOutput): void {
videoOutput.on('error', (error: BusinessError) => {
console.log(`Video output error code: ${error.code}`);
});
}
off(‘error’)
off(type: ‘error’, callback?: ErrorCallback): void
注销监听录像输出发生错误。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，videoOutput创建成功后可监听。 |
| callback | ErrorCallback | 否 | 回调函数，可选 |
示例：
function unregisterVideoOutputError(videoOutput: camera.VideoOutput): void {
videoOutput.off('error');
}
MetadataOutput
metadata流。继承CameraOutput
start
start(callback: AsyncCallback<void>): void
开始输出metadata，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startMetadataOutput(metadataOutput: camera.MetadataOutput): void {
metadataOutput.start((err: BusinessError) => {
if (err) {
console.error(`Failed to start metadataOutput. ${err.code}`);
return;
}
console.log('Callback returned with metadataOutput started.');
});
}
start
start(): Promise<void>
开始输出metadata，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。接口调用失败会返回相应错误码，错误码类型CameraErrorCode |
错误码：
以下错误码的详细介绍请参见Camera错误码。
| 错误码ID | 错误信息 |
|---|---|
| 7400103 | Session not config. |
| 7400201 | Camera service fatal error. |
示例：
import { BusinessError } from '@ohos.base';
function startMetadataOutput(metadataOutput: camera.MetadataOutput): void {
metadataOutput.start().then(() => {
console.log('Callback returned with metadataOutput started.');
}).catch((err: BusinessError) => {
console.log('Failed to metadataOutput start '+ err.code);
});
}
stop
stop(callback: AsyncCallback<void>): void
停止输出metadata，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，用于获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopMetadataOutput(metadataOutput: camera.MetadataOutput): void {
metadataOutput.stop((err: BusinessError) => {
if (err) {
console.error(`Failed to stop the metadataOutput. ${err.code}`);
return;
}
console.log('Callback returned with metadataOutput stopped.');
})
}
stop
stop(): Promise<void>
停止输出metadata，通过Promise获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | 使用Promise的方式获取结果。 |
示例：
import { BusinessError } from '@ohos.base';
function stopMetadataOutput(metadataOutput: camera.MetadataOutput): void {
metadataOutput.stop().then(() => {
console.log('Callback returned with metadataOutput stopped.');
}).catch((err: BusinessError) => {
console.log('Failed to metadataOutput stop '+ err.code);
});
}
on(‘metadataObjectsAvailable’)
on(type: ‘metadataObjectsAvailable’, callback: AsyncCallback<Array<MetadataObject>>): void
监听检测到的metadata对象，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’metadataObjectsAvailable’，metadataOutput创建成功后可监听。检测到有效的metadata数据时触发该事件发生并返回相应的metadata数据 |
| callback | Callback<Array<MetadataObject>> | 是 | 回调函数，用于获取metadata数据。 |
示例：
import { BusinessError } from '@ohos.base';
function registerMetadataObjectsAvailable(metadataOutput: camera.MetadataOutput): void {
metadataOutput.on('metadataObjectsAvailable', (err: BusinessError, metadataObjectArr: Array<camera.MetadataObject>) => {
console.log(`metadata output metadataObjectsAvailable`);
});
}
off(‘metadataObjectsAvailable’)
off(type: ‘metadataObjectsAvailable’, callback?: AsyncCallback<Array<MetadataObject>>): void
注销监听检测到的metadata对象。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’metadataObjectsAvailable’，metadataOutput创建成功后可监听。 |
| callback | Callback<Array<MetadataObject>> | 否 | 回调函数，可选。 |
示例：
function unregisterMetadataObjectsAvailable(metadataOutput: camera.MetadataOutput): void {
metadataOutput.off('metadataObjectsAvailable');
}
on(‘error’)
on(type: ‘error’, callback: ErrorCallback): void
监听metadata流的错误，通过注册回调函数获取结果。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，metadataOutput创建成功后可监听。metadata接口使用错误时触发该事件并返回对应错误码，比如调用（start（），release（））接口时发生错误返回对应错误信息。 |
| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。返回错误码，错误码类型CameraErrorCode |
示例：
import { BusinessError } from '@ohos.base';
function registerMetadataOutputError(metadataOutput: camera.MetadataOutput): void {
metadataOutput.on('error', (metadataOutputError: BusinessError) => {
console.log(`Metadata output error code: ${metadataOutputError.code}`);
});
}
off(‘error’)
off(type: ‘error’, callback?: ErrorCallback): void
注销监听metadata流的错误。
系统能力： SystemCapability.Multimedia.Camera.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 监听事件，固定为’error’，metadataOutput创建成功后可监听。 |
| callback | ErrorCallback | 否 | 回调函数，可选 |
示例：
function unregisterMetadataOutputError(metadataOutput: camera.MetadataOutput): void {
metadataOutput.off('error');
}
MetadataObjectType
枚举，metadata流。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 值 | 说明 |
|---|---|---|
| FACE_DETECTION | 0 | metadata对象类型,人脸检测。检测点应在0-1坐标系内，该坐标系左上角为{0，0}，右下角为{1，1}。 此坐标系是以设备充电口在右侧时的横向设备方向为基准的， 例如应用的预览界面布局以设备充电口在下侧时的竖向方向为基准， 布局宽高为{w，h}， 返回点为{x，y}，则转换后的坐标点为{1-y，x}。 |
Rect
矩形定义。
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| topLeftX | number | 是 | 矩形区域左上角x坐标。 |
| topLeftY | number | 是 | 矩形区域左上角y坐标。 |
| width | number | 是 | 矩形宽。 |
| height | number | 是 | 矩形高。 |
MetadataObject
相机元能力信息，CameraInput相机信息中的数据来源，通过metadataOutput.on(‘metadataObjectsAvailable’)接口获取
系统能力： SystemCapability.Multimedia.Camera.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | MetadataObjectType | 否 | metadata 类型，目前只有人脸识别。 |
| timestamp | number | 否 | 当前时间戳（毫秒）。 |
| boundingBox | Rect | 否 | metadata 区域框 |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦