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,
242 * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
243 * @deprecated Deprecated since 5.0.
244 * @brief The structure type for the Media storage handle.
245 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
247 typedef void *media_storage_h;
250 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
251 * @brief The structure type for the Media info handle.
252 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
254 typedef struct media_info_s *media_info_h;
257 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
258 * @brief The structure type for the Media folder handle.
259 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
261 typedef struct media_folder_s *media_folder_h;
264 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
265 * @brief The structure type for the Media playlist handle.
266 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
268 typedef struct media_playlist_s *media_playlist_h;
271 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
272 * @brief The structure type for the Media tag handle.
273 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
275 typedef struct media_tag_s *media_tag_h;
278 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
279 * @brief The structure type for the Media bookmark handle.
280 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
282 typedef struct media_bookmark_s *media_bookmark_h;
285 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
286 * @brief The structure type for the Media album handle.
287 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
289 typedef struct media_album_s *media_album_h;
292 * @ingroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE
293 * @brief The structure type for the Image metadata handle.
294 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
296 typedef struct image_meta_s *image_meta_h;
299 * @ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
300 * @brief The structure type for the Video metadata handle.
301 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
303 typedef struct video_meta_s *video_meta_h;
306 * @ingroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE
307 * @brief The structure type for the Audio metadata handle.
308 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
310 typedef struct audio_meta_s *audio_meta_h;
313 * @ingroup CAPI_CONTENT_MEDIA_BOOK_META_MODULE
314 * @brief The structure type for the Book metadata handle.
317 typedef struct book_meta_s *book_meta_h;
320 * @ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
321 * @brief The structure type for the Media filter handle.
322 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
324 typedef struct filter_s *filter_h;
327 * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
328 * @brief The structure type for the Media face handle.
331 typedef void *media_face_h;
334 * @ingroup CAPI_MEDIA_CONTENT_MODULE
335 * @brief The structure type for the Media content noti handle.
338 typedef void *media_content_noti_h;
341 * @ingroup CAPI_MEDIA_CONTENT_MODULE
342 * @brief Called when the media scanning is finished.
343 * @details The following error codes can be received: \n
344 * #MEDIA_CONTENT_ERROR_NONE : Success \n
345 * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
346 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
347 * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
348 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
349 * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
350 * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
351 * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
352 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
353 * @remarks The callback is called in a separate thread(not in the main loop).
355 * @param[in] error The error code
356 * @param[in] user_data The user data passed from the foreach function
358 * @pre media_content_scan_folder().
359 * @see media_content_scan_folder()
361 typedef void (*media_scan_completed_cb)(media_content_error_e error, void * user_data);
364 * @ingroup CAPI_MEDIA_CONTENT_MODULE
365 * @brief Called when the notification of the media DB change is subscribed.
366 * @details The following error codes can be received: \n
367 * #MEDIA_CONTENT_ERROR_NONE : Success \n
368 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
370 * @remarks The callback is called in a separate thread(not in the main loop).
372 * @param[in] error The error code
373 * @param[in] pid The PID which publishes notification
374 * @param[in] update_item The update item of notification
375 * @param[in] update_type The update type of notification
376 * @param[in] media_type The type of the media content (#media_content_type_e)
377 * @param[in] uuid The ID of media or directory, which is updated
378 * @param[in] path The path of the media or directory
379 * @param[in] mime_type The MIME of the media info
380 * @param[in] user_data The user data passed from the foreach function
382 * @pre media_content_add_db_updated_cb().
383 * @see media_content_add_db_updated_cb()
385 typedef void (*media_content_db_update_cb)(
386 media_content_error_e error,
388 media_content_db_update_item_type_e update_item,
389 media_content_db_update_type_e update_type,
390 media_content_type_e media_type,
398 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
399 * @brief Called for every available media info.
400 * @details Iterates over a list of media info.
401 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
403 * @remarks To use the @a media outside this function, copy the handle with media_info_clone() function. \n
404 * The callback is called in the main loop.
406 * @param[in] media The handle to the media info
407 * @param[in] user_data The user data passed from the foreach function
409 * @return @c true to continue with the next iteration of the loop,
410 * otherwise @c false to break out of the loop
412 * @pre media_tag_foreach_media_from_db(), media_playlist_foreach_media_from_db(), media_genre_foreach_media_from_db(),
413 * media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
415 * @see media_info_clone()
416 * @see media_album_foreach_media_from_db()
417 * @see media_playlist_foreach_media_from_db()
418 * @see media_tag_foreach_media_from_db()
419 * @see media_info_foreach_media_from_db()
420 * @see media_folder_foreach_media_from_db()
422 typedef bool (*media_info_cb)(media_info_h media, void *user_data);
426 * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
427 * @brief Called when media items are inserted completely.
428 * @details The following error codes can be received: \n
429 * #MEDIA_CONTENT_ERROR_NONE : Success \n
430 * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
431 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
432 * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
433 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
434 * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
435 * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
436 * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
437 * #MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported \n
438 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
440 * @remarks The callback is called in a separate thread(not in the main loop).
442 * @param[in] error The error code
443 * @param[in] user_data The user data passed from the foreach function
445 * @pre media_info_insert_batch_to_db()
446 * @see media_info_insert_batch_to_db()
448 typedef void (*media_insert_completed_cb)(media_content_error_e error, void * user_data);
451 * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
452 * @brief Called when face detection on the image is completed.
454 * @details The following error codes can be delivered. \n
455 * #MEDIA_CONTENT_ERROR_NONE, \n
456 * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY, \n
457 * #MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n
458 * #MEDIA_CONTENT_ERROR_DB_FAILED, \n
459 * #MEDIA_CONTENT_ERROR_DB_BUSY, \n
460 * #MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
464 * @remarks The callback is called in a separate thread(not in the main loop).
466 * @param[in] error The error code
467 * @param[in] face_count The number of all detected faces
468 * @param[in] user_data The user data passed from the foreach function
470 * @pre media_info_start_face_detection()
471 * @see media_info_start_face_detection()
473 typedef void (*media_face_detection_completed_cb)(media_content_error_e error, const int face_count, void *user_data);
477 * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
478 * @brief Called for every available media folder.
479 * @details Iterates over a list of folders.
481 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
483 * @remarks To use the @a folder outside this function, copy the handle with the media_folder_clone() function. \n
484 * The callback is called in the main loop.
486 * @param[in] folder The handle to the media folder
487 * @param[in] user_data The user data passed from the foreach function
489 * @return @c true to continue with the next iteration of the loop,
490 * otherwise @c false to break out of the loop
492 * @pre media_folder_foreach_folder_from_db() will invoke this function.
493 * @see media_folder_clone()
494 * @see media_folder_foreach_folder_from_db()
496 typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
499 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
500 * @brief Called for every playlist in the obtained list of playlists.
501 * @details Iterates over a playlist list.
503 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
505 * @remarks To use the @a playlist outside this function, copy the handle with the media_playlist_clone() function. \n
506 * The callback is called in the main loop.
508 * @param[in] playlist The handle to the media playlist
509 * @param[in] user_data The user data passed from the foreach function
511 * @return @c true to continue with the next iteration of the loop,
512 * otherwise @c false to break out of the loop
514 * @pre media_playlist_foreach_playlist_from_db() will invoke this function.
516 * @see media_playlist_clone()
517 * @see media_playlist_foreach_playlist_from_db()
519 typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
522 * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
523 * @brief Called for every media info with playlist member ID in the obtained list of media info.
524 * @details Iterates over playlist members.
526 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
528 * @remarks To use the @a media outside this function, copy the handle with the media_info_clone() function. \n
529 * The callback is called in the main loop.
531 * @param[in] playlist_member_id The ID of the playlist member
532 * @param[in] media The handle to the media info
533 * @param[in] user_data The user data passed from the foreach function
535 * @return @c true to continue with the next iteration of the loop,
536 * otherwise @c false to break out of the loop
538 * @pre media_playlist_foreach_media_from_db() will invoke this function.
540 * @see media_info_clone()
541 * @see media_playlist_foreach_media_from_db()
543 typedef bool (*playlist_member_cb)(int playlist_member_id, media_info_h media, void *user_data);
546 * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
547 * @brief Called for every tag in the obtained list of tags.
548 * @details Iterates over a list of tags.
550 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
552 * @remarks To use the @a tag outside this function, copy the handle with the media_tag_clone() function. \n
553 * The callback is called in the main loop.
555 * @param[in] tag The handle to the media tag
556 * @param[in] user_data The user data passed from the foreach function
558 * @return @c true to continue with the next iteration of the loop,
559 * otherwise @c false to break out of the loop
561 * @pre media_tag_foreach_tag_from_db(), media_info_foreach_tag_from_db() will invoke this function.
563 * @see media_tag_clone()
564 * @see media_tag_foreach_tag_from_db()
565 * @see media_info_foreach_tag_from_db()
567 typedef bool (*media_tag_cb)(media_tag_h tag, void *user_data);
570 * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
571 * @brief Called for every bookmark in the obtained list of bookmarks.
572 * @details Iterates over a bookmark list.
574 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
576 * @remarks To use the @a bookmark outside this function, copy the handle with the media_bookmark_clone() function. \n
577 * The callback is called in the main loop.
579 * @param[in] bookmark The handle to the media bookmark
580 * @param[in] user_data The user data passed from the foreach function
582 * @return @c true to continue with the next iteration of the loop,
583 * otherwise @c false to break out of the loop
585 * @pre media_info_foreach_bookmark_from_db() will invoke this function.
586 * @see media_info_foreach_bookmark_from_db()
588 typedef bool (*media_bookmark_cb)(media_bookmark_h bookmark, void *user_data);
591 * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
592 * @brief Called for every album in the obtained list of groups.
593 * @details Iterates over an album list.
595 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
597 * @remarks To use the @a album outside this function, copy the handle with the media_album_clone() function. \n
598 * The callback is called in the main loop.
600 * @param[in] album The handle to the media album
601 * @param[in] user_data The user data passed from the foreach function
603 * @return @c true to continue with the next iteration of the loop,
604 * otherwise @c false to break out of the loop
606 * @pre media_album_foreach_album_from_db() will invoke this function.
608 * @see media_album_clone()
609 * @see media_album_foreach_album_from_db()
611 typedef bool (*media_album_cb)(media_album_h album, void *user_data);
614 * @ingroup CAPI_CONTENT_MEDIA_GROUP_MODULE
615 * @brief Called for every group in the obtained list of groups.
616 * @details Iterates over a media group list.
618 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
620 * @remarks You should not free @a group_name returned by this function. \n
621 * The callback is called in the main loop.
623 * @param[in] group_name The name of the media group
624 * @param[in] user_data The user data passed from the foreach function
626 * @return @c true to continue with the next iteration of the loop,
627 * otherwise @c false to break out of the loop
629 * @pre media_group_foreach_group_from_db() will invoke this function.
630 * @see media_group_foreach_group_from_db()
632 typedef bool (*media_group_cb)(const char *group_name, void *user_data);
635 * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
636 * @brief Called for every storage in the obtained list of storages.
637 * @details Iterates over a media storage list.
639 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
641 * @remarks You should not destroy @a storage returned by this function. \n
642 * The callback is called in the main loop.
644 * @param[in] storage The handle of the media storage
645 * @param[in] user_data The user data passed from the foreach function
647 * @return @c true to continue with the next iteration of the loop,
648 * otherwise @c false to break out of the loop
650 * @pre media_storage_foreach_storage_from_db() will invoke this function.
651 * @see media_storage_foreach_storage_from_db()
653 typedef bool (*media_storage_cb)(media_storage_h storage, void *user_data);
656 * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
657 * @brief Called for every face in the obtained list of face.
658 * @details Iterates over a media face list.
662 * @remarks You should not destroy @a face returned by this function. \n
663 * The callback is called in the main loop.
665 * @param[in] face The handle of the media face
666 * @param[in] user_data The user data passed from the foreach function
668 * @return @c true to continue with the next iteration of the loop,
669 * otherwise @c false to break out of the loop
671 * @pre media_info_foreach_face_from_db() will invoke this function.
672 * @see media_info_foreach_face_from_db()
674 typedef bool (*media_face_cb)(media_face_h face, void *user_data);
681 * @addtogroup CAPI_CONTENT_MEDIA_FILTER_MODULE
687 * @details You can use above define to set the condition of media filter and order keyword.
688 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
691 #define MEDIA_ID "MEDIA_ID"
694 * @brief Media full path.
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_PATH "MEDIA_PATH"
702 * @brief The file name including the extension.
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_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
711 * @details There are 5 media types:\n
712 * 0-image, 1-video, 2-sound, 3-music, 4-other\n
713 * You can use above define to set the condition of media filter and order keyword.
714 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
717 #define MEDIA_TYPE "MEDIA_TYPE"
720 * @brief Media MIME type.
721 * @details You can use above define to set the condition of media filter and order keyword.
722 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
725 #define MEDIA_MIME_TYPE "MEDIA_MIME_TYPE"
729 * @brief Media file size.
730 * @details You can use above define to set the condition of media filter and order keyword.
731 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
734 #define MEDIA_SIZE "MEDIA_SIZE"
737 * @brief The time that content file was first added to media database.
738 * @details You can use above define to set the condition of media filter and order keyword.
739 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
742 #define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
745 * @brief The last modification time provided by the file system.
746 * @details You can use above define to set the condition of media filter and order keyword.
747 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
750 #define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
753 * @brief Media created time.
754 * @details You can use above define to set the condition of media filter and order keyword.
755 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
758 #define MEDIA_TIMELINE "MEDIA_TIMELINE"
761 * @brief Media thumbnail path.
762 * @details You can use above define to set the condition of media filter and order keyword.
763 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
766 #define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
769 * @brief Media title get from tag or file name.
770 * @details You can use above define to set the condition of media filter and order keyword.
771 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
774 #define MEDIA_TITLE "MEDIA_TITLE"
777 * @brief Media album name.
778 * @details You can use above define to set the condition of media filter and order keyword.
779 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
782 #define MEDIA_ALBUM "MEDIA_ALBUM"
785 * @brief Media artist.
786 * @details You can use above define to set the condition of media filter and order keyword.
787 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
790 #define MEDIA_ARTIST "MEDIA_ARTIST"
793 * @brief Media album artist.
794 * @details You can use above define to set the condition of media filter and order keyword.
795 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
798 #define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
801 * @brief Media genre.
802 * @details You can use above define to set the condition of media filter and order keyword.
803 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
806 #define MEDIA_GENRE "MEDIA_GENRE"
809 * @brief Media composer.
810 * @details You can use above define to set the condition of media filter and order keyword.
811 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
814 #define MEDIA_COMPOSER "MEDIA_COMPOSER"
818 * @details You can use above define to set the condition of media filter and order keyword.
819 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
822 #define MEDIA_YEAR "MEDIA_YEAR"
825 * @brief Media recorded date.
826 * @details You can use above define to set the condition of media filter and order keyword.
827 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
830 #define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
833 * @brief Media track number.
834 * @details You can use above define to set the condition of media filter and order keyword.
835 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
838 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
841 * @brief Media duration.
842 * @details You can use above define to set the condition of media filter and order keyword.
843 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
846 #define MEDIA_DURATION "MEDIA_DURATION"
849 * @brief Media longitude.
850 * @details You can use above define to set the condition of media filter and order keyword.
851 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
854 #define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
857 * @brief Media latitude.
858 * @details You can use above define to set the condition of media filter and order keyword.
859 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
862 #define MEDIA_LATITUDE "MEDIA_LATITUDE"
865 * @brief Media altitude.
866 * @details You can use above define to set the condition of media filter and order keyword.
867 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
870 #define MEDIA_ALTITUDE "MEDIA_ALTITUDE"
873 * @brief Media width.
874 * @details You can use above define to set the condition of media filter and order keyword.
875 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
878 #define MEDIA_WIDTH "MEDIA_WIDTH"
881 * @brief Media height.
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
886 #define MEDIA_HEIGHT "MEDIA_HEIGHT"
889 * @brief Media datetaken.
890 * @details You can use above define to set the condition of media filter and order keyword.
891 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
894 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
897 * @brief The time to register favourite.
898 * @details You can use above define to set the condition of media filter and order keyword.
899 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
902 #define MEDIA_FAVOURITE "MEDIA_FAVOURITE"
906 * @details There are 2 types:\n
908 * You can use above define to set the condition of media filter and order keyword.
909 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
912 #define MEDIA_IS_DRM "MEDIA_IS_DRM"
915 * @deprecated Deprecated since 7.0.
916 * @brief Media file name pinyin.
917 * @details You can use above define to set the condition of media filter and order keyword.
918 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
919 * @remarks Since 4.0, this keyword is related to the following feature:\n
920 * - %http://tizen.org/feature/content.filter.pinyin\n
921 * If this feature is not supported on the device, PINYIN search does not work.
924 #define MEDIA_FILE_NAME_PINYIN "MEDIA_FILE_NAME_PINYIN"
927 * @deprecated Deprecated since 7.0.
928 * @brief Media title pinyin.
929 * @details You can use above define to set the condition of media filter and order keyword.
930 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
931 * @remarks Since 4.0, this keyword is related to the following feature:\n
932 * - %http://tizen.org/feature/content.filter.pinyin\n
933 * If this feature is not supported on the device, PINYIN search does not work.
936 #define MEDIA_TITLE_PINYIN "MEDIA_TITLE_PINYIN"
939 * @deprecated Deprecated since 7.0.
940 * @brief Media album pinyin.
941 * @details You can use above define to set the condition of media filter and order keyword.
942 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
943 * @remarks Since 4.0, this keyword is related to the following feature:\n
944 * - %http://tizen.org/feature/content.filter.pinyin\n
945 * If this feature is not supported on the device, PINYIN search does not work.
948 #define MEDIA_ALBUM_PINYIN "MEDIA_ALBUM_PINYIN"
951 * @deprecated Deprecated since 7.0.
952 * @brief Media artist pinyin.
953 * @details You can use above define to set the condition of media filter and order keyword.
954 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
955 * @remarks Since 4.0, this keyword is related to the following feature:\n
956 * - %http://tizen.org/feature/content.filter.pinyin\n
957 * If this feature is not supported on the device, PINYIN search does not work.
960 #define MEDIA_ARTIST_PINYIN "MEDIA_ARTIST_PINYIN"
963 * @deprecated Deprecated since 7.0.
964 * @brief Media album artist pinyin.
965 * @details You can use above define to set the condition of media filter and order keyword.
966 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
967 * @remarks Since 4.0, this keyword is related to the following feature:\n
968 * - %http://tizen.org/feature/content.filter.pinyin\n
969 * If this feature is not supported on the device, PINYIN search does not work.
972 #define MEDIA_ALBUM_ARTIST_PINYIN "MEDIA_ALBUM_ARTIST_PINYIN"
975 * @deprecated Deprecated since 7.0.
976 * @brief Media genre pinyin.
977 * @details You can use above define to set the condition of media filter and order keyword.
978 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
979 * @remarks Since 4.0, this keyword is related to the following feature:\n
980 * - %http://tizen.org/feature/content.filter.pinyin\n
981 * If this feature is not supported on the device, PINYIN search does not work.
984 #define MEDIA_GENRE_PINYIN "MEDIA_GENRE_PINYIN"
987 * @deprecated Deprecated since 7.0.
988 * @brief Media composer pinyin.
989 * @details You can use above define to set the condition of media filter and order keyword.
990 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
991 * @remarks Since 4.0, this keyword is related to the following feature:\n
992 * - %http://tizen.org/feature/content.filter.pinyin\n
993 * If this feature is not supported on the device, PINYIN search does not work.
996 #define MEDIA_COMPOSER_PINYIN "MEDIA_COMPOSER_PINYIN"
999 * @brief Virtual Reality content.
1000 * @details You can use above define to set the condition of media filter and order keyword.
1004 #define MEDIA_360 "MEDIA_360"
1008 * @details You can use above define to set the condition of folder filter and order keyword.
1009 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1011 #define FOLDER_ID "FOLDER_ID"
1014 * @brief Folder full path.
1015 * @details You can use above define to set the condition of folder filter and order keyword.
1016 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1018 #define FOLDER_PATH "FOLDER_PATH"
1021 * @brief Folder base name.
1022 * @details You can use above define to set the condition of folder filter and order keyword.
1023 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1025 #define FOLDER_NAME "FOLDER_NAME"
1028 * @deprecated Deprecated since 7.0.
1029 * @brief Folder base name pinyin.
1030 * @details You can use above define to set the condition of folder filter and order keyword.
1031 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1032 * @remarks Since 4.0, this keyword is related to the following feature:\n
1033 * - %http://tizen.org/feature/content.filter.pinyin\n
1034 * If this feature is not supported on the device, PINYIN search does not work.
1036 #define FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN"
1039 * @brief Playlist name.
1040 * @details You can use above define to set the condition of playlist filter and order keyword.
1041 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1043 #define PLAYLIST_NAME "PLAYLIST_NAME"
1046 * @brief Playlist id.
1047 * @details You can use above define to set the condition of playlist filter and order keyword.
1050 #define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
1053 * @brief Playlist member order.
1054 * @details You can use above define to set the condition of playlist filter and order keyword.
1055 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1057 #define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
1060 * @brief Media count in playlist.
1061 * @details You can use above define to set the condition of playlist filter and order keyword.
1062 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1064 #define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
1068 * @details You can use above define to set the condition of tag filter and order keyword.
1069 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1071 #define TAG_NAME "TAG_NAME"
1075 * @details You can use above define to set the condition of tag filter and order keyword.
1078 #define MEDIA_TAG_ID "TAG_ID"
1081 * @brief Media count in tag.
1082 * @details You can use above define to set the condition of tag filter and order keyword.
1083 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1085 #define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
1088 * @brief Bookmark marked time.
1089 * @details You can use above define to set the condition of bookmark filter and order keyword.
1090 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1092 #define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
1095 * @brief Bookmark id.
1096 * @details You can use above define to set the condition of bookmark filter and order keyword.
1099 #define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
1102 * @brief Bookmark name.
1103 * @details You can use above define to set the condition of bookmark filter and order keyword.
1106 #define BOOKMARK_NAME "BOOKMARK_NAME"
1110 * @details You can use above define to set the condition of face filter and order keyword.
1113 #define MEDIA_FACE_TAG "MEDIA_FACE_TAG"
1117 * @details You can use above define to set the condition of face filter and order keyword.
1120 #define MEDIA_FACE_ID "MEDIA_FACE_ID"
1129 #endif /* __cplusplus */
1132 #endif /*__TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__*/