@ohos.multimedia.camera (相机管理)

说明：

• 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块接口为系统接口。

导入模块

import camera from '@ohos.multimedia.camera';

camera.getCameraManager

getCameraManager(context: Context): CameraManager

获取相机管理器实例，同步返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let cameraManager = camera.getCameraManager(context);

CameraStatus

枚举，相机状态。

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

Profile

相机配置信息项。

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

FrameRateRange

帧率范围。

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

VideoProfile

视频配置信息项。

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

CameraOutputCapability

相机输出能力项。

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

CameraErrorCode

相机错误码。接口使用不正确以及on接口监听error状态返回。

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

CameraManager

相机管理器类，使用前需要通过getCameraManager获取相机管理实例。

getSupportedCameras

getSupportedCameras(): Array<CameraDevice>

获取支持指定的相机设备对象，同步返回结果。

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

返回值：

示例：

let cameras = cameraManager.getSupportedCameras();

getSupportedOutputCapability

getSupportedOutputCapability(cameraDevice:CameraDevice): CameraOutputCapability

查询相机设备在模式下支持的输出能力，同步返回结果。

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

参数：

返回值：

示例：

let cameraDevice = cameras[0];
let cameraOutputCapability = cameraManager.getSupportedOutputCapability(cameraDevice);

isCameraMuted

isCameraMuted(): boolean

查询相机当前的禁用状态（禁用/未禁用）。

在此之前，需要通过isCameraMuteSupported确认当前设备支持禁用相机。

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

返回值：

示例：

let ismuted = cameraManager.isCameraMuted();

isCameraMuteSupported

isCameraMuteSupported(): boolean

查询当前设备是否支持禁用相机，通过返回值返回结果。

此接口为系统接口。

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

返回值：

示例：

let ismutesuppotred = cameraManager.isCameraMuteSupported();

muteCamera

muteCamera(mute: boolean): void

禁用相机。

此接口为系统接口。

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

参数：

示例：

let mute = true;
cameraManager.muteCamera(mute);

createCameraInput

createCameraInput(camera: CameraDevice): CameraInput

使用CameraDevice对象创建CameraInput实例，同步返回结果。

