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.
19 #ifndef __TIZEN_MEDIA_BOOKMARK_H__
20 #define __TIZEN_MEDIA_BOOKMARK_H__
22 #include <media_content_type.h>
26 #endif /* __cplusplus */
29 * @file media_bookmark.h
30 * @brief This file contains API on main functional operations with bookmarks that are related to media resources in the media database. \n
31 * Operations include: inserting a new bookmark in media to the media database, removing bookmark from database, \n
32 * getting number of bookmarks, cloning and destroying bookmark, getting bookmark`s ID, time marked parameter and thumbnail.
36 * @addtogroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
41 * @brief Inserts a new bookmark in media on the specified time offset to the media database.
42 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
45 * @privilege %http://tizen.org/privilege/content.write
47 * @param[in] media_id The media ID
48 * @param[in] time The bookmark time offset (in seconds)
49 * @param[in] thumbnail_path The thumbnail path of video bookmark\ n
50 * If the media type is audio, then thumbnail is null.
52 * @return @c 0 on success,
53 * otherwise a negative error value
55 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
56 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
57 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
58 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
59 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
60 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
61 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
63 * @pre This function requires opened connection to content service by media_content_connect().
65 * @see media_content_connect()
66 * @see media_bookmark_delete_from_db()
68 int media_bookmark_insert_to_db(const char *media_id, time_t time, const char *thumbnail_path);
71 * @brief Removes a media bookmark from the media database.
72 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
75 * @privilege %http://tizen.org/privilege/content.write
77 * @param[in] bookmark_id The ID of media bookmark
79 * @return @c 0 on success,
80 * otherwise a negative error value
82 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
83 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
84 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
85 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
86 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
87 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
88 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
90 * @pre This function requires opened connection to content service by media_content_connect().
92 * @see media_content_connect()
93 * @see media_bookmark_insert_to_db()
95 int media_bookmark_delete_from_db(int bookmark_id);
98 * @brief Gets the number of bookmarks with an optional filter from the media database.
99 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
101 * @param[in] filter The handle to the media filter
102 * @param[out] bookmark_count The count of the media bookmark
104 * @return @c 0 on success,
105 * otherwise a negative error value
107 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
108 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
109 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
110 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
111 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
113 * @pre This function requires opened connection to content service by media_content_connect().
115 * @see media_content_connect()
117 int media_bookmark_get_bookmark_count_from_db(filter_h filter, int *bookmark_count);
120 * @brief Iterates through the bookmarks with an optional filter from the media database.
121 * @details This function gets all bookmarks associated with the given filter and calls registered callback function for every retrieved media bookmark.
122 * If @c NULL is passed to the @a filter, then no filtering is applied.
125 * @param[in] filter The handle to the bookmark filter
126 * @param[in] callback The callback function to be invoked
127 * @param[in] user_data The user data to be passed to the callback function
129 * @return @c 0 on success,
130 * otherwise a negative error value
132 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
133 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
134 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
135 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
136 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
137 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
139 * @pre This function requires opened connection to content service by media_content_connect().
140 * @post This function invokes media_bookmark_cb().
142 * @see media_content_connect()
143 * @see media_bookmark_cb()
144 * @see media_filter_create()
146 int media_bookmark_foreach_bookmark_from_db(filter_h filter, media_bookmark_cb callback, void *user_data);
149 * @brief Clones a media bookmark.
150 * @details This function copies the media bookmark handle from a source to destination. There is no media_bookmark_create() function.
151 * The media_bookmark_h is created internally and available through media bookmark foreach function such as media_info_foreach_bookmark_from_db().
152 * To use this handle outside of these foreach functions, use this function.
154 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
156 * @remarks The destination handle must be released using media_bookmark_destroy().
158 * @param[out] dst The destination handle to media bookmark
159 * @param[in] src The source handle to media bookmark
161 * @return @c 0 on success,
162 * otherwise a negative error value
164 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
165 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
166 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
168 * @see media_bookmark_destroy()
169 * @see media_info_foreach_bookmark_from_db()
171 int media_bookmark_clone(media_bookmark_h *dst, media_bookmark_h src);
174 * @brief Destroys a media bookmark.
175 * @details This function frees all the resources related to the bookmark handle. This handle
176 * no longer can be used to perform any operation. A new handle has to
177 * be created before the next use.
179 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
181 * @param[in] bookmark The handle to media bookmark
183 * @return @c 0 on success,
184 * otherwise a negative error value
186 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
187 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
189 * @pre Get copy of bookmark handle by calling media_bookmark_clone().
191 * @see media_bookmark_clone()
193 int media_bookmark_destroy(media_bookmark_h bookmark);
196 * @brief Gets the bookmark ID.
197 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
199 * @param[in] bookmark The handle to media bookmark
200 * @param[out] bookmark_id The media bookmark ID
202 * @return @c 0 on success,
203 * otherwise a negative error value
205 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
206 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
208 int media_bookmark_get_bookmark_id(media_bookmark_h bookmark, int *bookmark_id);
211 * @brief Gets the bookmark time marked parameter.
212 * @details This function returns time offset in seconds from beginning of the movie on which bookmark
215 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
217 * @param[in] bookmark The handle to media bookmark
218 * @param[out] marked_time The bookmark time offset (in seconds)
220 * @return @c 0 on success,
221 * otherwise a negative error value
223 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
224 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
226 int media_bookmark_get_marked_time(media_bookmark_h bookmark, time_t *marked_time);
229 * @brief Gets the media bookmark thumbnail.
230 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
232 * @remarks You must release @a path using free().
234 * @param[in] bookmark The handle to media bookmark
235 * @param[out] path The thumbnail path of media bookmark
237 * @return @c 0 on success,
238 * otherwise a negative error value
240 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
241 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
242 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
244 int media_bookmark_get_thumbnail_path(media_bookmark_h bookmark, char **path);
247 * @brief Gets the media bookmark name which user set.
250 * @remarks You must release @a name using free().
252 * @param[in] bookmark The handle to media bookmark
253 * @param[out] name The name of media bookmark. If name was not set, empty string is returned.
254 * If User set bookmark name to NULL, name will be empty string also.
256 * @return @c 0 on success,
257 * otherwise a negative error value
259 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
260 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
261 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
263 int media_bookmark_get_name(media_bookmark_h bookmark, char **name);
266 * @brief Sets the media bookmark name.
269 * @param[in] bookmark The handle to media bookmark
270 * @param[in] name The name of media bookmark. Can be NULL, empty or non-empty string.
272 * @return @c 0 on success,
273 * otherwise a negative error value
275 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
276 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
277 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
279 * @post media_bookmark_update_to_db()
281 int media_bookmark_set_name(media_bookmark_h bookmark, const char *name);
284 * @brief Updates bookmark information to the media database.
285 * @details The function updates the given bookmark meta in the media database. \n
286 * The function should be called after any change in bookmark attributes, to be updated to the media database. \n
287 * For example, after using media_bookmark_set_name() for setting the name of the bookmark, \n
288 * the media_bookmark_update_to_db() function should be called so as to update the given bookmark attributes in the media database.
292 * @privilege %http://tizen.org/privilege/content.write
294 * @remarks Do not call this function in callback function of foreach function like media_info_foreach_bookmark_from_db().
295 * @param[in] bookmark The handle to media bookmark
297 * @return @c 0 on success,
298 * otherwise a negative error value
300 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
301 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
302 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
303 * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
304 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
305 * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
306 * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
307 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied when Application has no privilege
309 * @pre This function requires opened connection to content service by media_content_connect().
311 * @see media_content_connect()
312 * @see media_bookmark_set_name()
314 int media_bookmark_update_to_db(media_bookmark_h bookmark);
322 #endif /* __cplusplus */
323 #endif /*__TIZEN_MEDIA_BOOKMARK_H__*/