Merge "remove Doxygen warning" into tizen_2.1
[platform/framework/native/media.git] / inc / FMediaAudioManagerTypes.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17
18 /**
19 * @file                 FMediaAudioManagerTypes.h
20 * @brief                This is the header file for the types of audio manager classes.
21 *
22 * This header files contains all the common things required for audio manager classes and its associated classes.
23 *
24 */
25 #ifndef _FMEDIA_AUDIO_MANAGER_TYPES_H_
26 #define _FMEDIA_AUDIO_MANAGER_TYPES_H_
27
28 namespace Tizen { namespace Media
29 {
30 /**
31  * @enum InputAudioDevice
32  *
33  * Defines the input audio devices.
34  *
35  * @since               2.0
36  */
37 enum InputAudioDevice
38 {
39         INPUT_AUDIO_DEVICE_NONE,                                                        /**< No input audio device */
40         INPUT_AUDIO_DEVICE_MIC,                                                         /**< The microphone */
41         INPUT_AUDIO_DEVICE_WIRED_ACCESSORY,     /**< The wired accessory such as headset*/
42         INPUT_AUDIO_DEVICE_BT_SCO,                                      /**< The bluetooth(SCO) */
43 };
44
45
46 /**
47  * @enum OutputAudioDevice
48  *
49  * Defines the output audio devices.
50  *
51  * @since               2.0
52  */
53 enum OutputAudioDevice
54 {
55         OUTPUT_AUDIO_DEVICE_NONE,                                                       /**< No output audio device */
56         OUTPUT_AUDIO_DEVICE_SPEAKER,                                            /**< The speaker */
57         OUTPUT_AUDIO_DEVICE_RECEIVER,                                   /**< The receiver */
58         OUTPUT_AUDIO_DEVICE_WIRED_ACCESSORY,    /**< The wired accessory such as earjack, headphone or headset*/
59         OUTPUT_AUDIO_DEVICE_BT_SCO,                                             /**< The bluetooth(SCO) */
60         OUTPUT_AUDIO_DEVICE_BT_A2DP,                                            /**< The bluetooth(A2DP) */
61         OUTPUT_AUDIO_DEVICE_DOCK,                                                       /**DOCK device*/
62         OUTPUT_AUDIO_DEVICE_HDMI,                                                       /** HDMI device*/
63         OUTPUT_AUDIO_DEVICE_WFD,                                                        /** WiFi-Direct device*/
64         OUTPUT_AUDIO_DEVICE_USB_AUDIO,                                          /** USB audio device*/
65 };
66
67 /**
68  * @enum AudioStreamType
69  *
70  * Defines the audio stream types.
71  *
72  * @since               2.0
73  */
74 enum AudioStreamType
75 {
76         AUDIO_STREAM_TYPE_NO_SOUND,                     /**< System is not playing any sound */
77         AUDIO_STREAM_TYPE_SYSTEM,                                       /**< System audio */
78         AUDIO_STREAM_TYPE_NOTIFICATION,                 /**< Notification audio */
79         AUDIO_STREAM_TYPE_ALARM,                                        /**< Alarm type audio */
80         AUDIO_STREAM_TYPE_RINGTONE,                             /**< Ringtone type audio */
81         AUDIO_STREAM_TYPE_MEDIA,                                                /**< Media type audio */
82         AUDIO_STREAM_TYPE_CALL                                          /**< Call type audio */
83 };
84
85 }}      //Tizen::Media
86 #endif