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.
18 #ifndef __TIZEN_CONTENT_MEDIA_STORAGE_H__
19 #define __TIZEN_CONTENT_MEDIA_STORAGE_H__
22 #include <media_content_type.h>
27 #endif /* __cplusplus */
30 * @file media_storage.h
31 * @brief This file contains API on main functional operations with external storage that are related to media resources in the media database. \n
32 * Operations include: getting number of storages, cloning and destroying storage, getting storage`s ID, name, path and type.
36 * @addtogroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
41 * @brief Gets media storage from database.
42 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
44 * @remarks The @a storage should be released using media_storage_destroy().
46 * @param[in] storage_id The ID of the media storage
47 * @param[out] storage The media storage handle
49 * @return @c 0 on success,
50 * otherwise a negative error value
52 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
53 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
54 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
55 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
56 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
58 * @pre This function requires opened connection to content service by media_content_connect().
60 * @see media_content_connect()
62 int media_storage_get_storage_info_from_db(const char *storage_id, media_storage_h *storage);
65 * @brief Gets the count of media storage for the passed @a filter from the media database.
66 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
68 * @param[in] filter The handle to the media filter
69 * @param[out] storage_count The count of storage
71 * @return @c 0 on success,
72 * otherwise a negative error value
74 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
75 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
76 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
77 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
78 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
80 * @pre This function requires opened connection to content service by media_content_connect().
82 * @see media_content_connect()
84 int media_storage_get_storage_count_from_db(filter_h filter, int *storage_count);
87 * @brief Iterates through media storage from the media database.
88 * @details This function gets all media storage handles meeting the given @a filter.
89 * The @a callback function will be invoked for every retrieved media storage.
90 * If @c NULL is passed to the @a filter, then no filtering is applied.
92 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
94 * @param[in] filter The handle to the media filter
95 * @param[in] callback The callback function to be invoked
96 * @param[in] user_data The user data to be passed to the callback function
98 * @return @c 0 on success,
99 * otherwise a negative error value
101 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
102 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
103 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
104 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
105 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
107 * @pre This function requires opened connection to content service by media_content_connect().
108 * @post This function invokes media_storage_destroy().
110 * @see media_content_connect()
111 * @see media_storage_destroy()
113 int media_storage_foreach_storage_from_db(filter_h filter, media_storage_cb callback, void *user_data);
116 * @brief Gets the count of media files for the passed @a filter in the given @a storage_id from the media database.
117 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
119 * @remarks Use media_info_get_media_count_from_db() if you want to search for internal storage.
121 * @param[in] storage_id The ID of the media storage
122 * @param[in] filter The handle to the media filter
123 * @param[out] media_count The count of media storage items
125 * @return @c 0 on success,
126 * otherwise a negative error value
128 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
129 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
130 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
131 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
133 * @pre This function requires opened connection to content service by media_content_connect().
135 * @see media_content_connect()
137 int media_storage_get_media_count_from_db(const char *storage_id, filter_h filter, int *media_count);
140 * @brief Iterates through the media files with an optional @a filter in the given @a storage_id from the media database.
141 * @details This function gets all media files associated with the given storage and
142 * meeting desired filter option and calls @a callback for
143 * every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
145 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
147 * @remarks Do not call updating DB function like media_info_update_to_db(), media_info_refresh_metadata_to_db(), audio_meta_update_to_db(), image_meta_update_to_db() and video_meta_update_to_db() in your callback function,
148 * your callback function is invoked as inline function. \n
149 * So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
150 * We do not recommend you call updating DB function in callback of foreach function.\n
151 * Use media_info_foreach_media_from_db() if you want to search for internal storage.
153 * @param[in] storage_id The ID of the media storage
154 * @param[in] filter The handle to the media filter
155 * @param[in] callback The callback function to be invoked
156 * @param[in] user_data The user data to be passed to the callback function
158 * @return @c 0 on success,
159 * otherwise a negative error value
161 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
162 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
163 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
164 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
165 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
167 * @pre This function requires opened connection to content service by media_content_connect().
168 * @post This function invokes media_info_cb().
170 * @see #media_info_cb
171 * @see media_content_connect()
172 * @see media_filter_create()
174 int media_storage_foreach_media_from_db(const char *storage_id, filter_h filter, media_info_cb callback, void *user_data);
177 * @brief Destroys media storage handle.
178 * @details The function frees all resources related to the media storage handle. This handle
179 * can no longer be used to perform any operation. New media storage handle has to
180 * be created before the next usage.
182 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
184 * @param[in] storage The media storage handle
186 * @return @c 0 on success,
187 * otherwise a negative error value
189 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
190 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
192 * @pre Get copy of media_storage_h handle by calling media_storage_clone().
194 * @see media_storage_clone()
196 int media_storage_destroy(media_storage_h storage);
199 * @brief Clones the media storage handle.
201 * @details This function copies the media storage handle from a source to the destination.
202 * There is no media_storage_create() function. The media_storage_h is created internally and
203 * available through media storage foreach function such as media_storage_foreach_storage_from_db().
204 * To use this handle outside of these foreach functions, use this function.
206 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
208 * @remarks The @a dst should be released using media_storage_destroy().
210 * @param[out] dst The destination handle to the media storage
211 * @param[in] src The source handle to the media storage
213 * @return @c 0 on success,
214 * otherwise a negative error value
216 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
217 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
218 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
220 * @see media_storage_destroy()
221 * @see media_storage_foreach_storage_from_db()
222 * @see media_storage_get_storage_info_from_db()
224 int media_storage_clone(media_storage_h *dst, media_storage_h src);
227 * @brief Gets the storage id of media storage.
228 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
230 * @remarks The @a storage_id should be released using free().
232 * @param[in] storage The media storage handle
233 * @param[out] storage_id The ID of the media storage
235 * @return @c 0 on success,
236 * otherwise a negative error value
238 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
239 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
240 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
242 int media_storage_get_id(media_storage_h storage, char **storage_id);
245 * @deprecated Deprecated since 4.0.
246 * @brief Gets the storage name of media storage.
247 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
249 * @remarks The @a storage_name should be released using free().
250 * If the requested storage is not the cloud storage, this function returns NULL.
252 * @param[in] storage The media storage handle
253 * @param[out] storage_name The storage name of the media storage
255 * @return @c 0 on success,
256 * otherwise a negative error value
258 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
259 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
260 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
262 int media_storage_get_name(media_storage_h storage, char **storage_name) TIZEN_DEPRECATED_API;
265 * @brief Gets the storage path of media storage.
266 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
268 * @remarks The @a storage_path should be released using free().
270 * @param[in] storage The media storage handle
271 * @param[out] storage_path The storage path of the media storage
273 * @return @c 0 on success,
274 * otherwise a negative error value
276 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
277 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
278 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
280 int media_storage_get_path(media_storage_h storage, char **storage_path);
283 * @brief Gets the storage type of media storage.
284 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
286 * @param[in] storage The media storage handle
287 * @param[out] storage_type The storage type of the media storage
289 * @return @c 0 on success,
290 * otherwise a negative error value
292 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
293 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
295 int media_storage_get_type(media_storage_h storage, media_content_storage_e *storage_type);
303 #endif /* __cplusplus */
305 #endif /* __TIZEN_CONTENT_MEDIA_STORAGE_H__ */