doc/metadata_extractor_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17
  18 #ifndef __TIZEN_MEDIA_METADATA_EXTRACTOR_DOC_H__
  19 #define __TIZEN_MEDIA_METADATA_EXTRACTOR_DOC_H__
  20
  21 /**
  22  * @file metadata_extractor_doc.h
  23  * @brief File contains the high level documentation for the Metadata Extractor API.
  24  *
  25  */
  26
  27 /**
  28  * @defgroup CAPI_METADATA_EXTRACTOR_MODULE Metadata Extractor
  29  * @ingroup CAPI_MEDIA_FRAMEWORK
  30  */
  31
  32 /**
  33  * @addtogroup CAPI_METADATA_EXTRACTOR_MODULE
  34  * @brief The @ref CAPI_METADATA_EXTRACTOR_MODULE API provides functions for extracting the metadata from an input media file.
  35  * @ingroup CAPI_MEDIA_FRAMEWORK
  36   * @section CAPI_METADATA_EXTRACTOR_MODULE_HEADER Required Header
  37  *    \#include <metadata_extractor.h>
  38  *
  39  * @section CAPI_METADATA_EXTRACTOR_OVERVIEW Overview
  40  * The @ref CAPI_METADATA_EXTRACTOR_MODULE API allows you to extract the metadata from a media file. To extract a particular type of metadata(#metadata_extractor_attr_e), create/destroy the handle(#metadata_extractor_create()/#metadata_extractor_destroy). To set the path for extracting, and call metadata_extractor_get_metadata().
  41  */
  42
  43 #endif /* __TIZEN_MEDIA_METADATA_EXTRACTOR_DOC_H__ */
  44
  45