需要权限： ohos.permission.CAMERA

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let cameraDevice = cameras[0];
let cameraInput;
try {
	cameraInput = cameraManager.createCameraInput(cameraDevice);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createCameraInput

createCameraInput(position: CameraPosition, type: CameraType): CameraInput

根据相机位置和类型创建CameraInput实例，同步返回结果。

需要权限： ohos.permission.CAMERA

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let cameraDevice = cameras[0];
let position = cameraDevice.cameraPosition;
let type = cameraDevice.cameraType;
let cameraInput;
try {
    cameraInput = cameraManager.createCameraInput(position, type);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createPreviewOutput

createPreviewOutput(profile: Profile, surfaceId: string): PreviewOutput

创建预览输出对象，同步返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let profile = cameraOutputCapability.previewProfiles[0];
let previewOutput;
try {
    previewOutput = cameraManager.createPreviewOutput(profile, surfaceId);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createPhotoOutput

createPhotoOutput(profile: Profile, surfaceId: string): PhotoOutput

创建拍照输出对象，同步返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let profile = cameraOutputCapability.photoProfiles[0];
let photoOutput;
try {
    photoOutput = cameraManager.createPhotoOutput(profile, surfaceId);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createVideoOutput

createVideoOutput(profile: VideoProfile, surfaceId: string): VideoOutput

创建录像输出对象，同步返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let profile = cameraOutputCapability.videoProfiles[0];
let videoOutput;
try {
    videoOutput = cameraManager.createVideoOutput(profile, surfaceId);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createMetadataOutput

createMetadataOutput(metadataObjectTypes:Array<MetadataObjectType>): MetadataOutput

创建metadata流输出对象，同步返回结果。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let metadataObjectTypes = cameraOutputCapability.supportedMetadataObjectTypes;
let metadataOutput;
try {
    metadataOutput = cameraManager.createMetadataOutput(metadataObjectTypes);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

createCaptureSession

createCaptureSession(): CaptureSession

创建CaptureSession实例，通过注册回调函数获取结果。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let captureSession;
try {
    captureSession = cameraManager.createCaptureSession();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

on('cameraStatus')

on(type: 'cameraStatus', callback: AsyncCallback<CameraStatusInfo>): void

相机设备状态回调，通过注册回调函数获取相机的状态变化。

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

参数：

示例：

cameraManager.on('cameraStatus', (cameraStatusInfo) => {
    console.log(`camera : ${cameraStatusInfo.camera.cameraId}`);
    console.log(`status: ${cameraStatusInfo.status}`);
})

on('cameraMute')

on(type: 'cameraMute', callback: AsyncCallback<boolean>): void

禁用回调，通过注册回调函数获取相机禁用状态变化。

此接口为系统接口。

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

参数：

示例：

cameraManager.on('cameraMute', (curMuetd) => {
    let isMuted = curMuetd;
})

CameraStatusInfo

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

系统能力： SystemCapability.Multimedia.Camera.Core。

CameraPosition

枚举，相机位置。

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

CameraType

枚举，相机类型。

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

ConnectionType

枚举，相机连接类型。

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

CameraDevice

相机设备信息。

系统能力： SystemCapability.Multimedia.Camera.Core。

Size

枚举，输出能力查询。

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

Point

枚举，点坐标用于对焦、曝光配置。

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

CameraFormat

枚举，输出格式。

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

CameraInput

会话中CaptureSession使用的相机信息。

open

open(callback: AsyncCallback<void>): void

打开相机，通过注册回调函数获取状态。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

cameraInput.open((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

cameraInput.open().then(() => {
    console.log('Promise returned with camera opened.');
}).catch((err) => {
    console.error(`Failed to open the camera. ${err.code}`);
});

close

close(callback: AsyncCallback<void>): void

关闭相机，通过注册回调函数获取状态。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

cameraInput.close((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

cameraInput.close().then(() => {
    console.log('Promise returned with camera closed.');
}).catch((err) => {
    console.error(`Failed to close the cameras. ${err.code}`);
});

on('error')

on(type: 'error', cameraDevice:CameraDevice, callback: ErrorCallback<BusinessError>): void

监听CameraInput的错误事件，通过注册回调函数获取结果。

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

参数：

示例：

let cameraDevice = cameras[0];
cameraInput.on('error', cameraDevice, (error) => {
    console.log(`Camera input error code: ${error.code}`);
})

FlashMode

枚举，闪光灯模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

ExposureMode

枚举，曝光模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

FocusMode

枚举，焦距模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

FocusState

枚举，焦距状态。

系统能力： SystemCapability.Multimedia.Camera.Core。

VideoStabilizationMode

枚举，视频防抖模式。

系统能力： SystemCapability.Multimedia.Camera.Core。

CaptureSession

拍照会话类，保存一次相机运行所需要的所有资源CameraInput、CameraOutput，并向相机设备申请完成相机功能(录像，拍照)。

beginConfig

beginConfig(): void

开始配置会话。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.beginConfig();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

commitConfig

commitConfig(callback: AsyncCallback<void>): void

提交配置信息，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.commitConfig((err) => {
    if (err) {
        console.log('Failed to commitConfig '+ err.code);
        return;
    }
    console.log('Callback invoked to indicate the commit config success.');
});

commitConfig

commitConfig(): Promise<void>

提交配置信息，通过Promise获取结果。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.commitConfig().then(() => {
    console.log('Promise returned to indicate the commit config success.');
}).catch((err) => {
    // 失败返回错误码error.code并处理
    console.log('Failed to commitConfig '+ err.code);
});

addInput

addInput(cameraInput: CameraInput): void

把CameraInput加入到会话。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.addInput(cameraInput);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

removeInput

removeInput(cameraInput: CameraInput): void

移除CameraInput。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.removeInput(cameraInput);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

addOutput

addOutput(previewOutput: CameraOutput): void

把CameraOutput加入到会话。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.addOutput(previewOutput);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

removeOutput

removeOutput(previewOutput: CameraOutput): void

从会话中移除CameraOutput。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.removeOutput(previewOutput);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

start

start(callback: AsyncCallback<void>): void

开始会话工作，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.start((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.start().then(() => {
    console.log('Promise returned to indicate the session start success.');
}).catch((err) => {
    console.error(`Failed to start the session ${err.code}`);
});

stop

stop(callback: AsyncCallback<void>): void

停止会话工作，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.stop((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.stop().then(() => {
    console.log('Promise returned to indicate the session stop success.');
}).catch((err) => {
    console.error(`Failed to stop the session ${err.code}`);
});

release

release(callback: AsyncCallback<void>): void

释放会话资源，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.release((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

captureSession.release().then(() => {
    console.log('Promise returned to indicate that the CaptureSession instance is released successfully.');
}).catch((err) => {
    console.error(`Failed to release the CaptureSession instance ${err.code}`);
});

hasFlash

hasFlash(): boolean

检测是否有闪光灯，通过注册回调函数获取结果。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let status = captureSession.hasFlash();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode): boolean

检测闪光灯模式是否支持。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let status = captureSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setFlashMode

setFlashMode(flashMode: FlashMode): void

设置闪光灯模式。

进行设置之前，需要先检查：

1. 设备是否支持闪光灯，可使用方法hasFlash。
2. 设备是否支持指定的闪光灯模式，可使用方法isFlashModeSupported。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getFlashMode

getFlashMode(): FlashMode

获取当前设备的闪光灯模式。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let flashMode = captureSession.getFlashMode();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

isExposureModeSupported

isExposureModeSupported(aeMode: ExposureMode): boolean;

检测曝光模式是否支持。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let isSupported = captureSession.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getExposureMode

getExposureMode(): ExposureMode

获取当前曝光模式。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let exposureMode = captureSession.getExposureMode();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setExposureMode

setExposureMode(aeMode: ExposureMode): void

设置曝光模式。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.setExposureMode(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getMeteringPoint

getMeteringPoint(): Point

查询曝光区域中心点。（该接口目前为预留，将在3.2版本开放）

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let exposurePoint = captureSession.getMeteringPoint();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setMeteringPoint

setMeteringPoint(point: Point): void

设置曝光区域中心点。（该接口目前为预留，将在3.2版本开放）

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

const exposurePoint = {x: 1, y: 1};
try {
    captureSession.setMeteringPoint(exposurePoint);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getExposureBiasRange

getExposureBiasRange(): Array<number>

查询曝光补偿范围。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let biasRangeArray = captureSession.getExposureBiasRange();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setExposureBias

setExposureBias(exposureBias: number): void

设置曝光补偿。

进行设置之前，建议先通过方法getExposureBiasRange查询支持的范围。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let exposureBias = biasRangeArray[0];
try {
    captureSession.setExposureBias(exposureBias);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getExposureValue

getExposureValue(): number

查询当前曝光值。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let exposureValue = captureSession.getExposureValue();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode): boolean

检测对焦模式是否支持。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let status = captureSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setFocusMode

setFocusMode(afMode: FocusMode): void

设置对焦模式。

进行设置之前，需要先检查设备是否支持指定的焦距模式，可使用方法isFocusModeSupported。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getFocusMode

getFocusMode(): FocusMode

获取当前的对焦模式。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let afMode = captureSession.getFocusMode();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setFocusPoint

setFocusPoint(point: Point): void

设置焦点。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

const Point1 = {x: 1, y: 1};
try {
    captureSession.setFocusPoint(Point1);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getFocusPoint

getFocusPoint(): Point

查询焦点。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let point = captureSession.getFocusPoint();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getFocalLength

getFocalLength(): number

查询焦距值。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let focalLength = captureSession.getFocalLength();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getZoomRatioRange

getZoomRatioRange(): Array<number>

获取支持的变焦范围。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let zoomRatioRange = captureSession.getZoomRatioRange();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setZoomRatio

setZoomRatio(zoomRatio: number): void

设置变焦比。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let zoomRatio = zoomRatioRange[0];
try {
    captureSession.setZoomRatio(zoomRatio);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getZoomRatio

getZoomRatio(): number

获取当前的变焦比。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let zoomRatio = captureSession.getZoomRatio();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

isVideoStabilizationModeSupported

isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode): boolean

查询是否支持指定的视频防抖模式。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let isSupported = captureSession.isVideoStabilizationModeSupported(camera.VideoStabilizationMode.OFF);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

getActiveVideoStabilizationMode

getActiveVideoStabilizationMode(): VideoStabilizationMode

查询当前正在使用的视频防抖模式。

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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    let vsMode = captureSession.getActiveVideoStabilizationMode();
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

setVideoStabilizationMode

setVideoStabilizationMode(mode: VideoStabilizationMode): void

设置视频防抖模式。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

try {
    captureSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF);
} catch (error) {
    // 失败返回错误码error.code并处理
    console.log(error.code);
}

on('focusStateChange')

on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void

监听相机聚焦的状态变化，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.on('focusStateChange', (focusState) => {
    console.log(`Focus state  : ${focusState}`);
})

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): void

监听拍照会话的错误事件，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.on('error', (error) => {
    console.log(`Capture session error code: ${error.code}`);
})

CameraOutput

会话中CaptureSession使用的输出信息，output的基类。

PreviewOutput

预览输出类。继承CameraOutput

start

start(callback: AsyncCallback<void>): void

开始输出预览流，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

previewOutput.start((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

previewOutput.start().then(() => {
    console.log('Promise returned with previewOutput started.');
}).catch((err) => {
    console.log('Failed to previewOutput start '+ err.code);
});

stop

stop(callback: AsyncCallback<void>): void

停止输出预览流，通过注册回调函数获取结果。

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

参数：

示例：

previewOutput.stop((err) => {
    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

返回值：

示例：

previewOutput.stop().then(() => {
    console.log('Callback returned with previewOutput stopped.');
}).catch((err) => {
    console.log('Failed to previewOutput stop '+ err.code);
});

release

release(callback: AsyncCallback<void>): void

释放输出资源，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

previewOutput.release((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

previewOutput.release().then(() => {
    console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}).catch((err) => {
    console.log('Failed to previewOutput release '+ err.code);
});

on('frameStart')

on(type: 'frameStart', callback: AsyncCallback<void>): void

监听预览帧启动，通过注册回调函数获取结果。

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

参数：

示例：

previewOutput.on('frameStart', () => {
    console.log('Preview frame started');
})

on('frameEnd')

on(type: 'frameEnd', callback: AsyncCallback<void>): void

监听预览帧结束，通过注册回调函数获取结果。

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

参数：

示例：

previewOutput.on('frameEnd', () => {
    console.log('Preview frame ended');
})

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): void

监听预览输出的错误事件，通过注册回调函数获取结果。

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

参数：

示例：

previewOutput.on('error', (previewOutputError) => {
    console.log(`Preview output error code: ${previewOutputError.code}`);
})

ImageRotation

枚举，图片旋转角度。

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

Location

图片地理位置信息。

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

QualityLevel

枚举，图片质量。

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

PhotoCaptureSetting

拍摄照片的设置。

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

PhotoOutput

拍照会话中使用的输出信息，继承CameraOutput

capture

capture(callback: AsyncCallback<void>): void

以默认设置触发一次拍照，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

photoOutput.capture((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

photoOutput.capture().then(() => {
    console.log('Promise returned to indicate that photo capture request success.');
}).catch((err) => {
    console.log('Failed to photoOutput capture '+ err.code);
});

capture

capture(setting: PhotoCaptureSetting, callback: AsyncCallback<void>): void

以指定参数触发一次拍照，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

let captureLocation = {
  latitude: 0,
  longitude: 0,
  altitude: 0,
}
let settings = {
  quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
  rotation: camera.ImageRotation.ROTATION_0,
  location: captureLocation,
  mirror: false
}
photoOutput.capture(settings, (err) => {
    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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

photoOutput.capture(settings).then(() => {
    console.log('Promise returned to indicate that photo capture request success.');
}).catch((err) => {
    console.log('Failed to photoOutput capture '+ err.code);
});

isMirrorSupported

isMirrorSupported(): boolean

查询是否支持镜像拍照。

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

返回值：

示例：

let isSupported = photoOutput.isMirrorSupported();

release

release(callback: AsyncCallback<void>): void

释放输出资源，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

photoOutput.release((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

photoOutput.release().then(() => {
    console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}).catch((err) => {
    console.log('Failed to photoOutput release '+ err.code);
});

on('captureStart')

on(type: 'captureStart', callback: AsyncCallback<number>): void

监听拍照开始，通过注册回调函数获取Capture ID。

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

参数：

示例：

photoOutput.on('captureStart', (captureId) => {
    console.log(`photo capture stated, captureId : ${captureId}`);
})

on('frameShutter')

on(type: 'frameShutter', callback: AsyncCallback<FrameShutterInfo>): void

监听拍照帧输出捕获，通过注册回调函数获取结果。

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

参数：

示例：

photoOutput.on('frameShutter', (frameShutterInfo) => {
    console.log(`photo capture end, captureId : ${frameShutterInfo.captureId}`);
    console.log(`Timestamp for frame : ${frameShutterInfo.timestamp}`);
})

on('captureEnd')

on(type: 'captureEnd', callback: AsyncCallback<CaptureEndInfo>): void

监听拍照结束，通过注册回调函数获取结果。

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

参数：

示例：

photoOutput.on('captureEnd', (captureEndInfo) => {
    console.log(`photo capture end, captureId : ${captureEndInfo.captureId}`);
    console.log(`frameCount : ${captureEndInfo.frameCount}`);
})

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): void

监听拍照输出发生错误，通过注册回调函数获取结果。

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

参数：

示例：

photoOutput.on('error', (error) => {
    console.log(`Photo output error code: ${error.code}`);
})

FrameShutterInfo

拍照帧输出信息。

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

CaptureEndInfo

拍照停止信息。

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

VideoOutput

录像会话中使用的输出信息，继承CameraOutput

start

start(callback: AsyncCallback<void>): void

启动录制，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

videoOutput.start((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

videoOutput.start().then(() => {
    console.log('Promise returned to indicate that start method execution success.');
}).catch((err) => {
    console.log('Failed to videoOutput start '+ err.code);
});

stop

stop(callback: AsyncCallback<void>): void

结束录制，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.stop((err) => {
    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

返回值：

示例：

videoOutput.stop().then(() => {
    console.log('Promise returned to indicate that stop method execution success.');
}).catch((err) => {
    console.log('Failed to videoOutput stop '+ err.code);
});

release

release(callback: AsyncCallback<void>): void

释放输出资源，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

videoOutput.release((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

videoOutput.release().then(() => {
    console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
}).catch((err) => {
    console.log('Failed to videoOutput release '+ err.code);
});

on('frameStart')

on(type: 'frameStart', callback: AsyncCallback<void>): void

监听录像开始，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.on('frameStart', () => {
    console.log('Video frame started');
})

on('frameEnd')

on(type: 'frameEnd', callback: AsyncCallback<void>): void

监听录像结束，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.on('frameEnd', () => {
    console.log('Video frame ended');
})

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): void

监听录像输出发生错误，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.on('error', (error) => {
    console.log(`Video output error code: ${error.code}`);
})

MetadataOutput

metadata流。继承CameraOutput

start

start(callback: AsyncCallback<void>): void

开始输出metadata，通过注册回调函数获取结果。

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

参数：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

metadataOutput.start((err) => {
    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

返回值：

错误码：

以下错误码的详细介绍请参见相机错误码

示例：

metadataOutput.start().then(() => {
    console.log('Callback returned with metadataOutput started.');
}).catch((err) => {
    console.log('Failed to metadataOutput start '+ err.code);
});

stop

stop(callback: AsyncCallback<void>): void

停止输出metadata，通过注册回调函数获取结果。

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

参数：

示例：

metadataOutput.stop((err) => {
    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

返回值：

示例：

metadataOutput.stop().then(() => {
    console.log('Callback returned with metadataOutput stopped.');
}).catch((err) => {
    console.log('Failed to metadataOutput stop '+ err.code);
});

on('metadataObjectsAvailable')

on(type: 'metadataObjectsAvailable', callback: AsyncCallback<Array<MetadataObject>>): void

监听检测到的metadata对象，通过注册回调函数获取结果。

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

参数：

示例：

metadataOutput.on('metadataObjectsAvailable', (metadataObjectArr) => {
    console.log(`metadata output metadataObjectsAvailable`);
})

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): void

监听metadata流的错误，通过注册回调函数获取结果。

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

参数：

示例：

metadataOutput.on('error', (metadataOutputError) => {
    console.log(`Metadata output error code: ${metadataOutputError.code}`);
})

MetadataObjectType

枚举，metadata流。

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

Rect

矩形定义。

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

MetadataObject

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