相機管理

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 9開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

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

camera.getCameraManager

getCameraManager(context: Context, callback: AsyncCallback): 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

獲取相機管理器實例，通過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

Size

用于表示相機預覽、照片、視頻支持的尺寸大小。

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

CameraManager

相機管理器類，使用前需要通過getCameraManager獲取相機管理實例。

getCameras

getCameras(callback: AsyncCallback>): 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>

異步獲取設備支持的相機列表，通過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): void

使用相機ID異步創建CameraInput實例，通過注冊回調函數獲取結果。

需要權限： ohos.permission.CAMERA

系統能力： 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

使用相機ID異步創建CameraInput實例，通過Promise獲取結果。

需要權限： ohos.permission.CAMERA

系統能力： 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): void

使用相機位置和相機類型異步創建CameraInput實例，通過注冊回調函數獲取結果。

需要權限： ohos.permission.CAMERA

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

參數：

示例：

cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED, (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實例，通過Promise獲取結果。

需要權限： ohos.permission.CAMERA

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

參數：

返回值：

示例：

cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED).then((cameraInput) = > {
    console.log('Promise returned with the CameraInput instance.');
})

on('cameraStatus')

on(type: 'cameraStatus', callback: AsyncCallback): void

監聽相機的狀態變化，通過注冊回調函數獲取相機的狀態變化。

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

參數：

示例：

cameraManager.on('cameraStatus', (err, cameraStatusInfo) = > {
    if (err) {
        console.error('Failed to get cameraStatus callback. ${err.message}');
        return;
    }
    console.log('camera : ' + cameraStatusInfo.camera.cameraId);
    console.log('status: ' + cameraStatusInfo.status);
})

Camera

調用[camera.getCameraManager]后，將返回Camera實例，包括相機ID、位置、類型、連接類型等相機相關的元數據。

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

示例：

async function getCameraInfo("cameraId") {
    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 connectionType = cameraObj.connectionType;
}

CameraStatusInfo

相機管理器回調返回的接口實例，表示相機狀態信息。

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

CameraInput

相機輸入類。在使用該類的方法前，需要先構建一個CameraInput實例。

getCameraId

getCameraId(callback: AsyncCallback): 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

異步獲取該CameraInput實例的相機ID，通過Promise獲取結果。

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

返回值：

示例：

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

hasFlash

hasFlash(callback: AsyncCallback): 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

判斷設備是否支持閃光燈，通過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): void

判斷設備是否支持指定閃光燈模式，通過注冊回調函數獲取結果。

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

參數：

示例：

cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO, (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

判斷設備是否支持指定閃光燈模式，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

setFlashMode

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

設置閃光燈模式，通過注冊回調函數獲取結果。

進行設置之前，需要先檢查：

1. 設備是否支持閃光燈，可使用方法[hasFlash]。
2. 設備是否支持指定的閃光燈模式，可使用方法[isFlashModeSupported]。

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

參數：

示例：

cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO, (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

設置閃光燈模式，通過Promise獲取結果。

進行設置之前，需要先檢查：

1. 設備是否支持閃光燈，可使用方法[hasFlash]。
2. 設備是否支持指定的閃光燈模式。

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

參數：

返回值：

示例：

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

getFlashMode

getFlashMode(callback: AsyncCallback): 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

獲取當前設備的閃光燈模式，通過Promise獲取結果。

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

返回值：

示例：

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

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback): void

判斷設備是否支持指定的焦距模式，通過注冊回調函數獲取結果。

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

參數：

示例：

cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO, (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

判斷設備是否支持指定的焦距模式，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

setFocusMode

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

設置焦距模式，通過注冊回調函數獲取結果。

進行設置之前，需要先檢查設備是否支持指定的焦距模式。

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

參數：

示例：

cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO, (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

設置焦距模式，通過Promise獲取結果。

進行設置之前，需要先檢查設備是否支持指定的焦距模式，可使用方法[isFocusModeSupported]。

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

參數：

返回值：

示例：

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

getFocusMode

getFocusMode(callback: AsyncCallback): 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

獲取當前設備的焦距模式，通過Promise獲取結果。

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

返回值：

示例：

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

getZoomRatioRange

getZoomRatioRange(callback: AsyncCallback>): 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>

獲取可變焦距比范圍，通過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

設置可變焦距比，通過注冊回調函數獲取結果。

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

參數：

示例：

cameraInput.setZoomRatio(1, (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

設置可變焦距比，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

getZoomRatio

getZoomRatio(callback: AsyncCallback): 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

獲取當前的可變焦距比，通過Promise獲取結果。

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

返回值：

示例：

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

release

release(callback: AsyncCallback): void

釋放相機實例，通過注冊回調函數獲取結果。

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

參數：

示例：

cameraInput.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

釋放相機實例，通過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): void

監聽焦距的狀態變化，通過注冊回調函數獲取結果。

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

參數：

示例：

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

on('error')

on(type: 'error', callback: ErrorCallback): void

監聽CameraInput的錯誤事件，通過注冊回調函數獲取結果。

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

參數：

示例：

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

CameraInputErrorCode

枚舉，CameraInput的錯誤碼。

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

CameraInputError

CameraInput錯誤對象。

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

FlashMode

枚舉，閃光燈模式。

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

FocusMode

枚舉，焦距模式。

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

FocusState

枚舉，焦距狀態。

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

camera.createCaptureSession

createCaptureSession(context: Context, callback: AsyncCallback): 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實例，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

CaptureSession

拍照會話類。

beginConfig

beginConfig(callback: AsyncCallback): 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

開始配置會話，通過Promise獲取結果。

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

返回值：

示例：

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

commitConfig

commitConfig(callback: AsyncCallback): 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

提交會話配置，通過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

在當前會話中，添加一個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

在當前會話中，添加一個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

在當前會話中，添加一個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

在當前會話中，添加一個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

在當前會話中，添加一個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

在當前會話中，添加一個PhotoOutput實例，通過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

在當前會話中，添加一個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

在當前會話中，添加一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

在當前會話中，移除一個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

啟動拍照會話，通過注冊回調函數獲取結果。

系統能力： 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

啟動拍照會話，通過Promise獲取結果。

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

返回值：

示例：

captureSession.start().then(() = > {
    console.log('Promise returned to indicate the session start success.');
})

stop

stop(callback: AsyncCallback): 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

停止拍照會話，通過Promise獲取結果。

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

返回值：

示例：

captureSession.stop().then(() = > {
    console.log('Promise returned to indicate the session stop success.');
})

release

release(callback: AsyncCallback): 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

釋放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): void

監聽拍照會話的錯誤事件，通過注冊回調函數獲取結果。

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

參數：

示例：

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

CaptureSessionErrorCode

枚舉，拍照會話的錯誤碼。

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

CaptureSessionError

拍照會話錯誤對象。

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

camera.createPreviewOutput

createPreviewOutput(surfaceId: string, callback: AsyncCallback): 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實例，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

PreviewOutput

預覽輸出類。

release

release(callback: AsyncCallback): 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

釋放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

監聽預覽幀啟動，通過注冊回調函數獲取結果。

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

參數：

示例：

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

on('frameEnd')

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

監聽預覽幀結束，通過注冊回調函數獲取結果。

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

參數：

示例：

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

on('error')

on(type: 'error', callback: ErrorCallback): void

監聽預覽輸出的錯誤事件，通過注冊回調函數獲取結果。

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

參數：

示例：

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

PreviewOutputErrorCode

枚舉，預覽輸出的錯誤碼。

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

PreviewOutputError

預覽輸出錯誤對象。

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

camera.createPhotoOutput

createPhotoOutput(surfaceId: string, callback: AsyncCallback): 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實例，通過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

拍照，通過注冊回調函數獲取結果。

系統能力： 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

根據拍照設置拍照，通過注冊回調函數獲取結果。

系統能力： 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

根據拍照設置拍照，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

release

release(callback: AsyncCallback): 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

釋放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): void

監聽拍照啟動，通過注冊回調函數獲取Capture ID。

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

參數：

示例：

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

on('frameShutter')

on(type: 'frameShutter', callback: AsyncCallback): 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): 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): void

監聽拍照的錯誤事件，通過注冊回調函數獲取結果。

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

參數：

示例：

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

FrameShutterInfo

快門事件信息。

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

CaptureEndInfo

拍照停止信息。

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

PhotoOutputErrorCode

枚舉，拍照輸出的錯誤碼。

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

PhotoOutputError

拍照輸出錯誤對象。

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

camera.createVideoOutput

createVideoOutput(surfaceId: string, callback: AsyncCallback): 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實例，通過Promise獲取結果。

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

參數：

返回值：

示例：

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

VideoOutput

視頻輸出類。

start

start(callback: AsyncCallback): 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

開始拍攝視頻，通過Promise獲取結果。

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

返回值：

示例：

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

stop

stop(callback: AsyncCallback): 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

停止拍攝視頻，通過Promise獲取結果。

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

返回值：

示例：

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

release

release(callback: AsyncCallback): 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

釋放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

監聽視頻幀開啟，通過注冊回調函數獲取結果。

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

參數：

示例：

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

on('frameEnd')

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

監聽視頻幀結束，通過注冊回調函數獲取結果。

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

參數：

示例：

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

on('error')

on(type: 'error', callback: ErrorCallback): void

監聽視頻輸出的錯誤事件，通過注冊回調函數獲取結果。

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

參數：

示例：

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

VideoOutputErrorCode

枚舉，視頻輸出的錯誤碼。

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

VideoOutputError

視頻輸出錯誤對象。

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

審核編輯 黃宇