interface_sdk_c/multimedia/image_effect/image_effect_errors.h
秦川钞 6da1ec8a6e 添加@kit标签
Signed-off-by: 秦川钞 <qinchuanchao@h-partners.com>
2024-07-15 15:26:24 +08:00

105 lines
2.8 KiB
C

/*
* Copyright (c) 2024 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 ImageEffect
* @{
*
* @brief Provides the error code for ImageEffect.
*
* @since 12
*/
/**
* @file image_effect_errors.h
*
* @brief Defines the error code used in ImageEffect.
*
* @library libimage_effect.so
* @kit ImageKit
* @syscap SystemCapability.Multimedia.ImageEffect.Core
* @since 12
*/
#ifndef NATIVE_IMAGE_EFFECT_ERRORS_H
#define NATIVE_IMAGE_EFFECT_ERRORS_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Effect error code
*
* @syscap SystemCapability.Multimedia.ImageEffect.Core
* @since 12
*/
typedef enum ImageEffect_ErrorCode {
/**
* The operation completed successfully.
*/
EFFECT_SUCCESS = 0,
/**
* Permission denied.
*/
EFFECT_ERROR_PERMISSION_DENIED = 201,
/**
* Invalid parameter.
*/
EFFECT_ERROR_PARAM_INVALID = 401,
/**
* Warning code if input and output buffer size is not match, it will be rendered through output buffer size.
*/
EFFECT_BUFFER_SIZE_NOT_MATCH = 29000001,
/**
* Warning code if input and output color space is not match, it will be rendered by modifying the color space of
* output image.
*/
EFFECT_COLOR_SPACE_NOT_MATCH = 29000002,
/**
* The input and output image type is not match. For example, set input OH_Pixelmap and set output NativeBuffer.
*/
EFFECT_INPUT_OUTPUT_NOT_MATCH = 29000101,
/**
* Over the max number of the filters that can be added.
*/
EFFECT_EFFECT_NUMBER_LIMITED = 29000102,
/**
* The input or output image type is not supported. For example, the pixel format beyond the current definition.
*/
EFFECT_INPUT_OUTPUT_NOT_SUPPORTED = 29000103,
/**
* Allocate memory fail. For example, over sized image resource.
*/
EFFECT_ALLOCATE_MEMORY_FAILED = 29000104,
/**
* Parameter error. For example, the invalid value set for filter.
*/
EFFECT_PARAM_ERROR = 29000121,
/**
* Key error. For example, the invalid key set for filter.
*/
EFFECT_KEY_ERROR = 29000122,
/**
* Unknown error.
*/
EFFECT_UNKNOWN = 29000199,
} ImageEffect_ErrorCode;
#ifdef __cplusplus
}
#endif
#endif // NATIVE_IMAGE_EFFECT_ERRORS_H
/** @} */