2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef __TIZEN_MEDIA_CONTENT_H__
18 #define __TIZEN_MEDIA_CONTENT_H__
20 #include <media_audio.h>
21 #include <media_content_type.h>
22 #include <media_filter.h>
23 #include <media_folder.h>
24 #include <media_image.h>
25 #include <media_info.h>
26 #include <media_tag.h>
27 #include <media_video.h>
28 #include <media_group.h>
29 #include <media_playlist.h>
30 #include <media_bookmark.h>
31 #include <media_storage.h>
32 #include <media_face.h>
33 #include <media_content_product.h>
37 #endif /* __cplusplus */
40 * @file media_content.h
41 * @brief This file contains API providing functions for media content in DB. \n
42 * Operations include connect and disconnect the media content service, scanning media file and folder with subfolders, \n
43 * subscribing and unsubscribing notifications of media DB change.
47 * @addtogroup CAPI_MEDIA_CONTENT_MODULE
52 * @brief Connects to the media content service.
53 * @details Any media content related function call should be invoked after this function call.
55 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
57 * @return @c 0 on success,
58 * otherwise a negative error value
60 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
61 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
63 * @post media_content_disconnect()
65 * @see media_content_disconnect()
67 int media_content_connect(void);
70 * @brief Disconnects from the media content service.
71 * @details This function closes connection to the media content service. Any further media content related operation
72 * cannot be performed after this function is called.
74 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
76 * @return @c 0 on success,
77 * otherwise a negative error value
79 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
80 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
82 * @pre media_content_connect()
84 * @see media_content_connect()
87 int media_content_disconnect(void);
90 * @brief Requests to scan a media file.
91 * @details This function requests to scan a media file to the media server.
92 * If media file is not registered to DB yet, that media file information will be added to the media DB. If it is already registered to the DB, then this tries to refresh information. \n
93 * If requested file does not exist on file system, information of the media file will be removed from the media DB. \n
94 * If file information does not exist in DB, this API will be return #MEDIA_CONTENT_ERROR_INVALID_PARAMETER.
96 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
99 * @privilege %http://tizen.org/privilege/content.write \n
100 * %http://tizen.org/privilege/mediastorage \n
101 * %http://tizen.org/privilege/externalstorage
103 * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
104 * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
105 * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
106 * If you can access both storage, you must add all privilege.
108 * @param[in] path The file path
110 * @return @c 0 on success,
111 * otherwise a negative error value
113 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
114 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
115 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
116 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
117 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
118 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
120 * @pre This function requires opened connection to content service by media_content_connect().
121 * @see media_content_connect()
123 int media_content_scan_file(const char *path);
126 * @brief Requests to scan a media folder, asynchronously.
127 * @details This function requests to scan a media folder to the media server with given completed callback function.
128 * media_scan_completed_cb() function will be called when the scanning is finished.
129 * The sub folders are also scanned, if there are sub folders in that folder. \n
130 * If any folder must not be scanned, a blank file ".scan_ignore" has to be created in that folder.
131 * After adding or removing a folder from the filesystem, call this function on its source location
132 * (this will add or remove an entry from the database). \n
133 * After moving or renaming a folder in the filesystem, call this function on its source location
134 * (this will remove an entry from the database) and call this function again on its destination location
135 * (this will add a new entry to the database).\n
136 * Alternatively, you can call this API on any parent of source location and on any parent of destination location.\n
137 * You can also call the function once, on a folder which is a parent of both source and destination.\n
139 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
142 * @privilege %http://tizen.org/privilege/content.write \n
143 * %http://tizen.org/privilege/mediastorage \n
144 * %http://tizen.org/privilege/externalstorage
146 * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
147 * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
148 * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
149 * If you can access both storage, you must add all privilege.
151 * @param[in] path The folder path
152 * @param[in] is_recursive Set @c true to scan recursively subdirectories,
153 * otherwise @c false to scan only the current directory
154 * @param[in] callback The callback to be invoked when the scanning is finished
155 * @param[in] user_data The user data to be passed to the callback function
157 * @return @c 0 on success,
158 * otherwise a negative error value
160 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
161 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
162 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
163 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
164 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
165 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
166 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
168 * @pre This function requires opened connection to content service by media_content_connect().
169 * @see media_scan_completed_cb()
170 * @see media_content_connect()
172 int media_content_scan_folder(const char *path, bool is_recursive, media_scan_completed_cb callback, void *user_data);
175 * @brief Requests to cancel the media folder scanning.
176 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
178 * @param[in] path The folder path
180 * @return @c 0 on success,
181 * otherwise a negative error value
183 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
184 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
185 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
187 * @pre media_content_scan_folder()
189 int media_content_cancel_scan_folder(const char *path);
192 * @brief Subscribes notifications of the media DB change.
193 * @details This function subscribes notifications of the media DB change which are published by the media server or other apps. \n
194 * media_content_db_update_cb() function will be called when notification of the media DB change is subscribed. \n
195 * Using this API, multiple callback is possible to register in one process.
199 * @remarks To release the registered callback, you must use media_content_remove_db_updated_cb() API. \n
200 * If you set the same callback that you previously added, this API returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
202 * @param[in] callback The callback to be invoked when the scanning is finished
203 * @param[in] user_data The user data to be passed to the callback function
204 * @param[out] noti_handle The handle to db updated notification
206 * @return @c 0 on success,
207 * otherwise a negative error value
209 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
210 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
211 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
212 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
214 * @see media_content_db_update_cb()
215 * @see media_content_remove_db_updated_cb()
217 int media_content_add_db_updated_cb(media_content_db_update_cb callback, void *user_data, media_content_noti_h *noti_handle);
221 * @brief Unsubscribes notifications of the media DB change.
222 * @details This function unsubscribes notifications of the media DB change which are published by the media server or other apps.
226 * @param[in] noti_handle The handle to db updated notification
228 * @return @c 0 on success,
229 * otherwise a negative error value
231 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
232 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
234 * @pre media_content_add_db_updated_cb()
236 * @see media_content_add_db_updated_cb()
238 int media_content_remove_db_updated_cb(media_content_noti_h noti_handle);
246 #endif /* __cplusplus */
248 #endif /* __TIZEN_MEDIA_CONTENT_H__ */