The Media Filter API provides functions to manage media filters.

Required Header

#include <media_content.h>

Overview

A Media filter is required for filtering information associated with media Folder, Tag, Audio, Bookmark and Media Information on basis of details like offset, count, order and condition for searching.
Media Filter API provides functions for creating and destroying media filters.
It provide functions to set properties and also provide functions for getting filter properties associated with a given media filter.

Setting media filter properties helps to limit the number of filtered items as following:

Offset - Used to set starting position of the filter's search
Count - Used to set number of items to be searched from offset
Condition - Used to set keyword which user want to search
Order - Used to set type of media to be ordered by the filter

The Media Filter API provides functions for creating and destroying media filters.
It provide functions to set and get properties of the filter associated with a given media filter.
For creating a media filter (filter_h), call media_filter_create() function and call media_filter_destroy() function for destroying an existing filter.
For setting filter properties call the respective set functions e.g. to set offset position, call media_filter_set_offset() function and call media_filter_set_condition() function to set the condition like an sql "where" clause.
Searchable expression can use one of the following forms:

column = value
column > value
column >= value
column < value
column <= value
value = column
* - value > column
value >= column
value < column
value <= column
column IN (value)
column IN (value-list)
column NOT IN (value)
column NOT IN (value-list)
column LIKE value
expression1 AND expression2 OR expression3

