CCAux  2.17.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.17.0.0", 2019-10-22
8 *
9 * (c) CrossControl 2010-2019
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 
53  EXTERN_C
54  CCAUXDLL_API
55  BUZZERHANDLE
56  CCAUXDLL_CALLING_CONV
57  GetBuzzer(void);
58 
69  EXTERN_C
70  CCAUXDLL_API
71  void
72  CCAUXDLL_CALLING_CONV
73  Buzzer_release(BUZZERHANDLE);
74 
84  EXTERN_C
85  CCAUXDLL_API
86  eErr
87  CCAUXDLL_CALLING_CONV
88  Buzzer_getFrequency(BUZZERHANDLE, uint16_t* frequency);
89 
102  EXTERN_C
103  CCAUXDLL_API
104  eErr
105  CCAUXDLL_CALLING_CONV
106  Buzzer_getVolume(BUZZERHANDLE, uint16_t* volume);
107 
122  EXTERN_C
123  CCAUXDLL_API
124  eErr
125  CCAUXDLL_CALLING_CONV
126  Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t* volume);
127 
137  EXTERN_C
138  CCAUXDLL_API
139  eErr
140  CCAUXDLL_CALLING_CONV
141  Buzzer_getTrigger(BUZZERHANDLE, bool* trigger);
142 
155  EXTERN_C
156  CCAUXDLL_API
157  eErr
158  CCAUXDLL_CALLING_CONV
159  Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency);
160 
174  EXTERN_C
175  CCAUXDLL_API
176  eErr
177  CCAUXDLL_CALLING_CONV
178  Buzzer_setVolume(BUZZERHANDLE, uint16_t volume);
179 
192  EXTERN_C
193  CCAUXDLL_API
194  eErr
195  CCAUXDLL_CALLING_CONV
196  Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume);
197 
207  EXTERN_C
208  CCAUXDLL_API
209  eErr
210  CCAUXDLL_CALLING_CONV
211  Buzzer_setTrigger(BUZZERHANDLE, bool trigger);
212 
226  EXTERN_C
227  CCAUXDLL_API
228  eErr
229  CCAUXDLL_CALLING_CONV
230  Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking);
231 
233 #ifdef __cplusplus
234 } /* namespace CrossControl */
235 #endif
236 
237 #endif /* CC_BUZZER_H */
238 
CrossControl::BUZZERHANDLE
void * BUZZERHANDLE
Definition: Buzzer.h:32
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CrossControl::Buzzer_getTrigger
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getTrigger(BUZZERHANDLE, bool *trigger)
CCPlatform.h
CrossControl::Buzzer_setVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setVolume(BUZZERHANDLE, uint16_t volume)
CrossControl
Definition: About.h:30
CrossControl::GetBuzzer
EXTERN_C CCAUXDLL_API BUZZERHANDLE CCAUXDLL_CALLING_CONV GetBuzzer(void)
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::Buzzer_buzze
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_buzze(BUZZERHANDLE, int32_t time, bool blocking)
CrossControl::Buzzer_getVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getVolume(BUZZERHANDLE, uint16_t *volume)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
int32_t
signed int int32_t
Definition: CCAuxTypes.h:46
CrossControl::Buzzer_setFrequency
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setFrequency(BUZZERHANDLE, uint16_t frequency)
CrossControl::Buzzer_getScaledVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getScaledVolume(BUZZERHANDLE, uint8_t *volume)
CCAuxErrors.h
CrossControl::Buzzer_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Buzzer_release(BUZZERHANDLE)
CrossControl::Buzzer_getFrequency
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_getFrequency(BUZZERHANDLE, uint16_t *frequency)
CrossControl::Buzzer_setTrigger
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setTrigger(BUZZERHANDLE, bool trigger)
CrossControl::Buzzer_setScaledVolume
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Buzzer_setScaledVolume(BUZZERHANDLE, uint8_t volume)
Generated on Tue Oct 22 2019 17:00:44 for CCAux by   doxygen 1.8.14