-#ifndef __TIZEN_MEDIA_FILTER_H__
-#define __TIZEN_MEDIA_FILTER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FILTER_H__
+#define __TIZEN_CONTENT_MEDIA_FILTER_H__
#include <media_content_type.h>
* @details 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_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
- * @remarks You must release the @a filter handle using media_info_filter_destroy().
+ * @remarks The @a filter should be released using media_info_filter_destroy().
*
- * @param[out] filter A handle to the media filter
+ * @param[out] filter The handle to the media filter
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Destroys a media filter handle.
* @details The function frees all resources related to the media filter handle. The filter
- * handle no longer can be used to perform any operation. A new filter handle
+ * handle no longer can be used to perform any operations. A new filter handle
* has to be created before the next usage.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] filter The handle to the media filter
*
* @details This function sets the @a offset and @a count for the given filter used to limit number of items returned.
* 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.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] filter The handle to the media filter
- * @param[in] offset The start position of the given filter (Starting from zero)
- * @param[in] count The number of items to be searched with respect to the offset
+ * @param[in] offset The start position of the given media filter (Starting from zero)
+ * @param[in] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Sets the @a condition for the given @a filter.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
- * @param[in] filter The handle to the media filter
- * @param[in] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[in] condition The condition which is used WHERE clause on a query
* @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_set_condition(filter_h filter, const char *condition, media_content_collation_e collate_type);
/**
- * @brief Sets the media filter content @a order and order keyword i.e. either descending or ascending.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @brief Sets the media filter content @a order_type and @a order_keyword i.e. either descending or ascending.
+ * @since_tizen 2.3
+ *
+ * @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
+ * Therefore, @a order_keyword must include collation type and order type. \n
+ * e.g. MEDIA_DISPLAY_NAME COLLATE NOCASE DESC, MEDIA_MODIFIED_TIME DESC
*
- * @param[in] filter The handle to the media filter
- * @param[in] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[in] order_type The search order type
* @param[in] order_keyword The search order keyword
- * @param[in] collate_type The collate type for comparing two strings
+ * @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
int media_filter_set_order(filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type);
/**
- * @brief Sets the @a storage id for the given @a filter.
- * @details You can use this API when you want to search items only in the specific storage
+ * @brief Sets the @a storage_id for the given @a filter.
+ * @details You can use this function when you want to search items only in the specific storage
*
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*
- * @param[in] filter The handle to the media filter
- * @param[in] storage_id The storage_id for browsing or searching
+ * @param[in] filter The handle to the media filter
+ * @param[in] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
- * @param[in] filter The handle to the media filter
- * @param[out] offset The start position of the given filter (Starting from zero)
- * @param[out] count The number of items to be searched with respect to the offset
+ * @param[in] filter The handle to the media filter
+ * @param[out] offset The start position of the given media filter (Starting from zero)
+ * @param[out] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Gets the @a condition for the given @a filter.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
- * @remarks You must release @a condition using free().
+ * @remarks The @a condition should be released using free().
*
- * @param[in] filter The handle to the media info filter
- * @param[out] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[out] condition The condition which is used WHERE clause on a query
* @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_get_condition(filter_h filter, char **condition, media_content_collation_e *collate_type);
/**
- * @brief Gets the media filter's content @a order and order keyword i.e. either descending or ascending.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @brief Gets the media filter's content @a order_type and @a order_keyword i.e. either descending or ascending.
+ * @since_tizen 2.3
*
- * @remarks You must release @a order_keyword using free().
+ * @remarks The @a order_keyword should be released using free().
*
- * @param[in] filter The handle to the media filter
- * @param[out] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[out] order_type The search order type
* @param[out] order_keyword The search order keyword
- * @param[out] collate_type The collate type for comparing two strings
- *
- * @return @c 0 on success,
- * otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
- * @see media_filter_create()
- * @see 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);
-
-/**
- * @brief Get the @a storage id for given @a filter.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @remarks You must release @a storage_id using free().
- *
- * @param[in] filter The handle to media info filter
- * @param[out] storage_id The storage_id which is used in filter
+ * @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
* @see media_filter_create()
* @see media_filter_destroy()
*/
-int media_filter_get_storage(filter_h filter, char **storage_id);
+int media_filter_get_order(filter_h filter, media_content_order_e *order_type, char **order_keyword, media_content_collation_e *collate_type);
/**
* @}
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_FILTER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FILTER_H__ */
projects / platform / core / api / media-content.git / blobdiff