CCAux  2.15.2.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.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
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 
96  EXTERN_C
97  CCAUXDLL_API
98  eErr
99  CCAUXDLL_CALLING_CONV
100  Buzzer_getVolume(BUZZERHANDLE, uint16_t* volume);
101 
116  EXTERN_C
117  CCAUXDLL_API
118  eErr
119  CCAUXDLL_CALLING_CONV
120  Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t* volume);
121 
131  EXTERN_C
132  CCAUXDLL_API
133  eErr
134  CCAUXDLL_CALLING_CONV
135  Buzzer_getTrigger(BUZZERHANDLE, bool* trigger);
136 
149  EXTERN_C
150  CCAUXDLL_API
151  eErr
152  CCAUXDLL_CALLING_CONV
153  Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency);
154 
168  EXTERN_C
169  CCAUXDLL_API
170  eErr
171  CCAUXDLL_CALLING_CONV
172  Buzzer_setVolume(BUZZERHANDLE, uint16_t volume);
173 
186  EXTERN_C
187  CCAUXDLL_API
188  eErr
189  CCAUXDLL_CALLING_CONV
190  Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume);
191 
201  EXTERN_C
202  CCAUXDLL_API
203  eErr
204  CCAUXDLL_CALLING_CONV
205  Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
206 
220  EXTERN_C
221  CCAUXDLL_API
222  eErr
223  CCAUXDLL_CALLING_CONV
224  Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking);
225 
226 #ifdef __cplusplus
227 } /* namespace CrossControl */
228 #endif
229 
230 #endif /* CC_BUZZER_H */
231 
CrossControl::BUZZERHANDLE
void * BUZZERHANDLE
Definition: Buzzer.h:32
CrossControl::Buzzer_setFrequency
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::Buzzer_getFrequency
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getFrequency(BUZZERHANDLE, uint16_t *frequency)
CrossControl::Buzzer_getVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getVolume(BUZZERHANDLE, uint16_t *volume)
CrossControl
Definition: About.h:30
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::Buzzer_setScaledVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
int32_t
signed int int32_t
Definition: CCAuxTypes.h:46
CCAuxErrors.h
CrossControl::Buzzer_setVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setVolume(BUZZERHANDLE, uint16_t volume)
CrossControl::Buzzer_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Buzzer_release(BUZZERHANDLE)
CrossControl::Buzzer_setTrigger
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setTrigger(BUZZERHANDLE, bool trigger)
CrossControl::Buzzer_getScaledVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t *volume)
CrossControl::Buzzer_getTrigger
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getTrigger(BUZZERHANDLE, bool *trigger)
CrossControl::GetBuzzer
EXTERN_C CCAUXDLL_API BUZZERHANDLE CCAUXDLL_CALLING_CONV GetBuzzer(void)
CrossControl::Buzzer_buzze
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking)
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14