added changelog for v0.7
[deb_libcec.git] / include / cec.h
CommitLineData
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
39namespace 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 /*!
2abe74eb 74 * @see cec_get_min_version
abbca718 75 */
25701fa6 76 virtual int8_t GetMinVersion(void) = 0;
abbca718
LOK
77
78 /*!
2abe74eb 79 * @see cec_get_lib_version
abbca718 80 */
25701fa6 81 virtual int8_t GetLibVersion(void) = 0;
abbca718
LOK
82
83 /*!
84 * @see cec_get_next_log_message
85 */
86 virtual bool GetNextLogMessage(cec_log_message *message) = 0;
87
88 /*!
89 * @see cec_get_next_keypress
90 */
91 virtual bool GetNextKeypress(cec_keypress *key) = 0;
92
825ddb96
LOK
93 /*!
94 * @see cec_get_next_command
95 */
96 virtual bool GetNextCommand(cec_command *command) = 0;
97
abbca718
LOK
98 /*!
99 * @see cec_transmit
100 */
9dee1670 101 virtual bool Transmit(const cec_command &data, bool bWaitForAck = true) = 0;
abbca718
LOK
102
103 /*!
6dfe9213 104 * @see cec_set_logical_address
abbca718 105 */
2492216a
LOK
106 virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
107
108 /*!
109 * @see cec_set_physical_address
110 */
111 virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
6dfe9213
LOK
112
113 /*!
2abe74eb 114 * @see cec_power_on_devices
6dfe9213 115 */
2abe74eb 116 virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
abbca718 117
df7339c6 118 /*!
2abe74eb 119 * @see cec_standby_devices
df7339c6 120 */
2abe74eb 121 virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
df7339c6
LOK
122
123 /*!
2abe74eb 124 * @see cec_set_active_view
df7339c6 125 */
2abe74eb
LOK
126 virtual bool SetActiveView(void) = 0;
127
128 /*!
129 * @see cec_set_inactive_view
130 */
131 virtual bool SetInactiveView(void) = 0;
1969b140
LOK
132
133 /*!
134 * @see cec_set_osd_string
135 */
136 virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
abbca718
LOK
137 };
138};
139
acec5f48
LOK
140extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
141extern "C" DECLSPEC void CECDestroy(CEC::ICECAdapter *instance);
abbca718 142
acec5f48 143#endif /* CECEXPORTS_H_ */