include_product/media_content_product.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_PRODUCT_H__
  18 #define __TIZEN_MEDIA_CONTENT_PRODUCT_H__
  19
  20 #include <media_content_type_product.h>
  21 #include <media_pvr.h>
  22 #include <media_uhd.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif /* __cplusplus */
  27
  28 /********** media_content **********/
  29
  30 int media_content_scan_folder_v2(const char *path, bool is_recursive, media_scan_completed_cb_v2 callback, void *user_data);
  31
  32
  33 /********** media_info **********/
  34
  35 int media_info_delete_from_db(const char *media_id);
  36
  37 /**
  38  * @brief Gets the extract_flag of media info.
  39  * @since_tizen 2.3
  40  *
  41  * @remarks You must release @a title using free().
  42  *
  43  * @param[in] media         The media info handle
  44  * @param[out] extract_flag  The extract_flag of the media info
  45  *
  46  * @return @c 0 on success,
  47  *         otherwise a negative error value
  48  *
  49  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  50  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  51  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  52  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  53  */
  54 int media_info_get_extract_flag(media_info_h media, int *extract_flag);
  55 int media_info_get_stitched_state(media_info_h media, int *type_360);
  56 int media_info_get_stitched_engine(media_info_h media, int *type_360);
  57 /**
  58  * @brief Gets the content's played position parameter.
  59  * @details Function returns content's elapsed playback position parameter as period
  60  * starting from the beginning of the track.
  61  *
  62  * @param[in] media The handle to media info
  63  * @param[out] played_position The elapsed time of the content
  64  * @return 0 on success, otherwise a negative error value.
  65  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  66  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  67  */
  68 int media_info_get_played_position(media_info_h media, int *played_position);
  69 /**
  70  * @brief Gets the provider to media info.
  71  *
  72  * @remarks @a modified_month should be released with free() by you.
  73  *
  74  * @param[in] media The handle to media info
  75  * @param[out] category The modified month of media info
  76  * @return 0 on success, otherwise a negative error value.
  77  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  78  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
  79  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  80  *
  81  */
  82 int media_info_get_modified_month(media_info_h media, char **modified_month);
  83
  84 /**
  85  * @brief Gets the played count to content meta handle.
  86  *
  87  * @param[in] media The handle to media info
  88  * @param[out] played_count The played count of content
  89  * @return 0 on success, otherwise a negative error value.
  90  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
  91  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  92  */
  93 int media_info_get_played_count(media_info_h media, int *played_count);
  94
  95 /**
  96  * @brief Sets the played count to content meta handle.
  97  *
  98  * @param[in] media The handle to media info
  99  * @param[in] played_count The played count of content
 100  * @return 0 on success, otherwise a negative error value.
 101  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 102  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 103  * @post media_info_update_to_db()
 104  */
 105 int media_info_set_played_count(media_info_h media, int played_count);
 106
 107 /**
 108  * @brief Sets the played position to content meta handle.
 109  *
 110  * @param[in] media The handle to media info
 111  * @param[in] played_position The played position of content
 112  * @return 0 on success, otherwise a negative error value.
 113  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 114  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 115  * @post media_info_update_to_db()
 116  */
 117 int media_info_set_played_position(media_info_h media, int played_position);
 118
 119 /**
 120  * @brief Gets the content's played time parameter.
 121  * @details Function returns content's elapsed playback time parameter as period
 122  *          starting from the beginning of the track.
 123  *
 124  * @param[in] media The handle to the media info
 125  * @param[out] played_time The elapsed time of the content
 126  *
 127  * @return 0 on success,
 128  *         otherwise a negative error value
 129  *
 130  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 131  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 132  */
 133 int media_info_get_played_time(media_info_h media, time_t *played_time);
 134
 135 /**
 136  * @brief Sets the played time to content meta handle.
 137  * @details You can set the latest played(opened) time of the content file. the latest played time to be set the current time on the system.
 138  *
 139  * @param[in] media The handle to the media info
 140  *
 141  * @return 0 on success,
 142  *         otherwise a negative error value
 143  *
 144  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 145  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 146  *
 147  * @post media_info_update_to_db()
 148  */
 149 int media_info_set_played_time(media_info_h media);
 150
 151
 152 int media_info_get_media_info_by_path_from_db(const char* path, media_info_h* media);
 153
 154
 155 /********** media_folder **********/
 156 int media_folder_get_scan_status(const char *storage_uuid, char* path, media_folder_scan_status_e *scan_status);
 157 int media_folder_reset_scan_status(const char *storage_uuid, const char* path);
 158
 159 /**
 160  * @brief Sets the folder name.
 161  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 162  *
 163  * @param[in] folder The handle to the media folder
 164  * @param[in] name The name of the media folder
 165  *
 166  * @return @c 0 on success,
 167  *         otherwise a negative error value
 168  *
 169  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 170  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 171  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 172  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 173  */
 174 int media_folder_set_name(media_folder_h folder, const char *name);
 175
 176 /**
 177  * @brief Updates the media folder to the media database.
 178  *
 179  * @details The function updates the given media folder in the media database. The function should be called after any change in folder attributes, to be updated to the media
 180  *          database.
 181  *
 182  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 183  *
 184  * @privlevel public
 185  * @privilege %http://tizen.org/privilege/content.write
 186  *
 187  * @param[in] folder The handle to the media folder
 188  *
 189  * @return @c 0 on success,
 190  *         otherwise a negative error value
 191  *
 192  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 193  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 194  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 195  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 196  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 197  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 198  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 199  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 200  *
 201  * @pre This function requires opened connection to content service by media_content_connect().
 202  *
 203  * @see media_content_connect()
 204  * @see media_folder_destroy()
 205  */
 206 int media_folder_update_to_db(media_folder_h folder);
 207
 208 /**
 209  * @brief insert media folder into database by folder path
 210  * @since_tizen 4.0
 211  *
 212  * @param[in] folder path
 213  *
 214  * @return @c 0 on success,
 215  *         otherwise a negative error value
 216  *
 217  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 218  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 219  */
 220 int media_folder_insert_to_db(const char *path);
 221
 222 /********** media_group **********/
 223
 224  /**
 225  * @brief Iterates through the media group with optional @a filter from the media database.
 226  * @details This function gets the names and counts of media group meeting the given filter.
 227  * The callback function will be invoked for every retrieved media group.
 228  * If NULL is passed to the filter, no filtering is applied.
 229  *
 230  * @param[in] filter The handle to media filter
 231  * @param[in] group The type of media group
 232  * @param[in] callback The callback function to invoke
 233  * @param[in] user_data The user data to be passed to the callback function
 234  * @return 0 on success, otherwise a negative error value.
 235  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 236  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 237  * @pre This function requires opened connection to content service by media_content_connect().
 238  * @post This function invokes media_group_cb().
 239  * @see #media_group_and_count_cb
 240  * @see media_content_connect()
 241  * @see media_filter_create()
 242  */
 243 int media_group_foreach_group_and_count_from_db(filter_h filter, media_group_e group, media_group_and_count_cb callback, void *user_data);
 244
 245
 246 /********** media_storage **********/
 247
 248 /**
 249  * @brief Gets the storage scan status of media storage.
 250  * @since_tizen 2.4
 251  *
 252  * @param[in] storage The media storage handle
 253  * @param[out] scan_status  The storage type of the media storage
 254  *
 255  * @return @c 0 on success,
 256  *         otherwise a negative error value
 257  *
 258  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 259  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 260  */
 261 int media_storage_get_scan_status(const char *storage_uuid, media_storage_scan_status_e *scan_status);
 262
 263
 264 #ifdef __cplusplus
 265 }
 266 #endif /* __cplusplus */
 267
 268 #endif /* __TIZEN_MEDIA_CONTENT_PRODUCT_H__ */