Camera Management

NOTE
The initial APIs of this module are supported since API version 9. API version 9 is a canary release for trial use. The APIs of this version may be unstable.

Modules to Import

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

Required Permissions

ohos.permission.CAMERA

camera.getCameraManager

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

Obtains a CameraManager instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Obtains a CameraManager instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

CameraStatus

Enumerates the camera statuses.

System capability: SystemCapability.Multimedia.Camera.Core

CameraPosition

Enumerates the camera positions.

System capability: SystemCapability.Multimedia.Camera.Core

CameraType

Enumerates the camera types.

System capability: SystemCapability.Multimedia.Camera.Core

ConnectionType

Enumerates the camera connection types.

System capability: SystemCapability.Multimedia.Camera.Core

CameraManager

Implements camera management. Before calling any API in CameraManager, you must use getCameraManager to obtain a CameraManager instance.

getCameras

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

Obtains all cameras supported by the device. This API uses an asynchronous callback to return the array of supported cameras.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Obtains all cameras supported by the device. This API uses a promise to return the array of supported cameras.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

createCameraInput

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

Creates a CameraInput instance with the specified camera ID. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Creates a CameraInput instance with the specified camera ID. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

createCameraInput

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

Creates a CameraInput instance with the specified camera position and camera type. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Creates a CameraInput instance with the specified camera position and camera type. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

on('cameraStatus')

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

Listens for camera status changes. This API uses a callback to return the camera status changes.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Camera

After camera.getCameraManager is called, a camera instance is returned, including camera-related metadata such as cameraId, cameraPosition, cameraType, and connectionType.

System capability: SystemCapability.Multimedia.Camera.Core

Example

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

Describes the camera status information.

System capability: SystemCapability.Multimedia.Camera.Core

CameraInput

Implements a CameraInput instance. Before calling any API in CameraInput, you must create a CameraInput instance.

getCameraId

getCameraId(callback: AsyncCallback<string>): void

Obtains the camera ID based on which this CameraInput instance is created. This API uses an asynchronous callback to return the camera ID.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Obtains the camera ID based on which this CameraInput instance is created. This API uses a promise to return the camera ID.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

hasFlash

hasFlash(callback: AsyncCallback<boolean>): void

Checks whether the device has flash light. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Checks whether the device has flash light. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

isFlashModeSupported

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

Checks whether a specified flash mode is supported. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Checks whether a specified flash mode is supported. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

setFlashMode

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

Sets the flash mode. This API uses an asynchronous callback to return the result.

Before setting the parameters, do the following checks:

1. Use hasFlash to check whether the device has flash light.
2. Use isFlashModeSupported to check whether the device supports a specified flash mode.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Sets the flash mode. This API uses a promise to return the result.

Before setting the parameters, do the following checks:

1. Use hasFlash to check whether the device has flash light.
2. Use isFlashModeSupported to check whether the device supports a specified flash mode.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

getFlashMode

getFlashMode(callback: AsyncCallback<FlashMode>): void

Obtains the current flash mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Obtains the current flash mode. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

isFocusModeSupported

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

Checks whether a specified focus mode is supported. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Checks whether a specified focus mode is supported. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

setFocusMode

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

Sets the focus mode. This API uses an asynchronous callback to return the result.

Before setting the focus mode, use isFocusModeSupported to check whether the focus mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Sets the focus mode. This API uses a promise to return the result.

Before setting the focus mode, use isFocusModeSupported to check whether the focus mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

getFocusMode

getFocusMode(callback: AsyncCallback<FocusMode>): void

Obtains the current focus mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Obtains the current focus mode. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

getZoomRatioRange

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

Obtains the zoom ratio range. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Obtains the zoom ratio range. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

setZoomRatio

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

Sets a zoom ratio. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Sets a zoom ratio. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

getZoomRatio

getZoomRatio(callback: AsyncCallback<number>): void

Obtains the current zoom ratio. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Obtains the current zoom ratio. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases this CameraInput instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Releases this CameraInput instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

Listens for focus state changes. This API uses a callback to return the focus state changes.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

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

