b45e1f434bd3b05172e8e914edd2b3bbe46e09f4
[platform/core/api/video-util.git] / doc / video_util_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_VIDEO_UTIL_DOC_H__
19 #define __TIZEN_MEDIA_VIDEO_UTIL_DOC_H__
20
21 /**
22  * @file video_util_doc.h
23  * @brief This file contains high level documentation of the Multimedia Service.
24  */
25
26 /**
27  * @defgroup CAPI_MEDIA_VIDEO_UTIL_MODULE Video Util
28  * @brief  The @ref CAPI_MEDIA_VIDEO_UTIL_MODULE  APIs provides functions that transcode a media file.
29  * @ingroup CAPI_MEDIA_FRAMEWORK
30  *
31  * @section CAPI_MEDIA_VIDEO_UTIL_MODULE_HEADER Required Header
32  *   \#include <video_util.h>
33  *
34  * @section CAPI_MEDIA_VIDEO_UTIL_MODULE_OVERVIEW Overview
35  *
36  * Video Util API provides support for transcoding of a media file. Codec and the format that the API supported :
37  *- Video : mpge4/h.263/h.264
38  *- Audio : aac/amrnb
39  *- Format : 3gp/mp4/max
40  *
41  * @section CAPI_MEDIA_VIDEO_UTIL_FEATURE Related Features
42  * This API is related with the following features:\n
43  *  - http://tizen.org/feature/multimedia.transcoder\n
44  *
45  * It is recommended to design feature related codes in your application for reliability.\n
46  *
47  * 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
48  *
49  * 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
50  *
51  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
52  *
53  * @subsection CAPI_MEDIA_VIDEO_UTIL_FOREACH_OPERATIONS Foreach Operations
54  * <div><table class="doxtable" >
55  *     <tr>
56  *        <th><b>FOREACH</b></th>
57  *        <th><b>CALLBACK</b></th>
58  *        <th><b>DESCRIPTION</b></th>
59  *     </tr>
60  *     <tr>
61  *        <td>video_util_foreach_supported_file_format()</td>
62  *        <td>video_util_supported_file_format_cb()</td>
63  *        <td>Retrieves the list of supported media format</td>
64  *     </tr>
65  *     <tr>
66  *        <td>video_util_foreach_supported_video_codec()</td>
67  *        <td>video_util_supported_video_encoder_cb()</td>
68  *        <td>Retrieves the list of supported video codec</td>
69  *     </tr>
70  *     <tr>
71  *        <td>video_util_foreach_supported_audio_codec()</td>
72  *        <td>video_util_supported_audio_encoder_cb()</td>
73  *        <td>Retrieves the list of supported audio codec</td>
74  *     </tr>
75  *</table></div>
76  */
77
78 #endif // __TIZEN_MEDIA_VIDEO_UTIL_DOC_H__