相机管理

说明： 本模块首批接口从API version 9开始支持。API Version 9当前为Canary版本，仅供试用，不保证接口可稳定调用。

导入模块

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

权限

ohos.permission.CAMERA

camera.getCameraManager

getCameraManager(context: Context, callback: AsyncCallback<CameraManager>): void

获取相机管理器实例，通过注册回调函数获取结果。

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

参数：

示例：

camera.getCameraManager(context, (err, cameraManager) => {
    if (err) {
        console.error('Failed to get the CameraManager instance ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraManager instance');
});

camera.getCameraManager

getCameraManager(context: Context): Promise<CameraManager>

获取相机管理器实例，通过Promise获取结果。

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

参数：

返回值：

示例：

camera.getCameraManager(context).then((cameraManager) => {
    console.log('Promise returned with the CameraManager instance.');
})

CameraStatus

枚举，相机状态。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

CameraPosition

枚举，相机方向。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

CameraType

枚举，相机类型。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

ConnectionType

枚举，相机连接类型。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

CameraManager

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

getCameras

getCameras(callback: AsyncCallback<Array<Camera>>): void

异步获取设备支持的相机列表，通过注册回调函数获取结果。

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

参数：

示例：

cameraManager.getCameras((err, cameras) => {
    if (err) {
        console.error('Failed to get the cameras. ${err.message}');
        return;
    }
    console.log('Callback returned with an array of supported cameras: ' + cameras.length);
})

getCameras

getCameras(): Promise<Array<Camera>>

异步获取设备支持的相机列表，通过Promise获取结果。

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

返回值：

示例：

cameraManager.getCameras().then((cameraArray) => {
    console.log('Promise returned with an array of supported cameras: ' + cameraArray.length);
})

createCameraInput

createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput>): void

使用相机ID异步创建CameraInput实例，通过注册回调函数获取结果。

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

参数：

示例：

cameraManager.createCameraInput(cameraId, (err, cameraInput) => {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance.');
})

createCameraInput

createCameraInput(cameraId: string): Promise<CameraInput>

使用相机ID异步创建CameraInput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

cameraManager.createCameraInput(cameraId).then((cameraInput) => {
    console.log('Promise returned with the CameraInput instance');
})

createCameraInput

createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCallback<CameraInput>): void

使用相机位置和相机类型异步创建CameraInput实例，通过注册回调函数获取结果。

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

参数：

示例：

cameraManager.createCameraInput(cameraPosition, cameraType, (err, cameraInput) => {
    if (err) {
        console.error('Failed to create the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CameraInput instance');
})

createCameraInput

createCameraInput(position: CameraPosition, type: CameraType): Promise<CameraInput>

使用相机位置和相机类型异步创建CameraInput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

cameraManager.createCameraInput(cameraPosition, cameraType).then((cameraInput) => {
    console.log('Promise returned with the CameraInput instance.');
})

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);
})

Camera

调用camera.getCameraManager后，将返回Camera实例，包括相机ID、位置、类型、连接类型等相机相关的元数据。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

示例：

async function getCameraInfo() {
    var cameraManager = await camera.getCameraManager();
    var cameras = await cameraManager.getCameras();
    var cameraObj = cameras[0];
    var cameraId = cameraObj.cameraId;
    var cameraPosition = cameraObj.cameraPosition;
    var cameraType = cameraObj.cameraType;
    var cameraId = cameraObj.connectionType;
}

CameraStatusInfo

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

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

CameraInput

相机输入类。在使用该类的方法前，需要先构建一个CameraInput实例。

getCameraId

getCameraId(callback: AsyncCallback<string>): void

异步获取该CameraInput实例的相机ID，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.getCameraId((err, cameraId) => {
    if (err) {
        console.error('Failed to get the camera ID. ${err.message}');
        return;
    }
    console.log('Callback returned with the camera ID: ' + cameraId);
})

getCameraId

getCameraId(): Promise<string>

异步获取该CameraInput实例的相机ID，通过Promise获取结果。

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

返回值：

示例：

cameraInput.getCameraId().then((cameraId) => {
    console.log('Promise returned with the camera ID:' + cameraId);
})

hasFlash

hasFlash(callback: AsyncCallback<boolean>): void

判断设备是否支持闪光灯，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.hasFlash((err, status) => {
    if (err) {
        console.error('Failed to check whether the device has flash light. ${err.message}');
        return;
    }
    console.log('Callback returned with flash light support status: ' + status);
})

