diff options
Diffstat (limited to 'doc/media_codec_doc.h')
-rw-r--r-- | doc/media_codec_doc.h | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/media_codec_doc.h b/doc/media_codec_doc.h new file mode 100644 index 0000000..28971c8 --- /dev/null +++ b/doc/media_codec_doc.h @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (the License); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an AS IS BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __TIZEN_MEDIA_CODEC_DOC_H__ +#define __TIZEN_MEDIA_CODEC_DOC_H__ + + +/** + * @file media_codec_doc.h + * @brief This file contains high level documentation of the CAPI MEDIA CODEC API. + */ + +/** + * @defgroup CAPI_MEDIA_CODEC_MODULE Media Codec + * @brief The @ref CAPI_MEDIA_CODEC_MODULE APIs provides functions for encodinging and decoding using media data + * @ingroup CAPI_MEDIA_FRAMEWORK + * + * @section CAPI_MEDIA_CODEC_MODULE_HEADER Required Header + * \#include <media_codec.h> + * + * @section CAPI_MEDIA_CODEC_MODULE_OVERVIEW Overview + * + * MEDIA CODEC API allows : + * The API allows you to direct access to the media codec on device. It operates on "raw" data, so any file headers + * must be stripped off. media_packet is used for zero-copy. + * + */ + +#endif // __TIZEN_MEDIA_CODEC_DOC_H__ |