Tizen Native API
5.5
|
The Media Information API provides functions to get information about media items stored on an internal and external storage.
Required Header
#include <media_content.h>
Overview
The Media Information API provides functions to get basic information e.g. path, date, type etc about media items (media_info_h) present in the device. Media Information (media_info_h) is a generalization of media content of any type (audio, image, video and others).
Received information about media items can be the processed using dedicated APIs:
API | Description |
---|---|
Media Information | Provides details about all items present in the device. Provide functions to get information (e.g. title, size, mime type etc) about the files. |
Audio Metadata | Provides details about audio items present in the device. Provide functions to get information (e.g. genre, album, year, bitrate etc) about the audio files. |
Face Detection | Provide functions to detect faces from image. |
Image Metadata | Provides details about image items present in the device. Provide functions to get information (e.g. longitude, description, date etc) about the image files. |
Video Metadata | Provides details about video items present in the device. Provide functions to get information (e.g. duration, date etc) about the video files. |
The media information API provides the following information. Regarding the information of each media type (audio, video, or image), please refer to the type-specific metadata page.
Attribute | Filter Keyword | Comments |
---|---|---|
media_id | MEDIA_ID | UUID |
file_path | MEDIA_PATH | Full path of the file |
display_name | MEDIA_DISPLAY_NAME | Base name of the file |
media_type | MEDIA_TYPE | Type (media_content_type_e) |
mime_type | MEDIA_MIME_TYPE | MIME type |
size | MEDIA_SIZE | File size |
added_time | MEDIA_ADDED_TIME | Added time to Media DB |
modified_time | MEDIA_MODIFIED_TIME | Time of last modification |
timeline | MEDIA_TIMELINE | Same as date taken time(for image) or recorded time(for Audio/Video) if exit. if not, same as modified time. |
is_drm | MEDIA_IS_DRM | Whether DRM content or not |
storage_id | MEDIA_STORAGE_ID | Storage UUID. |
storage_type | MEDIA_STORAGE_TYPE | Storage type (media_content_storage_e) |
favorite | MEDIA_FAVOURITE | User data. Not guarantee independence between applications. |
thumbnail_path | MEDIA_THUMBNAIL_PATH | Thumbnail path(album art for Audio) if exist. |
description | MEDIA_DESCRIPTION | Get from metadata if exist. |
Video and Audio information can be further processed with respect to its properties i.e. playlist, album, using their respective APIs.
Foreach Operations
FOREACH | CALLBACK | DESCRIPTION |
---|---|---|
media_info_foreach_media_from_db() | media_info_cb() | Iterates through items |
media_info_foreach_tag_from_db() | media_tag_cb() | Iterate through tags |
media_info_foreach_bookmark_from_db() | media_bookmark_cb() | Iterate through bookmark |
Functions | |
int | media_info_insert_to_db (const char *path, media_info_h *info) |
Inserts the content file into the media database. | |
int | media_info_insert_batch_to_db (const char **path_array, unsigned int array_length, media_insert_completed_cb callback, void *user_data) |
Inserts content files into the media database, asynchronously. | |
int | media_info_delete_from_db (const char *media_id) TIZEN_DEPRECATED_API |
Deletes the media information from the media database. | |
int | media_info_destroy (media_info_h media) |
Destroys media info. | |
int | media_info_clone (media_info_h *dst, media_info_h src) |
Clones the media info handle. | |
int | media_info_get_media_count_from_db (filter_h filter, int *media_count) |
Gets the count of media info for the passed filter from the media database. | |
int | media_info_foreach_media_from_db (filter_h filter, media_info_cb callback, void *user_data) |
Iterates through media info from the media database. | |
int | media_info_get_tag_count_from_db (const char *media_id, filter_h filter, int *tag_count) |
Gets the count of media tags for the passed filter in the given media_id from the media database. | |
int | media_info_foreach_tag_from_db (const char *media_id, filter_h filter, media_tag_cb callback, void *user_data) |
Iterates through the media tag in the given media info from the media database. | |
int | media_info_get_bookmark_count_from_db (const char *media_id, filter_h filter, int *bookmark_count) |
Gets the number of bookmarks for the passed filter in the given media ID from the media database. | |
int | media_info_foreach_bookmark_from_db (const char *media_id, filter_h filter, media_bookmark_cb callback, void *user_data) |
Iterates through the media bookmark in the given media info from the media database. | |
int | media_info_get_face_count_from_db (const char *media_id, filter_h filter, int *face_count) |
Gets the number of face for the passed media_id from the media database. | |
int | media_info_foreach_face_from_db (const char *media_id, filter_h filter, media_face_cb callback, void *user_data) |
Iterates through the media files with optional filter in the given media_id from the media database. | |
int | media_info_get_image (media_info_h media, image_meta_h *image) |
Gets the image metadata handle for a given media info. | |
int | media_info_get_video (media_info_h media, video_meta_h *video) |
Gets a video metadata handle for a given media info. | |
int | media_info_get_audio (media_info_h media, audio_meta_h *audio) |
Gets an audio metadata handle for a given media info. | |
int | media_info_get_media_id (media_info_h media, char **media_id) |
Gets the media ID. | |
int | media_info_get_file_path (media_info_h media, char **path) |
Gets the full path of the content file. | |
int | media_info_get_display_name (media_info_h media, char **name) |
Gets the file name including the extension of the content file. | |
int | media_info_get_media_type (media_info_h media, media_content_type_e *type) |
Gets the content type of the content file. | |
int | media_info_get_mime_type (media_info_h media, char **mime_type) |
Gets the MIME type of the content file. | |
int | media_info_get_size (media_info_h media, unsigned long long *size) |
Gets the content file size. | |
int | media_info_get_added_time (media_info_h media, time_t *added_time) |
Gets the added time of the content file. | |
int | media_info_get_modified_time (media_info_h media, time_t *time) |
Gets the modified time of the content file. | |
int | media_info_get_timeline (media_info_h media, time_t *time) |
Gets the timeline of content file. | |
int | media_info_get_thumbnail_path (media_info_h media, char **path) |
Gets the thumbnail path of content file. | |
int | media_info_get_description (media_info_h media, char **description) |
Gets the description of content file. | |
int | media_info_get_longitude (media_info_h media, double *longitude) |
Gets the longitude of content file. | |
int | media_info_get_latitude (media_info_h media, double *latitude) |
Gets the latitude of content file. | |
int | media_info_get_altitude (media_info_h media, double *altitude) |
Gets the altitude of content file. | |
int | media_info_get_rating (media_info_h media, int *rating) |
Gets the rating of content file. | |
int | media_info_get_favorite (media_info_h media, bool *favorite) |
Gets the favorite status of content file which User set. | |
int | media_info_get_title (media_info_h media, char **title) |
Gets the title of content file. | |
int | media_info_get_storage_id (media_info_h media, char **storage_id) TIZEN_DEPRECATED_API |
Gets the storage id of content file. | |
int | media_info_is_drm (media_info_h media, bool *is_drm) |
Checks whether the media is protected via DRM. | |
int | media_info_is_360_content (media_info_h media, bool *is_360) |
Checks whether the content file is 360 content. | |
int | media_info_get_storage_type (media_info_h media, media_content_storage_e *storage_type) TIZEN_DEPRECATED_API |
Gets the storage type of content file. | |
int | media_info_get_media_from_db (const char *media_id, media_info_h *media) |
Gets the media info from the media database. | |
int | media_info_set_favorite (media_info_h media, bool favorite) |
Sets the favorite of media info. | |
int | media_info_update_to_db (media_info_h media) |
Updates the media info to the media database. | |
int | media_info_move_to_db (media_info_h media, const char *dst_path) |
Moves the media info to the given destination path in the media database. | |
int | media_info_create_thumbnail (media_info_h media, media_thumbnail_completed_cb callback, void *user_data) TIZEN_DEPRECATED_API |
Creates a thumbnail file for the given media, asynchronously. | |
int | media_info_cancel_thumbnail (media_info_h media) TIZEN_DEPRECATED_API |
Cancels the creation of thumbnail file for the given media. | |
int | media_info_generate_thumbnail (media_info_h media) |
Generates a thumbnail file for the given media, synchronously. | |
Typedefs | |
typedef struct media_info_s * | media_info_h |
The structure type for the Media info handle. | |
typedef bool(* | media_info_cb )(media_info_h media, void *user_data) |
Called for every available media info. | |
typedef void(* | media_insert_completed_cb )(media_content_error_e error, void *user_data) |
Called when media items are inserted completely. | |
typedef void(* | media_thumbnail_completed_cb )(media_content_error_e error, const char *path, void *user_data) |
Called when creating a thumbnail image. |
Typedef Documentation
typedef bool(* media_info_cb)(media_info_h media, void *user_data) |
Called for every available media info.
Iterates over a list of media info.
- Since :
- 2.3
- Remarks:
- To use the media outside this function, copy the handle with media_info_clone() function.
The callback is called in the main loop.
- Parameters:
-
[in] media The handle to the media info [in] user_data The user data passed from the foreach function
- Returns:
true
to continue with the next iteration of the loop, otherwisefalse
to break out of the loop
- Precondition:
- media_tag_foreach_media_from_db(), media_playlist_foreach_media_from_db(), media_genre_foreach_media_from_db(), media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
typedef struct media_info_s* media_info_h |
The structure type for the Media info handle.
- Since :
- 2.3
typedef void(* media_insert_completed_cb)(media_content_error_e error, void *user_data) |
Called when media items are inserted completely.
The following error codes can be received:
MEDIA_CONTENT_ERROR_NONE : Success
MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter
MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation
MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory
MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed
MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy
MEDIA_CONTENT_ERROR_NETWORK : Network fail
MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported
- Since :
- 2.3
- Remarks:
- The callback is called in a separate thread(not in the main loop).
- Parameters:
-
[in] error The error code [in] user_data The user data passed from the foreach function
- Precondition:
- media_info_insert_batch_to_db()
- See also:
- media_info_insert_batch_to_db()
typedef void(* media_thumbnail_completed_cb)(media_content_error_e error, const char *path, void *user_data) |
Called when creating a thumbnail image.
- Deprecated:
- Deprecated since 5.0.
This callback is called for completion of generating the thumbnail image. The following error codes can be delivered.
MEDIA_CONTENT_ERROR_NONE,
MEDIA_CONTENT_ERROR_INVALID_PARAMETER,
MEDIA_CONTENT_ERROR_INVALID_OPERATION,
MEDIA_CONTENT_ERROR_PERMISSION_DENIED,
MEDIA_CONTENT_ERROR_DB_FAILED,
MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
- Since :
- 2.3
- Remarks:
- The callback is called in a separate thread(not in the main loop).
- Parameters:
-
[in] error The error code [in] path The path of the thumbnail which is generated [in] user_data The user data passed from the foreach function
- Precondition:
- media_info_create_thumbnail()
- See also:
- media_info_create_thumbnail()
Enumeration Type Documentation
Enumeration for orientation types.
- Since :
- 2.3
- Enumerator:
Function Documentation
int media_info_cancel_thumbnail | ( | media_info_h | media | ) |
Cancels the creation of thumbnail file for the given media.
- Deprecated:
- Deprecated since 5.0.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
- Remarks:
- If you request cancel for the already thumbnail created media, this function returns MEDIA_CONTENT_ERROR_INVALID_OPERATION
- Parameters:
-
[in] media The handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
- Precondition:
- This function requires opened connection to content service by media_content_connect().
- See also:
- media_content_connect()
int media_info_clone | ( | media_info_h * | dst, |
media_info_h | src | ||
) |
Clones the media info handle.
This function copies the media info handle from a source to the destination. To use this handle outside of these foreach functions, use this function.
- Since :
- 2.3
- Remarks:
- The dst should be released using media_info_destroy().
- Parameters:
-
[out] dst The destination handle to the media info [in] src The source handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_create_thumbnail | ( | media_info_h | media, |
media_thumbnail_completed_cb | callback, | ||
void * | user_data | ||
) |
Creates a thumbnail file for the given media, asynchronously.
- Deprecated:
- Deprecated since 5.0. Use media_info_generate_thumbnail() instead.
This function creates an thumbnail file for given media item and calls callback for completion of creating the thumbnail. If a thumbnail already exists for the given media, then the path of thumbnail will be returned in callback function.
Since 3.0, a thumbnail is not automatically extracted during media scanning.
Therefore, if there exists no thumbnail for the given media, you MUST call this function to create a thumbnail.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
http://tizen.org/privilege/mediastorage
http://tizen.org/privilege/externalstorage
- Remarks:
- If you want to destroy media handle before callback invoked, you must cancel thumbnail request by using media_info_cancel_thumbnail()
Since 3.0, if creation of a thumbnail is failed, empty string will be passed through media_thumbnail_completed_cb(). Items in external storage except MMC not supported.
- Parameters:
-
[in] media The handle to the media info [in] callback The callback function to be invoked [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- Precondition:
- This function requires opened connection to content service by media_content_connect().
- See also:
- media_content_connect()
int media_info_delete_from_db | ( | const char * | media_id | ) |
Deletes the media information from the media database.
- Deprecated:
- Deprecated since 5.0. Use media_content_scan_file() instead.
This function only remove media information in the media database.
You can use media_content_scan_file()/media_content_scan_folder() function instead of this function if a file is removed from the file system.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
- Parameters:
-
[in] media_id The media ID. It can get from media info handle.
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_destroy | ( | media_info_h | media | ) |
Destroys media info.
The function frees all resources related to the media info handle. This handle can no longer be used to perform any operations. New media info handle has to be created before the next usage.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- Precondition:
- Get copy of media_info handle by calling media_info_clone().
- See also:
- media_info_clone()
int media_info_foreach_bookmark_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
media_bookmark_cb | callback, | ||
void * | user_data | ||
) |
Iterates through the media bookmark in the given media info from the media database.
This function gets all media bookmarks associated with the given media and calls callback for every retrieved media bookmark. If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [in] callback The callback function to be invoked [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
- Postcondition:
- This function invokes media_bookmark_cb().
int media_info_foreach_face_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
media_face_cb | callback, | ||
void * | user_data | ||
) |
Iterates through the media files with optional filter in the given media_id from the media database.
This function gets all media face info associated with the given media id and meeting desired filter option and calls callback for every retrieved media face info. If NULL is passed to the filter, no filtering is applied.
- Since :
- 3.0
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [in] callback The callback function to invoke [in] user_data The user data to be passed to the callback function
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_foreach_media_from_db | ( | filter_h | filter, |
media_info_cb | callback, | ||
void * | user_data | ||
) |
Iterates through media info from the media database.
This function gets all media info handles meeting the given filter. The callback function will be invoked for every retrieved media info. If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Remarks:
- Do not call updating DB function like media_info_update_to_db() in your callback function, your callback function is invoked as inline function. So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. We do not recommend you call updating DB function in callback of foreach function.
- Parameters:
-
[in] filter The handle to the media filter [in] callback The callback function to be invoked [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
- Postcondition:
- This function invokes media_info_cb().
int media_info_foreach_tag_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
media_tag_cb | callback, | ||
void * | user_data | ||
) |
Iterates through the media tag in the given media info from the media database.
This function gets all the media tags associated with the given media_id and calls callback for every retrieved media tag.
If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [in] callback The callback function to be invoked [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
- Postcondition:
- This function invokes media_tag_cb().
int media_info_generate_thumbnail | ( | media_info_h | media | ) |
Generates a thumbnail file for the given media, synchronously.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
- Remarks:
- http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
Items in external storage are not supported, with the exception of MMC.
- Parameters:
-
[in] media The handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_added_time | ( | media_info_h | media, |
time_t * | added_time | ||
) |
Gets the added time of the content file.
The added time refers to the time that content file was first added to media database.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] added_time The added time to the media database
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_altitude | ( | media_info_h | media, |
double * | altitude | ||
) |
Gets the altitude of content file.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] altitude The altitude of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_audio | ( | media_info_h | media, |
audio_meta_h * | audio | ||
) |
Gets an audio metadata handle for a given media info.
This function returns an audio metadata handle retrieved from the media info handle.
- Since :
- 2.3
- Remarks:
- The audio should be released using audio_meta_destroy().
- Parameters:
-
[in] media The handle to the media info [out] audio The handle to the audio metadata
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- audio_meta_destroy()
int media_info_get_bookmark_count_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
int * | bookmark_count | ||
) |
Gets the number of bookmarks for the passed filter in the given media ID from the media database.
If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [out] bookmark_count The count of the media tag
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_description | ( | media_info_h | media, |
char ** | description | ||
) |
Gets the description of content file.
If the value is an empty string, the method returns "Unknown".
Since 3.0, if the media info has no description, the method returns empty string.
- Since :
- 2.3
- Remarks:
- The description should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] description The description of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_display_name | ( | media_info_h | media, |
char ** | name | ||
) |
Gets the file name including the extension of the content file.
- Since :
- 2.3
- Remarks:
- The name should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] name The file name including the extension of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_face_count_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
int * | face_count | ||
) |
Gets the number of face for the passed media_id from the media database.
If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 3.0
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [out] face_count The count of media face
- Returns:
- 0 on success, otherwise a negative error value.
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_favorite | ( | media_info_h | media, |
bool * | favorite | ||
) |
Gets the favorite status of content file which User set.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] favorite true
if content file is set as favorite, otherwisefalse
if content file is not set as favorite
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- media_info_set_favorite()
int media_info_get_file_path | ( | media_info_h | media, |
char ** | path | ||
) |
Gets the full path of the content file.
- Since :
- 2.3
- Remarks:
- The path should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] path The full path of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_image | ( | media_info_h | media, |
image_meta_h * | image | ||
) |
Gets the image metadata handle for a given media info.
This function returns an image metadata handle retrieved from the media info.
- Since :
- 2.3
- Remarks:
- The image should be released using image_meta_destroy().
- Parameters:
-
[in] media The handle to the media info [out] image The handle to the image metadata
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- image_meta_destroy()
int media_info_get_latitude | ( | media_info_h | media, |
double * | latitude | ||
) |
Gets the latitude of content file.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] latitude The latitude of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_longitude | ( | media_info_h | media, |
double * | longitude | ||
) |
Gets the longitude of content file.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] longitude The longitude of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_media_count_from_db | ( | filter_h | filter, |
int * | media_count | ||
) |
Gets the count of media info for the passed filter from the media database.
If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Parameters:
-
[in] filter The handle to the media filter [out] media_count The count of media
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_media_from_db | ( | const char * | media_id, |
media_info_h * | media | ||
) |
Gets the media info from the media database.
This function creates a new media handle from the media database by the given media_id. Media info will be created and filled with information.
- Since :
- 2.3
- Remarks:
- The media should be released using media_info_destroy().
- Parameters:
-
[in] media_id The media ID [out] media The handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_media_id | ( | media_info_h | media, |
char ** | media_id | ||
) |
Gets the media ID.
- Since :
- 2.3
- Remarks:
- The media_id should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] media_id The media ID
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_media_type | ( | media_info_h | media, |
media_content_type_e * | type | ||
) |
Gets the content type of the content file.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] type The content type of the content file (media_content_type_e)
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- media_content_type_e
int media_info_get_mime_type | ( | media_info_h | media, |
char ** | mime_type | ||
) |
Gets the MIME type of the content file.
- Since :
- 2.3
- Remarks:
- The mime_type should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] mime_type The MIME type of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_modified_time | ( | media_info_h | media, |
time_t * | time | ||
) |
Gets the modified time of the content file.
The modified time refers to the last modification time provided by the file system.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] time The last modification time of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_rating | ( | media_info_h | media, |
int * | rating | ||
) |
Gets the rating of content file.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] rating The rating of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_size | ( | media_info_h | media, |
unsigned long long * | size | ||
) |
Gets the content file size.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] size The content file size
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_storage_id | ( | media_info_h | media, |
char ** | storage_id | ||
) |
Gets the storage id of content file.
- Deprecated:
- Deprecated since 5.0.
- Since :
- 2.4
- Remarks:
- The storage_id should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] storage_id The ID of the media storage
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_storage_type | ( | media_info_h | media, |
media_content_storage_e * | storage_type | ||
) |
Gets the storage type of content file.
- Deprecated:
- Deprecated since 5.0. Use storage_get_type_dev() instead.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] storage_type The storage type of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_tag_count_from_db | ( | const char * | media_id, |
filter_h | filter, | ||
int * | tag_count | ||
) |
Gets the count of media tags for the passed filter in the given media_id from the media database.
If NULL
is passed to the filter, then no filtering is applied.
- Since :
- 2.3
- Parameters:
-
[in] media_id The media ID [in] filter The handle to the media filter [out] tag_count The count of the media tag
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_get_thumbnail_path | ( | media_info_h | media, |
char ** | path | ||
) |
Gets the thumbnail path of content file.
- Since :
- 2.3
- Remarks:
- The path should be released using free().
If the thumbnail extraction for the given media has not been requested yet, this function returns NULL.
To create a thumbnail, you should use media_info_generate_thumbnail() function.
This function returns an empty string if media_info_generate_thumbnail() has failed to create a thumbnail for the given media.
- Parameters:
-
[in] media The handle to the media info [out] path The thumbnail path
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_timeline | ( | media_info_h | media, |
time_t * | time | ||
) |
Gets the timeline of content file.
If the content file has the creation time information (like Content recorded date or Image creation date), that value is timeline.
Otherwise, timeline value is the same as modified time.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] time The timeline of content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_title | ( | media_info_h | media, |
char ** | title | ||
) |
Gets the title of content file.
If the content file does not have a title, this method returns the filename without the extension.
- Since :
- 2.3
- Remarks:
- The title should be released using free().
- Parameters:
-
[in] media The handle to the media info [out] title The title of the content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_get_video | ( | media_info_h | media, |
video_meta_h * | video | ||
) |
Gets a video metadata handle for a given media info.
This function returns a video metadata handle retrieved from the media info handle.
- Since :
- 2.3
- Remarks:
- The video should be released using video_meta_destroy().
- Parameters:
-
[in] media The handle to the media info [out] video The handle to the video metadata
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- See also:
- video_meta_destroy()
int media_info_insert_batch_to_db | ( | const char ** | path_array, |
unsigned int | array_length, | ||
media_insert_completed_cb | callback, | ||
void * | user_data | ||
) |
Inserts content files into the media database, asynchronously.
This function can insert multiple content files into the media database.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
http://tizen.org/privilege/mediastorage
http://tizen.org/privilege/externalstorage
- Remarks:
- You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path.
If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage.
Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage.
If you can access both storage, you must add all privilege.
Since 4.0, This function does not allow a symbolic link.
-
Since 4.0, this function is related to the following feature:
http://tizen.org/feature/content.scanning.others
If this feature is not supported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
- Parameters:
-
[in] path_array The path array of the content files to add [in] array_length The length of the array [in] callback The callback function to be invoked when media items inserted completely [in] user_data The user data to be passed to the callback function
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied MEDIA_CONTENT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_insert_to_db | ( | const char * | path, |
media_info_h * | info | ||
) |
Inserts the content file into the media database.
In general, you can use this function to insert content files into the media database.
You can use media_content_scan_file()/media_content_scan_folder() function instead of this function.
If media information exists in the media database, this function returns information stored in the database.
Since 5.5, if media information already exists in the media database, this function returns the updated latest information. (Media database will be updated if necessary).
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
http://tizen.org/privilege/mediastorage
http://tizen.org/privilege/externalstorage
- Remarks:
- The info should be released using media_info_destroy().
You must add the privilege http://tizen.org/privilege/content.write. You need to add more privileges depending on your choice of contents path.
If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage.
If you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage.
If you want to access storages of both types, you must add all privileges.
Since 4.0, this function does not accept symbolic links.
-
Since 4.0, this function is related to the following feature:
http://tizen.org/feature/content.scanning.others
If this feature is not supported on the device, MEDIA_CONTENT_TYPE_OTHERS type files are not scanned.
- Parameters:
-
[in] path The path of the content file to add [out] info The handle of the inserted content file
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied MEDIA_CONTENT_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_is_360_content | ( | media_info_h | media, |
bool * | is_360 | ||
) |
Checks whether the content file is 360 content.
- Since :
- 3.0
- Parameters:
-
[in] media The handle to the media info [out] is_360 true
if media is 360 content, otherwisefalse
if media is not 360 content
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_is_drm | ( | media_info_h | media, |
bool * | is_drm | ||
) |
Checks whether the media is protected via DRM.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [out] is_drm true
if media is DRM media, otherwisefalse
if media is not DRM media
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_move_to_db | ( | media_info_h | media, |
const char * | dst_path | ||
) |
Moves the media info to the given destination path in the media database.
After moving or renaming a file in the filesystem, call this function to update the database.
If the source path and destination path are the same, then this function does nothing. If you want to refresh media information, you should use media_content_scan_file() function.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
http://tizen.org/privilege/mediastorage
http://tizen.org/privilege/externalstorage
- Remarks:
- You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path.
If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage.
Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage.
If you can access both storage, you should add all privilege.
Since 4.0, this function does not allow symbolic links.
This function does not support USB storage before 5.0. Since 5.0, USB storage is supported.
Since 5.0, the thumbnail is removed if it exists.
- Parameters:
-
[in] media The handle to the media info [in] dst_path The path of destination
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter (Especially, if the request is duplicated, this error returns.) MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- Precondition:
- This function requires opened connection to content service by media_content_connect().
int media_info_set_favorite | ( | media_info_h | media, |
bool | favorite | ||
) |
Sets the favorite of media info.
This function can mark favorite of the media. If set to true
, this function record the time of the change moment.
So, If you use it in order parameter, you can sort the order of the time was a favorite.
Or, if you use it in condition parameter, you can get the result of the favorite media.
- Since :
- 2.3
- Parameters:
-
[in] media The handle to the media info [in] favorite Set true
to set the media info as favorite, otherwise setfalse
to not set the media info as favorite
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
int media_info_update_to_db | ( | media_info_h | media | ) |
Updates the media info to the media database.
The function updates the given media info in the media database.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/content.write
- Remarks:
- The function should be called after any change in media, to be updated to the media database. For example, after using media_info_set_favorite() for setting the name of the media, the media_info_update_to_db() function should be called so as to update the given media info attributes in the media database.
- Parameters:
-
[in] media The handle to the media info
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
MEDIA_CONTENT_ERROR_NONE Successful MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy MEDIA_CONTENT_ERROR_NETWORK Network fail MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- Precondition:
- This function requires opened connection to content service by media_content_connect().