Commit | Line | Data |
---|---|---|
abbca718 LOK |
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 | ||
acec5f48 LOK |
34 | #ifndef CECEXPORTS_H_ |
35 | #define CECEXPORTS_H_ | |
36 | ||
761dcc45 | 37 | #include <cectypes.h> |
acec5f48 | 38 | |
abbca718 LOK |
39 | namespace CEC |
40 | { | |
2abe74eb | 41 | class ICECAdapter |
abbca718 LOK |
42 | { |
43 | public: | |
6eb6d0fd | 44 | virtual ~ICECAdapter() {}; |
2abe74eb LOK |
45 | /*! @name Adapter methods */ |
46 | //@{ | |
abbca718 LOK |
47 | /*! |
48 | * @see cec_open | |
49 | */ | |
25701fa6 | 50 | virtual bool Open(const char *strPort, uint32_t iTimeoutMs = 10000) = 0; |
abbca718 | 51 | |
f99bc831 LOK |
52 | /*! |
53 | * @see cec_close | |
54 | */ | |
5f39c4d8 | 55 | virtual void Close(void) = 0; |
f99bc831 | 56 | |
abbca718 | 57 | /*! |
2abe74eb | 58 | * @see cec_find_adapters |
abbca718 | 59 | */ |
25701fa6 | 60 | virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0; |
abbca718 LOK |
61 | |
62 | /*! | |
2abe74eb | 63 | * @see cec_ping_adapters |
abbca718 | 64 | */ |
2abe74eb | 65 | virtual bool PingAdapter(void) = 0; |
abbca718 LOK |
66 | |
67 | /*! | |
68 | * @see cec_start_bootloader | |
69 | */ | |
70 | virtual bool StartBootloader(void) = 0; | |
2abe74eb | 71 | //@} |
abbca718 LOK |
72 | |
73 | /*! | |
d75be19b | 74 | * @see cec_get_min_lib_version |
abbca718 | 75 | */ |
99e89a5b | 76 | virtual int8_t GetMinLibVersion(void) const = 0; |
abbca718 LOK |
77 | |
78 | /*! | |
d75be19b | 79 | * @see cec_get_lib_version_major |
abbca718 | 80 | */ |
99e89a5b | 81 | virtual int8_t GetLibVersionMajor(void) const = 0; |
abbca718 | 82 | |
eafd9bed | 83 | /*! |
d75be19b | 84 | * @see cec_get_lib_version_minor |
eafd9bed | 85 | */ |
99e89a5b | 86 | virtual int8_t GetLibVersionMinor(void) const = 0; |
eafd9bed | 87 | |
abbca718 LOK |
88 | /*! |
89 | * @see cec_get_next_log_message | |
90 | */ | |
91 | virtual bool GetNextLogMessage(cec_log_message *message) = 0; | |
92 | ||
93 | /*! | |
94 | * @see cec_get_next_keypress | |
95 | */ | |
96 | virtual bool GetNextKeypress(cec_keypress *key) = 0; | |
97 | ||
825ddb96 LOK |
98 | /*! |
99 | * @see cec_get_next_command | |
100 | */ | |
101 | virtual bool GetNextCommand(cec_command *command) = 0; | |
102 | ||
abbca718 LOK |
103 | /*! |
104 | * @see cec_transmit | |
105 | */ | |
8d84e2c0 | 106 | virtual bool Transmit(const cec_command &data) = 0; |
abbca718 LOK |
107 | |
108 | /*! | |
6dfe9213 | 109 | * @see cec_set_logical_address |
abbca718 | 110 | */ |
2492216a LOK |
111 | virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0; |
112 | ||
113 | /*! | |
114 | * @see cec_set_physical_address | |
115 | */ | |
116 | virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0; | |
6dfe9213 LOK |
117 | |
118 | /*! | |
2abe74eb | 119 | * @see cec_power_on_devices |
6dfe9213 | 120 | */ |
2abe74eb | 121 | virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0; |
abbca718 | 122 | |
df7339c6 | 123 | /*! |
2abe74eb | 124 | * @see cec_standby_devices |
df7339c6 | 125 | */ |
2abe74eb | 126 | virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0; |
df7339c6 LOK |
127 | |
128 | /*! | |
2abe74eb | 129 | * @see cec_set_active_view |
df7339c6 | 130 | */ |
2abe74eb LOK |
131 | virtual bool SetActiveView(void) = 0; |
132 | ||
133 | /*! | |
134 | * @see cec_set_inactive_view | |
135 | */ | |
136 | virtual bool SetInactiveView(void) = 0; | |
1969b140 LOK |
137 | |
138 | /*! | |
139 | * @see cec_set_osd_string | |
140 | */ | |
141 | virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0; | |
8b7e5ff6 LOK |
142 | |
143 | /*! | |
144 | * @see cec_switch_monitoring | |
145 | */ | |
146 | virtual bool SwitchMonitoring(bool bEnable) = 0; | |
6a1c0009 LOK |
147 | |
148 | /*! | |
149 | * @see cec_get_device_cec_version | |
150 | */ | |
151 | virtual cec_version GetDeviceCecVersion(cec_logical_address iAddress) = 0; | |
a3269a0a LOK |
152 | |
153 | /*! | |
154 | * @see cec_get_device_menu_language | |
155 | */ | |
156 | virtual bool GetDeviceMenuLanguage(cec_logical_address iAddress, cec_menu_language *language) = 0; | |
44c74256 LOK |
157 | |
158 | /*! | |
159 | * @see cec_get_device_vendor_id | |
160 | */ | |
161 | virtual uint64_t GetDeviceVendorId(cec_logical_address iAddress) = 0; | |
e55f3f70 LOK |
162 | |
163 | /*! | |
164 | * @see cec_get_device_power_status | |
165 | */ | |
166 | virtual cec_power_status GetDevicePowerStatus(cec_logical_address iAddress) = 0; | |
57f45e6c LOK |
167 | |
168 | /*! | |
169 | * @see cec_poll_device | |
170 | */ | |
171 | virtual bool PollDevice(cec_logical_address iAddress) = 0; | |
abbca718 LOK |
172 | }; |
173 | }; | |
174 | ||
f8513317 | 175 | extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list devicesTypes); |
acec5f48 LOK |
176 | extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); |
177 | extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance); | |
abbca718 | 178 | |
acec5f48 | 179 | #endif /* CECEXPORTS_H_ */ |