@ohos.multimedia.camera (Camera Management)

NOTE

• The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• The APIs provided by this module are system APIs.

Modules to Import

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

camera.getCameraManager

getCameraManager(context: Context): CameraManager

Obtains a CameraManager instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let cameraManager = camera.getCameraManager(context);

CameraStatus

Enumerates the camera statuses.

System capability: SystemCapability.Multimedia.Camera.Core

Profile

Defines the camera profile.

System capability: SystemCapability.Multimedia.Camera.Core

FrameRateRange

Defines the frame rate range.

System capability: SystemCapability.Multimedia.Camera.Core

VideoProfile

Defines the video profile.

System capability: SystemCapability.Multimedia.Camera.Core

CameraOutputCapability

Defines the camera output capability.

System capability: SystemCapability.Multimedia.Camera.Core

CameraErrorCode

Enumerates the camera error codes, which are returned when an API call is incorrect or the on() API is used to listen for the error status.

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.

getSupportedCameras

getSupportedCameras(): Array<CameraDevice>

Obtains supported cameras. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

let cameras = cameraManager.getSupportedCameras();

getSupportedOutputCapability

getSupportedOutputCapability(cameraDevice:CameraDevice): CameraOutputCapability

Obtains the output capability supported by a camera. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Example

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

isCameraMuted

isCameraMuted(): boolean

Checks whether the camera is muted.

Before calling the API, ensure that the camera can be muted. You can use isCameraMuteSupported to check whether the camera can be muted.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

let ismuted = cameraManager.isCameraMuted();

isCameraMuteSupported

isCameraMuteSupported(): boolean

Checks whether the camera can be muted.

This is a system API.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

let ismutesuppotred = cameraManager.isCameraMuteSupported();

muteCamera

muteCamera(mute: boolean): void

Mutes or unmutes the camera.

This is a system API.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

createCameraInput

createCameraInput(camera: CameraDevice): CameraInput

Creates a CameraInput instance with the specified CameraDevice object. This API returns the result synchronously.

