Fix Doxygen mistakes
[platform/core/api/metadata-editor.git] / include / metadata_editor_type.h
1 /*
2 * Copyright (c) 2013 Samsung Electronics Co., Ltd All Rights Reserved
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17
18
19 #ifndef __TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__
20 #define __TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__
21
22 #include <tizen.h>
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif /* __cplusplus */
27
28
29 /**
30 * @addtogroup CAPI_MEDIA_METADATA_EDITOR_MODULE
31 * @{
32 */
33
34
35 /**
36 * @brief Definition for Metadata editor Error Class.
37 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
38 *
39 */
40 #define METADATA_EDITOR_ERROR_CLASS                             TIZEN_ERROR_METADATA_EDITOR
41
42 /**
43  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
44  * @brief The enumerations of media metadata error.
45  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
46  */
47 typedef enum {
48         METADATA_EDITOR_ERROR_NONE                                      = TIZEN_ERROR_NONE,                             /**< Successful */
49         METADATA_EDITOR_ERROR_INVALID_PARAMETER                 = TIZEN_ERROR_INVALID_PARAMETER,                /**< Invalid parameter */
50         METADATA_EDITOR_ERROR_OUT_OF_MEMORY             = TIZEN_ERROR_OUT_OF_MEMORY,                    /**< Out of memory */
51         METADATA_EDITOR_ERROR_FILE_EXISTS                       = TIZEN_ERROR_FILE_EXISTS,                      /**< File not exist */
52         METADATA_EDITOR_ERROR_PERMISSION_DENIED         = TIZEN_ERROR_PERMISSION_DENIED,        /**< Permission denied */
53         METADATA_EDITOR_ERROR_NOT_SUPPORTED                             = TIZEN_ERROR_NOT_SUPPORTED,            /**< Unsupported type */
54         METADATA_EDITOR_ERROR_OPERATION_FAILED                  = METADATA_EDITOR_ERROR_CLASS |0x01,            /**< Invalid internal operation */
55 } metadata_editor_error_e;
56
57
58 /**
59  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
60  * @brief The enumerations of attribute.
61  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
62  */
63 typedef enum {
64         METADATA_EDITOR_ATTR_ARTIST,                                    /**< Artist*/
65         METADATA_EDITOR_ATTR_TITLE,                                     /**< Title*/
66         METADATA_EDITOR_ATTR_ALBUM,                                     /**< Album*/
67         METADATA_EDITOR_ATTR_GENRE,                                     /**< Genre*/
68         METADATA_EDITOR_ATTR_AUTHOR,                                /**< Author*/
69         METADATA_EDITOR_ATTR_COPYRIGHT,                         /**< Copyright*/
70         METADATA_EDITOR_ATTR_DATE,                                      /**< Date*/
71         METADATA_EDITOR_ATTR_DESCRIPTION,                               /**< Description*/
72         METADATA_EDITOR_ATTR_COMMENT,                                   /**< Comment*/
73         METADATA_EDITOR_ATTR_TRACK_NUM,                         /**< Track number info*/
74         METADATA_EDITOR_ATTR_PICTURE_NUM,                       /**< Picture number*/
75         METADATA_EDITOR_ATTR_CONDUCTOR,                         /**< Conductor*/
76         METADATA_EDITOR_ATTR_UNSYNCLYRICS,                      /**< Unsynchronized lyric*/
77 } metadata_editor_attr_e;
78
79 /**
80  * @ingroup CAPI_MEDIA_METADATA_EDITOR_MODULE
81  * @brief The handle of media metadata.
82  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
83  */
84 typedef void * metadata_editor_h;
85
86 /**
87  * @}
88  */
89
90 #ifdef __cplusplus
91 }
92 #endif /* __cplusplus */
93
94 #endif /*__TIZEN_MULTIMEDIA_METADATA_EDITOR_TYPE_H__*/