hasFlash

hasFlash(): Promise<boolean>

判断设备是否支持闪光灯，通过Promise获取结果。

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

返回值：

示例：

cameraInput.hasFlash().then((status) => {
    console.log('Promise returned with the flash light support status:' + status);
})

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean>): void

判断设备是否支持指定闪光灯模式，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.isFlashModeSupported(flashMode, (err, status) => {
    if (err) {
        console.error('Failed to check whether the flash mode is supported. ${err.message}');
        return;
    }
    console.log('Callback returned with the flash mode support status: ' + status);
})

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode): Promise<boolean>

判断设备是否支持指定闪光灯模式，通过Promise获取结果。

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

参数：

返回值：

示例：

cameraInput.isFlashModeSupported(flashMode).then((status) => {
    console.log('Promise returned with flash mode support status.' + status);
})

setFlashMode

setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void>): void

设置闪光灯模式，通过注册回调函数获取结果。

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

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

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

参数：

示例：

cameraInput.setFlashMode(flashMode, (err) => {
    if (err) {
        console.error('Failed to set the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setFlashMode.');
})

setFlashMode

setFlashMode(flashMode: FlashMode): Promise<void>

设置闪光灯模式，通过Promise获取结果。

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

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

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

参数：

返回值：

示例：

cameraInput.setFlashMode(flashMode).then(() => {
    console.log('Promise returned with the successful execution of setFlashMode.');
})

getFlashMode

getFlashMode(callback: AsyncCallback<FlashMode>): void

获取当前设备的闪光灯模式，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.getFlashMode((err, flashMode) => {
    if (err) {
        console.error('Failed to get the flash mode  ${err.message}');
        return;
    }
    console.log('Callback returned with current flash mode: ' + flashMode);
})

getFlashMode

getFlashMode(): Promise<FlashMode>

获取当前设备的闪光灯模式，通过Promise获取结果。

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

返回值：

示例：

cameraInput.getFlashMode().then((flashMode) => {
    console.log('Promise returned with current flash mode : ' + flashMode);
})

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean>): void

判断设备是否支持指定的焦距模式，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.isFocusModeSupported(afMode, (err, status) => {
    if (err) {
        console.error('Failed to check whether the focus mode is supported. ${err.message}');
        return;
    }
    console.log('Callback returned with the focus mode support status: ' + status);
})

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode): Promise<boolean>

判断设备是否支持指定的焦距模式，通过Promise获取结果。

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

参数：

返回值：

示例：

cameraInput.isFocusModeSupported(afMode).then((status) => {
    console.log('Promise returned with focus mode support status.' + status);
})

setFocusMode

setFocusMode(afMode: FocusMode, callback: AsyncCallback<void>): void

设置焦距模式，通过注册回调函数获取结果。

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

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

参数：

示例：