Note that if you want to set quotation(" ' " or " " ") as value of LIKE operator, you should use two times.(" '' " or " "" ") \n And the optional ESCAPE clause is supported. Both percent symbol("%") and underscore symbol("_") are used in the LIKE pattern.
If these characters are used as value of LIKE operation, then the expression following the ESCAPE clause of sqlite will be ignored.

For example,

column LIKE ('#') ESCAPE('#') - "#" is escape character, it will be ignored.

Similarly, call respective get function to get filter properties e.g. call media_filter_get_condition() function to get condition of the media filter and call media_filter_get_order() function to get order (media_content_order_e) of the filtered items and so on.

Example

You can set the filter as follows.

 #include <stdio.h>
 #include <string.h>
 #include <media_content.h>

 #define MAX_QUERY_LEN 512
 #define DLOG_TAG "media-content-test"

 filter_h g_filter = NULL;

 int create_filter()
 {
     int ret = MEDIA_CONTENT_ERROR_NONE;
     char condition[MAX_QUERY_LEN] = {0,};

     snprintf(condition,sizeof(condition),"%s = 0",MEDIA_TYPE);

     ret = media_filter_create(&g_filter);
     ret = media_filter_set_condition(g_filter, condition, MEDIA_CONTENT_COLLATE_DEFAULT);
     ret = media_filter_set_order(g_filter, MEDIA_CONTENT_ORDER_DESC, MEDIA_ARTIST, MEDIA_CONTENT_COLLATE_DEFAULT);

     return ret;
 }

And you can use the created filter as follows.

 int get_media_count()
 {
     int ret = MEDIA_CONTENT_ERROR_NONE;
     int media_cnt = 0;

     ret = media_info_get_media_count_from_db(g_filter, &media_cnt);
     dlog_print(DLOG_DEBUG, DLOG_TAG, "media count [%d]\n", media_cnt);

     return ret;
 }

Functions
int	media_filter_create (filter_h *filter)
	Creates a media filter handle.
int	media_filter_destroy (filter_h filter)
	Destroys a media filter handle.
int	media_filter_set_offset (filter_h filter, int offset, int count)
	Sets the media filter offset and count.
int	media_filter_set_condition (filter_h filter, const char *condition, media_content_collation_e collate_type)
	Sets the condition for the given filter.
int	media_filter_set_order (filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type)
	Sets the media filter content order_type and order_keyword i.e. either descending or ascending.
int	media_filter_get_offset (filter_h filter, int offset, int count)
	Gets the offset and count for the given filter used to limit the number of items returned.
int	media_filter_get_condition (filter_h filter, char *condition, media_content_collation_e collate_type)
	Gets the condition for the given filter.
int	media_filter_get_order (filter_h filter, media_content_order_e order_type, char order_keyword, media_content_collation_e collate_type)
	Gets the media filter's content order_type and order_keyword i.e. either descending or ascending.
Typedefs
typedef struct filter_s *	filter_h
	The structure type for the Media filter handle.
Defines
#define	MEDIA_ID "MEDIA_ID"
	Media ID.
#define	MEDIA_PATH "MEDIA_PATH"
	Media full path.
#define	MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
	The file name including the extension.
#define	MEDIA_TYPE "MEDIA_TYPE"
	Media type.
#define	MEDIA_MIME_TYPE "MEDIA_MIME_TYPE"
	Media MIME type.
#define	MEDIA_SIZE "MEDIA_SIZE"
	Media file size.
#define	MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
	The time that content file was first added to media database.
#define	MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
	The last modification time provided by the file system.
#define	MEDIA_TIMELINE "MEDIA_TIMELINE"
	Media created time.
#define	MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
	Media thumbnail path.
#define	MEDIA_TITLE "MEDIA_TITLE"
	Media title get from tag or file name.
#define	MEDIA_ALBUM "MEDIA_ALBUM"
	Media album name.
#define	MEDIA_ARTIST "MEDIA_ARTIST"
	Media artist.
#define	MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
	Media album artist.
#define	MEDIA_GENRE "MEDIA_GENRE"
	Media genre.
#define	MEDIA_COMPOSER "MEDIA_COMPOSER"
	Media composer.
#define	MEDIA_YEAR "MEDIA_YEAR"
	Media year.
#define	MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
	Media recorded date.
#define	MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
	Media track number.
#define	MEDIA_DURATION "MEDIA_DURATION"
	Media duration.
#define	MEDIA_LONGITUDE "MEDIA_LONGITUDE"
	Media longitude.
#define	MEDIA_LATITUDE "MEDIA_LATITUDE"
	Media latitude.
#define	MEDIA_ALTITUDE "MEDIA_ALTITUDE"
	Media altitude.
#define	MEDIA_WIDTH "MEDIA_WIDTH"
	Media width.
#define	MEDIA_HEIGHT "MEDIA_HEIGHT"
	Media height.
#define	MEDIA_DATETAKEN "MEDIA_DATETAKEN"
	Media datetaken.
#define	MEDIA_FAVOURITE "MEDIA_FAVOURITE"
	The time to register favourite.
#define	MEDIA_IS_DRM "MEDIA_IS_DRM"
	Is DRM.
#define	MEDIA_360 "MEDIA_360"
	Virtual Reality content.
#define	FOLDER_ID "FOLDER_ID"
	Folder ID.
#define	FOLDER_PATH "FOLDER_PATH"
	Folder full path.
#define	FOLDER_NAME "FOLDER_NAME"
	Folder base name.
#define	PLAYLIST_NAME "PLAYLIST_NAME"
	Playlist name.
#define	MEDIA_PLAYLIST_ID "PLAYLIST_ID"
	Playlist id.
#define	PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
	Playlist member order.
#define	PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
	Media count in playlist.
#define	TAG_NAME "TAG_NAME"
	Tag name.
#define	MEDIA_TAG_ID "TAG_ID"
	Tag id.
#define	TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
	Media count in tag.
#define	BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
	Bookmark marked time.
#define	MEDIA_BOOKMARK_ID "BOOKMARK_ID"
	Bookmark id.
#define	BOOKMARK_NAME "BOOKMARK_NAME"
	Bookmark name.

Define Documentation

#define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"

Bookmark marked time.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of bookmark filter and order keyword.

Since :: 2.3

#define BOOKMARK_NAME "BOOKMARK_NAME"

Bookmark name.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of bookmark filter and order keyword.

Since :: 4.0

#define FOLDER_ID "FOLDER_ID"

Folder ID.

You can use above define to set the condition of folder filter and order keyword.

Since :: 2.3

#define FOLDER_NAME "FOLDER_NAME"

Folder base name.

You can use above define to set the condition of folder filter and order keyword.

Since :: 2.3

#define FOLDER_PATH "FOLDER_PATH"

Folder full path.

You can use above define to set the condition of folder filter and order keyword.

Since :: 2.3

#define MEDIA_360 "MEDIA_360"

Virtual Reality content.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 3.0

#define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"

The time that content file was first added to media database.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_ALBUM "MEDIA_ALBUM"

Media album name.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"

Media album artist.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_ALTITUDE "MEDIA_ALTITUDE"

Media altitude.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_ARTIST "MEDIA_ARTIST"

Media artist.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_BOOKMARK_ID "BOOKMARK_ID"

Bookmark id.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of bookmark filter and order keyword.

Since :: 4.0

#define MEDIA_COMPOSER "MEDIA_COMPOSER"

Media composer.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_DATETAKEN "MEDIA_DATETAKEN"

Media datetaken.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"

The file name including the extension.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_DURATION "MEDIA_DURATION"

Media duration.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_FAVOURITE "MEDIA_FAVOURITE"

The time to register favourite.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_GENRE "MEDIA_GENRE"

Media genre.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_HEIGHT "MEDIA_HEIGHT"

Media height.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_ID "MEDIA_ID"

Media ID.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_IS_DRM "MEDIA_IS_DRM"

Is DRM.

Deprecated:: Deprecated since 9.0.

There are 2 types:
0-not drm, 1-drm
You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_LATITUDE "MEDIA_LATITUDE"

Media latitude.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_LONGITUDE "MEDIA_LONGITUDE"

Media longitude.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_MIME_TYPE "MEDIA_MIME_TYPE"

Media MIME type.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"

The last modification time provided by the file system.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_PATH "MEDIA_PATH"

Media full path.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_PLAYLIST_ID "PLAYLIST_ID"

Playlist id.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of playlist filter and order keyword.

Since :: 4.0

#define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"

Media recorded date.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_SIZE "MEDIA_SIZE"

Media file size.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_TAG_ID "TAG_ID"

Tag id.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of tag filter and order keyword.

Since :: 4.0

#define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"

Media thumbnail path.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_TIMELINE "MEDIA_TIMELINE"

Media created time.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_TITLE "MEDIA_TITLE"

Media title get from tag or file name.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"

Media track number.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_TYPE "MEDIA_TYPE"

Media type.

There are 5 media types:
0-image, 1-video, 2-sound, 3-music, 4-other
You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_WIDTH "MEDIA_WIDTH"

Media width.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define MEDIA_YEAR "MEDIA_YEAR"

Media year.

You can use above define to set the condition of media filter and order keyword.

Since :: 2.3

#define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"

Media count in playlist.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of playlist filter and order keyword.

Since :: 2.3

#define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"

Playlist member order.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of playlist filter and order keyword.

Since :: 2.3

#define PLAYLIST_NAME "PLAYLIST_NAME"

Playlist name.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of playlist filter and order keyword.

Since :: 2.3

#define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"

Media count in tag.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of tag filter and order keyword.

Since :: 2.3

#define TAG_NAME "TAG_NAME"

Tag name.

Deprecated:: Deprecated since 9.0.

You can use above define to set the condition of tag filter and order keyword.

Since :: 2.3

Typedef Documentation

typedef struct filter_s* filter_h

The structure type for the Media filter handle.

Since :: 2.3

Function Documentation

int media_filter_create ( filter_h * filter )

Creates a media filter handle.

This function creates a media filter handle. The handle can be used to get the filtered information based on filter properties i.e. offset, count, condition for searching and order.

Since :: 2.3

Remarks:: The filter should be released using media_filter_destroy().

Parameters:

[out] filter The handle to the media filter

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

See also:: media_filter_destroy()

int media_filter_destroy ( filter_h filter )

Destroys a media filter handle.

The function frees all resources related to the media filter handle. The filter handle no longer can be used to perform any operations. A new filter handle has to be created before the next usage.

Since :: 2.3

Parameters:

[in] filter The handle to the media filter

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_filter_create()

int media_filter_get_condition	(	filter_h	filter,
		char **	condition,
		media_content_collation_e *	collate_type
	)

Gets the condition for the given filter.

Since :: 2.3

Remarks:: The condition should be released using free().

Parameters:

[in]	filter	The handle to the media filter
[out]	condition	The condition which is used WHERE clause on a query
[out]	collate_type	The collate type for comparing two strings

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:: media_filter_create(); media_filter_destroy()

int media_filter_get_offset	(	filter_h	filter,
		int *	offset,
		int *	count
	)

Gets the offset and count for the given filter used to limit the number of items returned.

Since :: 2.3

Parameters:

[in]	filter	The handle to the media filter
[out]	offset	The start position of the given media filter (Starting from zero)
[out]	count	The number of items to be searched with respect to the offset

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_filter_create(); media_filter_destroy()

int media_filter_get_order	(	filter_h	filter,
		media_content_order_e *	order_type,
		char **	order_keyword,
		media_content_collation_e *	collate_type
	)

Gets the media filter's content order_type and order_keyword i.e. either descending or ascending.

Since :: 2.3

Remarks:: The order_keyword should be released using free().

Parameters:

[in]	filter	The handle to the media filter
[out]	order_type	The search order type
[out]	order_keyword	The search order keyword
[out]	collate_type	The collate type for comparing two strings

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_filter_create(); media_filter_destroy()

int media_filter_set_condition	(	filter_h	filter,
		const char *	condition,
		media_content_collation_e	collate_type
	)

Sets the condition for the given filter.

Since :: 2.3

Parameters:

[in]	filter	The handle to the media filter
[in]	condition	The condition which is used WHERE clause on a query
[in]	collate_type	The collate type for comparing two strings

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:: media_filter_create(); media_filter_destroy()

int media_filter_set_offset	(	filter_h	filter,
		int	offset,
		int	count
	)

Sets the media filter offset and count.

This function sets the offset and count for the given filter used to limit number of items returned. For example, if you set the offset as 10 and count as 5, then only searched data from 10 to 14 will be returned when the filter is used with foreach functions.

Since :: 2.3

Parameters:

[in]	filter	The handle to the media filter
[in]	offset	The start position of the given media filter (Starting from zero)
[in]	count	The number of items to be searched with respect to the offset

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_filter_create(); media_filter_destroy()

int media_filter_set_order	(	filter_h	filter,
		media_content_order_e	order_type,
		const char *	order_keyword,
		media_content_collation_e	collate_type
	)

Sets the media filter content order_type and order_keyword i.e. either descending or ascending.

Since :: 2.3

Remarks:: If order_type set to MEDIA_CONTENT_ORDER_OTHER, media_filter sorts by referring only to the value of order_keyword.
Therefore, order_keyword must include collation type and order type.
e.g. MEDIA_DISPLAY_NAME COLLATE NOCASE DESC, MEDIA_MODIFIED_TIME DESC

Parameters:

[in]	filter	The handle to the media filter
[in]	order_type	The search order type
[in]	order_keyword	The search order keyword
[in]	collate_type	The collate type for comparing two strings

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_filter_create(); media_filter_destroy()

Required Header

Overview

Example

Functions

Typedefs

Defines

Define Documentation

Typedef Documentation

Function Documentation