Listens for CameraInput errors. This API uses a callback to return the errors.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

FlashMode

Enumerates the flash modes.

System capability: SystemCapability.Multimedia.Camera.Core

FocusMode

Enumerates the focus modes.

System capability: SystemCapability.Multimedia.Camera.Core

FocusState

Enumerates the focus states.

System capability: SystemCapability.Multimedia.Camera.Core

camera.createCaptureSession

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

Creates a CaptureSession instance. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Creates a CaptureSession instance. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

CaptureSession

Implements session capture.

beginConfig

beginConfig(callback: AsyncCallback<void>): void

Starts configuration for this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Starts configuration for this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

commitConfig

commitConfig(callback: AsyncCallback<void>): void

Commits the configuration for this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Commits the configuration for this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

addInput

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

Adds a CameraInput instance to this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Adds a CameraInput instance to this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

addOutput

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

Adds a PreviewOutput instance to this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Adds a PreviewOutput instance to this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

addOutput

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

Adds a PhotoOutput instance to this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Adds a PhotoOutput instance to this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

addOutput

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

Adds a VideoOutput instance to this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Adds a VideoOutput instance to this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

removeInput

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

Removes a CameraInput instance from this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Removes a CameraInput instance from this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

removeOutput

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

Removes a PreviewOutput instance from this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Removes a PreviewOutput instance from this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

removeOutput

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

Removes a PhotoOutput instance from this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Removes a PhotoOutput instance from this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

removeOutput

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

Removes a VideoOutput instance from this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Removes a VideoOutput instance from this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

start

start(callback: AsyncCallback<void>): void

Starts this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Starts this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

stop

stop(callback: AsyncCallback<void>): void

Stops this CaptureSession instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Stops this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases this CaptureSession instance. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Releases this CaptureSession instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

Listens for CaptureSession errors. This API uses a callback to return the errors.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

camera.createPreviewOutput

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

Creates a PreviewOutput instance. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Creates a PreviewOutput instance. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

PreviewOutput

Implements preview output.

release

release(callback: AsyncCallback<void>): void

Releases this PreviewOutput instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Releases this PreviewOutput instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

Listens for preview frame start events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('frameEnd')

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

Listens for preview frame end events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

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

Listens for PreviewOutput errors. This API uses a callback to return the errors.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

camera.createPhotoOutput

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

Creates a PhotoOutput instance. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Creates a PhotoOutput instance. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

ImageRotation

Enumerates the image rotation angles.

System capability: SystemCapability.Multimedia.Camera.Core

QualityLevel

Enumerates the image quality levels.

System capability: SystemCapability.Multimedia.Camera.Core

PhotoCaptureSetting

Defines the settings for image capture.

System capability: SystemCapability.Multimedia.Camera.Core

PhotoOutput

Implements photo output.

capture

capture(callback: AsyncCallback<void>): void

Captures a photo. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Captures a photo with the specified capture settings. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Captures a photo with the specified capture settings. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases this PhotoOutput instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Releases this PhotoOutput instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

Listens for photo capture start events. This API uses a callback to return the event information.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('frameShutter')

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

Listens for frame shutter events. This API uses a callback to return the event information.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Listens for photo capture end events. This API uses a callback to return the event information.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

Listens for PhotoOutput errors. This API uses a callback to return the errors.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

camera.createVideoOutput

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

Creates a VideoOutput instance. This API uses an asynchronous callback to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Creates a VideoOutput instance. This API uses a promise to return the instance.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

VideoOutput

Implements video output.

start

start(callback: AsyncCallback<void>): void

Starts the video output. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Starts the video output. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

stop

stop(callback: AsyncCallback<void>): void

Stops the video output. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Stops the video output. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases this VideoOutput instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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>

Releases this VideoOutput instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

Listens for video frame start events. This API uses a callback to return the event information.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('frameEnd')

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

Listens for video frame end events. This API uses a callback to return the event information.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

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

Listens for VideoOutput errors. This API uses a callback to return the errors.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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