提交 1f57986f 编写于 作者: M mali

Improve the description of interface change of beta3 to beta4 cameras-03

Signed-off-by: Nmali <mali81@huawei.com>
上级 5c4a5f54
...@@ -158,627 +158,625 @@ OpenHarmony3.2 Beta4版本相较于OpenHarmony3.2 Beta3版本,媒体子系统c ...@@ -158,627 +158,625 @@ OpenHarmony3.2 Beta4版本相较于OpenHarmony3.2 Beta3版本,媒体子系统c
除新增接口,和废弃接口之外,开发者需要关注变更的接口的适配: 除新增接口,和废弃接口之外,开发者需要关注变更的接口的适配:
**接口变更**
从Beta4版本开始,对以下接口进行调整: 从Beta4版本开始,对以下接口进行调整:
1. CameraManager中接口getCameras返回值由Array<Camera>变更为Array<CameraDevice>,因此旧接口getCameras(callback: AsyncCallback<Array<Camera>>): void;以及getCameras(): Promise<Array<Camera>>;变更为getSupportedCameras(callback: AsyncCallback<Array<CameraDevice>>): void和getSupportedCameras(): Promise<Array<CameraDevice>>; **新增接口**
1. Profile接口
属性1:readonly format,类型:CameraFormat;
属性2:readonly size,类型:Size;
2. FrameRateRange接口
属性1:readonly min,类型:number;
属性2:readonly max,类型:number;
3. VideoProfile接口,继承自Profile
属性:readonly frameRateRange,类型:FrameRateRange;
4. CameraOutputCapability接口
属性1:readonly previewProfiles,类型:Array<Profile>;
属性2:readonly photoProfiles,类型:Array<Profile>;
属性3:readonly videoProfiles,类型:Array<VideoProfile>;
属性4:readonly supportedMetadataObjectTypes,类型:Array<MetadataObjectType>;
5. CameraManager中新增
getSupportedOutputCapability(camera: CameraDevice, callback: AsyncCallback<CameraOutputCapability>): void;
getSupportedOutputCapability(camera: CameraDevice): Promise<CameraOutputCapability>;
参考代码如下: 参考代码如下:
``` ```
cameraManager.getSupportedCameras((err, cameras) => { cameraManager.getSupportedCameras().then((cameras) => {
let cameraDevice = cameras[0];
cameraManager.getSupportedOutputCapability(cameraDevice, (err, CameraOutputCapability) => {
if (err) { if (err) {
console.error(`Failed to get the cameras. ${err.message}`); console.error(`Failed to get the outputCapability. ${err.message}`);
return; return;
} }
console.log(`Callback returned with an array of supported cameras: ${cameras.length}`); console.log('Callback returned with an array of supported outputCapability');
})
}) })
``` ```
``` ```
cameraManager.getSupportedCameras().then((cameras) => { cameraManager.getSupportedCameras().then((cameras) => {
console.log(`Promise returned with an array of supported cameras: ${cameras.length}`); let cameraDevice = cameras[0];
cameraManager.getSupportedOutputCapability(cameraDevice).then((cameraoutputcapability) => {
console.log('Promise returned with an array of supported outputCapability');
})
}) })
``` ```
2. CameraManager中接口createCameraInput传递参数由原来cameraId: string变更为camera: CameraDevice,因此旧接口createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput>): void;以及createCameraInput(cameraId: string): Promise<CameraInput>;变更为createCameraInput(camera: CameraDevice, callback: AsyncCallback<CameraInput>): void;和createCameraInput(camera: CameraDevice): Promise<CameraInput>; 6. CameraManager中新增isCameraMuted(): boolean;
参考代码如下: 参考代码如下:
``` ```
let cameraDevice = cameras[0]; let ismuted = cameraManager.isCameraMuted();
cameraManager.createCameraInput(cameraDevice, (err, cameraInput) => { ```
7. CameraManager中新增isCameraMuteSupported(): boolean;
参考代码如下:
```
let ismutesuppotred = cameraManager.isCameraMuteSupported();
```
8. CameraManager中新增muteCamera(mute: boolean): void;
参考代码如下:
```
let mute = true;
cameraManager.muteCamera(mute);
```
9. CameraManager中新增on(type: 'cameraMute', callback: AsyncCallback<boolean>): void;
参考代码如下:
```
cameraManager.on('cameraMute', (err, curMuetd) => {
if (err) { if (err) {
console.error(`Failed to create the CameraInput instance. ${err.message}`); console.error(`Failed to get cameraMute callback. ${err.message}`);
return; return;
} }
console.log('Callback returned with the CameraInput instance.');
}) })
``` ```
``` 10. CameraInput中新增open(callback: AsyncCallback<void>): void;以及open(): Promise<void>;
let cameraDevice = cameras[0];
cameraManager.createCameraInput(cameraDevice).then((cameraInput) => { 参考代码如下:
console.log('Promise returned with the CameraInput instance');
}) ```
``` cameraInput.open((err) => {
if (err) {
console.error(`Failed to open the camera. ${err.message}`);
return;
}
console.log('Callback returned with camera opened.');
})
```
```
cameraInput.open().then(() => {
console.log('Promise returned with camera opened.');
})
```
3. CameraManager中接口createPreviewOutput新增传递参数profile: Profile,因此旧接口createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput>): void;以及createPreviewOutput(surfaceId: string): Promise<PreviewOutput>;变更为createPreviewOutput(profile: Profile, surfaceId: string, callback: AsyncCallback<PreviewOutput>): void;createPreviewOutput(profile: Profile, surfaceId: string): Promise<PreviewOutput>; 11. CameraInput中新增close(callback: AsyncCallback<void>): void;以及close(): Promise<void>;
参考代码如下: 参考代码如下:
``` ```
let profile = cameraoutputcapability.previewProfiles[0]; cameraInput.close((err) => {
cameraManager.createPreviewOutput(profile, surfaceId, (err, previewOutput) => {
if (err) { if (err) {
console.error(`Failed to gcreate previewOutput. ${err.message}`); console.error(`Failed to close the cameras. ${err.message}`);
return; return;
} }
console.log('Callback returned with previewOutput created.'); console.log('Callback returned with camera closed.');
}) })
``` ```
``` ```
let profile = cameraoutputcapability.previewProfiles[0]; cameraInput.close().then(() => {
cameraManager.createPreviewOutput(profile, surfaceId).then((previewOutput) => { console.log('Promise returned with camera closed.');
console.log('Promise returned with previewOutput created.');
}) })
``` ```
4. CameraManager中接口createPhotoOutput新增传递参数profile: Profile,因此旧接口CreatePhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput>): void;以及CreatePhotoOutput(surfaceId: string): Promise<PhotoOutput>;变更为createPhotoOutput(profile: Profile, surfaceId: string, callback: AsyncCallback<PhotoOutput>): void;和createPhotoOutput(profile: Profile, surfaceId: string): Promise<PhotoOutput>; 12. 枚举CameraInputErrorCode中新增
枚举值名称:ERROR_NO_PERMISSION,值:0;
枚举值名称:ERROR_DEVICE_PREEMPTED,值:1;
枚举值名称:ERROR_DEVICE_DISCONNECTED,值:2;
枚举值名称:ERROR_DEVICE_IN_USE,值:3;
枚举值名称:ERROR_DRIVER_ERROR,值:4;
13. 枚举CameraFormat中新增
枚举值名称:CAMERA_FORMAT_RGBA_8888,值:3;
14. CaptureSession中新增getMeteringPoint(callback: AsyncCallback<Point>): void;以及getMeteringPoint(): Promise<Point>;
参考代码如下: 参考代码如下:
``` ```
let profile = cameraoutputcapability.photoProfiles[0]; captureSession.getMeteringPoint((err, exposurePoint) => {
cameraManager.createPhotoOutput(profile, surfaceId, (err, photoOutput) => {
if (err) { if (err) {
console.error(`Failed to create photoOutput. ${err.message}`); console.log(`Failed to get the current exposure point ${err.message}`);
return; return ;
} }
console.log('Callback returned with photoOutput created.'); console.log(`Callback returned with current exposure point: ${exposurePoint}`);
}) })
``` ```
``` ```
let profile = cameraoutputcapability.photoProfiles[0]; captureSession.getMeteringPoint().then((exposurePoint) => {
cameraManager.createPhotoOutput(profile, surfaceId).then((photoOutput) => { console.log(`Promise returned with current exposure point : ${exposurePoint}`);
console.log('Promise returned with photoOutput created.');
}) })
``` ```
5. CameraManager中接口createVideoOutput新增传递参数profile: Profile,因此旧接口createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput>): void;以及createVideoOutput(surfaceId: string): Promise<VideoOutput>;变更为createVideoOutput(profile: VideoProfile, surfaceId: string, callback: AsyncCallback<VideoOutput>): void;和createVideoOutput(profile: VideoProfile, surfaceId: string): Promise<VideoOutput>; 15. CaptureSession中新增setMeteringPoint(point: Point, callback: AsyncCallback<void>): void;以及setMeteringPoint(point: Point): Promise<void>;
参考代码如下: 参考代码如下:
``` ```
let profile = cameraoutputcapability.videoProfiles[0]; const Point1 = {x: 1, y: 1};
cameraManager.createVideoOutput(profile, surfaceId, (err, videoOutput) => {
captureSession.setMeteringPoint(Point1,(err) => {
if (err) { if (err) {
console.error(`Failed to create videoOutput. ${err.message}`); console.log(`Failed to set the exposure point ${err.message}`);
return; return ;
} }
console.log('Callback returned with an array of supported outputCapability' ); console.log('Callback returned with the successful execution of setMeteringPoint');
}) })
``` ```
``` ```
let profile = cameraoutputcapability.videoProfiles[0]; const Point2 = {x: 2, y: 2};
cameraManager.createVideoOutput(profile, surfaceId).then((videoOutput) => {
console.log('Promise returned with videoOutput created.'); captureSession.setMeteringPoint(Point2).then(() => {
console.log('Promise returned with the successful execution of setMeteringPoint');
}) })
``` ```
6. CameraManager中接口createMetadataOutput新增传递参数metadataObjectTypes: Array<MetadataObjectType>,因此旧接口createMetadataOutput(callback: AsyncCallback<MetadataOutput>): void;以及createVideoOutput(): Promise<MetadataOutput>;变更为createMetadataOutput(metadataObjectTypes: Array<MetadataObjectType>, callback: AsyncCallback<MetadataOutput>): void;和createMetadataOutput(metadataObjectTypes: Array<MetadataObjectType>): Promise<MetadataOutput>; 16. 枚举CaptureSessionErrorCode中新增
参考代码如下: 枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:0;
枚举值名称:ERROR_TIMEOUT,值:1;
17. 新增接口CameraOutput,接口下有release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;方法
参考代码如下:用previewOutput做示例
``` ```
let metadataObjectTypes = cameraoutputcapability.supportedMetadataObjectTypes; previewOutput.release((err) => {
cameraManager.createMetadataOutput(metadataObjectTypes, (err, metadataOutput) => {
if (err) { if (err) {
console.error(`Failed to create metadataOutput. ${err.message}`); console.error(`Failed to release the PreviewOutput instance ${err.message}`);
return; return;
} }
console.log('Callback returned with metadataOutput created.'); console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.');
}) });
``` ```
``` ```
let metadataObjectTypes = cameraoutputcapability.supportedMetadataObjectTypes; previewOutput.release().then(() => {
cameraManager.createMetadataOutput(metadataObjectTypes).then((metadataOutput) => { console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
console.log('Promise returned with metadataOutput created.');
}) })
``` ```
7. CameraManager中createCaptureSession不需要考虑context属性,因此旧接口createCaptureSession(context: Context, callback: AsyncCallback<CaptureSession>): void;以及createCaptureSession(context: Context): Promise<CaptureSession>;改为createCaptureSession(callback: AsyncCallback<CaptureSession>): void;和createCaptureSession(): Promise<CaptureSession>; 18. PreviewOutput中新增start(callback: AsyncCallback<void>): void;以及start(): Promise<void>;
参考代码如下: 参考代码如下
```typescript ```
cameraManager.createCaptureSession((err, captureSession) => { previewOutput.start((err) => {
if (err) { if (err) {
console.error(`Failed to create captureSession. ${err.message}`); console.error(`Failed to start the previewOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with captureSession created.'); console.log('Callback returned with previewOutput started.');
}) })
``` ```
``` ```
cameraManager.createCaptureSession().then((captureSession) => { previewOutput.start().then(() => {
console.log('Promise returned with captureSession created.'); console.log('Promise returned with previewOutput started.');
}) })
``` ```
8. CameraStatusInfo接口下属性camera类型由Camera变更为CameraDevice 19. PreviewOutput中新增stop(callback: AsyncCallback<void>): void;以及stop(): Promise<void>;
9. CameraInput中接口on(type: 'error')新增传递参数camera: CameraDevice,因此旧接口on(type: 'error', callback: ErrorCallback<CameraInputError>): void;变更为on(type: 'error', camera: CameraDevice, callback: ErrorCallback<CameraInputError>): void; 参考代码如下
参考代码如下: ```
previewOutput.stop((err) => {
if (err) {
console.error(`Failed to stop the previewOutput. ${err.message}`);
return;
}
console.log('Callback returned with previewOutput stopped.');
})
```
``` ```
let cameraDevice = cameras[0]; previewOutput.stop().then(() => {
cameraInput.on('error', cameraDevice, (cameraInputError) => { console.log('Callback returned with previewOutput stopped.');
console.log(`Camera input error code: ${cameraInputError.code}`);
}) })
``` ```
10. CameraInput中以下接口调整到CaptureSession中 20. PhotoCaptureSetting接口
hasFlash(callback: AsyncCallback<boolean>): void;<br/>hasFlash(): Promise<boolean>;<br/> 属性1:mirror?,类型:boolean;
isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean>): void;<br/>isFlashModeSupported(flashMode: FlashMode): Promise<boolean>;<br/> 21. 枚举PhotoOutputErrorCode中新增
getFlashMode(callback: AsyncCallback<FlashMode>): void;<br/>getFlashMode(): Promise<FlashMode>;<br/> 枚举值名称:ERROR_DRIVER_ERROR,值:0;
setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void>): void;<br/>setFlashMode(flashMode: FlashMode): Promise<void>;<br/> 枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:1;
isExposureModeSupported(aeMode: ExposureMode, callback: AsyncCallback<boolean>): void;<br/>isExposureModeSupported(aeMode: ExposureMode): Promise<boolean>;<br/> 枚举值名称:ERROR_TIMEOUT,值:2;
getExposureMode(callback: AsyncCallback<ExposureMode>): void;<br/>getExposureMode(): Promise<ExposureMode>;<br/> 22. 枚举VideoOutputErrorCode中新增
setExposureMode(aeMode: ExposureMode, callback: AsyncCallback<void>): void;<br/>setExposureMode(aeMode: ExposureMode): Promise<void>;<br/> 枚举值名称:ERROR_DRIVER_ERROR,值:0;
getMeteringPoint(callback: AsyncCallback<Point>): void;<br/>getMeteringPoint(): Promise<Point>;<br/> 23. MetadataOutput中新增on(type: 'error', callback: ErrorCallback<MetadataOutputError>): void;
setMeteringPoint(point: Point, callback: AsyncCallback<void>): void;<br/>setMeteringPoint(point: Point): Promise<void>;<br/> 参考代码如下
getExposureBiasRange(callback: AsyncCallback<Array<number>>): void;<br/>getExposureBiasRange(): Promise<Array<number>>;<br/> ```
metadataOutput.on('error', (metadataOutputError) => {
console.log(`Metadata output error code: ${metadataOutputError.code}`);
})
```
setExposureBias(exposureBias: number, callback: AsyncCallback<void>): void;<br/>setExposureBias(exposureBias: number): Promise<void>;<br/> 24. MetadataOutputErrorCode枚举
getExposureValue(callback: AsyncCallback<number>): void;<br/>getExposureValue(): Promise<number>;<br/> 枚举值名称:ERROR_UNKNOWN,值:-1;
isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean>): void;<br/>isFocusModeSupported(afMode: FocusMode): Promise<boolean>;<br/>
getFocusMode(callback: AsyncCallback<FocusMode>): void;<br/>getFocusMode(): Promise<FocusMode>;<br/>
setFocusMode(afMode: FocusMode, callback: AsyncCallback<void>): void;<br/>setFocusMode(afMode: FocusMode): Promise<void>;<br/>
setFocusPoint(point: Point, callback: AsyncCallback<void>): void;<br/>setFocusPoint(point: Point): Promise<void>;<br/>
getFocusPoint(callback: AsyncCallback<Point>): void;<br/>getFocusPoint(): Promise<Point>;<br/>
getFocalLength(callback: AsyncCallback<number>): void;<br/>getFocalLength(): Promise<number>;<br/>
getZoomRatioRange(callback: AsyncCallback<Array<number>>): void;<br/>getZoomRatioRange(): Promise<Array<number>>;<br/>
getZoomRatio(callback: AsyncCallback<number>): void;<br/>getZoomRatio(): Promise<number>;<br/> 枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:0;
setZoomRatio(zoomRatio: number, callback: AsyncCallback<void>): void;<br/>setZoomRatio(zoomRatio: number): Promise<void>; 25. MetadataOutputError接口
11. CameraInput中接口on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void;调整到CaptureSession中,对应接口on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void; 属性名称:code,值:MetadataOutputErrorCode
参考代码如下: **废弃接口**
``` 1. CameraInput中废弃接口on(type: 'exposureStateChange', callback: AsyncCallback<ExposureState>): void;
captureSession.on('focusStateChange', (focusState) => {
console.log(`Focus state : ${focusState}`);
})
```
12. 枚举ExposureMode中 2. previewOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;
枚举值名称:EXPOSURE_MODE_AUTO,初值由默认变更为1; 3. metadataOutput中废弃接口
枚举值名称:EXPOSURE_MODE_CONTINUOUS_AUTO,初值由默认变更为2; setCapturingMetadataObjectTypes(metadataObjectTypes: Array<MetadataObjectType>, callback: AsyncCallback<void>): void;<br/>setCapturingMetadataObjectTypes(metadataObjectTypes: Array<MetadataObjectType>): Promise<void>;
13. 枚举VideoStabilizationMode中 4. metadataOutput中废弃接口
枚举值名称:LOW,初值由默认变更为1; getSupportedMetadataObjectTypes(callback: AsyncCallback<Array<MetadataObjectType>>): void;<br/>getSupportedMetadataObjectTypes(): Promise<Array<MetadataObjectType>>;
枚举值名称:MIDDLE,初值由默认变更为2; 5. PreviewOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;
枚举值名称:HIGH,初值由默认变更为3; 6. PhotoOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;
枚举值名称:AUTO,初值由默认变更为4; 7. VideoOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;
14. CaptureSession中接口addOutput参数由原来子类类型(PreviewOutput,PhotoOutput,VideoOutput,MetadataOutput)统一修改为基类类型(CameraOutput),由原来8个接口改变之后只有2个接口 8. CameraInput中废弃接口getCameraId(callback: AsyncCallback<string>): void;以及getCameraId(): Promise<string>;
改变前接口为: 9. CameraInput中废弃接口getExposurePoint(callback: AsyncCallback<Point>): void;以及getExposurePoint(): Promise<Point>;
addOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void;<br/>addOutput(previewOutput: PreviewOutput): Promise<void>;<br/>addOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void;<br/>addOutput(photoOutput: PhotoOutput): Promise<void>;<br/>addOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void;<br/>addOutput(videoOutput: VideoOutput): Promise<void>;<br/>addOutput(metadataOutput: MetadataOutput, callback: AsyncCallback<void>): void;<br/>addOutput(metadataOutput: MetadataOutput): Promise<void>; 10. CameraInput中废弃接口setExposurePoint(exposurePoint: Point, callback: AsyncCallback<void>): void;以及setExposurePoint(exposurePoint: Point): Promise<void>;
改变后接口为: **接口变更**
addOutput(cameraOutput: CameraOutput, callback: AsyncCallback<void>): void;<br/>addOutput(cameraOutput: CameraOutput): Promise<void>; 1. CameraManager中接口getCameras返回值由Array<Camera>变更为Array<CameraDevice>,接口名由getCameras 更换为 getSupportedCameras,因此旧接口getCameras(callback: AsyncCallback<Array<Camera>>): void;以及getCameras(): Promise<Array<Camera>>;变更为getSupportedCameras(callback: AsyncCallback<Array<CameraDevice>>): void和getSupportedCameras(): Promise<Array<CameraDevice>>;
参考代码如下:以PreviewOutput为例 参考代码如下:
``` ```
captureSession.addOutput(previewOutput, (err) => { cameraManager.getSupportedCameras((err, cameras) => {
if (err) { if (err) {
console.error(`Failed to add output. ${err.message}`); console.error(`Failed to get the cameras. ${err.message}`);
return; return;
} }
console.log('Callback returned with output added.'); console.log(`Callback returned with an array of supported cameras: ${cameras.length}`);
}) })
``` ```
``` ```
captureSession.addOutput(previewOutput).then(() => { cameraManager.getSupportedCameras().then((cameras) => {
console.log('Promise returned with cameraOutput added.'); console.log(`Promise returned with an array of supported cameras: ${cameras.length}`);
}) })
``` ```
15. CaptureSession中接口removeOutput参数由原来子类类型(PreviewOutput,PhotoOutput,VideoOutput,MetadataOutput)统一修改为基类类型(CameraOutput),由原来8个接口改变之后只有2个接口 2. CameraManager中接口createCameraInput传递参数由原来cameraId: string变更为camera: CameraDevice,因此旧接口createCameraInput(cameraId: string, callback: AsyncCallback<CameraInput>): void;以及createCameraInput(cameraId: string): Promise<CameraInput>;变更为createCameraInput(camera: CameraDevice, callback: AsyncCallback<CameraInput>): void;和createCameraInput(camera: CameraDevice): Promise<CameraInput>;
改变前接口为:
removeOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(previewOutput: PreviewOutput): Promise<void>;<br/>removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(photoOutput: PhotoOutput): Promise<void>;<br/>removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(videoOutput: VideoOutput): Promise<void>;<br/>removeOutput(metadataOutput: MetadataOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(metadataOutput: MetadataOutput): Promise<void>;
改变后接口为:
removeOutput(cameraOutput: CameraOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(cameraOutput: CameraOutput): Promise<void>;
参考代码如下:以PreviewOutput为例 参考代码如下:
``` ```
captureSession.removeOutput(previewOutput, (err) => { let cameraDevice = cameras[0];
cameraManager.createCameraInput(cameraDevice, (err, cameraInput) => {
if (err) { if (err) {
console.error(`Failed to remove the CameraOutput instance. ${err.message}`); console.error(`Failed to create the CameraInput instance. ${err.message}`);
return; return;
} }
console.log('Callback invoked to indicate that the CameraOutput instance is removed.'); console.log('Callback returned with the CameraInput instance.');
}); })
``` ```
``` ```
captureSession.removeOutput(previewOutput).then(() => { let cameraDevice = cameras[0];
console.log('Promise returned to indicate that the CameraOutput instance is removed.'); cameraManager.createCameraInput(cameraDevice).then((cameraInput) => {
console.log('Promise returned with the CameraInput instance');
}) })
``` ```
16. 枚举MetadataObjectType中 3. CameraManager中接口createPreviewOutput新增传递参数profile: Profile,profile参数由getSupportedOutputCapability接口获取,因此旧接口createPreviewOutput(surfaceId: string, callback: AsyncCallback<PreviewOutput>): void;以及createPreviewOutput(surfaceId: string): Promise<PreviewOutput>;变更为createPreviewOutput(profile: Profile, surfaceId: string, callback: AsyncCallback<PreviewOutput>): void;createPreviewOutput(profile: Profile, surfaceId: string): Promise<PreviewOutput>;
枚举值名称由FACE变更为FACE_DETECTION;
17. 接口Camera名称更改为CameraDevice
**新增接口**
1. Profile接口
属性1:readonly format,类型:CameraFormat;
属性2:readonly size,类型:Size;
2. FrameRateRange接口
属性1:readonly min,类型:number;
属性2:readonly max,类型:number;
3. VideoProfile接口,继承自Profile
属性:readonly frameRateRange,类型:FrameRateRange;
4. CameraOutputCapability接口
属性1:readonly previewProfiles,类型:Array<Profile>;
属性2:readonly photoProfiles,类型:Array<Profile>;
属性3:readonly videoProfiles,类型:Array<VideoProfile>;
属性4:readonly supportedMetadataObjectTypes,类型:Array<MetadataObjectType>;
5. CameraManager中新增
getSupportedOutputCapability(camera: CameraDevice, callback: AsyncCallback<CameraOutputCapability>): void;
getSupportedOutputCapability(camera: CameraDevice): Promise<CameraOutputCapability>;
参考代码如下: 参考代码如下:
``` ```
cameraManager.getSupportedCameras().then((cameras) => { let profile = cameraoutputcapability.previewProfiles[0];
let cameraDevice = cameras[0]; cameraManager.createPreviewOutput(profile, surfaceId, (err, previewOutput) => {
cameraManager.getSupportedOutputCapability(cameraDevice, (err, CameraOutputCapability) => {
if (err) { if (err) {
console.error(`Failed to get the outputCapability. ${err.message}`); console.error(`Failed to gcreate previewOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with an array of supported outputCapability'); console.log('Callback returned with previewOutput created.');
})
}) })
``` ```
``` ```
cameraManager.getSupportedCameras().then((cameras) => { let profile = cameraoutputcapability.previewProfiles[0];
let cameraDevice = cameras[0]; cameraManager.createPreviewOutput(profile, surfaceId).then((previewOutput) => {
cameraManager.getSupportedOutputCapability(cameraDevice).then((cameraoutputcapability) => { console.log('Promise returned with previewOutput created.');
console.log('Promise returned with an array of supported outputCapability');
})
}) })
``` ```
6. CameraManager中新增isCameraMuted(): boolean; 4. CameraManager中接口createPhotoOutput新增传递参数profile: Profile,profile参数由getSupportedOutputCapability接口获取,因此旧接口CreatePhotoOutput(surfaceId: string, callback: AsyncCallback<PhotoOutput>): void;以及CreatePhotoOutput(surfaceId: string): Promise<PhotoOutput>;变更为createPhotoOutput(profile: Profile, surfaceId: string, callback: AsyncCallback<PhotoOutput>): void;和createPhotoOutput(profile: Profile, surfaceId: string): Promise<PhotoOutput>;
参考代码如下: 参考代码如下:
``` ```
let ismuted = cameraManager.isCameraMuted(); let profile = cameraoutputcapability.photoProfiles[0];
``` cameraManager.createPhotoOutput(profile, surfaceId, (err, photoOutput) => {
if (err) {
7. CameraManager中新增isCameraMuteSupported(): boolean; console.error(`Failed to create photoOutput. ${err.message}`);
return;
参考代码如下: }
console.log('Callback returned with photoOutput created.');
``` })
let ismutesuppotred = cameraManager.isCameraMuteSupported();
``` ```
8. CameraManager中新增muteCamera(mute: boolean): void;
参考代码如下:
``` ```
let mute = true; let profile = cameraoutputcapability.photoProfiles[0];
cameraManager.muteCamera(mute); cameraManager.createPhotoOutput(profile, surfaceId).then((photoOutput) => {
console.log('Promise returned with photoOutput created.');
})
``` ```
9. CameraManager中新增on(type: 'cameraMute', callback: AsyncCallback<boolean>): void; 5. CameraManager中接口createVideoOutput新增传递参数profile: Profile,profile参数由getSupportedOutputCapability接口获取,因此旧接口createVideoOutput(surfaceId: string, callback: AsyncCallback<VideoOutput>): void;以及createVideoOutput(surfaceId: string): Promise<VideoOutput>;变更为createVideoOutput(profile: VideoProfile, surfaceId: string, callback: AsyncCallback<VideoOutput>): void;和createVideoOutput(profile: VideoProfile, surfaceId: string): Promise<VideoOutput>;
参考代码如下: 参考代码如下:
``` ```
cameraManager.on('cameraMute', (err, curMuetd) => { let profile = cameraoutputcapability.videoProfiles[0];
cameraManager.createVideoOutput(profile, surfaceId, (err, videoOutput) => {
if (err) { if (err) {
console.error(`Failed to get cameraMute callback. ${err.message}`); console.error(`Failed to create videoOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with an array of supported outputCapability' );
}) })
``` ```
10. CameraInput中新增open(callback: AsyncCallback<void>): void;以及open(): Promise<void>; ```
let profile = cameraoutputcapability.videoProfiles[0];
cameraManager.createVideoOutput(profile, surfaceId).then((videoOutput) => {
console.log('Promise returned with videoOutput created.');
})
```
参考代码如下: 6. CameraManager中接口createMetadataOutput新增传递参数metadataObjectTypes: Array<MetadataObjectType>,metadataObjectTypes参数由getSupportedOutputCapability接口获取,因此旧接口function createMetadataOutput(callback: AsyncCallback<MetadataOutput>): void;以及function createMetadataOutput(): Promise<MetadataOutput>;变更为createMetadataOutput(metadataObjectTypes: Array<MetadataObjectType>, callback: AsyncCallback<MetadataOutput>): void;和createMetadataOutput(metadataObjectTypes: Array<MetadataObjectType>): Promise<MetadataOutput>;
``` 参考代码如下:
cameraInput.open((err) => {
```
let metadataObjectTypes = cameraoutputcapability.supportedMetadataObjectTypes;
cameraManager.createMetadataOutput(metadataObjectTypes, (err, metadataOutput) => {
if (err) { if (err) {
console.error(`Failed to open the camera. ${err.message}`); console.error(`Failed to create metadataOutput. ${err.message}`);
return; return;
} }
console.log('Callback returned with camera opened.'); console.log('Callback returned with metadataOutput created.');
}) })
``` ```
```
cameraInput.open().then(() => {
console.log('Promise returned with camera opened.');
})
```
```
let metadataObjectTypes = cameraoutputcapability.supportedMetadataObjectTypes;
cameraManager.createMetadataOutput(metadataObjectTypes).then((metadataOutput) => {
console.log('Promise returned with metadataOutput created.');
})
```
11. CameraInput中新增close(callback: AsyncCallback<void>): void;以及close(): Promise<void>; 7. CameraManager中createCaptureSession不需要考虑context属性,因此旧接口createCaptureSession(context: Context, callback: AsyncCallback<CaptureSession>): void;以及createCaptureSession(context: Context): Promise<CaptureSession>;改为createCaptureSession(callback: AsyncCallback<CaptureSession>): void;和createCaptureSession(): Promise<CaptureSession>;
参考代码如下: 参考代码如下:
``` ```typescript
cameraInput.close((err) => { cameraManager.createCaptureSession((err, captureSession) => {
if (err) { if (err) {
console.error(`Failed to close the cameras. ${err.message}`); console.error(`Failed to create captureSession. ${err.message}`);
return; return;
} }
console.log('Callback returned with camera closed.'); console.log('Callback returned with captureSession created.');
}) })
``` ```
``` ```
cameraInput.close().then(() => { cameraManager.createCaptureSession().then((captureSession) => {
console.log('Promise returned with camera closed.'); console.log('Promise returned with captureSession created.');
}) })
``` ```
12. 枚举CameraInputErrorCode中新增 8. CameraStatusInfo接口下属性camera类型由Camera变更为CameraDevice
枚举值名称:ERROR_NO_PERMISSION,值:0; 9. CameraInput中接口on(type: 'error')新增传递参数camera: CameraDevice,因此旧接口on(type: 'error', callback: ErrorCallback<CameraInputError>): void;变更为on(type: 'error', camera: CameraDevice, callback: ErrorCallback<CameraInputError>): void;
枚举值名称:ERROR_DEVICE_PREEMPTED,值:1; 参考代码如下:
枚举值名称:ERROR_DEVICE_DISCONNECTED,值:2; ```
let cameraDevice = cameras[0];
cameraInput.on('error', cameraDevice, (cameraInputError) => {
console.log(`Camera input error code: ${cameraInputError.code}`);
})
```
枚举值名称:ERROR_DEVICE_IN_USE,值:3; 10. CameraInput中以下接口调整到CaptureSession中
枚举值名称:ERROR_DRIVER_ERROR,值:4; hasFlash(callback: AsyncCallback<boolean>): void;<br/>hasFlash(): Promise<boolean>;<br/>
13. 枚举CameraFormat中新增 isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback<boolean>): void;<br/>isFlashModeSupported(flashMode: FlashMode): Promise<boolean>;<br/>
枚举值名称:CAMERA_FORMAT_RGBA_8888,值:3; getFlashMode(callback: AsyncCallback<FlashMode>): void;<br/>getFlashMode(): Promise<FlashMode>;<br/>
14. CaptureSession中新增getMeteringPoint(callback: AsyncCallback<Point>): void;以及getMeteringPoint(): Promise<Point>; setFlashMode(flashMode: FlashMode, callback: AsyncCallback<void>): void;<br/>setFlashMode(flashMode: FlashMode): Promise<void>;<br/>
参考代码如下: isExposureModeSupported(aeMode: ExposureMode, callback: AsyncCallback<boolean>): void;<br/>isExposureModeSupported(aeMode: ExposureMode): Promise<boolean>;<br/>
``` getExposureMode(callback: AsyncCallback<ExposureMode>): void;<br/>getExposureMode(): Promise<ExposureMode>;<br/>
captureSession.getMeteringPoint((err, exposurePoint) => {
if (err) {
console.log(`Failed to get the current exposure point ${err.message}`);
return ;
}
console.log(`Callback returned with current exposure point: ${exposurePoint}`);
})
```
``` setExposureMode(aeMode: ExposureMode, callback: AsyncCallback<void>): void;<br/>setExposureMode(aeMode: ExposureMode): Promise<void>;<br/>
captureSession.getMeteringPoint().then((exposurePoint) => {
console.log(`Promise returned with current exposure point : ${exposurePoint}`);
})
```
15. CaptureSession中新增setMeteringPoint(point: Point, callback: AsyncCallback<void>): void;以及setMeteringPoint(point: Point): Promise<void>; getMeteringPoint(callback: AsyncCallback<Point>): void;<br/>getMeteringPoint(): Promise<Point>;<br/>
参考代码如下: setMeteringPoint(point: Point, callback: AsyncCallback<void>): void;<br/>setMeteringPoint(point: Point): Promise<void>;<br/>
``` getExposureBiasRange(callback: AsyncCallback<Array<number>>): void;<br/>getExposureBiasRange(): Promise<Array<number>>;<br/>
const Point1 = {x: 1, y: 1};
captureSession.setMeteringPoint(Point1,(err) => { setExposureBias(exposureBias: number, callback: AsyncCallback<void>): void;<br/>setExposureBias(exposureBias: number): Promise<void>;<br/>
if (err) {
console.log(`Failed to set the exposure point ${err.message}`);
return ;
}
console.log('Callback returned with the successful execution of setMeteringPoint');
})
```
``` getExposureValue(callback: AsyncCallback<number>): void;<br/>getExposureValue(): Promise<number>;<br/>
const Point2 = {x: 2, y: 2};
captureSession.setMeteringPoint(Point2).then(() => { isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback<boolean>): void;<br/>isFocusModeSupported(afMode: FocusMode): Promise<boolean>;<br/>
console.log('Promise returned with the successful execution of setMeteringPoint');
})
```
16. 枚举CaptureSessionErrorCode中新增 getFocusMode(callback: AsyncCallback<FocusMode>): void;<br/>getFocusMode(): Promise<FocusMode>;<br/>
枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:0; setFocusMode(afMode: FocusMode, callback: AsyncCallback<void>): void;<br/>setFocusMode(afMode: FocusMode): Promise<void>;<br/>
枚举值名称:ERROR_TIMEOUT,值:1; setFocusPoint(point: Point, callback: AsyncCallback<void>): void;<br/>setFocusPoint(point: Point): Promise<void>;<br/>
17. 新增接口CameraOutput,接口下有release(callback: AsyncCallback<void>): void;以及release(): Promise<void>;方法 getFocusPoint(callback: AsyncCallback<Point>): void;<br/>getFocusPoint(): Promise<Point>;<br/>
参考代码如下:用previewOutput做示例 getFocalLength(callback: AsyncCallback<number>): void;<br/>getFocalLength(): Promise<number>;<br/>
``` getZoomRatioRange(callback: AsyncCallback<Array<number>>): void;<br/>getZoomRatioRange(): Promise<Array<number>>;<br/>
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.');
});
```
``` getZoomRatio(callback: AsyncCallback<number>): void;<br/>getZoomRatio(): Promise<number>;<br/>
previewOutput.release().then(() => {
console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.');
})
```
18. PreviewOutput中新增start(callback: AsyncCallback<void>): void;以及start(): Promise<void>; setZoomRatio(zoomRatio: number, callback: AsyncCallback<void>): void;<br/>setZoomRatio(zoomRatio: number): Promise<void>;
参考代码如下 11. CameraInput中接口on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void;调整到CaptureSession中,对应接口on(type: 'focusStateChange', callback: AsyncCallback<FocusState>): void;
``` 参考代码如下:
previewOutput.start((err) => {
if (err) {
console.error(`Failed to start the previewOutput. ${err.message}`);
return;
}
console.log('Callback returned with previewOutput started.');
})
```
``` ```
previewOutput.start().then(() => { captureSession.on('focusStateChange', (focusState) => {
console.log('Promise returned with previewOutput started.'); console.log(`Focus state : ${focusState}`);
}) })
``` ```
19. PreviewOutput中新增stop(callback: AsyncCallback<void>): void;以及stop(): Promise<void>; 12. 枚举ExposureMode中
参考代码如下 枚举值名称:EXPOSURE_MODE_AUTO,初值由默认变更为1;
``` 枚举值名称:EXPOSURE_MODE_CONTINUOUS_AUTO,初值由默认变更为2;
previewOutput.stop((err) => {
if (err) {
console.error(`Failed to stop the previewOutput. ${err.message}`);
return;
}
console.log('Callback returned with previewOutput stopped.');
})
```
``` 13. 枚举VideoStabilizationMode中
previewOutput.stop().then(() => {
console.log('Callback returned with previewOutput stopped.');
})
```
20. PhotoCaptureSetting接口 枚举值名称:LOW,初值由默认变更为1;
属性1:mirror?,类型:boolean; 枚举值名称:MIDDLE,初值由默认变更为2;
21. 枚举PhotoOutputErrorCode中新增 枚举值名称:HIGH,初值由默认变更为3;
枚举值名称:ERROR_DRIVER_ERROR,值:0; 枚举值名称:AUTO,初值由默认变更为4;
枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:1; 14. CaptureSession中接口addOutput参数由原来子类类型(PreviewOutput,PhotoOutput,VideoOutput,MetadataOutput)统一修改为基类类型(CameraOutput),由原来8个接口改变之后只有2个接口
枚举值名称:ERROR_TIMEOUT,值:2; 改变前接口为:
22. 枚举VideoOutputErrorCode中新增 addOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void;<br/>addOutput(previewOutput: PreviewOutput): Promise<void>;<br/>addOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void;<br/>addOutput(photoOutput: PhotoOutput): Promise<void>;<br/>addOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void;<br/>addOutput(videoOutput: VideoOutput): Promise<void>;<br/>addOutput(metadataOutput: MetadataOutput, callback: AsyncCallback<void>): void;<br/>addOutput(metadataOutput: MetadataOutput): Promise<void>;
枚举值名称:ERROR_DRIVER_ERROR,值:0; 改变后接口为:
23. MetadataOutput中新增on(type: 'error', callback: ErrorCallback<MetadataOutputError>): void; addOutput(cameraOutput: CameraOutput, callback: AsyncCallback<void>): void;<br/>addOutput(cameraOutput: CameraOutput): Promise<void>;
参考代码如下 参考代码如下:以PreviewOutput为例
``` ```
metadataOutput.on('error', (metadataOutputError) => { captureSession.addOutput(previewOutput, (err) => {
console.log(`Metadata output error code: ${metadataOutputError.code}`); if (err) {
console.error(`Failed to add output. ${err.message}`);
return;
}
console.log('Callback returned with output added.');
}) })
``` ```
24. MetadataOutputErrorCode枚举 ```
captureSession.addOutput(previewOutput).then(() => {
枚举值名称:ERROR_UNKNOWN,值:-1; console.log('Promise returned with cameraOutput added.');
})
枚举值名称:ERROR_INSUFFICIENT_RESOURCES,值:0; ```
25. MetadataOutputError接口
属性名称:code,值:MetadataOutputErrorCode
**接口废弃**
1. CameraInput中废弃接口on(type: 'exposureStateChange', callback: AsyncCallback<ExposureState>): void;
2. previewOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>; 15. CaptureSession中接口removeOutput参数由原来子类类型(PreviewOutput,PhotoOutput,VideoOutput,MetadataOutput)统一修改为基类类型(CameraOutput),由原来8个接口改变之后只有2个接口
3. metadataOutput中废弃接口 改变前接口为:
setCapturingMetadataObjectTypes(metadataObjectTypes: Array<MetadataObjectType>, callback: AsyncCallback<void>): void;<br/>setCapturingMetadataObjectTypes(metadataObjectTypes: Array<MetadataObjectType>): Promise<void>; removeOutput(previewOutput: PreviewOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(previewOutput: PreviewOutput): Promise<void>;<br/>removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(photoOutput: PhotoOutput): Promise<void>;<br/>removeOutput(videoOutput: VideoOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(videoOutput: VideoOutput): Promise<void>;<br/>removeOutput(metadataOutput: MetadataOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(metadataOutput: MetadataOutput): Promise<void>;
4. metadataOutput中废弃接口 改变后接口为:
getSupportedMetadataObjectTypes(callback: AsyncCallback<Array<MetadataObjectType>>): void;<br/>getSupportedMetadataObjectTypes(): Promise<Array<MetadataObjectType>>; removeOutput(cameraOutput: CameraOutput, callback: AsyncCallback<void>): void;<br/>removeOutput(cameraOutput: CameraOutput): Promise<void>;
5. PreviewOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>; 参考代码如下:以PreviewOutput为例
6. PhotoOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>; ```
captureSession.removeOutput(previewOutput, (err) => {
if (err) {
console.error(`Failed to remove the CameraOutput instance. ${err.message}`);
return;
}
console.log('Callback invoked to indicate that the CameraOutput instance is removed.');
});
```
7. VideoOutput中废弃接口release(callback: AsyncCallback<void>): void;以及release(): Promise<void>; ```
captureSession.removeOutput(previewOutput).then(() => {
console.log('Promise returned to indicate that the CameraOutput instance is removed.');
})
```
8. CameraInput中废弃接口getCameraId(callback: AsyncCallback<string>): void;以及getCameraId(): Promise<string>; 16. 枚举MetadataObjectType中
9. CameraInput中废弃接口getExposurePoint(callback: AsyncCallback<Point>): void;以及getExposurePoint(): Promise<Point>; 枚举值名称由FACE变更为FACE_DETECTION;
10. CameraInput中废弃接口setExposurePoint(exposurePoint: Point, callback: AsyncCallback<void>): void;以及setExposurePoint(exposurePoint: Point): Promise<void>; 17. 接口Camera名称更改为CameraDevice
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册