Stabilization inherits from StabilizationQuery.
It provides APIs to set video stabilization.
You can set video stabilization only when a VideoOutput stream exists in the session.
- The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
- The initial APIs of this interface are supported since API version 11.
getActiveVideoStabilizationMode11+
getActiveVideoStabilizationMode(): VideoStabilizationMode
Obtains the video stabilization mode in use.
Atomic service API: This API can be used in atomic services since API version 19.
System capability: SystemCapability.Multimedia.Camera.Core
Return value
| Type | Description |
|---|---|
| VideoStabilizationMode | Video stabilization mode obtained. If the API call fails, undefined is returned. |
Error codes
For details about the error codes, see Camera Error Codes.
| Error Code | Error Message |
|---|---|
| 7400103 | Session not config. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
function getActiveVideoStabilizationMode(videoSession: camera.VideoSession): camera.VideoStabilizationMode | undefined {
let vsMode: camera.VideoStabilizationMode | undefined = undefined;
try {
vsMode = videoSession.getActiveVideoStabilizationMode();
} catch (error) {
// If the operation fails, error.code is returned and processed.
let err = error as BusinessError;
console.error(`The getActiveVideoStabilizationMode call failed. error code: ${err.code}`);
}
return vsMode;
} setVideoStabilizationMode11+
setVideoStabilizationMode(mode: VideoStabilizationMode): void
Sets a video stabilization mode. Before the setting, call isVideoStabilizationModeSupported to check whether the target video stabilization mode is supported. It is recommended that you set the video stabilization mode between commitConfig and Start.
Atomic service API: This API can be used in atomic services since API version 19.
System capability: SystemCapability.Multimedia.Camera.Core
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| mode | VideoStabilizationMode | Yes | Video stabilization mode. |
Error codes
For details about the error codes, see Camera Error Codes.
| Error Code | Error Message |
|---|---|
| 7400103 | Session not config. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
function setVideoStabilizationMode(videoSession: camera.VideoSession): void {
try {
videoSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF);
} catch (error) {
// If the operation fails, error.code is returned and processed.
let err = error as BusinessError;
console.error(`The setVideoStabilizationMode call failed. error code: ${err.code}`);
}
}