CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Buzzer.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Buzzer.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Buzzer settings
14  *
15  * Use the function GetBuzzer() to get a handle to pass on to the other functions.
16  * Use the method Buzzer_release(BUZZERHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include buzzer_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_BUZZER_H
23 #define CC_BUZZER_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* BUZZERHANDLE;
33 
47  EXTERN_C
48  CCAUXDLL_API
49  BUZZERHANDLE
50  CCAUXDLL_CALLING_CONV
51  GetBuzzer(void);
52 
63  EXTERN_C
64  CCAUXDLL_API
65  void
66  CCAUXDLL_CALLING_CONV
67  Buzzer_release(BUZZERHANDLE);
68 
78  EXTERN_C
79  CCAUXDLL_API
80  eErr
81  CCAUXDLL_CALLING_CONV
82  Buzzer_getFrequency(BUZZERHANDLE, unsigned short* frequency);
83 
96  EXTERN_C
97  CCAUXDLL_API
98  eErr
99  CCAUXDLL_CALLING_CONV
100  Buzzer_getVolume(BUZZERHANDLE, unsigned short* volume);
101 
111  EXTERN_C
112  CCAUXDLL_API
113  eErr
114  CCAUXDLL_CALLING_CONV
115  Buzzer_getTrigger(BUZZERHANDLE, bool* trigger);
116 
129  EXTERN_C
130  CCAUXDLL_API
131  eErr
132  CCAUXDLL_CALLING_CONV
133  Buzzer_setFrequency(BUZZERHANDLE, unsigned short frequency);
134 
147  EXTERN_C
148  CCAUXDLL_API
149  eErr
150  CCAUXDLL_CALLING_CONV
151  Buzzer_setVolume(BUZZERHANDLE, unsigned short volume);
152 
162  EXTERN_C
163  CCAUXDLL_API
164  eErr
165  CCAUXDLL_CALLING_CONV
166  Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
167 
181  EXTERN_C
182  CCAUXDLL_API
183  eErr
184  CCAUXDLL_CALLING_CONV
185  Buzzer_buzze(BUZZERHANDLE, int time, bool blocking);
186 
187 #ifdef __cplusplus
188 } /* namespace CrossControl */
189 #endif
190 
191 #endif /* CC_BUZZER_H */
192 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1