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_CONTENT_TYPE_H__
19 #define __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
26 #endif /* __cplusplus */
29 * @file media_content_type.h
30 * @brief This file contains API related to media-content enumerations for media data types, groups, orientations, \n
31 * classes of errors and definitions of media-data. \n
32 * Listed APIs are called when iterating over lists of album, group, bookmark and other media, \n
33 * when media items are inserted completely and when notification of media DB change is subscribed.
37 * @addtogroup CAPI_MEDIA_CONTENT_MODULE
42 * @ingroup CAPI_MEDIA_CONTENT_MODULE
43 * @brief Enumeration for the media file format.
44 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
45 * @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n
46 * %http://tizen.org/feature/content.scanning.others\n
47 * If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
50 MEDIA_CONTENT_TYPE_IMAGE = 0, /**<The type of an image */
51 MEDIA_CONTENT_TYPE_VIDEO = 1, /**<The type of a video */
52 MEDIA_CONTENT_TYPE_SOUND = 2, /**<The type of sound */
53 MEDIA_CONTENT_TYPE_MUSIC = 3, /**<The type of music */
54 MEDIA_CONTENT_TYPE_OTHERS = 4, /**<The type of other */
55 MEDIA_CONTENT_TYPE_BOOK = 5, /**<The type of book (Since 6.5)*/
56 MEDIA_CONTENT_TYPE_PVR = 1001, /**<The type of PVR */
57 MEDIA_CONTENT_TYPE_UHD = 1002, /**<The type of UHD */
58 MEDIA_CONTENT_TYPE_SCSA = 1003, /**<The type of SCSA */
59 MEDIA_CONTENT_TYPE_APK = 1004, /**<The type of ARK*/
60 MEDIA_CONTENT_TYPE_DOC = 1005, /**<The type of DOC*/
61 } media_content_type_e;
64 * @ingroup CAPI_MEDIA_CONTENT_MODULE
65 * @brief Enumeration for media content DB update items.
66 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
69 MEDIA_ITEM_FILE = 0, /**< File type, an item updated to DB */
70 MEDIA_ITEM_DIRECTORY = 1, /**< Directory type, an item updated to DB */
71 MEDIA_ITEM_STORAGE = 2, /**< Storage type, an item updated to DB */
72 } media_content_db_update_item_type_e;
75 * @ingroup CAPI_MEDIA_CONTENT_MODULE
76 * @brief Enumeration for media content DB update types.
77 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
80 MEDIA_CONTENT_INSERT = 0, /**< Insert, the type of DB update */
81 MEDIA_CONTENT_DELETE = 1, /**< Delete, The type of DB update */
82 MEDIA_CONTENT_UPDATE = 2, /**< Update, The type of DB update */
83 } media_content_db_update_type_e;
86 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
87 * @brief Enumeration for orientation types.
88 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
91 MEDIA_CONTENT_ORIENTATION_NOT_AVAILABLE = 0, /**< Not available*/
92 MEDIA_CONTENT_ORIENTATION_NORMAL = 1, /**< Normal*/
93 MEDIA_CONTENT_ORIENTATION_HFLIP = 2, /**< Flip horizontal*/
94 MEDIA_CONTENT_ORIENTATION_ROT_180 = 3, /**< Rotate 180 degrees*/
95 MEDIA_CONTENT_ORIENTATION_VFLIP = 4, /**< Flip vertical*/
96 MEDIA_CONTENT_ORIENTATION_TRANSPOSE = 5, /**< Transpose*/
97 MEDIA_CONTENT_ORIENTATION_ROT_90 = 6, /**< Rotate 90 degrees*/
98 MEDIA_CONTENT_ORIENTATION_TRANSVERSE = 7, /**< Transverse*/
99 MEDIA_CONTENT_ORIENTATION_ROT_270 = 8, /**< Rotate 270 degrees*/
100 } media_content_orientation_e;
103 * @ingroup CAPI_MEDIA_CONTENT_MODULE
104 * @brief Enumeration for ordering.
105 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
108 MEDIA_CONTENT_ORDER_ASC = 0, /**< Ascending order*/
109 MEDIA_CONTENT_ORDER_DESC = 1, /**< Descending order*/
110 MEDIA_CONTENT_ORDER_OTHER = 2, /**< order by order key**/
111 } media_content_order_e;
114 * @ingroup CAPI_MEDIA_CONTENT_MODULE
115 * @brief Enumeration for collations.
116 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
119 MEDIA_CONTENT_COLLATE_DEFAULT = 0, /**< Default collation BINARY */
120 MEDIA_CONTENT_COLLATE_NOCASE = 1, /**< Collation NOCASE, not case sensitive */
121 MEDIA_CONTENT_COLLATE_RTRIM = 2, /**< Collation RTRIM, trailing space characters are ignored */
122 MEDIA_CONTENT_COLLATE_LOCALIZED = 3, /**< Collation LOCALIZATION, NOCASE also applied */
123 } media_content_collation_e;
126 * @brief Error class.
127 * @details Class for Media Content error
128 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
131 #define MEDIA_CONTENT_ERROR_CLASS TIZEN_ERROR_MEDIA_CONTENT
134 * @ingroup CAPI_MEDIA_CONTENT_MODULE
135 * @brief Enumeration for a media content error.
136 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
139 MEDIA_CONTENT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
140 MEDIA_CONTENT_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
141 MEDIA_CONTENT_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
142 MEDIA_CONTENT_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid Operation */
143 MEDIA_CONTENT_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on device */
144 MEDIA_CONTENT_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
145 MEDIA_CONTENT_ERROR_DB_FAILED = MEDIA_CONTENT_ERROR_CLASS | 0x01, /**< DB operation failed */
146 MEDIA_CONTENT_ERROR_DB_BUSY = MEDIA_CONTENT_ERROR_CLASS | 0x02, /**< DB operation BUSY */
147 MEDIA_CONTENT_ERROR_NETWORK = MEDIA_CONTENT_ERROR_CLASS | 0x03, /**< Network Fail */
148 MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT = MEDIA_CONTENT_ERROR_CLASS | 0x04, /**< Unsupported Content */
149 MEDIA_CONTENT_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
150 } media_content_error_e;
153 * @ingroup CAPI_MEDIA_CONTENT_MODULE
154 * @brief Enumeration for a media group.
155 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
158 MEDIA_CONTENT_GROUP_DISPLAY_NAME = 0, /**< Media group ID for display name */
159 MEDIA_CONTENT_GROUP_TYPE, /**< Media group ID for a media type */
160 MEDIA_CONTENT_GROUP_MIME_TYPE, /**< Media group ID for a mime type */
161 MEDIA_CONTENT_GROUP_SIZE, /**< Media group ID for content size */
162 MEDIA_CONTENT_GROUP_ADDED_TIME, /**< Media group ID for the added time */
163 MEDIA_CONTENT_GROUP_MODIFIED_TIME, /**< Media group ID for the modified time */
164 MEDIA_CONTENT_GROUP_TITLE, /**< Media group ID for a content title */
165 MEDIA_CONTENT_GROUP_ARTIST, /**< Media group ID for an artist*/
166 MEDIA_CONTENT_GROUP_ALBUM_ARTIST, /**< Media group ID for an album artist */
167 MEDIA_CONTENT_GROUP_GENRE, /**< Media group ID for a genre*/
168 MEDIA_CONTENT_GROUP_COMPOSER, /**< Media group ID for a composer*/
169 MEDIA_CONTENT_GROUP_YEAR, /**< Media group ID for a year*/
170 MEDIA_CONTENT_GROUP_RECORDED_DATE, /**< Media group ID for the recorded date*/
171 MEDIA_CONTENT_GROUP_COPYRIGHT, /**< Media group ID for the copyright*/
172 MEDIA_CONTENT_GROUP_TRACK_NUM, /**< Media group ID for a track number*/
173 MEDIA_CONTENT_GROUP_DESCRIPTION, /**< Media group ID for a description */
174 MEDIA_CONTENT_GROUP_LONGITUDE, /**< Media group ID for the longitude*/
175 MEDIA_CONTENT_GROUP_LATITUDE, /**< Media group ID for the latitude*/
176 MEDIA_CONTENT_GROUP_ALTITUDE, /**< Media group ID for the altitude*/
177 MEDIA_CONTENT_GROUP_RATING = 20, /**< Media group ID for a rating*/
178 MEDIA_CONTENT_GROUP_MODIFIED_MONTH = 29, /**< Media group ID for the modified time*/
179 MEDIA_CONTENT_GROUP_MODIFIED_DATE, /**< Media group ID for the modified date*/
180 MEDIA_CONTENT_GROUP_ALBUM,
181 MEDIA_CONTENT_GROUP_MAX, /**< Invalid media group ID*/
182 MEDIA_PVR_GROUP_DURATION,
183 MEDIA_PVR_GROUP_TIME_ZONE,
185 MEDIA_PVR_GROUP_MAJOR,
186 MEDIA_PVR_GROUP_MINOR,
187 MEDIA_PVR_GROUP_CHANNEL_TYPE,
188 MEDIA_PVR_GROUP_CHANNEL_NAME,
189 MEDIA_PVR_GROUP_CHANNEL_NUM,
190 MEDIA_PVR_GROUP_PROGRAM_TITLE,
191 MEDIA_PVR_GROUP_PROGRAM_NUM,
192 MEDIA_PVR_GROUP_PROGRAM_CRID,
193 MEDIA_PVR_GROUP_GUIDANCE,
194 MEDIA_PVR_GROUP_SYNOPSIS,
195 MEDIA_PVR_GROUP_GENRE,
196 MEDIA_PVR_GROUP_LANGUAGE,
197 MEDIA_PVR_GROUP_EMBARGO_TIME,
198 MEDIA_PVR_GROUP_EXPIRY_TIME,
199 MEDIA_PVR_GROUP_START_TIME,
200 MEDIA_PVR_GROUP_PROGRAM_START_TIME,
201 MEDIA_PVR_GROUP_PROGRAM_END_TIME,
202 MEDIA_PVR_GROUP_PROGRAM_DATE,
203 MEDIA_PVR_GROUP_PARENTAL_RATING,
204 MEDIA_PVR_GROUP_TIMER_RECORD,
205 MEDIA_PVR_GROUP_SERIES_RECORD,
207 MEDIA_PVR_GROUP_SUBTITLE,
210 MEDIA_PVR_GROUP_HARDOF_HEARINGRADIO,
211 MEDIA_PVR_GROUP_DATA_SERVICE,
212 MEDIA_PVR_GROUP_CONTENT_LOCK,
213 MEDIA_PVR_GROUP_CONTENT_WATCH,
214 MEDIA_PVR_GROUP_HAS_AUDIO_ONLY,
215 MEDIA_PVR_GROUP_IS_LOCAL_RECORDED,
216 MEDIA_PVR_GROUP_RESOLUTION,
217 MEDIA_PVR_GROUP_ASPECTRATIO,
218 MEDIA_PVR_GROUP_MODIFIED_MONTH,
219 MEDIA_PVR_GROUP_MODIFIED_DATE,
220 MEDIA_PVR_GROUP_SPORTS_TYPE,
221 MEDIA_PVR_GROUP_GUIDANCE_LENGTH,
222 MEDIA_PVR_GROUP_TVMODE,
223 MEDIA_PVR_GROUP_PLAY_COUNT,
224 MEDIA_PVR_GROUP_PRIVATE_DATA,
226 MEDIA_UHD_GROUP_CONTENT_TITLE,
227 MEDIA_UHD_GROUP_RELEASE_DATE,
228 MEDIA_UHD_GROUP_SUB_TYPE,
229 MEDIA_UHD_GROUP_FILE_NAME,
230 MEDIA_UHD_GROUP_PLAYED_COUNT,
236 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
237 * @brief The structure type for the Media info handle.
238 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
240 typedef struct media_info_s *media_info_h;
243 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
244 * @brief The structure type for the Media folder handle.
245 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
247 typedef struct media_folder_s *media_folder_h;
250 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
251 * @brief The structure type for the Media playlist handle.
252 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
254 typedef struct media_playlist_s *media_playlist_h;
257 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
258 * @brief The structure type for the Media tag handle.
259 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
261 typedef struct media_tag_s *media_tag_h;
264 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
265 * @brief The structure type for the Media bookmark handle.
266 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
268 typedef struct media_bookmark_s *media_bookmark_h;
271 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
272 * @brief The structure type for the Media album handle.
273 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
275 typedef struct media_album_s *media_album_h;
278 * @ingroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE
279 * @brief The structure type for the Image metadata handle.
280 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
282 typedef struct image_meta_s *image_meta_h;
285 * @ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
286 * @brief The structure type for the Video metadata handle.
287 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
289 typedef struct video_meta_s *video_meta_h;
292 * @ingroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE
293 * @brief The structure type for the Audio metadata handle.
294 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
296 typedef struct audio_meta_s *audio_meta_h;
299 * @ingroup CAPI_CONTENT_MEDIA_BOOK_META_MODULE
300 * @brief The structure type for the Book metadata handle.
303 typedef struct book_meta_s *book_meta_h;
306 * @ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
307 * @brief The structure type for the Media filter handle.
308 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
310 typedef struct filter_s *filter_h;
313 * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
314 * @brief The structure type for the Media face handle.
317 typedef void *media_face_h;
320 * @ingroup CAPI_MEDIA_CONTENT_MODULE
321 * @brief The structure type for the Media content noti handle.
324 typedef void *media_content_noti_h;
327 * @ingroup CAPI_MEDIA_CONTENT_MODULE
328 * @brief Called when the media scanning is finished.
329 * @details The following error codes can be received: \n
330 * #MEDIA_CONTENT_ERROR_NONE : Success \n
331 * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
332 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
333 * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
334 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
335 * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
336 * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
337 * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
338 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
339 * @remarks The callback is called in a separate thread(not in the main loop).
341 * @param[in] error The error code
342 * @param[in] user_data The user data passed from the foreach function
344 * @pre media_content_scan_folder().
345 * @see media_content_scan_folder()
347 typedef void (*media_scan_completed_cb)(media_content_error_e error, void * user_data);
350 * @ingroup CAPI_MEDIA_CONTENT_MODULE
351 * @brief Called when the notification of the media DB change is subscribed.
352 * @details The following error codes can be received: \n
353 * #MEDIA_CONTENT_ERROR_NONE : Success \n
354 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
356 * @remarks The callback is called in a separate thread(not in the main loop).
358 * @param[in] error The error code
359 * @param[in] pid The PID which publishes notification
360 * @param[in] update_item The update item of notification
361 * @param[in] update_type The update type of notification
362 * @param[in] media_type The type of the media content (#media_content_type_e)
363 * @param[in] uuid The ID of media or directory, which is updated
364 * @param[in] path The path of the media or directory
365 * @param[in] mime_type The MIME of the media info
366 * @param[in] user_data The user data passed from the foreach function
368 * @pre media_content_add_db_updated_cb().
369 * @see media_content_add_db_updated_cb()
371 typedef void (*media_content_db_update_cb)(
372 media_content_error_e error,
374 media_content_db_update_item_type_e update_item,
375 media_content_db_update_type_e update_type,
376 media_content_type_e media_type,
384 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
385 * @brief Called for every available media info.
386 * @details Iterates over a list of media info.
387 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
389 * @remarks To use the @a media outside this function, copy the handle with media_info_clone() function. \n
390 * The callback is called in the main loop.
392 * @param[in] media The handle to the media info
393 * @param[in] user_data The user data passed from the foreach function
395 * @return @c true to continue with the next iteration of the loop,
396 * otherwise @c false to break out of the loop
398 * @pre media_tag_foreach_media_from_db(), media_playlist_foreach_media_from_db(), media_genre_foreach_media_from_db(),
399 * media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
401 * @see media_info_clone()
402 * @see media_album_foreach_media_from_db()
403 * @see media_playlist_foreach_media_from_db()
404 * @see media_tag_foreach_media_from_db()
405 * @see media_info_foreach_media_from_db()
406 * @see media_folder_foreach_media_from_db()
408 typedef bool (*media_info_cb)(media_info_h media, void *user_data);
412 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
413 * @brief Called when media items are inserted completely.
414 * @details The following error codes can be received: \n
415 * #MEDIA_CONTENT_ERROR_NONE : Success \n
416 * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
417 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
418 * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
419 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
420 * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
421 * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
422 * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
423 * #MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported \n
424 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
426 * @remarks The callback is called in a separate thread(not in the main loop).
428 * @param[in] error The error code
429 * @param[in] user_data The user data passed from the foreach function
431 * @pre media_info_insert_batch_to_db()
432 * @see media_info_insert_batch_to_db()
434 typedef void (*media_insert_completed_cb)(media_content_error_e error, void * user_data);
437 * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
438 * @brief Called when face detection on the image is completed.
440 * @details The following error codes can be delivered. \n
441 * #MEDIA_CONTENT_ERROR_NONE, \n
442 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY, \n
443 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n
444 * #MEDIA_CONTENT_ERROR_DB_FAILED, \n
445 * #MEDIA_CONTENT_ERROR_DB_BUSY, \n
446 * #MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
450 * @remarks The callback is called in a separate thread(not in the main loop).
452 * @param[in] error The error code
453 * @param[in] face_count The number of all detected faces
454 * @param[in] user_data The user data passed from the foreach function
456 * @pre media_info_start_face_detection()
457 * @see media_info_start_face_detection()
459 typedef void (*media_face_detection_completed_cb)(media_content_error_e error, const int face_count, void *user_data);
463 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
464 * @brief Called for every available media folder.
465 * @details Iterates over a list of folders.
467 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
469 * @remarks To use the @a folder outside this function, copy the handle with the media_folder_clone() function. \n
470 * The callback is called in the main loop.
472 * @param[in] folder The handle to the media folder
473 * @param[in] user_data The user data passed from the foreach function
475 * @return @c true to continue with the next iteration of the loop,
476 * otherwise @c false to break out of the loop
478 * @pre media_folder_foreach_folder_from_db() will invoke this function.
479 * @see media_folder_clone()
480 * @see media_folder_foreach_folder_from_db()
482 typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
485 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
486 * @brief Called for every playlist in the obtained list of playlists.
487 * @details Iterates over a playlist list.
489 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
491 * @remarks To use the @a playlist outside this function, copy the handle with the media_playlist_clone() function. \n
492 * The callback is called in the main loop.
494 * @param[in] playlist The handle to the media playlist
495 * @param[in] user_data The user data passed from the foreach function
497 * @return @c true to continue with the next iteration of the loop,
498 * otherwise @c false to break out of the loop
500 * @pre media_playlist_foreach_playlist_from_db() will invoke this function.
502 * @see media_playlist_clone()
503 * @see media_playlist_foreach_playlist_from_db()
505 typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
508 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
509 * @brief Called for every media info with playlist member ID in the obtained list of media info.
510 * @details Iterates over playlist members.
512 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
514 * @remarks To use the @a media outside this function, copy the handle with the media_info_clone() function. \n
515 * The callback is called in the main loop.
517 * @param[in] playlist_member_id The ID of the playlist member
518 * @param[in] media The handle to the media info
519 * @param[in] user_data The user data passed from the foreach function
521 * @return @c true to continue with the next iteration of the loop,
522 * otherwise @c false to break out of the loop
524 * @pre media_playlist_foreach_media_from_db() will invoke this function.
526 * @see media_info_clone()
527 * @see media_playlist_foreach_media_from_db()
529 typedef bool (*playlist_member_cb)(int playlist_member_id, media_info_h media, void *user_data);
532 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
533 * @brief Called for every tag in the obtained list of tags.
534 * @details Iterates over a list of tags.
536 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
538 * @remarks To use the @a tag outside this function, copy the handle with the media_tag_clone() function. \n
539 * The callback is called in the main loop.
541 * @param[in] tag The handle to the media tag
542 * @param[in] user_data The user data passed from the foreach function
544 * @return @c true to continue with the next iteration of the loop,
545 * otherwise @c false to break out of the loop
547 * @pre media_tag_foreach_tag_from_db(), media_info_foreach_tag_from_db() will invoke this function.
549 * @see media_tag_clone()
550 * @see media_tag_foreach_tag_from_db()
551 * @see media_info_foreach_tag_from_db()
553 typedef bool (*media_tag_cb)(media_tag_h tag, void *user_data);
556 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
557 * @brief Called for every bookmark in the obtained list of bookmarks.
558 * @details Iterates over a bookmark list.
560 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
562 * @remarks To use the @a bookmark outside this function, copy the handle with the media_bookmark_clone() function. \n
563 * The callback is called in the main loop.
565 * @param[in] bookmark The handle to the media bookmark
566 * @param[in] user_data The user data passed from the foreach function
568 * @return @c true to continue with the next iteration of the loop,
569 * otherwise @c false to break out of the loop
571 * @pre media_info_foreach_bookmark_from_db() will invoke this function.
572 * @see media_info_foreach_bookmark_from_db()
574 typedef bool (*media_bookmark_cb)(media_bookmark_h bookmark, void *user_data);
577 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
578 * @brief Called for every album in the obtained list of groups.
579 * @details Iterates over an album list.
581 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
583 * @remarks To use the @a album outside this function, copy the handle with the media_album_clone() function. \n
584 * The callback is called in the main loop.
586 * @param[in] album The handle to the media album
587 * @param[in] user_data The user data passed from the foreach function
589 * @return @c true to continue with the next iteration of the loop,
590 * otherwise @c false to break out of the loop
592 * @pre media_album_foreach_album_from_db() will invoke this function.
594 * @see media_album_clone()
595 * @see media_album_foreach_album_from_db()
597 typedef bool (*media_album_cb)(media_album_h album, void *user_data);
600 * @ingroup CAPI_CONTENT_MEDIA_GROUP_MODULE
601 * @brief Called for every group in the obtained list of groups.
602 * @details Iterates over a media group list.
604 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
606 * @remarks You should not free @a group_name returned by this function. \n
607 * The callback is called in the main loop.
609 * @param[in] group_name The name of the media group
610 * @param[in] user_data The user data passed from the foreach function
612 * @return @c true to continue with the next iteration of the loop,
613 * otherwise @c false to break out of the loop
615 * @pre media_group_foreach_group_from_db() will invoke this function.
616 * @see media_group_foreach_group_from_db()
618 typedef bool (*media_group_cb)(const char *group_name, void *user_data);
621 * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
622 * @brief Called for every face in the obtained list of face.
623 * @details Iterates over a media face list.
627 * @remarks You should not destroy @a face returned by this function. \n
628 * The callback is called in the main loop.
630 * @param[in] face The handle of the media face
631 * @param[in] user_data The user data passed from the foreach function
633 * @return @c true to continue with the next iteration of the loop,
634 * otherwise @c false to break out of the loop
636 * @pre media_info_foreach_face_from_db() will invoke this function.
637 * @see media_info_foreach_face_from_db()
639 typedef bool (*media_face_cb)(media_face_h face, void *user_data);
646 * @addtogroup CAPI_CONTENT_MEDIA_FILTER_MODULE
652 * @details You can use above define to set the condition of media filter and order keyword.
653 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
656 #define MEDIA_ID "MEDIA_ID"
659 * @brief Media full path.
660 * @details You can use above define to set the condition of media filter and order keyword.
661 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
664 #define MEDIA_PATH "MEDIA_PATH"
667 * @brief The file name including the extension.
668 * @details You can use above define to set the condition of media filter and order keyword.
669 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
672 #define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
676 * @details There are 5 media types:\n
677 * 0-image, 1-video, 2-sound, 3-music, 4-other\n
678 * You can use above define to set the condition of media filter and order keyword.
679 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
682 #define MEDIA_TYPE "MEDIA_TYPE"
685 * @brief Media MIME type.
686 * @details You can use above define to set the condition of media filter and order keyword.
687 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
690 #define MEDIA_MIME_TYPE "MEDIA_MIME_TYPE"
694 * @brief Media file size.
695 * @details You can use above define to set the condition of media filter and order keyword.
696 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
699 #define MEDIA_SIZE "MEDIA_SIZE"
702 * @brief The time that content file was first added to media database.
703 * @details You can use above define to set the condition of media filter and order keyword.
704 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
707 #define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
710 * @brief The last modification time provided by the file system.
711 * @details You can use above define to set the condition of media filter and order keyword.
712 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
715 #define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
718 * @brief Media created time.
719 * @details You can use above define to set the condition of media filter and order keyword.
720 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
723 #define MEDIA_TIMELINE "MEDIA_TIMELINE"
726 * @brief Media thumbnail path.
727 * @details You can use above define to set the condition of media filter and order keyword.
728 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
731 #define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
734 * @brief Media title get from tag or file name.
735 * @details You can use above define to set the condition of media filter and order keyword.
736 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
739 #define MEDIA_TITLE "MEDIA_TITLE"
742 * @brief Media album name.
743 * @details You can use above define to set the condition of media filter and order keyword.
744 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
747 #define MEDIA_ALBUM "MEDIA_ALBUM"
750 * @brief Media artist.
751 * @details You can use above define to set the condition of media filter and order keyword.
752 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
755 #define MEDIA_ARTIST "MEDIA_ARTIST"
758 * @brief Media album artist.
759 * @details You can use above define to set the condition of media filter and order keyword.
760 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
763 #define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
766 * @brief Media genre.
767 * @details You can use above define to set the condition of media filter and order keyword.
768 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
771 #define MEDIA_GENRE "MEDIA_GENRE"
774 * @brief Media composer.
775 * @details You can use above define to set the condition of media filter and order keyword.
776 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
779 #define MEDIA_COMPOSER "MEDIA_COMPOSER"
783 * @details You can use above define to set the condition of media filter and order keyword.
784 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
787 #define MEDIA_YEAR "MEDIA_YEAR"
790 * @brief Media recorded date.
791 * @details You can use above define to set the condition of media filter and order keyword.
792 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
795 #define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
798 * @brief Media track number.
799 * @details You can use above define to set the condition of media filter and order keyword.
800 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
803 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
806 * @brief Media duration.
807 * @details You can use above define to set the condition of media filter and order keyword.
808 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
811 #define MEDIA_DURATION "MEDIA_DURATION"
814 * @brief Media longitude.
815 * @details You can use above define to set the condition of media filter and order keyword.
816 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
819 #define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
822 * @brief Media latitude.
823 * @details You can use above define to set the condition of media filter and order keyword.
824 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
827 #define MEDIA_LATITUDE "MEDIA_LATITUDE"
830 * @brief Media altitude.
831 * @details You can use above define to set the condition of media filter and order keyword.
832 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
835 #define MEDIA_ALTITUDE "MEDIA_ALTITUDE"
838 * @brief Media width.
839 * @details You can use above define to set the condition of media filter and order keyword.
840 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
843 #define MEDIA_WIDTH "MEDIA_WIDTH"
846 * @brief Media height.
847 * @details You can use above define to set the condition of media filter and order keyword.
848 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
851 #define MEDIA_HEIGHT "MEDIA_HEIGHT"
854 * @brief Media datetaken.
855 * @details You can use above define to set the condition of media filter and order keyword.
856 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
859 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
862 * @brief The time to register favourite.
863 * @details You can use above define to set the condition of media filter and order keyword.
864 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
867 #define MEDIA_FAVOURITE "MEDIA_FAVOURITE"
871 * @details There are 2 types:\n
873 * You can use above define to set the condition of media filter and order keyword.
874 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
877 #define MEDIA_IS_DRM "MEDIA_IS_DRM"
880 * @deprecated Deprecated since 7.0.
881 * @brief Media file name pinyin.
882 * @details You can use above define to set the condition of media filter and order keyword.
883 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
884 * @remarks Since 4.0, this keyword is related to the following feature:\n
885 * - %http://tizen.org/feature/content.filter.pinyin\n
886 * If this feature is not supported on the device, PINYIN search does not work.
889 #define MEDIA_FILE_NAME_PINYIN "MEDIA_FILE_NAME_PINYIN"
892 * @deprecated Deprecated since 7.0.
893 * @brief Media title pinyin.
894 * @details You can use above define to set the condition of media filter and order keyword.
895 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
896 * @remarks Since 4.0, this keyword is related to the following feature:\n
897 * - %http://tizen.org/feature/content.filter.pinyin\n
898 * If this feature is not supported on the device, PINYIN search does not work.
901 #define MEDIA_TITLE_PINYIN "MEDIA_TITLE_PINYIN"
904 * @deprecated Deprecated since 7.0.
905 * @brief Media album pinyin.
906 * @details You can use above define to set the condition of media filter and order keyword.
907 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
908 * @remarks Since 4.0, this keyword is related to the following feature:\n
909 * - %http://tizen.org/feature/content.filter.pinyin\n
910 * If this feature is not supported on the device, PINYIN search does not work.
913 #define MEDIA_ALBUM_PINYIN "MEDIA_ALBUM_PINYIN"
916 * @deprecated Deprecated since 7.0.
917 * @brief Media artist pinyin.
918 * @details You can use above define to set the condition of media filter and order keyword.
919 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
920 * @remarks Since 4.0, this keyword is related to the following feature:\n
921 * - %http://tizen.org/feature/content.filter.pinyin\n
922 * If this feature is not supported on the device, PINYIN search does not work.
925 #define MEDIA_ARTIST_PINYIN "MEDIA_ARTIST_PINYIN"
928 * @deprecated Deprecated since 7.0.
929 * @brief Media album artist pinyin.
930 * @details You can use above define to set the condition of media filter and order keyword.
931 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
932 * @remarks Since 4.0, this keyword is related to the following feature:\n
933 * - %http://tizen.org/feature/content.filter.pinyin\n
934 * If this feature is not supported on the device, PINYIN search does not work.
937 #define MEDIA_ALBUM_ARTIST_PINYIN "MEDIA_ALBUM_ARTIST_PINYIN"
940 * @deprecated Deprecated since 7.0.
941 * @brief Media genre pinyin.
942 * @details You can use above define to set the condition of media filter and order keyword.
943 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
944 * @remarks Since 4.0, this keyword is related to the following feature:\n
945 * - %http://tizen.org/feature/content.filter.pinyin\n
946 * If this feature is not supported on the device, PINYIN search does not work.
949 #define MEDIA_GENRE_PINYIN "MEDIA_GENRE_PINYIN"
952 * @deprecated Deprecated since 7.0.
953 * @brief Media composer pinyin.
954 * @details You can use above define to set the condition of media filter and order keyword.
955 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
956 * @remarks Since 4.0, this keyword is related to the following feature:\n
957 * - %http://tizen.org/feature/content.filter.pinyin\n
958 * If this feature is not supported on the device, PINYIN search does not work.
961 #define MEDIA_COMPOSER_PINYIN "MEDIA_COMPOSER_PINYIN"
964 * @brief Virtual Reality content.
965 * @details You can use above define to set the condition of media filter and order keyword.
969 #define MEDIA_360 "MEDIA_360"
973 * @details You can use above define to set the condition of folder filter and order keyword.
974 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
976 #define FOLDER_ID "FOLDER_ID"
979 * @brief Folder full path.
980 * @details You can use above define to set the condition of folder filter and order keyword.
981 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
983 #define FOLDER_PATH "FOLDER_PATH"
986 * @brief Folder base name.
987 * @details You can use above define to set the condition of folder filter and order keyword.
988 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
990 #define FOLDER_NAME "FOLDER_NAME"
993 * @deprecated Deprecated since 7.0.
994 * @brief Folder base name pinyin.
995 * @details You can use above define to set the condition of folder filter and order keyword.
996 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
997 * @remarks Since 4.0, this keyword is related to the following feature:\n
998 * - %http://tizen.org/feature/content.filter.pinyin\n
999 * If this feature is not supported on the device, PINYIN search does not work.
1001 #define FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN"
1004 * @brief Playlist name.
1005 * @details You can use above define to set the condition of playlist filter and order keyword.
1006 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1008 #define PLAYLIST_NAME "PLAYLIST_NAME"
1011 * @brief Playlist id.
1012 * @details You can use above define to set the condition of playlist filter and order keyword.
1015 #define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
1018 * @brief Playlist member order.
1019 * @details You can use above define to set the condition of playlist filter and order keyword.
1020 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1022 #define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
1025 * @brief Media count in playlist.
1026 * @details You can use above define to set the condition of playlist filter and order keyword.
1027 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1029 #define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
1033 * @details You can use above define to set the condition of tag filter and order keyword.
1034 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1036 #define TAG_NAME "TAG_NAME"
1040 * @details You can use above define to set the condition of tag filter and order keyword.
1043 #define MEDIA_TAG_ID "TAG_ID"
1046 * @brief Media count in tag.
1047 * @details You can use above define to set the condition of tag filter and order keyword.
1048 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1050 #define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
1053 * @brief Bookmark marked time.
1054 * @details You can use above define to set the condition of bookmark filter and order keyword.
1055 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1057 #define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
1060 * @brief Bookmark id.
1061 * @details You can use above define to set the condition of bookmark filter and order keyword.
1064 #define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
1067 * @brief Bookmark name.
1068 * @details You can use above define to set the condition of bookmark filter and order keyword.
1071 #define BOOKMARK_NAME "BOOKMARK_NAME"
1075 * @details You can use above define to set the condition of face filter and order keyword.
1078 #define MEDIA_FACE_TAG "MEDIA_FACE_TAG"
1082 * @details You can use above define to set the condition of face filter and order keyword.
1085 #define MEDIA_FACE_ID "MEDIA_FACE_ID"
1094 #endif /* __cplusplus */
1097 #endif /*__TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__*/