* Copyright (c) 2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
* @addtogroup OH_Camera
* @{
*
* @brief Provide the definition of the C interface for the camera module.
*
* @syscap SystemCapability.Multimedia.Camera.Core
*
* @since 11
* @version 1.0
*/
* @file capture_session.h
*
* @brief Declare the capture Session concepts.
*
* @library libohcamera.so
* @kit CameraKit
* @syscap SystemCapability.Multimedia.Camera.Core
* @since 11
* @version 1.0
*/
#ifndef NATIVE_INCLUDE_CAMERA_CAMERA_SESSION_H
#define NATIVE_INCLUDE_CAMERA_CAMERA_SESSION_H
#include <stdint.h>
#include <stdio.h>
#include "camera.h"
#include "camera_input.h"
#include "preview_output.h"
#include "photo_output.h"
#include "video_output.h"
#include "metadata_output.h"
#include "native_buffer.h"
#ifdef __cplusplus
extern "C" {
#endif
* @brief Capture session object
*
* A pointer can be created using {@link Camera_CaptureSession} method.
*
* @since 11
* @version 1.0
*/
typedef struct Camera_CaptureSession Camera_CaptureSession;
* @brief Capture session focus state callback to be called in {@link CaptureSession_Callbacks}.
*
* @param session the {@link Camera_CaptureSession} which deliver the callback.
* @param focusState the {@link Camera_FocusState} which delivered by the callback.
* @since 11
*/
typedef void (*OH_CaptureSession_OnFocusStateChange)(Camera_CaptureSession* session, Camera_FocusState focusState);
* @brief Capture session error callback to be called in {@link CaptureSession_Callbacks}.
*
* @param session the {@link Camera_CaptureSession} which deliver the callback.
* @param errorCode the {@link Camera_ErrorCode} of the capture session.
*
* @see CAMERA_SERVICE_FATAL_ERROR
* @since 11
*/
typedef void (*OH_CaptureSession_OnError)(Camera_CaptureSession* session, Camera_ErrorCode errorCode);
* @brief Capture session smooth zoom info callback.
*
* @param session the {@link Camera_CaptureSession} which deliver the callback.
* @param smoothZoomInfo the {@link Camera_SmoothZoomInfo} which delivered by the callback.
* @since 12
*/
typedef void (*OH_CaptureSession_OnSmoothZoomInfo)(Camera_CaptureSession* session,
Camera_SmoothZoomInfo* smoothZoomInfo);
* @brief Capture session device switch status callback.
*
* @param session the {@link Camera_CaptureSession} which deliver the callback.
* @param autoDeviceSwitchStatusInfo the {@link Camera_AutoDeviceSwitchStatusInfo} which delivered by the callback.
* @since 13
*/
typedef void (*OH_CaptureSession_OnAutoDeviceSwitchStatusChange)(Camera_CaptureSession* session,
Camera_AutoDeviceSwitchStatusInfo* autoDeviceSwitchStatusInfo);
* @brief Capture session system pressure level callback.
*
* @param session the {@link Camera_CaptureSession} which deliver the callback.
* @param systemPressureLevel the {@link Camera_SystemPressureLevel} which delivered by the callback.
* @since 20
*/
typedef void (*OH_CaptureSession_OnSystemPressureLevelChange)(Camera_CaptureSession* session,
Camera_SystemPressureLevel systemPressureLevel);
* @brief A listener for capture session.
*
* @see OH_CaptureSession_RegisterCallback
* @since 11
* @version 1.0
*/
typedef struct CaptureSession_Callbacks {
* Capture session focus state change event.
*/
OH_CaptureSession_OnFocusStateChange onFocusStateChange;
* Capture session error event.
*/
OH_CaptureSession_OnError onError;
} CaptureSession_Callbacks;
* @brief Register capture session event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param callback the {@link CaptureSession_Callbacks} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RegisterCallback(Camera_CaptureSession* session,
CaptureSession_Callbacks* callback);
* @brief Unregister capture session event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param callback the {@link CaptureSession_Callbacks} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_UnregisterCallback(Camera_CaptureSession* session,
CaptureSession_Callbacks* callback);
* @brief Register smooth zoom information event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param smoothZoomInfoCallback the {@link OH_CaptureSession_OnSmoothZoomInfo} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_RegisterSmoothZoomInfoCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnSmoothZoomInfo smoothZoomInfoCallback);
* @brief Unregister smooth zoom information event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param smoothZoomInfoCallback the {@link OH_CaptureSession_OnSmoothZoomInfo} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_UnregisterSmoothZoomInfoCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnSmoothZoomInfo smoothZoomInfoCallback);
* @brief Specifies the specific mode.
*
* This interface cannot be used after {@link OH_CaptureSession_BeginConfig}.
* We recommend using this interface immediately after using {@link OH_CameraManager_CreateCaptureSession}.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param sceneMode the {@link CaptureSession_SceneMode} instance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* {@link #CAMERA_SESSION_CONFIG_LOCKED} if session config locked.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_SetSessionMode(Camera_CaptureSession* session, Camera_SceneMode sceneMode);
* @brief Add Secure output for camera.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param previewOutput the target {@link Camera_PreviewOutput} to Set as a secure flow.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* {@link #CAMERA_SESSION_CONFIG_LOCKED} if session config locked.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_AddSecureOutput(Camera_CaptureSession* session, Camera_PreviewOutput* previewOutput);
* @brief Begin capture session config.
*
* @param session the {@link Camera_CaptureSession} instance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_CONFIG_LOCKED} if session config locked.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_BeginConfig(Camera_CaptureSession* session);
* @brief Commit capture session config.
*
* @param session the {@link Camera_CaptureSession} instance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_CommitConfig(Camera_CaptureSession* session);
* @brief Add a camera input.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraInput the target {@link Camera_Input} to add.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_AddInput(Camera_CaptureSession* session, Camera_Input* cameraInput);
* @brief Remove a camera input.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraInput the target {@link Camera_Input} to remove.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RemoveInput(Camera_CaptureSession* session, Camera_Input* cameraInput);
* @brief Add a preview output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param previewOutput the target {@link Camera_PreviewOutput} to add.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_AddPreviewOutput(Camera_CaptureSession* session,
Camera_PreviewOutput* previewOutput);
* @brief Remove a preview output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param previewOutput the target {@link Camera_PreviewOutput} to remove.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RemovePreviewOutput(Camera_CaptureSession* session,
Camera_PreviewOutput* previewOutput);
* @brief Add a photo output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param photoOutput the target {@link Camera_PhotoOutput} to add.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_AddPhotoOutput(Camera_CaptureSession* session, Camera_PhotoOutput* photoOutput);
* @brief Remove a photo output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param photoOutput the target {@link Camera_PhotoOutput} to remove.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RemovePhotoOutput(Camera_CaptureSession* session, Camera_PhotoOutput* photoOutput);
* @brief Add a video output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param videoOutput the target {@link Camera_VideoOutput} to add.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_AddVideoOutput(Camera_CaptureSession* session, Camera_VideoOutput* videoOutput);
* @brief Remove a video output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param videoOutput the target {@link Camera_VideoOutput} to remove.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RemoveVideoOutput(Camera_CaptureSession* session, Camera_VideoOutput* videoOutput);
* @brief Add a metadata output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param metadataOutput the target {@link Camera_MetadataOutput} to add.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_AddMetadataOutput(Camera_CaptureSession* session,
Camera_MetadataOutput* metadataOutput);
* @brief Remove a metadata output.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param metadataOutput the target {@link Camera_MetadataOutput} to remove.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_RemoveMetadataOutput(Camera_CaptureSession* session,
Camera_MetadataOutput* metadataOutput);
* @brief Start capture session.
*
* @param session the {@link Camera_CaptureSession} instance to be started.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_Start(Camera_CaptureSession* session);
* @brief Stop capture session.
*
* @param session the {@link Camera_CaptureSession} instance to be stoped.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_Stop(Camera_CaptureSession* session);
* @brief Release capture session.
*
* @param session the {@link Camera_CaptureSession} instance to be release.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_Release(Camera_CaptureSession* session);
* @brief Check if device has flash light.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param hasFlash the result of whether flash supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_HasFlash(Camera_CaptureSession* session, bool* hasFlash);
* @brief Check whether a specified flash mode is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param flashMode the {@link Camera_FlashMode} to be checked.
* @param isSupported the result of whether flash mode supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_IsFlashModeSupported(Camera_CaptureSession* session,
Camera_FlashMode flashMode, bool* isSupported);
* @brief Get current flash mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param flashMode the current {@link Camera_FlashMode}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetFlashMode(Camera_CaptureSession* session, Camera_FlashMode* flashMode);
* @brief Set flash mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param flashMode the target {@link Camera_FlashMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetFlashMode(Camera_CaptureSession* session, Camera_FlashMode flashMode);
* @brief Check whether a specified exposure mode is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureMode the {@link Camera_ExposureMode} to be checked.
* @param isSupported the result of whether exposure mode supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_IsExposureModeSupported(Camera_CaptureSession* session,
Camera_ExposureMode exposureMode, bool* isSupported);
* @brief Get current exposure mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureMode the current {@link Camera_ExposureMode}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetExposureMode(Camera_CaptureSession* session, Camera_ExposureMode* exposureMode);
* @brief Set exposure mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureMode the target {@link Camera_ExposureMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetExposureMode(Camera_CaptureSession* session, Camera_ExposureMode exposureMode);
* @brief Get current metering point.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param point the current {@link Camera_Point} metering point.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetMeteringPoint(Camera_CaptureSession* session, Camera_Point* point);
* @brief Set the center point of the metering area.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param point the target {@link Camera_Point} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetMeteringPoint(Camera_CaptureSession* session, Camera_Point point);
* @brief Query the exposure compensation range.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param minExposureBias the minimum of exposure compensation.
* @param maxExposureBias the Maximum of exposure compensation.
* @param step the step of exposure compensation between each level.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetExposureBiasRange(Camera_CaptureSession* session, float* minExposureBias,
float* maxExposureBias, float* step);
* @brief Set exposure compensation.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureBias the target exposure compensation to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetExposureBias(Camera_CaptureSession* session, float exposureBias);
* @brief Get current exposure compensation.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureBias the current exposure compensation.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetExposureBias(Camera_CaptureSession* session, float* exposureBias);
* @brief Check whether a specified focus mode is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param focusMode the {@link Camera_FocusMode} to be checked.
* @param isSupported the result of whether focus mode supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_IsFocusModeSupported(Camera_CaptureSession* session,
Camera_FocusMode focusMode, bool* isSupported);
* @brief Get current focus mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureBias the current {@link Camera_FocusMode}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetFocusMode(Camera_CaptureSession* session, Camera_FocusMode* focusMode);
* @brief Set focus mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param focusMode the target {@link Camera_FocusMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetFocusMode(Camera_CaptureSession* session, Camera_FocusMode focusMode);
* @brief Get current focus point.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param focusPoint the current {@link Camera_Point}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetFocusPoint(Camera_CaptureSession* session, Camera_Point* focusPoint);
* @brief Set focus point.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param focusPoint the target {@link Camera_Point} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetFocusPoint(Camera_CaptureSession* session, Camera_Point focusPoint);
* @brief Get all supported zoom ratio range.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param minZoom the minimum of zoom ratio range.
* @param maxZoom the Maximum of zoom ratio range.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetZoomRatioRange(Camera_CaptureSession* session, float* minZoom, float* maxZoom);
* @brief Get current zoom ratio.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param zoom the current zoom ratio.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetZoomRatio(Camera_CaptureSession* session, float* zoom);
* @brief Set zoom ratio.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param zoom the target zoom ratio to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetZoomRatio(Camera_CaptureSession* session, float zoom);
* @brief Check whether a specified video stabilization mode is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param mode the {@link Camera_VideoStabilizationMode} to be checked.
* @param isSupported the result of whether video stabilization mode supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_IsVideoStabilizationModeSupported(Camera_CaptureSession* session,
Camera_VideoStabilizationMode mode, bool* isSupported);
* @brief Get current video stabilization mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param mode the current {@link Camera_VideoStabilizationMode}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_GetVideoStabilizationMode(Camera_CaptureSession* session,
Camera_VideoStabilizationMode* mode);
* @brief Set video stabilization mode.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param mode the target {@link Camera_VideoStabilizationMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 11
*/
Camera_ErrorCode OH_CaptureSession_SetVideoStabilizationMode(Camera_CaptureSession* session,
Camera_VideoStabilizationMode mode);
* @brief Determines whether the camera input can be added into the session.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraInput the target {@link Camera_Input} to set.
* @param isSuccessful the result of whether the camera input can be added into the session.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanAddInput(Camera_CaptureSession* session,
Camera_Input* cameraInput, bool* isSuccessful);
* @brief Determines whether the camera preview output can be added into the session.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraOutput the target {@link Camera_PreviewOutput} to set.
* @param isSuccessful the result of whether the camera preview output can be added into the session.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanAddPreviewOutput(Camera_CaptureSession* session,
Camera_PreviewOutput* cameraOutput, bool* isSuccessful);
* @brief Determines whether the camera photo output can be added into the session.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraOutput the target {@link Camera_PhotoOutput} to set.
* @param isSuccessful the result of whether the camera photo output can be added into the session.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanAddPhotoOutput(Camera_CaptureSession* session,
Camera_PhotoOutput* cameraOutput, bool* isSuccessful);
* @brief Determines whether the camera video output can be added into the session.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param cameraOutput the target {@link Camera_VideoOutput} to set.
* @param isSuccessful the result of whether the camera video output can be added into the session.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanAddVideoOutput(Camera_CaptureSession* session,
Camera_VideoOutput* cameraOutput, bool* isSuccessful);
* @brief Check the preconfig type is supported or not.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param preconfigType The type {@link Camera_PreconfigType} to check support for.
* @param canPreconfig The result of whether preconfiguration supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanPreconfig(Camera_CaptureSession* session,
Camera_PreconfigType preconfigType, bool* canPreconfig);
* @brief Check the preconfig type with ratio is supported or not.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param preconfigType The type {@link Camera_PreconfigType} to check support for.
* @param preconfigRatio The ratio {@link Camera_PreconfigRatio} to check support for.
* @param canPreconfig The result of whether preconfiguration supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_CanPreconfigWithRatio(Camera_CaptureSession* session,
Camera_PreconfigType preconfigType, Camera_PreconfigRatio preconfigRatio, bool* canPreconfig);
* @brief Set the preconfig type.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param preconfigType The type {@link Camera_PreconfigType} to check support for.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if the internal preconfiguration fails.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_Preconfig(Camera_CaptureSession* session,
Camera_PreconfigType preconfigType);
* @brief Set the preconfig type with ratio.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param preconfigType The type {@link Camera_PreconfigType} to check support for.
* @param preconfigRatio The ratio {@link Camera_PreconfigRatio} to check support for.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if the internal preconfiguration fails.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_PreconfigWithRatio(Camera_CaptureSession* session,
Camera_PreconfigType preconfigType, Camera_PreconfigRatio preconfigRatio);
* @brief Query the exposure value.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param exposureValue the current exposure value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_GetExposureValue(Camera_CaptureSession* session, float* exposureValue);
* @brief Get current focal length.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param focalLength the current focal length.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_GetFocalLength(Camera_CaptureSession* session, float* focalLength);
* @brief Set target zoom ratio by smooth method.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param targetZoom the target zoom ratio to set.
* @param smoothZoomMode the {@link Camera_SmoothZoomMode} instance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_SetSmoothZoom(Camera_CaptureSession* session,
float targetZoom, Camera_SmoothZoomMode smoothZoomMode);
* @brief Get the supported color spaces.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param colorSpace the supported {@link OH_NativeBuffer_ColorSpace} list to be filled if the method call succeeds.
* @param size the size of supported color Spaces queried.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_GetSupportedColorSpaces(Camera_CaptureSession* session,
OH_NativeBuffer_ColorSpace** colorSpace, uint32_t* size);
* @brief Delete the color spaces.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param colorSpace the target {@link OH_NativeBuffer_ColorSpace} list to be deleted if the method call succeeds.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_DeleteColorSpaces(Camera_CaptureSession* session,
OH_NativeBuffer_ColorSpace* colorSpace);
* @brief Get current color space.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param colorSpace the current {@link OH_NativeBuffer_ColorSpace} .
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_GetActiveColorSpace(Camera_CaptureSession* session,
OH_NativeBuffer_ColorSpace* colorSpace);
* @brief Set current color space.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param colorSpace the target {@link OH_NativeBuffer_ColorSpace} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 12
*/
Camera_ErrorCode OH_CaptureSession_SetActiveColorSpace(Camera_CaptureSession* session,
OH_NativeBuffer_ColorSpace colorSpace);
* @brief Register device switch event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param autoDeviceSwitchStatusChange the {@link OH_CaptureSession_OnAutoDeviceSwitchStatusChange} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 13
*/
Camera_ErrorCode OH_CaptureSession_RegisterAutoDeviceSwitchStatusCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnAutoDeviceSwitchStatusChange autoDeviceSwitchStatusChange);
* @brief Unregister device switch event callback.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param autoDeviceSwitchStatusChange the {@link OH_CaptureSession_OnAutoDeviceSwitchStatusChange} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 13
*/
Camera_ErrorCode OH_CaptureSession_UnregisterAutoDeviceSwitchStatusCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnAutoDeviceSwitchStatusChange autoDeviceSwitchStatusChange);
* @brief Check whether auto device switch is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param isSupported the result of whether auto device switch supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 13
*/
Camera_ErrorCode OH_CaptureSession_IsAutoDeviceSwitchSupported(Camera_CaptureSession* session, bool* isSupported);
* @brief Enable auto switch or not for the camera device.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param enabled the flag of enable auto switch or not.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error.
* @since 13
*/
Camera_ErrorCode OH_CaptureSession_EnableAutoDeviceSwitch(Camera_CaptureSession* session, bool enabled);
* @brief Set quality prioritization.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param qualityPrioritization the target {@link Camera_QualityPrioritization} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 14
*/
Camera_ErrorCode OH_CaptureSession_SetQualityPrioritization(
Camera_CaptureSession* session, Camera_QualityPrioritization qualityPrioritization);
* @brief Subscribes to system pressure level changes.
*
* @param session Pointer to a <b>CaptureSession</b> instance.
* @param systemPressureLevelChange Callback used for subscription.
* @return Execution result of the function. <b>CAMERA_OK</b> is returned if the execution is successful;
* <b>CAMERA_INVALID_ARGUMENT</b> is returned if a parameter is missing or incorrect.
* @since 20
*/
Camera_ErrorCode OH_CaptureSession_RegisterSystemPressureLevelChangeCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnSystemPressureLevelChange systemPressureLevel);
* @brief Unsubscribes from system pressure level changes.
*
* @param session Pointer to a <b>CaptureSession</b> instance.
* @param systemPressureLevelChange Callback used for unsubscription.
* @return Execution result of the function. <b>CAMERA_OK</b> is returned if the execution is successful;
* <b>CAMERA_INVALID_ARGUMENT</b> is returned if a parameter is missing or incorrect.
* @since 20
*/
Camera_ErrorCode OH_CaptureSession_UnregisterSystemPressureLevelChangeCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnSystemPressureLevelChange systemPressureLevel);
* @brief Check whether macro ability is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param isSupported the result of whether macro ability supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 17
*/
Camera_ErrorCode OH_CaptureSession_IsMacroSupported(Camera_CaptureSession* session, bool* isSupported);
* @brief Enable macro ability or not for the camera device.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param enabled the flag of enable macro ability or not.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed.
* @since 17
*/
Camera_ErrorCode OH_CaptureSession_EnableMacro(Camera_CaptureSession *session, bool enabled);
* @brief Capture session exposure duration change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} which deliver the callback.
* @param exposureDuration The exposure duration which delivered by the callback.
* @since 24
*/
typedef void (*OH_CaptureSession_OnExposureDurationChange)(const Camera_CaptureSession* session,
int32_t exposureDuration);
* @brief Register exposure info change event callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureDurationChange The {@link OH_CaptureSession_OnExposureDurationChange} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_RegisterExposureInfoChangeCallback(const Camera_CaptureSession* session,
OH_CaptureSession_OnExposureDurationChange exposureDurationChange);
* @brief Unregister exposure info change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureDurationChange The {@link OH_CaptureSession_OnExposureDurationChange} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_UnregisterExposureInfoChangeCallback(const Camera_CaptureSession* session,
OH_CaptureSession_OnExposureDurationChange exposureDurationChange);
* @brief Capture session exposure state change callback.
*
* @param exposureState The exposure duration which delivered by the callback.
* @since 26
*/
typedef void(*OH_CaptureSession_OnExposureStateChange)(void* context, OH_Camera_ExposureState exposureState);
* @brief Register exposure state change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param callback The {@link OH_CaptureSession_OnExposureStateChange} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 26
*/
Camera_ErrorCode OH_CaptureSession_RegisterExposureStateChangeCallback(const Camera_CaptureSession* session,
void* context, OH_CaptureSession_OnExposureStateChange callback);
* @brief Unregister exposure state change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param callback The {@link OH_CaptureSession_OnExposureStateChange} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 26
*/
Camera_ErrorCode OH_CaptureSession_UnregisterExposureStateChangeCallback(const Camera_CaptureSession* session,
void* context, OH_CaptureSession_OnExposureStateChange callback);
* @brief Capture session flash state change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} which deliver the callback.
* @param flashState The {@link OH_Camera_FlashState} which delivered by the callback.
* @since 24
*/
typedef void (*OH_CaptureSession_OnFlashStateChange)(const Camera_CaptureSession* session,
OH_Camera_FlashState flashState);
* @brief Register flash state change event callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param flashStateChange The {@link OH_CaptureSession_OnFlashStateChange} to be registered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_RegisterFlashStateChangeCallback(const Camera_CaptureSession* session,
OH_CaptureSession_OnFlashStateChange flashStateChange);
* @brief Unregister flash state change callback.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param flashStateChange The {@link OH_CaptureSession_OnFlashStateChange} to be unregistered.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_UnregisterFlashStateChangeCallback(const Camera_CaptureSession* session,
OH_CaptureSession_OnFlashStateChange flashStateChange);
* @brief Sets ISO sensitivity value, within the range of getSupportedIsoRange. This control is only effective if
* ExposureMode is set to EXPOSURE_MODE_LOCKED.
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param isoValue Indicates target iso value to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetIso(const Camera_CaptureSession* session, int32_t isoValue);
* @brief Get current iso sensitivity value, as defined in ISO 12232:2006.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param isoValue Pointer to the current iso sensitivity value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if session config locked.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetIso(const Camera_CaptureSession* session, int32_t* isoValue);
* @brief Query the iso range.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param minIsoValue the minimum of iso value.
* @param maxIsoValue the Maximum of iso value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetSupportedISORange(const Camera_CaptureSession* session,
int32_t *minIsoValue, int32_t *maxIsoValue);
* @brief Check whether manual focus is supported.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param isSupported the result of whether manual focus supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_IsFocusDistanceSupported(const Camera_CaptureSession* session, bool* isSupported);
* @brief Get current focus distance, ranging from 0.0 to 1.0, with 0.0 being shortest
* distance at which the lens can focus and 1.0 the furthest. The default value is 1.0.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param focusDistance Pointer to the current focus distance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if session config locked.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetFocusDistance(const Camera_CaptureSession* session, float* focusDistance);
* @brief Sets focus distance. Possible distance values range from 0.0 to 1.0, with 0.0 being shortest
* distance at which the lens can focus and 1.0 the furthest. The default value is 1.0.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param focusDistance The focus distance to be set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetFocusDistance(const Camera_CaptureSession* session, float focusDistance);
* @brief Get current exposure duration. Units: Microseconds.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureDuration Pointer to the current exposure duration.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetExposureDuration(const Camera_CaptureSession* session,
int32_t* exposureDuration);
* @brief Set exposure duration. Units: Microseconds.
* If the sensor can't expose this duration exactly, it will shorten the duration to the nearest supported value, which
* is reporeted by Callback {@link OH_CaptureSession_OnExposureDurationChange}.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureDuration the target exposure duration to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetExposureDuration(const Camera_CaptureSession* session, int32_t exposureDuration);
* @brief Get the supported range of exposure durations. Units: Microseconds.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param minExposureDuration Pointer to the minimum of exposure duration.
* @param maxExposureDuration Pointer to the maximum of exposure duration.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetSupportedExposureDurationRange(const Camera_CaptureSession* session,
int32_t* minExposureDuration, int32_t* maxExposureDuration);
* @brief Get current exposure metering mode.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureMeteringMode Pointer to the {@link OH_Camera_ExposureMeteringMode} instance.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetExposureMeteringMode(const Camera_CaptureSession* session,
OH_Camera_ExposureMeteringMode* exposureMeteringMode);
* @brief Check whether a specified exposure metering mode is supported.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureMeteringMode The {@link OH_Camera_ExposureMeteringMode} to be checked.
* @param isSupported Pointer to the result of whether exposure mode supported.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_IsExposureMeteringModeSupported(const Camera_CaptureSession* session,
OH_Camera_ExposureMeteringMode exposureMeteringMode, bool* isSupported);
* @brief Set exposure metering mode.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param exposureMeteringMode The target {@link OH_Camera_ExposureMeteringMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetExposureMeteringMode(const Camera_CaptureSession* session,
OH_Camera_ExposureMeteringMode exposureMeteringMode);
Camera_ErrorCode OH_CaptureSession_IsWhiteBalanceModeSupported(
Camera_CaptureSession* session, Camera_WhiteBalanceMode whiteBalanceMode, bool* isSupported);
Camera_ErrorCode OH_CaptureSession_GetWhiteBalanceMode(
Camera_CaptureSession* session, Camera_WhiteBalanceMode* whiteBalanceMode);
Camera_ErrorCode OH_CaptureSession_GetWhiteBalanceRange(
Camera_CaptureSession* session, int32_t* minColorTemperature, int32_t* maxColorTemperature);
Camera_ErrorCode OH_CaptureSession_GetWhiteBalance(Camera_CaptureSession* session, int32_t* colorTemperature);
Camera_ErrorCode OH_CaptureSession_SetWhiteBalance(Camera_CaptureSession* session, int32_t colorTemperature);
Camera_ErrorCode OH_CaptureSession_SetWhiteBalanceMode(
Camera_CaptureSession* session, Camera_WhiteBalanceMode whiteBalanceMode);
* @brief Obtains the supported white balance color tint range.
*
* @param session Pointer to a {@link Camera_CaptureSession} instance.
* @param minColorTint Pointer to the minimum color tint.
* @param maxColorTint Pointer to the maximum color tint.
* @return Result code.
* {@link #CAMERA_OK} is returned if the function is called successfully.
* {@link #CAMERA_INVALID_ARGUMENT} is returned if an input parameter is missing or the parameter type is incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} is returned if the session is not configured when the function is called.
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_GetColorTintRange(
const Camera_CaptureSession* session, int32_t* minColorTint, int32_t* maxColorTint);
* @brief Obtains the white balance color tint.
*
* @param session Pointer to a {@link Camera_CaptureSession} instance.
* @param colorTint Pointer to the color tint.
* @return Result code.
* {@link #CAMERA_OK} is returned if the function is called successfully.
* {@link #CAMERA_INVALID_ARGUMENT} is returned if an input parameter is missing or the parameter type is incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} is returned if the session is not configured when the function is called.
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_GetColorTint(const Camera_CaptureSession* session, int32_t* colorTintValue);
* @brief Sets the white balance color tint.
*
* @param session Pointer to a {@link Camera_CaptureSession} instance.
* @param colorTint Color tint.
* @return Result code.
* {@link #CAMERA_OK} is returned if the function is called successfully.
* {@link #CAMERA_INVALID_ARGUMENT} is returned if an input parameter is missing or the parameter type is incorrect.
* {@link #CAMERA_SESSION_NOT_CONFIG} is returned if the session is not configured when the function is called.
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_SetColorTint(const Camera_CaptureSession* session, int32_t colorTintValue);
Camera_ErrorCode OH_CaptureSession_IsControlCenterSupported(Camera_CaptureSession* session, bool* isSupported);
Camera_ErrorCode OH_CaptureSession_GetSupportedEffectTypes(
Camera_CaptureSession* session, Camera_ControlCenterEffectType** types, uint32_t* size);
Camera_ErrorCode OH_CaptureSession_DeleteSupportedEffectTypes(
Camera_CaptureSession* session, Camera_ControlCenterEffectType* types, uint32_t size);
Camera_ErrorCode OH_CaptureSession_EnableControlCenter(Camera_CaptureSession* session, bool enabled);
typedef void (*OH_CaptureSession_OnControlCenterEffectStatusChange)(Camera_CaptureSession* session,
Camera_ControlCenterStatusInfo* controlCenterStatusInfo);
Camera_ErrorCode OH_CaptureSession_RegisterControlCenterEffectStatusChangeCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnControlCenterEffectStatusChange controlCenterEffectStatusChange);
Camera_ErrorCode OH_CaptureSession_UnregisterControlCenterEffectStatusChangeCallback(Camera_CaptureSession* session,
OH_CaptureSession_OnControlCenterEffectStatusChange controlCenterEffectStatusChange);
typedef void (*OH_CaptureSession_OnCameraSwitchRequest)(Camera_CaptureSession *session, Camera_Device *device);
Camera_ErrorCode OH_CaptureSession_RegisterCameraSwitchRequestCallback(
Camera_CaptureSession *session, OH_CaptureSession_OnCameraSwitchRequest cameraSwitchRequest);
Camera_ErrorCode OH_CaptureSession_UnregisterRemoteDeviceSwitchCallback(
Camera_CaptureSession *session, OH_CaptureSession_OnCameraSwitchRequest cameraSwitchRequest);
typedef void (*OH_CaptureSession_OnMacroStatusChange)(Camera_CaptureSession *session, bool isMacroActive);
Camera_ErrorCode OH_CaptureSession_RegisterMacroStatusChangeCallback(
Camera_CaptureSession* session, OH_CaptureSession_OnMacroStatusChange macroStatusChange);
Camera_ErrorCode OH_CaptureSession_UnregisterMacroStatusChangeCallback(
Camera_CaptureSession* session, OH_CaptureSession_OnMacroStatusChange macroStatusChange);
typedef void (*OH_CaptureSession_OnIsoChange)(Camera_CaptureSession *session, int32_t isoValue);
Camera_ErrorCode OH_CaptureSession_RegisterIsoChangeCallback(
Camera_CaptureSession* session, OH_CaptureSession_OnIsoChange isoChange);
Camera_ErrorCode OH_CaptureSession_UnregisterIsoChangeCallback(
Camera_CaptureSession* session, OH_CaptureSession_OnIsoChange isoChange);
* @brief Query the raw zoom range.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param minZoom the minimum of zoom value.
* @param maxZoom the Maximum of zoom value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetRAWCaptureZoomRatioRange(const Camera_CaptureSession* session,
float* minZoom, float* maxZoom);
* @brief Gets the supported physical apertures list.
* Release the physical apertures memory by calling {@link OH_CaptureSession_DeletePhysicalApertures}.
*
* @param session the {@link Camera_CaptureSession} instance
* @param apertures pointer to an array for storing physical aperture values
* @param size the size of physical apertures.
* @return {@link #CAMERA_OK} success
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetSupportedPhysicalApertures(const Camera_CaptureSession* session,
OH_Camera_PhysicalAperture** apertures, uint32_t* size);
* @brief Get current physical aperture value
*
* @param session the {@link Camera_CaptureSession} instance
* @param aperture returned current aperture value
* @return {@link #CAMERA_OK} success
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if session config locked.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetPhysicalAperture(const Camera_CaptureSession* session, double* aperture);
* @brief Delete the physical apertures.
*
* @param session the {@link Camera_CaptureSession} instance.
* @param apertures pointer to an array for storing physical aperture values
* @param size the array size of the physical apertures.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_DeletePhysicalApertures(const Camera_CaptureSession* session,
OH_Camera_PhysicalAperture* apertures, uint32_t size);
* @brief Set physical aperture value
*
* @param session the {@link Camera_CaptureSession} instance
* @param aperture the aperture value to set
* @return {@link #CAMERA_OK} success
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation not allowed, session or inputdevice maybe abnormal.
* {@link #CAMERA_SESSION_NOT_CONFIG} if session config locked.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetPhysicalAperture(const Camera_CaptureSession* session, double aperture);
* @brief Checks if the specified OIS mode is supported.
*
* @param session Pointer to a session.
* @param oisMode The OIS mode {@link OH_Camera_OISMode} to check.
* @param isSupported Output parameter indicating support status.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_IsOISModeSupported(const Camera_CaptureSession* session,
OH_Camera_OISMode oisMode, bool* isSupported);
* @brief Gets the current OIS mode.
*
* @param session Pointer to a session.
* @param oisMode Output parameter for current OIS mode {@link OH_Camera_OISMode}.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetCurrentOISMode(const Camera_CaptureSession* session,
OH_Camera_OISMode* oisMode);
* @brief Sets the OIS mode.
*
* @param session Pointer to a session.
* @param oisMode The OIS mode {@link OH_Camera_OISMode} to set.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetOISMode(const Camera_CaptureSession* session,
OH_Camera_OISMode oisMode);
* @brief Gets the supported bias range for the specified OIS axis.
*
* @param session Pointer to a session.
* @param oisAxis The OIS axis {@link OH_Camera_OISAxes}
* @param minBias Output parameter for minimum bias value.
* @param maxBias Output parameter for maximum bias value.
* @param step Output parameter for bias step value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetSupportedOISBiasRange(const Camera_CaptureSession* session,
OH_Camera_OISAxes oisAxis, float* minBias, float* maxBias, float* step);
* @brief Gets the current custom bias values for all OIS axes.
*
* @param session Pointer to a session.
* @param pitchBias Output parameter for pitch axis bias value.
* @param yawBias Output parameter for yaw axis bias value.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_GetCurrentCustomOISBias(const Camera_CaptureSession* session,
float* pitchBias, float* yawBias);
* @brief Sets custom OIS bias values for all axes.
*
* @param session Pointer to a session.
* @param pitchBias Bias value for pitch axis.
* @param yawBias Bias value for yaw axis.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 24
*/
Camera_ErrorCode OH_CaptureSession_SetOISModeCustom(const Camera_CaptureSession* session,
float pitchBias, float yawBias);
* @brief Gets the zoom point infos.
* Release the zoom point infos memory by calling {@link OH_CaptureSession_DeleteZoomPointInfos}.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param size Pointer to the size of queried zoom point info.
* @param zoomPointInfo Double pointer to the queried zoom point info.
* @return {@link #CAMERA_OK} is returned if the function is called successfully.
* {@link #CAMERA_INVALID_ARGUMENT} if parameters are invalid.
* {@link #CAMERA_OPERATION_NOT_ALLOWED} if operation is not allowed.
* {@link #CAMERA_SESSION_NOT_CONFIG} if the capture session not config.
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_GetZoomPointInfos(const Camera_CaptureSession* session, uint32_t* size,
OH_Camera_ZoomPointInfo** zoomPointInfo);
* @brief Delete the zoom point infos.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param zoomPointInfo the target {@link Camera_ZoomPointInfo} list to be deleted if the method call succeeds.
* @return {@link #CAMERA_OK} if the method call succeeds.
* {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect.
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_DeleteZoomPointInfos(const Camera_CaptureSession* session,
OH_Camera_ZoomPointInfo* zoomPointInfo);
* @brief Checks whether the lock focus tracking is supported.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @return **true** if supported, **false** otherwise.
* @since 26.0.0
*/
bool OH_CaptureSession_IsLockFocusTrackingSupported(const Camera_CaptureSession* session);
* @brief Lock focus tracking, can be unlocked by {@link OH_CaptureSession_UnlockFocusTracking}.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @param focusPoint Pointer to the lock focus tracking point.
* @return <ul>
* <li>{@link CAMERA_OK} The operation is successful.</li>
* <li>{@link CAMERA_INVALID_ARGUMENT} A parameter is missing or the parameter type is incorrect.</li>
* <li>{@link CAMERA_SESSION_NOT_CONFIG} The capture session is not configured.</li>
* <li>{@link CAMERA_SERVICE_FATAL_ERROR} The camera service is abnormal.</li>
* </ul>
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_LockFocusTracking(Camera_CaptureSession* session, Camera_Point focusPoint);
* @brief Unlock focus tracking.
*
* @param session Pointer to the {@link Camera_CaptureSession} instance.
* @return <ul>
* <li>{@link CAMERA_OK} The operation is successful.</li>
* <li>{@link CAMERA_INVALID_ARGUMENT} A parameter is missing or the parameter type is incorrect.</li>
* <li>{@link CAMERA_SESSION_NOT_CONFIG} The capture session is not configured.</li>
* <li>{@link CAMERA_SERVICE_FATAL_ERROR} The camera service is abnormal.</li>
* </ul>
* @since 26.0.0
*/
Camera_ErrorCode OH_CaptureSession_UnlockFocusTracking(Camera_CaptureSession* session);
#ifdef __cplusplus
}
#endif
#endif
