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.
17 #ifndef __TIZEN_MEDIA_CODEC_DOC_H__
18 #define __TIZEN_MEDIA_CODEC_DOC_H__
22 * @file media_codec_doc.h
23 * @brief This file contains high level documentation of the CAPI MEDIA CODEC API.
27 * @defgroup CAPI_MEDIA_CODEC_MODULE Media Codec
28 * @brief The @ref CAPI_MEDIA_CODEC_MODULE APIs provides functions for encoding and decoding using media data
29 * @ingroup CAPI_MEDIA_FRAMEWORK
31 * @section CAPI_MEDIA_CODEC_MODULE_HEADER Required Header
32 * \#include <media_codec.h>
34 * @section CAPI_MEDIA_CODEC_MODULE_OVERVIEW Overview
36 * @section CAPI_MEDIA_CODEC_FEATURE Related Features
37 * This API is related with the following features:\n
38 * - %http://tizen.org/feature/multimedia.media_codec\n
40 * It is recommended to design feature related codes in your application for reliability.\n
42 * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
44 * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
46 * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
48 * MEDIA CODEC API allows :
49 * The API allows you to direct access to the media codec on device. It operates on "raw" data, so any file headers
50 * must be stripped off. media_packet is used for zero-copy.
54 #endif /* __TIZEN_MEDIA_CODEC_DOC_H__ */