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.
19 #ifndef __TIZEN_CONTENT_MEDIA_FILTER_H__
20 #define __TIZEN_CONTENT_MEDIA_FILTER_H__
22 #include <media_content_type.h>
27 #endif /* __cplusplus */
30 * @file media_filter.h
31 * @brief This file contains the media filter API and related operation with filters. \n
32 * The functions include: creating and destroying media filter handles that are used to get the filtered information, \n
33 * making free all resources related to the filter handle, limiting number of items returned, setting conditions for the filter, \n
34 * setting and getting media filter's content order and ordering keyword either descending or ascending.
38 * @addtogroup CAPI_CONTENT_MEDIA_FILTER_MODULE
43 * @brief Creates a media filter handle.
44 * @details This function creates a media filter handle. The handle can be
45 * used to get the filtered information based on filter properties i.e. offset, count, condition for searching and order.
49 * @remarks The @a filter should be released using media_info_filter_destroy().
51 * @param[out] filter The handle to the media filter
53 * @return @c 0 on success,
54 * otherwise a negative error value
56 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
57 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
58 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
60 * @see media_filter_destroy()
62 int media_filter_create(filter_h *filter);
65 * @brief Destroys a media filter handle.
66 * @details The function frees all resources related to the media filter handle. The filter
67 * handle no longer can be used to perform any operations. A new filter handle
68 * has to be created before the next usage.
72 * @param[in] filter The handle to the media filter
74 * @return @c 0 on success,
75 * otherwise a negative error value
77 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
78 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
80 * @see media_filter_create()
82 int media_filter_destroy(filter_h filter);
85 * @brief Sets the media filter offset and count.
86 * @details This function sets the @a offset and @a count for the given filter used to limit number of items returned.
87 * For example, if you set the @a offset as @c 10 and @a count as @c 5, then only searched data from @c 10 to @c 14 will be returned when the filter is used with foreach functions.
91 * @param[in] filter The handle to the media filter
92 * @param[in] offset The start position of the given media filter (Starting from zero)
93 * @param[in] count The number of items to be searched with respect to the offset
95 * @return @c 0 on success,
96 * otherwise a negative error value
98 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
99 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
101 * @see media_filter_create()
102 * @see media_filter_destroy()
104 int media_filter_set_offset(filter_h filter, int offset, int count);
107 * @brief Sets the @a condition for the given @a filter.
110 * @param[in] filter The handle to the media filter
111 * @param[in] condition The condition which is used WHERE clause on a query
112 * @param[in] collate_type The collate type for comparing two strings
114 * @return @c 0 on success,
115 * otherwise a negative error value
117 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
118 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
119 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
121 * @see media_filter_create()
122 * @see media_filter_destroy()
124 int media_filter_set_condition(filter_h filter, const char *condition, media_content_collation_e collate_type);
127 * @brief Sets the media filter content @a order_type and @a order_keyword i.e. either descending or ascending.
130 * @remarks If @a order_type set to #MEDIA_CONTENT_ORDER_OTHER, media_filter sorts by referring only to the value of @a order_keyword. \n
131 * Therefore, @a order_keyword must include collation type and order type. \n
132 * e.g. MEDIA_DISPLAY_NAME COLLATE NOCASE DESC, MEDIA_MODIFIED_TIME DESC
134 * @param[in] filter The handle to the media filter
135 * @param[in] order_type The search order type
136 * @param[in] order_keyword The search order keyword
137 * @param[in] collate_type The collate type for comparing two strings
139 * @return @c 0 on success,
140 * otherwise a negative error value
142 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
143 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
145 * @see media_filter_create()
146 * @see media_filter_destroy()
148 int media_filter_set_order(filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type);
151 * @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
154 * @param[in] filter The handle to the media filter
155 * @param[out] offset The start position of the given media filter (Starting from zero)
156 * @param[out] count The number of items to be searched with respect to the offset
158 * @return @c 0 on success,
159 * otherwise a negative error value
161 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
162 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
164 * @see media_filter_create()
165 * @see media_filter_destroy()
167 int media_filter_get_offset(filter_h filter, int *offset, int *count);
170 * @brief Gets the @a condition for the given @a filter.
173 * @remarks The @a condition should be released using free().
175 * @param[in] filter The handle to the media filter
176 * @param[out] condition The condition which is used WHERE clause on a query
177 * @param[out] collate_type The collate type for comparing two strings
179 * @return @c 0 on success,
180 * otherwise a negative error value
182 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
183 * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
184 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
186 * @see media_filter_create()
187 * @see media_filter_destroy()
189 int media_filter_get_condition(filter_h filter, char **condition, media_content_collation_e *collate_type);
192 * @brief Gets the media filter's content @a order_type and @a order_keyword i.e. either descending or ascending.
195 * @remarks The @a order_keyword should be released using free().
197 * @param[in] filter The handle to the media filter
198 * @param[out] order_type The search order type
199 * @param[out] order_keyword The search order keyword
200 * @param[out] collate_type The collate type for comparing two strings
202 * @return @c 0 on success,
203 * otherwise a negative error value
205 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
206 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
208 * @see media_filter_create()
209 * @see media_filter_destroy()
211 int media_filter_get_order(filter_h filter, media_content_order_e *order_type, char **order_keyword, media_content_collation_e *collate_type);
219 #endif /* __cplusplus */
221 #endif /* __TIZEN_CONTENT_MEDIA_FILTER_H__ */