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