cec: change the previously unused boolean parameter in volume control methods to...
[deb_libcec.git] / include / cecc.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
34 #ifndef CECEXPORTS_C_H_
35 #define CECEXPORTS_C_H_
36
37 #include <cectypes.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 #ifdef __cplusplus
44 extern DECLSPEC int cec_init(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress);
45 #else
46 extern DECLSPEC int cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress, uint16_t iPhysicalAddress);
47 #endif
48
49 #ifdef __cplusplus
50 extern DECLSPEC int cec_init_typed(const char *strDeviceName, CEC::cec_device_type_list devicesTypes);
51 #else
52 extern DECLSPEC int cec_init_typed(const char *strDeviceName, cec_device_type_list devicesTypes);
53 #endif
54
55
56 extern DECLSPEC void cec_destroy(void);
57
58 extern DECLSPEC int cec_open(const char *strPort, uint32_t iTimeout);
59
60 extern DECLSPEC void cec_close(void);
61
62 #ifdef __cplusplus
63 extern DECLSPEC int8_t cec_find_adapters(CEC::cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath);
64 #else
65 extern DECLSPEC int8_t cec_find_adapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath);
66 #endif
67
68 extern DECLSPEC int cec_ping_adapters(void);
69
70 extern DECLSPEC int cec_start_bootloader(void);
71
72 extern DECLSPEC int8_t cec_get_min_lib_version(void);
73
74 extern DECLSPEC int8_t cec_get_lib_version_major(void);
75
76 extern DECLSPEC int8_t cec_get_lib_version_minor(void);
77
78 #ifdef __cplusplus
79 extern DECLSPEC int cec_power_on_devices(CEC::cec_logical_address address);
80 #else
81 extern DECLSPEC int cec_power_on_devices(cec_logical_address address);
82 #endif
83
84 #ifdef __cplusplus
85 extern DECLSPEC int cec_standby_devices(CEC::cec_logical_address address);
86 #else
87 extern DECLSPEC int cec_standby_devices(cec_logical_address address);
88 #endif
89
90 extern DECLSPEC int cec_set_active_view(void);
91
92 #ifdef __cplusplus
93 extern DECLSPEC int cec_set_active_source(CEC::cec_device_type type);
94 #else
95 extern DECLSPEC int cec_set_active_source(cec_device_type type);
96 #endif
97
98 #ifdef __cplusplus
99 extern DECLSPEC int cec_set_deck_control_mode(CEC::cec_deck_control_mode mode, int bSendUpdate);
100 #else
101 extern DECLSPEC int cec_set_deck_control_mode(cec_deck_control_mode mode, int bSendUpdate);
102 #endif
103
104 #ifdef __cplusplus
105 extern DECLSPEC int cec_set_deck_info(CEC::cec_deck_info info, int bSendUpdate);
106 #else
107 extern DECLSPEC int cec_set_deck_info(cec_deck_info info, int bSendUpdate);
108 #endif
109
110 extern DECLSPEC int cec_set_inactive_view(void);
111
112 #ifdef __cplusplus
113 extern DECLSPEC int cec_set_menu_state(CEC::cec_menu_state state, int bSendUpdate);
114 #else
115 extern DECLSPEC int cec_set_menu_state(cec_menu_state state, int bSendUpdate);
116 #endif
117
118 #ifdef __cplusplus
119 extern DECLSPEC int cec_get_next_log_message(CEC::cec_log_message *message);
120 #else
121 extern DECLSPEC int cec_get_next_log_message(cec_log_message *message);
122 #endif
123
124 #ifdef __cplusplus
125 extern DECLSPEC int cec_get_next_keypress(CEC::cec_keypress *key);
126 #else
127 extern DECLSPEC int cec_get_next_keypress(cec_keypress *key);
128 #endif
129
130 #ifdef __cplusplus
131 extern DECLSPEC int cec_get_next_command(CEC::cec_command *command);
132 #else
133 extern DECLSPEC int cec_get_next_command(cec_command *command);
134 #endif
135
136 #ifdef __cplusplus
137 extern DECLSPEC int cec_transmit(const CEC::cec_command *data);
138 #else
139 extern DECLSPEC int cec_transmit(const cec_command *data);
140 #endif
141
142 #ifdef __cplusplus
143 extern DECLSPEC int cec_set_logical_address(CEC::cec_logical_address iLogicalAddress);
144 #else
145 extern DECLSPEC int cec_set_logical_address(cec_logical_address iLogicalAddress);
146 #endif
147
148 extern DECLSPEC int cec_set_physical_address(uint16_t iPhysicalAddress);
149
150 #ifdef __cplusplus
151 extern DECLSPEC int cec_set_osd_string(CEC::cec_logical_address iLogicalAddress, CEC::cec_display_control duration, const char *strMessage);
152 #else
153 extern DECLSPEC int cec_set_osd_string(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage);
154 #endif
155
156 extern DECLSPEC int cec_switch_monitoring(int bEnable);
157
158 #ifdef __cplusplus
159 extern DECLSPEC CEC::cec_version cec_get_device_cec_version(CEC::cec_logical_address iLogicalAddress);
160 #else
161 extern DECLSPEC cec_version cec_get_device_cec_version(cec_logical_address iLogicalAddress);
162 #endif
163
164 #ifdef __cplusplus
165 extern DECLSPEC int cec_get_device_menu_language(CEC::cec_logical_address iLogicalAddress, CEC::cec_menu_language *language);
166 #else
167 extern DECLSPEC int cec_get_device_menu_language(cec_logical_address iLogicalAddress, cec_menu_language *language);
168 #endif
169
170 #ifdef __cplusplus
171 extern DECLSPEC uint64_t cec_get_device_vendor_id(CEC::cec_logical_address iLogicalAddress);
172 #else
173 extern DECLSPEC uint64_t cec_get_device_vendor_id(cec_logical_address iLogicalAddress);
174 #endif
175
176 #ifdef __cplusplus
177 extern DECLSPEC uint16_t cec_get_device_physical_address(CEC::cec_logical_address iLogicalAddress);
178 #else
179 extern DECLSPEC uint16_t cec_get_device_physical_address(cec_logical_address iLogicalAddress);
180 #endif
181
182 #ifdef __cplusplus
183 extern DECLSPEC CEC::cec_logical_address cec_get_active_source(void);
184 #else
185 extern DECLSPEC cec_logical_address cec_get_active_source(void);
186 #endif
187
188 #ifdef __cplusplus
189 extern DECLSPEC int cec_is_active_source(CEC::cec_logical_address iAddress);
190 #else
191 extern DECLSPEC int cec_is_active_source(cec_logical_address iAddress);
192 #endif
193
194 #ifdef __cplusplus
195 extern DECLSPEC CEC::cec_power_status cec_get_device_power_status(CEC::cec_logical_address iLogicalAddress);
196 #else
197 extern DECLSPEC cec_power_status cec_get_device_power_status(cec_logical_address iLogicalAddress);
198 #endif
199
200 #ifdef __cplusplus
201 extern DECLSPEC int cec_poll_device(CEC::cec_logical_address iLogicalAddress);
202 #else
203 extern DECLSPEC int cec_poll_device(cec_logical_address iLogicalAddress);
204 #endif
205
206 #ifdef __cplusplus
207 extern DECLSPEC CEC::cec_logical_addresses cec_get_active_devices(void);
208 #else
209 extern DECLSPEC cec_logical_addresses cec_get_active_devices(void);
210 #endif
211
212 #ifdef __cplusplus
213 extern DECLSPEC int cec_is_active_device(CEC::cec_logical_address iAddress);
214 #else
215 extern DECLSPEC int cec_is_active_device(cec_logical_address iAddress);
216 #endif
217
218 #ifdef __cplusplus
219 extern DECLSPEC int cec_is_active_device_type(CEC::cec_device_type type);
220 #else
221 extern DECLSPEC int cec_is_active_device_type(cec_device_type type);
222 #endif
223
224 #ifdef __cplusplus
225 extern DECLSPEC int cec_set_hdmi_port(CEC::cec_logical_address iBaseDevice, uint8_t iPort);
226 #else
227 extern DECLSPEC int cec_set_hdmi_port(cec_logical_address iBaseDevice, uint8_t iPort);
228 #endif
229
230 extern DECLSPEC int cec_volume_up(int bSendRelease);
231
232 extern DECLSPEC int cec_volume_down(int bSendRelease);
233
234 extern DECLSPEC int cec_mute_audio(int bSendRelease);
235
236 #ifdef __cplusplus
237 extern DECLSPEC int cec_send_keypress(CEC::cec_logical_address iDestination, CEC::cec_user_control_code key, int bWait);
238 #else
239 extern DECLSPEC int cec_send_keypress(cec_logical_address iDestination, cec_user_control_code key, int bWait);
240 #endif
241
242 #ifdef __cplusplus
243 extern DECLSPEC int cec_send_key_release(CEC::cec_logical_address iDestination, int bWait);
244 #else
245 extern DECLSPEC int cec_send_key_release(cec_logical_address iDestination, int bWait);
246 #endif
247
248 #ifdef __cplusplus
249 extern DECLSPEC CEC::cec_osd_name cec_get_device_osd_name(CEC::cec_logical_address iAddress);
250 #else
251 extern DECLSPEC cec_osd_name cec_get_device_osd_name(cec_logical_address iAddress);
252 #endif
253
254 extern DECLSPEC int cec_enable_physical_address_detection(void);
255
256 #ifdef __cplusplus
257 };
258 #endif
259
260 #endif /* CECEXPORTS_C_H_ */