CCAux  2.7.2.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.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Buzzer settings
13 *
14 * Use the function GetBuzzer() to get a handle to pass on to the other functions.
15 * Use the method Buzzer_release(BUZZERHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include buzzer_example.cpp
19 *
20 ************************************************/
21 #ifndef CC_BUZZER_H
22 #define CC_BUZZER_H
23 
24 #include "CCAuxErrors.h"
25 #include "CCPlatform.h"
26 
27 #ifdef __cplusplus
28 namespace CrossControl {
29 #endif
30 
31  typedef void* BUZZERHANDLE;
32 
46  EXTERN_C
47  CCAUXDLL_API
48  BUZZERHANDLE
49  CCAUXDLL_CALLING_CONV
50  GetBuzzer(void);
51 
62  EXTERN_C
63  CCAUXDLL_API
64  void
65  CCAUXDLL_CALLING_CONV
66  Buzzer_release(BUZZERHANDLE);
67 
77  EXTERN_C
78  CCAUXDLL_API
79  eErr
80  CCAUXDLL_CALLING_CONV
81  Buzzer_getFrequency(BUZZERHANDLE, unsigned short* frequency);
82 
95  EXTERN_C
96  CCAUXDLL_API
97  eErr
98  CCAUXDLL_CALLING_CONV
99  Buzzer_getVolume(BUZZERHANDLE, unsigned short* volume);
100 
110  EXTERN_C
111  CCAUXDLL_API
112  eErr
113  CCAUXDLL_CALLING_CONV
114  Buzzer_getTrigger(BUZZERHANDLE, bool* trigger);
115 
128  EXTERN_C
129  CCAUXDLL_API
130  eErr
131  CCAUXDLL_CALLING_CONV
132  Buzzer_setFrequency(BUZZERHANDLE, unsigned short frequency);
133 
146  EXTERN_C
147  CCAUXDLL_API
148  eErr
149  CCAUXDLL_CALLING_CONV
150  Buzzer_setVolume(BUZZERHANDLE, unsigned short volume);
151 
161  EXTERN_C
162  CCAUXDLL_API
163  eErr
164  CCAUXDLL_CALLING_CONV
165  Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
166 
180  EXTERN_C
181  CCAUXDLL_API
182  eErr
183  CCAUXDLL_CALLING_CONV
184  Buzzer_buzze(BUZZERHANDLE, int time, bool blocking);
185 
186 #ifdef __cplusplus
187 } /* namespace CrossControl */
188 #endif
189 
190 #endif /* CC_BUZZER_H */
191 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1