Add error case of device policy restriction for audio_in_prepare()
[platform/core/api/audio-io.git] / include / CAudioError.h
1 /*
2  * Copyright (c) 2015 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 #ifndef __TIZEN_MEDIA_AUDIO_IO_CAUDIOERROR_H__
18 #define __TIZEN_MEDIA_AUDIO_IO_CAUDIOERROR_H__
19
20
21 #ifdef __cplusplus
22
23
24 namespace tizen_media_audio {
25
26
27     /**
28      * Audio Error
29      */
30     class CAudioError {
31     public:
32         /* Enums Definition */
33         enum class EError : unsigned int {
34             ERROR_NONE,
35
36             ERROR_INVALID_ARGUMENT,
37             ERROR_INVALID_HANDLE,
38             ERROR_INVALID_SAMPLERATE,
39             ERROR_INVALID_CHANNEL,
40             ERROR_INVALID_FORMAT,
41             ERROR_INVALID_POINTER,
42             ERROR_INVALID_OPERATION,
43
44             ERROR_NOT_INITIALIZED,
45             ERROR_NOT_SUPPORTED,
46             ERROR_NOT_SUPPORTED_TYPE,
47
48             ERROR_PERMISSION_DENIED,
49
50             ERROR_DEVICE_POLICY_RESTRICTION,
51             ERROR_DEVICE_NOT_OPENED,
52             ERROR_DEVICE_NOT_CLOSED,
53
54             ERROR_OUT_OF_MEMORY,
55             ERROR_INTERNAL_OPERATION,
56             ERROR_FAILED_OPERATION,
57
58             ERROR_POLICY_BLOCKED,
59             ERROR_POLICY_INTERRUPTED,
60             ERROR_POLICY_DUPLICATED,
61
62             ERROR_MAX
63         };
64
65         /* Constants Definition */
66         static const unsigned int MSG_LENGTH = 512;
67
68         /* Constructor & Destructor */
69         CAudioError(EError err);
70         CAudioError(EError err, const char* fileName, const char* parentFunc, int lineNum);
71         CAudioError(EError err, const char* msg, const char* fileName, const char* parentFunc, int lineNum);
72         //CAudioError(CAudioError& err);
73         ~CAudioError();
74
75         /* Static Methods */
76         static EError getLastError();
77         static const char* getLastErrorMsg();
78
79         /* Setter & Getter */
80         EError getError();
81         const char* getErrorMsg();
82
83         /* Overrided Operation */
84         CAudioError& operator =  (const EError err);
85         CAudioError& operator =  (const CAudioError& err);
86         bool         operator != (const EError err);
87         bool         operator == (const EError err);
88         //friend bool operator == (const CAudioError& src, const EError& err);
89
90     private:
91         const char* __convertErrorToString(EError err);
92
93         /* Members */
94         static EError __mLastError;
95         static char   __mLastErrorMsg[MSG_LENGTH];
96         EError        __mError;
97         char          __mErrorMsg[MSG_LENGTH];
98     };
99
100
101 } /* namespace tizen_media_audio */
102
103 #endif
104 #endif /* __TIZEN_MEDIA_CPP_OBJECTS_IO_H__ */