Required permissions: ohos.permission.CAMERA

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let cameraDevice = cameras[0];
let cameraInput;
try {
	cameraInput = cameraManager.createCameraInput(cameraDevice);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createCameraInput

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

Creates a CameraInput instance with the specified camera position and type. This API returns the result synchronously.

Required permissions: ohos.permission.CAMERA

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let cameraDevice = cameras[0];
let position = cameraDevice.cameraPosition;
let type = cameraDevice.cameraType;
let cameraInput;
try {
    cameraInput = cameraManager.createCameraInput(position, type);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createPreviewOutput

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

Creates a PreviewOutput instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let profile = cameraOutputCapability.previewProfiles[0];
let previewOutput;
try {
    previewOutput = cameraManager.createPreviewOutput(profile, surfaceId);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createPhotoOutput

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

Creates a PhotoOutput instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let profile = cameraOutputCapability.photoProfiles[0];
let photoOutput;
try {
    photoOutput = cameraManager.createPhotoOutput(profile, surfaceId);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createVideoOutput

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

Creates a VideoOutput instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let profile = cameraOutputCapability.videoProfiles[0];
let videoOutput;
try {
    videoOutput = cameraManager.createVideoOutput(profile, surfaceId);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createMetadataOutput

createMetadataOutput(metadataObjectTypes:Array<MetadataObjectType>): MetadataOutput

Creates a MetadataOutput instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let metadataObjectTypes = cameraOutputCapability.supportedMetadataObjectTypes;
let metadataOutput;
try {
    metadataOutput = cameraManager.createMetadataOutput(metadataObjectTypes);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

createCaptureSession

createCaptureSession(): CaptureSession

Creates a CaptureSession instance. This API returns the result synchronously.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let captureSession;
try {
    captureSession = cameraManager.createCaptureSession();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

on('cameraStatus')

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

Listens for camera status changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('cameraMute')

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

Listens for camera mute status changes. This API uses an asynchronous callback to return the result.

This is a system API.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

CameraStatusInfo

Describes the camera status information.

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

CameraDevice

Defines the camera device information.

System capability: SystemCapability.Multimedia.Camera.Core

Size

Enumerates the camera output capability.

System capability: SystemCapability.Multimedia.Camera.Core

Point

Enumerates the point coordinates, which are used for focus and exposure configuration.

System capability: SystemCapability.Multimedia.Camera.Core

CameraFormat

Enumerates the camera output formats.

System capability: SystemCapability.Multimedia.Camera.Core

CameraInput

Provides camera information used in CaptureSession.

open

open(callback: AsyncCallback<void>): void

Opens this camera. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

open

open(): Promise<void>

Opens this camera. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

close

close(callback: AsyncCallback<void>): void

Closes this camera. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

close

close(): Promise<void>

Closes this camera. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

on('error')

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

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

FlashMode

Enumerates the flash modes.

System capability: SystemCapability.Multimedia.Camera.Core

ExposureMode

Enumerates the exposure 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

VideoStabilizationMode

Enumerates the video stabilization modes.

System capability: SystemCapability.Multimedia.Camera.Core

CaptureSession

Implements a shooting session, which saves all CameraInput and CameraOutput instances required to run the camera and requests the camera to complete shooting or video recording.

beginConfig

beginConfig(): void

Starts configuration for the session.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.beginConfig();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

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

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

commitConfig

commitConfig(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

captureSession.commitConfig().then(() => {
    console.log('Promise returned to indicate the commit config success.');
}).catch((err) => {
    // If the operation fails, error.code is returned and processed.
    console.log('Failed to commitConfig '+ err.code);
});

addInput

addInput(cameraInput: CameraInput): void

Adds a CameraInput instance to the session.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.addInput(cameraInput);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

removeInput

removeInput(cameraInput: CameraInput): void

Removes a CameraInput instance from the session.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.removeInput(cameraInput);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

addOutput

addOutput(previewOutput: CameraOutput): void

Adds a CameraOutput instance to the session.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.addOutput(previewOutput);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

removeOutput

removeOutput(previewOutput: CameraOutput): void

Removes a CameraOutput instance from the session.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.removeOutput(previewOutput);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

start

start(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

captureSession.start((err) => {
    if (err) {
        console.error(`Failed to start the session ${err.code}`);
        return;
    }
    console.log('Callback invoked to indicate the session start success.');
});

start

start(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

stop

stop(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

captureSession.stop((err) => {
    if (err) {
        console.error(`Failed to stop the session ${err.code}`);
        return;
    }
    console.log('Callback invoked to indicate the session stop success.');
});

stop

stop(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

release

release(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

release

release(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

hasFlash

hasFlash(): boolean

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let status = captureSession.hasFlash();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

isFlashModeSupported

isFlashModeSupported(flashMode: FlashMode): boolean

Checks whether a flash mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let status = captureSession.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setFlashMode

setFlashMode(flashMode: FlashMode): void

Sets a flash mode for the device.

Before the setting, do the following checks:

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getFlashMode

getFlashMode(): FlashMode

Obtains the flash mode in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let flashMode = captureSession.getFlashMode();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

isExposureModeSupported

isExposureModeSupported(aeMode: ExposureMode): boolean;

Checks whether an exposure mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let isSupported = captureSession.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getExposureMode

getExposureMode(): ExposureMode

Obtains the exposure mode in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let exposureMode = captureSession.getExposureMode();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setExposureMode

setExposureMode(aeMode: ExposureMode): void

Sets an exposure mode for the device.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.setExposureMode(camera.ExposureMode.EXPOSURE_MODE_LOCKED);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getMeteringPoint

getMeteringPoint(): Point

Obtains the metering point of the device.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let exposurePoint = captureSession.getMeteringPoint();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setMeteringPoint

setMeteringPoint(point: Point): void

Sets the metering point, which is the center point of the metering rectangle.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

const exposurePoint = {x: 1, y: 1};
try {
    captureSession.setMeteringPoint(exposurePoint);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getExposureBiasRange

getExposureBiasRange(): Array<number>

Obtains the exposure compensation values of the device.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let biasRangeArray = captureSession.getExposureBiasRange();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setExposureBias

setExposureBias(exposureBias: number): void

Sets an exposure compensation value (EV).

Before the setting, you are advised to use getExposureBiasRange to obtain the supported values.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

let exposureBias = biasRangeArray[0];
try {
    captureSession.setExposureBias(exposureBias);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getExposureValue

getExposureValue(): number

Obtains the exposure value in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let exposureValue = captureSession.getExposureValue();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

isFocusModeSupported

isFocusModeSupported(afMode: FocusMode): boolean

Checks whether a focus mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let status = captureSession.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setFocusMode

setFocusMode(afMode: FocusMode): void

Sets a focus mode for the device.

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getFocusMode

getFocusMode(): FocusMode

Obtains the focus mode in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let afMode = captureSession.getFocusMode();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setFocusPoint

setFocusPoint(point: Point): void

Sets the focal point.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

const Point1 = {x: 1, y: 1};
try {
    captureSession.setFocusPoint(Point1);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getFocusPoint

getFocusPoint(): Point

Obtains the focal point of the device.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let point = captureSession.getFocusPoint();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getFocalLength

getFocalLength(): number

Obtains the focal length of the device.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let focalLength = captureSession.getFocalLength();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getZoomRatioRange

getZoomRatioRange(): Array<number>

Obtains the supported zoom ratio range.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let zoomRatioRange = captureSession.getZoomRatioRange();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setZoomRatio

setZoomRatio(zoomRatio: number): void

Sets a zoom ratio.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

let zoomRatio = zoomRatioRange[0];
try {
    captureSession.setZoomRatio(zoomRatio);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getZoomRatio

getZoomRatio(): number

Obtains the zoom ratio in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let zoomRatio = captureSession.getZoomRatio();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

isVideoStabilizationModeSupported

isVideoStabilizationModeSupported(vsMode: VideoStabilizationMode): boolean

Checks whether the specified video stabilization mode is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let isSupported = captureSession.isVideoStabilizationModeSupported(camera.VideoStabilizationMode.OFF);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

getActiveVideoStabilizationMode

getActiveVideoStabilizationMode(): VideoStabilizationMode

Obtains the video stabilization mode in use.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    let vsMode = captureSession.getActiveVideoStabilizationMode();
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

setVideoStabilizationMode

setVideoStabilizationMode(mode: VideoStabilizationMode): void

Sets a video stabilization mode for the device.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

try {
    captureSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF);
} catch (error) {
    // If the operation fails, error.code is returned and processed.
    console.log(error.code);
}

on('focusStateChange')

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

Listens for focus state changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

on(type: 'error', callback: ErrorCallback<BusinessError>): 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', (error) => {
    console.log(`Capture session error code: ${error.code}`);
})

CameraOutput

Implements output information used in a CaptureSession. It is the base class of output.

PreviewOutput

Implements preview output. It inherits CameraOutput.

start

start(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

previewOutput.start((err) => {
    if (err) {
        console.error(`Failed to start the previewOutput. ${err.code}`);
        return;
    }
    console.log('Callback returned with previewOutput started.');
})

start

start(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

stop

stop(callback: AsyncCallback<void>): void

Stops outputting preview streams. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

previewOutput.stop((err) => {
    if (err) {
        console.error(`Failed to stop the previewOutput. ${err.code}`);
        return;
    }
    console.log('Callback returned with previewOutput stopped.');
})

stop

stop(): Promise<void>

Stops outputting preview streams. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases output resources. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

release

release(): Promise<void>

Releases output resources. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

on('frameStart')

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

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<BusinessError>): 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}`);
})

ImageRotation

Enumerates the image rotation angles.

System capability: SystemCapability.Multimedia.Camera.Core

Location

Defines geolocation information.

System capability: SystemCapability.Multimedia.Camera.Core

QualityLevel

Enumerates the image quality levels.

System capability: SystemCapability.Multimedia.Camera.Core

PhotoCaptureSetting

Defines the settings for photo capture.

System capability: SystemCapability.Multimedia.Camera.Core

PhotoOutput

Implements output information used in a shooting session. This class inherits from CameraOutput.

capture

capture(callback: AsyncCallback<void>): void

Captures a photo with the default shooting parameters. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

capture

capture(): Promise<void>

Captures a photo with the default shooting parameters. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

capture

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

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

let captureLocation = {
  latitude: 0,
  longitude: 0,
  altitude: 0,
}
let settings = {
  quality: camera.QualityLevel.QUALITY_LEVEL_LOW,
  rotation: camera.ImageRotation.ROTATION_0,
  location: captureLocation,
  mirror: false
}
photoOutput.capture(settings, (err) => {
    if (err) {
        console.error(`Failed to capture the photo ${err.code}`);
        return;
    }
    console.log('Callback invoked to indicate the photo capture request success.');
});

capture

capture(setting?: PhotoCaptureSetting): Promise<void>

Captures a photo with the specified shooting parameters. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

isMirrorSupported

isMirrorSupported(): boolean

Checks whether mirroring is supported.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

let isSupported = photoOutput.isMirrorSupported();

release

release(callback: AsyncCallback<void>): void

Releases output resources. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

release

release(): Promise<void>

Releases output resources. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

on('captureStart')

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

Listens for shooting start events. This API uses an asynchronous callback to return the capture ID.

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 an asynchronous 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 shooting end events. This API uses an asynchronous 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<BusinessError>): 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', (error) => {
    console.log(`Photo output error code: ${error.code}`);
})

FrameShutterInfo

Defines the frame shutter information.

System capability: SystemCapability.Multimedia.Camera.Core

CaptureEndInfo

Defines the capture end information.

System capability: SystemCapability.Multimedia.Camera.Core

VideoOutput

Implements output information used in a video recording session. This class inherits from CameraOutput.

start

start(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

start

start(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

stop

stop(callback: AsyncCallback<void>): void

Stops video recording. 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.code}`);
        return;
    }
    console.log('Callback invoked to indicate the video output stop success.');
});

stop

stop(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

release

release(callback: AsyncCallback<void>): void

Releases output resources. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

release

release(): Promise<void>

Releases output resources. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

on('frameStart')

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

Listens for video recording start events. This API uses an asynchronous callback to return the result.

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 recording stop events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

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

Listens for errors that occur during video recording. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

MetadataOutput

Implements metadata streams. It inherits CameraOutput.

start

start(callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Error codes

For details about the error codes, see CameraErrorCode.

Example

metadataOutput.start((err) => {
    if (err) {
        console.error(`Failed to start metadataOutput. ${err.code}`);
        return;
    }
    console.log('Callback returned with metadataOutput started.');
})

start

start(): Promise<void>

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

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Error codes

For details about the error codes, see CameraErrorCode.

Example

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

stop

stop(callback: AsyncCallback<void>): void

Stops outputting metadata. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

metadataOutput.stop((err) => {
    if (err) {
        console.error(`Failed to stop the metadataOutput. ${err.code}`);
        return;
    }
    console.log('Callback returned with metadataOutput stopped.');
})

stop

stop(): Promise<void>

Stops outputting metadata. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Return value

Example

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

on('metadataObjectsAvailable')

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

Listens for metadata objects. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

on('error')

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

Listens for metadata errors. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Camera.Core

Parameters

Example

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

MetadataObjectType

Enumerates the metadata object types.

System capability: SystemCapability.Multimedia.Camera.Core

Rect

Defines a rectangle.

System capability: SystemCapability.Multimedia.Camera.Core

MetadataObject

Implements camera metadata, which is the data source of CameraInput. The metadata is obtained through metadataOutput.on('metadataObjectsAvailable').