cameraInput.setFocusMode(afMode, (err) => {
    if (err) {
        console.error('Failed to set the focus mode  ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setFocusMode.');
})

setFocusMode

setFocusMode(afMode: FocusMode): Promise<void>

设置焦距模式，通过Promise获取结果。

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

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

参数：

返回值：

示例：

cameraInput.setFocusMode(afMode).then(() => {
    console.log('Promise returned with the successful execution of setFocusMode.');
})

getFocusMode

getFocusMode(callback: AsyncCallback<FocusMode>): void

获取当前设备的焦距模式，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.getFocusMode((err, afMode) => {
    if (err) {
        console.error('Failed to get the focus mode  ${err.message}');
        return;
    }
    console.log('Callback returned with current focus mode: ' + afMode);
})

getFocusMode

getFocusMode(): Promise<FocusMode>

获取当前设备的焦距模式，通过Promise获取结果。

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

返回值：

示例：

cameraInput.getFocusMode().then((afMode) => {
    console.log('Promise returned with current focus mode : ' + afMode);
})

getZoomRatioRange

getZoomRatioRange(callback: AsyncCallback<Array<number>>): void

获取可变焦距比范围，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.getZoomRatioRange((err, zoomRatioRange) => {
    if (err) {
        console.error('Failed to get the zoom ratio range. ${err.message}');
        return;
    }
    console.log('Callback returned with zoom ratio range: ' + zoomRatioRange.length);
})

getZoomRatioRange

getZoomRatioRange(): Promise<Array<number>>

获取可变焦距比范围，通过Promise获取结果。

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

返回值：

示例：

cameraInput.getZoomRatioRange().then((zoomRatioRange) => {
    console.log('Promise returned with zoom ratio range: ' + zoomRatioRange.length);
})

setZoomRatio

setZoomRatio(zoomRatio: number, callback: AsyncCallback<void>): void

设置可变焦距比，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.setZoomRatio(zoomRatio, (err) => {
    if (err) {
        console.error('Failed to set the zoom ratio value ${err.message}');
        return;
    }
    console.log('Callback returned with the successful execution of setZoomRatio.');
})

setZoomRatio

setZoomRatio(zoomRatio: number): Promise<void>

设置可变焦距比，通过Promise获取结果。

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

参数：

返回值：

示例：

cameraInput.setZoomRatio(zoomRatio).then(() => {
    console.log('Promise returned with the successful execution of setZoomRatio.');
})

getZoomRatio

getZoomRatio(callback: AsyncCallback<number>): void

获取当前的可变焦距比，通过注册回调函数获取结果。

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

参数：

示例：

cameraInput.getZoomRatio((err, zoomRatio) => {
    if (err) {
        console.error('Failed to get the zoom ratio ${err.message}');
        return;
    }
    console.log('Callback returned with current zoom ratio: ' + zoomRatio);
})

getZoomRatio

getZoomRatio(): Promise<number>

获取当前的可变焦距比，通过Promise获取结果。

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

返回值：

示例：

cameraInput.getZoomRatio().then((zoomRatio) => {
    console.log('Promise returned with current zoom ratio : ' + zoomRatio);
})

release

release(callback: AsyncCallback<void>): void

释放相机实例，通过注册回调函数获取结果。

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

参数：

示例：

camera.release((err) => {
    if (err) {
        console.error('Failed to release the CameraInput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is released successfully.');
});

release

release(): Promise<void>

释放相机实例，通过Promise获取结果。

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

返回值：

示例：

cameraInput.release().then(() => {
    console.log('Promise returned to indicate that the CameraInput instance is released successfully.');
})

on('focusStateChange')

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

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

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

参数：

示例：

cameraInput.on('focusStateChange', (focusState) => {
    console.log('Focus state  : ' + focusState);
})

on('error')

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

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

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

参数：

示例：

cameraInput.on('error', (cameraInputError) => {
    console.log('Camera input error code: ' + cameraInputError.code);
})

FlashMode

枚举，闪光灯模式。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

FocusMode

枚举，焦距模式。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

FocusState

枚举，焦距状态。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

camera.createCaptureSession

createCaptureSession(context: Context, callback: AsyncCallback<CaptureSession>): void

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

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

参数：

示例：

camera.createCaptureSession((context), (err, captureSession) => {
    if (err) {
        console.error('Failed to create the CaptureSession instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the CaptureSession instance.' + captureSession);
});

camera.createCaptureSession

createCaptureSession(context: Context): Promise<CaptureSession>;

获取CaptureSession实例，通过Promise获取结果。

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

参数：

返回值：

示例：

camera.createCaptureSession(context).then((captureSession) => {
    console.log('Promise returned with the CaptureSession instance');
})

CaptureSession

拍照会话类。

beginConfig

beginConfig(callback: AsyncCallback<void>): void

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

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

参数：

示例：

captureSession.beginConfig((err) => {
    if (err) {
        console.error('Failed to start the configuration. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the begin config success.');
});

beginConfig

beginConfig(): Promise<void>

开始配置会话，通过Promise获取结果。

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

返回值：

示例：

captureSession.beginConfig().then(() => {
    console.log('Promise returned to indicate the begin config success.');
})

commitConfig

commitConfig(callback: AsyncCallback<void>): void

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

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

参数：

示例：

captureSession.commitConfig((err) => {
    if (err) {
        console.error('Failed to commit the configuration. ${err.message}');
        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.');
})

addInput

addInput(cameraInput: CameraInput, callback: AsyncCallback<void>): void

在当前会话中，添加一个CameraInput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.addInput(cameraInput, (err) => {
    if (err) {
        console.error('Failed to add the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CameraInput instance is added.');
});

addInput

addInput(cameraInput: CameraInput): Promise<void>

在当前会话中，添加一个CameraInput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.addInput(cameraInput).then(() => {
    console.log('Promise used to indicate that the CameraInput instance is added.');
})

addOutput

addOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void

在当前会话中，添加一个PreviewOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.addOutput(previewOutput, (err) => {
    if (err) {
        console.error('Failed to add the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is added.');
});

addOutput

addOutput(previewOutput: PreviewOutput): Promise<void>

在当前会话中，添加一个PreviewOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.addOutput(previewOutput).then(() => {
    console.log('Promise used to indicate that the PreviewOutput instance is added.');
})

addOutput

addOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void

在当前会话中，添加一个PhotoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.addOutput(photoOutput, (err) => {
    if (err) {
        console.error('Failed to add the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is added.');
});

addOutput

addOutput(photoOutput: PhotoOutput): Promise<void>

在当前会话中，添加一个PreviewOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.addOutput(photoOutput).then(() => {
    console.log('Promise used to indicate that the PhotoOutput instance is added.');
})

addOutput

addOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void

在当前会话中，添加一个VideoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.addOutput(videoOutput, (err) => {
    if (err) {
        console.error('Failed to add the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is added.');
});

addOutput

addOutput(videoOutput: VideoOutput): Promise<void>

在当前会话中，添加一个VideoOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.addOutput(videoOutput).then(() => {
    console.log('Promise used to indicate that the VideoOutput instance is added.');
})

removeInput

removeInput(cameraInput: CameraInput, callback: AsyncCallback<void>): void

在当前会话中，移除一个CameraInput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.removeInput(cameraInput, (err) => {
    if (err) {
        console.error('Failed to remove the CameraInput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the cameraInput instance is removed.');
});

removeInput

removeInput(cameraInput: CameraInput): Promise<void>

在当前会话中，移除一个CameraInput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.removeInput(cameraInput).then(() => {
    console.log('Promise returned to indicate that the cameraInput instance is removed.');
})

removeOutput

removeOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void

在当前会话中，移除一个PreviewOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.removeOutput(previewOutput, (err) => {
    if (err) {
        console.error('Failed to remove the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is removed.');
});

removeOutput

removeOutput(previewOutput: PreviewOutput): Promise<void>

在当前会话中，移除一个PreviewOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.removeOutput(previewOutput).then(() => {
    console.log('Promise returned to indicate that the PreviewOutput instance is removed.');
})

removeOutput

removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void

在当前会话中，移除一个PhotoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.removeOutput(photoOutput, (err) => {
    if (err) {
        console.error('Failed to remove the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is removed.');
});

removeOutput

removeOutput(photoOutput: PhotoOutput): Promise<void>

在当前会话中，移除一个PhotoOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.removeOutput(photoOutput).then(() => {
    console.log('Promise returned to indicate that the PhotoOutput instance is removed.');
})

removeOutput

removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void

在当前会话中，移除一个VideoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.removeOutput(videoOutput, (err) => {
    if (err) {
        console.error('Failed to remove the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is removed.');
});

removeOutput

removeOutput(videoOutput: VideoOutput): Promise<void>

在当前会话中，移除一个VideoOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

captureSession.removeOutput(videoOutput).then(() => {
    console.log('Promise returned to indicate that the VideoOutput instance is removed.');
})

start

start(callback: AsyncCallback<void>): void

启动拍照会话，通过注册回调函数获取结果。

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

参数：

示例：

captureSession.start((err) => {
    if (err) {
        console.error('Failed to start the session ${err.message}');
        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.');
})

stop

stop(callback: AsyncCallback<void>): void

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

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

参数：

示例：

captureSession.stop((err) => {
    if (err) {
        console.error('Failed to stop the session ${err.message}');
        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.');
})

release

release(callback: AsyncCallback<void>): void

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

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

参数：

示例：

captureSession.release((err) => {
    if (err) {
        console.error('Failed to release the CaptureSession instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the CaptureSession instance is released successfully.');
});

release

release(): Promise<void>

释放CaptureSession实例，通过Promise获取结果。

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

返回值：

示例：

captureSession.release().then(() => {
    console.log('Promise returned to indicate that the CaptureSession instance is released successfully.');
})

on('error')

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

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

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

参数：

示例：

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

camera.createPreviewOutput

createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput>): void

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

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

参数：

示例：

camera.createPreviewOutput((surfaceId), (err, previewOutput) => {
    if (err) {
        console.error('Failed to create the PreviewOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with previewOutput instance');
});

camera.createPreviewOutput

createPreviewOutput(surfaceId: string): Promise<PreviewOutput>

获取PreviewOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

camera.createPreviewOutput(surfaceId).then((previewOutput) => {
    console.log('Promise returned with the PreviewOutput instance');
})

PreviewOutput

预览输出类。

release

release(callback: AsyncCallback<void>): void

释放PreviewOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

previewOutput.release((err) => {
    if (err) {
        console.error('Failed to release the PreviewOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
});

release

release(): Promise<void>

释放PreviewOutput实例，通过Promise获取结果。

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

返回值：

示例：

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

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<PreviewOutputError>): void

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

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

参数：

示例：

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

camera.createPhotoOutput

createPhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput>): void

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

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

参数：

示例：

camera.createPhotoOutput((surfaceId), (err, photoOutput) => {
    if (err) {
        console.error('Failed to create the PhotoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the PhotoOutput instance.');
});

camera.createPhotoOutput

createPhotoOutput(surfaceId: string): Promise<PhotoOutput>

获取PhotoOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

camera.createPhotoOutput(surfaceId).then((photoOutput) => {
    console.log('Promise returned with PhotoOutput instance');
})

ImageRotation

枚举，图片旋转角度。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

QualityLevel

枚举，图片质量。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

PhotoCaptureSetting

拍摄照片的设置。

系统能力： 以下各项对应的系统能力均为SystemCapability.Multimedia.Camera.Core。

PhotoOutput

照片输出类。

capture

capture(callback: AsyncCallback<void>): void

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

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

参数：

示例：

photoOutput.capture((err) => {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});

capture

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

根据拍照设置拍照，通过注册回调函数获取结果。

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

参数：

示例：

photoOutput.capture(settings, (err) => {
    if (err) {
        console.error('Failed to capture the photo ${err.message}');
        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().then(() => {
    console.log('Promise returned to indicate that photo capture request success.');
})

release

release(callback: AsyncCallback<void>): void

释放PhotoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

photoOutput.release((err) => {
    if (err) {
        console.error('Failed to release the PhotoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the PhotoOutput instance is released successfully.');
});

release

release(): Promise<void>

释放PhotoOutput实例，通过Promise获取结果。

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

返回值：

示例：

photoOutput.release().then(() => {
    console.log('Promise returned to indicate that the PhotoOutput instance is released successfully.');
})

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<PhotoOutputError>): void

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

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

参数：

示例：

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

camera.createVideoOutput

createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput>): void

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

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

参数：

示例：

camera.createVideoOutput((surfaceId), (err, videoOutput) => {
    if (err) {
        console.error('Failed to create the VideoOutput instance. ${err.message}');
        return;
    }
    console.log('Callback returned with the VideoOutput instance');
});

camera.createVideoOutput

createVideoOutput(surfaceId: string): Promise<VideoOutput>

获取VideoOutput实例，通过Promise获取结果。

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

参数：

返回值：

示例：

camera.createVideoOutput(surfaceId).then((videoOutput) => {
    console.log('Promise returned with the VideoOutput instance');
})

VideoOutput

视频输出类。

start

start(callback: AsyncCallback<void>): void

开始拍摄视频，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.start((err) => {
    if (err) {
        console.error('Failed to start the video output ${err.message}');
        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.');
})

stop

stop(callback: AsyncCallback<void>): void

停止拍摄视频，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.stop((err) => {
    if (err) {
        console.error('Failed to stop the video output ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate the video output stop success.');
});

stop

stop(): Promise<void>

停止拍摄视频，通过Promise获取结果。

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

返回值：

示例：

videoOutput.start().then(() => {
    console.log('Promise returned to indicate that stop method execution success.');
})

release

release(callback: AsyncCallback<void>): void

释放VideoOutput实例，通过注册回调函数获取结果。

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

参数：

示例：

videoOutput.release((err) => {
    if (err) {
        console.error('Failed to release the VideoOutput instance ${err.message}');
        return;
    }
    console.log('Callback invoked to indicate that the VideoOutput instance is released successfully.');
});

release

release(): Promise<void>

释放VideoOutput实例，通过Promise获取结果。

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

返回值：

示例：

videoOutput.release().then(() => {
    console.log('Promise returned to indicate that the VideoOutput instance is released successfully.');
})

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<VideoOutputError>): void

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

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

参数：

示例：

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