CCAux  2.12.0.0
CCAux API reference
Buzzer.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Buzzer.h
6 *
7 * Version 2.12.0.0, 2017-12-21
8 *
9 * (c) CrossControl 2010-2017
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, uint16_t* frequency);
83 
97  EXTERN_C
98  CCAUXDLL_API
99  eErr
100  CCAUXDLL_CALLING_CONV
101  Buzzer_getVolume(BUZZERHANDLE, uint16_t* volume);
102 
117  EXTERN_C
118  CCAUXDLL_API
119  eErr
120  CCAUXDLL_CALLING_CONV
121  Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t* volume);
122 
132  EXTERN_C
133  CCAUXDLL_API
134  eErr
135  CCAUXDLL_CALLING_CONV
136  Buzzer_getTrigger(BUZZERHANDLE, bool* trigger);
137 
150  EXTERN_C
151  CCAUXDLL_API
152  eErr
153  CCAUXDLL_CALLING_CONV
154  Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency);
155 
169  EXTERN_C
170  CCAUXDLL_API
171  eErr
172  CCAUXDLL_CALLING_CONV
173  Buzzer_setVolume(BUZZERHANDLE, uint16_t volume);
174 
187  EXTERN_C
188  CCAUXDLL_API
189  eErr
190  CCAUXDLL_CALLING_CONV
191  Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume);
192 
202  EXTERN_C
203  CCAUXDLL_API
204  eErr
205  CCAUXDLL_CALLING_CONV
206  Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
207 
221  EXTERN_C
222  CCAUXDLL_API
223  eErr
224  CCAUXDLL_CALLING_CONV
225  Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking);
226 
227 #ifdef __cplusplus
228 } /* namespace CrossControl */
229 #endif
230 
231 #endif /* CC_BUZZER_H */
232 
void * BUZZERHANDLE
Definition: Buzzer.h:32
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency)
eErr
Definition: CCAuxTypes.h:154
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getFrequency(BUZZERHANDLE, uint16_t *frequency)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getVolume(BUZZERHANDLE, uint16_t *volume)
Definition: About.h:30
unsigned short uint16_t
Definition: CCAuxTypes.h:48
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume)
unsigned char uint8_t
Definition: CCAuxTypes.h:47
signed int int32_t
Definition: CCAuxTypes.h:46
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setVolume(BUZZERHANDLE, uint16_t volume)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Buzzer_release(BUZZERHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setTrigger(BUZZERHANDLE, bool trigger)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t *volume)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getTrigger(BUZZERHANDLE, bool *trigger)
EXTERN_C CCAUXDLL_API BUZZERHANDLE CCAUXDLL_CALLING_CONV GetBuzzer(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking)