Tizen Native API
|
Functions | |
int | media_folder_get_folder_count_from_db (filter_h filter, int *folder_count) |
Gets the count of folder for the passed filter from the media database. | |
int | media_folder_foreach_folder_from_db (filter_h filter, media_folder_cb callback, void *user_data) |
Iterates through available media folders with optional filter from the media database. | |
int | media_folder_get_media_count_from_db (const char *folder_id, filter_h filter, int *media_count) |
Gets the count of media files for the passed filter in the given folder from the media database. | |
int | media_folder_foreach_media_from_db (const char *folder_id, filter_h filter, media_info_cb callback, void *user_data) |
Iterates through the media files with an optional filter in the given folder from the media database. | |
int | media_folder_clone (media_folder_h *dst, media_folder_h src) |
Clones the media folder. | |
int | media_folder_destroy (media_folder_h folder) |
Destroys the media folder. | |
int | media_folder_get_folder_id (media_folder_h folder, char **folder_id) |
Gets the media folder ID. | |
int | media_folder_get_path (media_folder_h folder, char **path) |
Gets the absolute path to the media folder. | |
int | media_folder_get_name (media_folder_h folder, char **folder_name) |
Gets the media folder name. | |
int | media_folder_get_modified_time (media_folder_h folder, time_t *date) |
Gets the modified date of the folder. | |
int | media_folder_get_storage_type (media_folder_h folder, media_content_storage_e *storage_type) |
Gets the folder storage type. | |
int | media_folder_get_folder_from_db (const char *folder_id, media_folder_h *folder) |
Gets the media folder from the media database. | |
int | media_folder_update_to_db (media_folder_h folder) |
Updates the media folder to the media database. | |
int | media_folder_set_name (media_folder_h folder, const char *name) |
Sets the folder name. | |
Typedefs | |
typedef struct media_folder_s * | media_folder_h |
The structure type for the Media folder handle. | |
typedef bool(* | media_folder_cb )(media_folder_h folder, void *user_data) |
Called for every available media folder. | |
Defines | |
#define | FOLDER_ID "FOLDER_ID" |
#define | FOLDER_PATH "FOLDER_PATH" |
#define | FOLDER_NAME "FOLDER_NAME" |
#define | FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME" |
#define | FOLDER_STORAGE_TYPE "FOLDER_STORAGE_TYPE" |
#define | FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN" |
The Media folder API provides functions to get information about folders.
#include <media_content.h>
A Folder is used to organize media content files i.e. image, audio, video files, in the physical storage of the device. The Media Folder API provides functions to get basic information about existing folders e.g. folder name, path and storage type. It also provides functions to get information related to media items present in the folder.
For getting information about folder call the respective get functions e.g. to get path and name of a given folder call media_folder_get_path() and media_folder_get_name() function respectively and so on.
Similarly call media_folder_get_media_count_from_db() to get count of media items present in a given folder.
FOREACH | CALLBACK | DESCRIPTION |
---|---|---|
media_folder_foreach_folder_from_db() | media_folder_cb() | Iterates over a folder information list |
media_folder_foreach_media_from_db() | media_info_cb() | Iterates media information trough the folder |
#define FOLDER_ID "FOLDER_ID" |
Folder ID
#define FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME" |
Folder modified time
#define FOLDER_NAME "FOLDER_NAME" |
Folder base name
#define FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN" |
Folder base name pinyin
#define FOLDER_PATH "FOLDER_PATH" |
Folder full path
#define FOLDER_STORAGE_TYPE "FOLDER_STORAGE_TYPE" |
Folder storage. 0-internal storage, 1-external storage
typedef bool(* media_folder_cb)(media_folder_h folder, void *user_data) |
Called for every available media folder.
Iterates over a list of folders.
[in] | folder | The handle to the media folder |
[in] | user_data | The user data passed from the foreach function |
true
to continue with the next iteration of the loop, otherwise false
to break out of the loopint media_folder_clone | ( | media_folder_h * | dst, |
media_folder_h | src | ||
) |
Clones the media folder.
This function copies the media folder handle from a source to destination. There is no media_folder_create() function. The media_folder_h is created internally and available through media folder foreach function such as media_folder_foreach_folder_from_db(). To use this handle outside of these foreach functions, use this function.
[out] | dst | The destination handle to the media folder |
[in] | src | The source handle to the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_destroy | ( | media_folder_h | folder | ) |
Destroys the media folder.
The function frees all resources related to the folder handle. This handle no longer can be used to perform any operation. A new handle has to be created before the next use.
[in] | folder | The handle to the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_foreach_folder_from_db | ( | filter_h | filter, |
media_folder_cb | callback, | ||
void * | user_data | ||
) |
Iterates through available media folders with optional filter from the media database.
This function gets the media folder meeting the given filter. The callback function will be invoked for every retrieved folder. If NULL
is passed to the filter, no filtering is applied.
[in] | filter | The handle to the media folder filter |
[in] | callback | The callback function to be invoked |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_foreach_media_from_db | ( | const char * | folder_id, |
filter_h | filter, | ||
media_info_cb | callback, | ||
void * | user_data | ||
) |
Iterates through the media files with an optional filter in the given folder from the media database.
This function gets all media files associated with the given folder and meeting desired filter option and calls registered callback function for every retrieved media item. If NULL
is passed to the filter, no filtering is applied.
[in] | folder_id | The ID of the media folder |
[in] | filter | The handle to the media info filter |
[in] | callback | The callback function to be invoked |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_folder_count_from_db | ( | filter_h | filter, |
int * | folder_count | ||
) |
Gets the count of folder for the passed filter from the media database.
[in] | filter | The handle to filter To allow searching over different content types, you should use filter_h. |
[out] | folder_count | The count of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_DB_FAILED | DB operation failed |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_folder_from_db | ( | const char * | folder_id, |
media_folder_h * | folder | ||
) |
Gets the media folder from the media database.
This function creates a new media folder handle from the media database by the given folder_id. Media folder will be created, which is filled with folder information.
[in] | folder_id | The ID of the media folder |
[out] | folder | The media folder handle associated with the folder ID |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_folder_id | ( | media_folder_h | folder, |
char ** | folder_id | ||
) |
Gets the media folder ID.
[in] | folder | The handle to the media folder |
[out] | folder_id | The ID of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_media_count_from_db | ( | const char * | folder_id, |
filter_h | filter, | ||
int * | media_count | ||
) |
Gets the count of media files for the passed filter in the given folder from the media database.
[in] | folder_id | The ID of the media folder |
[in] | filter | The filter of the media content |
[out] | media_count | The count of media folder items |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_DB_FAILED | DB operation failed |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_modified_time | ( | media_folder_h | folder, |
time_t * | date | ||
) |
Gets the modified date of the folder.
[in] | folder | The handle to the media folder |
[out] | date | The modified date of the folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
int media_folder_get_name | ( | media_folder_h | folder, |
char ** | folder_name | ||
) |
Gets the media folder name.
[in] | folder | The handle to the media folder |
[out] | folder_name | The name of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_path | ( | media_folder_h | folder, |
char ** | path | ||
) |
Gets the absolute path to the media folder.
[in] | folder | The handle to the media folder |
[out] | path | The path of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_get_storage_type | ( | media_folder_h | folder, |
media_content_storage_e * | storage_type | ||
) |
Gets the folder storage type.
[in] | folder | The handle to the media folder |
[out] | storage_type | The storage type of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_set_name | ( | media_folder_h | folder, |
const char * | name | ||
) |
Sets the folder name.
[in] | folder | The handle to the media folder |
[in] | name | The name of the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |
int media_folder_update_to_db | ( | media_folder_h | folder | ) |
Updates the media folder to the media database.
The function updates the given media folder in the media database. The function should be called after any change in folder attributes, to be updated to the media database. For example, after using media_folder_set_name() for setting the name of the folder, the media_folder_update_to_db() function should be called so as to update the given folder attributes in the media database.
[in] | folder | The handle to the media folder |
0
on success, otherwise a negative error valueMEDIA_CONTENT_ERROR_NONE | Successful |
MEDIA_CONTENT_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTENT_ERROR_PERMISSION_DENIED | Permission denied |