include_product/media_content.h

   1 /*
   2 * Copyright (c) 2011 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 #ifndef __TIZEN_MEDIA_CONTENT_H__
  18 #define __TIZEN_MEDIA_CONTENT_H__
  19
  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>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 /**
  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.
  44  */
  45
  46 /**
  47  * @addtogroup CAPI_MEDIA_CONTENT_MODULE
  48  * @{
  49  */
  50
  51 /**
  52  * @brief Connects to the media content service.
  53  * @details Any media content related function call should be invoked after this function call.
  54  *
  55  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  56  *
  57  * @return @c 0 on success,
  58  *         otherwise a negative error value
  59  *
  60  * @retval #MEDIA_CONTENT_ERROR_NONE      Successful
  61  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
  62  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  63  *
  64  * @post media_content_disconnect()
  65  *
  66  * @see media_content_disconnect()
  67  */
  68 int media_content_connect(void);
  69
  70 /**
  71  * @brief Disconnects from the media content service.
  72  * @details This function closes connection to the media content service. Any further media content related operation
  73  *          cannot be performed after this function is called.
  74  *
  75  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  76  *
  77  * @return @c 0 on success,
  78  *         otherwise a negative error value
  79  *
  80  * @retval #MEDIA_CONTENT_ERROR_NONE      Successful
  81  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
  82  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  83  *
  84  * @pre media_content_connect()
  85  *
  86  * @see media_content_connect()
  87  *
  88  */
  89 int media_content_disconnect(void);
  90
  91 /**
  92  * @brief Requests to scan a media file.
  93  * @details This function requests to scan a media file to the media server.
  94  *          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.
  95  *          If requested file does not exist on file system, information of the media file will be removed from the media DB.
  96  *
  97  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  98  *
  99  * @privlevel public
 100  * @privilege %http://tizen.org/privilege/content.write \n
 101  *                   %http://tizen.org/privilege/mediastorage \n
 102  *                   %http://tizen.org/privilege/externalstorage
 103  *
 104  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
 105  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
 106  *                   Or if you want to access only external storage by using  this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
 107  *                   If you can access both storage, you must add all privilege.
 108  *
 109  * @param[in] path The file path
 110  *
 111  * @return @c 0 on success,
 112  *         otherwise a negative error value
 113  *
 114  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 115  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 116  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 117  *
 118  * @pre This function requires opened connection to content service by media_content_connect().
 119  */
 120 int media_content_scan_file(const char *path);
 121
 122 /**
 123  * @brief Requests to scan a media folder, asynchronously.
 124  * @details This function requests to scan a media folder to the media server with given completed callback function.
 125  *          media_scan_completed_cb() function will be called when the scanning is finished.
 126  *          The sub folders are also scanned, if there are sub folders in that folder. \n
 127  *          If any folder must not be scanned, a blank file ".scan_ignore" has to be created in that folder.
 128  *          After adding or removing a folder from the filesystem, call this function on its source location
 129  *          (this will add or remove an entry from the database). \n
 130  *          After moving or renaming a folder in the filesystem, call this function on its source location
 131  *          (this will remove an entry from the database) and call this function again on its destination location
 132  *          (this will add a new entry to the database).\n
 133  *          Alternatively, you can call this API on any parent of source location and on any parent of destination location.\n
 134  *          You can also call the function once, on a folder which is a parent of both source and destination.\n
 135  *
 136  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 137  *
 138  * @privlevel public
 139  * @privilege %http://tizen.org/privilege/content.write \n
 140  *                   %http://tizen.org/privilege/mediastorage \n
 141  *                   %http://tizen.org/privilege/externalstorage
 142  *
 143  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
 144  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
 145  *                   Or if you want to access only external storage by using  this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
 146  *                   If you can access both storage, you must add all privilege.
 147  *
 148  * @param[in] path         The folder path
 149  * @param[in] is_recursive Set @c true to scan recursively subdirectories,
 150  *                         otherwise @c false to scan only the current directory
 151  * @param[in] callback     The callback to be invoked when the scanning is finished
 152  * @param[in] user_data    The user data to be passed to the callback function
 153  *
 154  * @return @c 0 on success,
 155  *         otherwise a negative error value
 156  *
 157  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 158  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 159  *
 160  * @see media_scan_completed_cb()
 161  */
 162 int media_content_scan_folder(const char *path, bool is_recursive, media_scan_completed_cb callback, void *user_data);
 163
 164 /**
 165  * @brief Requests to cancel the media folder scanning.
 166  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 167  *
 168  * @param[in] path         The folder path
 169  *
 170  * @return @c 0 on success,
 171  *         otherwise a negative error value
 172  *
 173  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 174  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 175  *
 176  * @pre media_content_scan_folder()
 177  */
 178 int media_content_cancel_scan_folder(const char *path);
 179
 180 /**
 181  * @deprecated Deprecated since 3.0. Use media_content_add_db_updated_cb() instead.
 182  * @brief Subscribes notifications of the media DB change.
 183  * @details This function subscribes notifications of the media DB change which are published by the media server or other apps.
 184  *          media_content_db_update_cb() function will be called when notification of the media DB change is subscribed.
 185  *
 186  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 187  *
 188  * @param[in] callback  The callback to be invoked when the scanning is finished
 189  * @param[in] user_data The user data to be passed to the callback function
 190  *
 191  * @return @c 0 on success,
 192  *         otherwise a negative error value
 193  *
 194  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 195  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 196  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 197  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 198  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 199  *
 200  * @see media_content_db_update_cb()
 201  * @see media_content_unset_db_updated_cb()
 202  */
 203 int media_content_set_db_updated_cb(media_content_db_update_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 204
 205 /**
 206  * @deprecated Deprecated since 3.0. Use media_content_remove_db_updated_cb() instead.
 207  * @brief Unsubscribes notifications of the media DB change.
 208  * @details This function unsubscribes notifications of the media DB change which are published by the media server or other apps.
 209  *
 210  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 211  *
 212  * @return @c 0 on success,
 213  *         otherwise a negative error value
 214  *
 215  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 216  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 217  *
 218  * @pre media_content_set_db_updated_cb()
 219  *
 220  * @see media_content_set_db_updated_cb()
 221  */
 222 int media_content_unset_db_updated_cb(void) TIZEN_DEPRECATED_API;
 223
 224 /**
 225  * @brief Subscribes notifications of the media DB change.
 226  * @details This function subscribes notifications of the media DB change which are published by the media server or other apps. \n
 227  *          media_content_db_update_cb() function will be called when notification of the media DB change is subscribed. \n
 228  *          Using this API, multiple callback is possible to register in one process.
 229  *
 230  * @since_tizen 3.0
 231  *
 232  * @remarks  To release the registered callback, you must use media_content_remove_db_updated_cb() API. \n
 233  *                    media_content_unset_db_updated_cb() API can not release the callbacks added by this API. \n
 234  *                    If you set the same callback that you previously added, this API returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
 235  *
 236  * @param[in] callback  The callback to be invoked when the scanning is finished
 237  * @param[in] user_data The user data to be passed to the callback function
 238  * @param[out] noti_handle The handle to db updated notification
 239  *
 240  * @return @c 0 on success,
 241  *         otherwise a negative error value
 242  *
 243  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 244  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 245  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 246  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 247  *
 248  * @see media_content_db_update_cb()
 249  * @see media_content_remove_db_updated_cb()
 250  */
 251 int media_content_add_db_updated_cb(media_content_db_update_cb callback, void *user_data, media_content_noti_h *noti_handle);
 252
 253
 254 /**
 255  * @brief Unsubscribes notifications of the media DB change.
 256  * @details This function unsubscribes notifications of the media DB change which are published by the media server or other apps.
 257  *
 258  * @since_tizen 3.0
 259  *
 260  * @param[in] noti_handle The handle to db updated notification
 261  *
 262  * @return @c 0 on success,
 263  *         otherwise a negative error value
 264  *
 265  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 266  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 267  *
 268  * @pre media_content_add_db_updated_cb()
 269  *
 270  * @see media_content_add_db_updated_cb()
 271  */
 272 int media_content_remove_db_updated_cb(media_content_noti_h noti_handle);
 273
 274 /**
 275  * @}
 276  */
 277
 278 #ifdef __cplusplus
 279 }
 280 #endif /* __cplusplus */
 281
 282 #endif /* __TIZEN_MEDIA_CONTENT_H__ */