#ifndef CECEXPORTS_H_
#define CECEXPORTS_H_
-#include <cectypes.h>
+#include "cectypes.h"
namespace CEC
{
virtual bool StartBootloader(void) = 0;
//@}
- /*!
- * @return Get the minimal version of libcec that this version of libcec can interface with.
- */
- virtual int8_t GetMinLibVersion(void) const = 0;
-
- /*!
- * @return Get the major version of libcec.
- */
- virtual int8_t GetLibVersionMajor(void) const = 0;
-
- /*!
- * @return Get the minor version of libcec.
- */
- virtual int8_t GetLibVersionMinor(void) const = 0;
-
- /*!
- * @brief Get the next log message in the queue, if there is one.
- * @param message The next message.
- * @return True if a message was passed, false otherwise.
- */
- virtual bool GetNextLogMessage(cec_log_message *message) = 0;
-
- /*!
- * @brief Get the next keypress in the queue, if there is one.
- * @param key The next keypress.
- * @return True if a key was passed, false otherwise.
- */
- virtual bool GetNextKeypress(cec_keypress *key) = 0;
-
- /*!
- * @brief Get the next CEC command that was received by the adapter.
- * @param action The next command.
- * @return True when a command was passed, false otherwise.
- */
- virtual bool GetNextCommand(cec_command *command) = 0;
-
/*!
* @brief Transmit a command over the CEC line.
* @param data The command to send.
*/
virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
- /*!
- * @brief Enable physical address detection (if the connected adapter supports this).
- * @return True when physical address detection was enabled, false otherwise.
- */
- virtual bool EnablePhysicalAddressDetection(void) = 0;
-
/*!
* @brief Changes the active HDMI port.
* @param iBaseDevice The device to which this libcec is connected.
*/
virtual bool SetActiveSource(cec_device_type type = CEC_DEVICE_TYPE_RESERVED) = 0;
- /*!
- * @deprecated Use SetActiveSource() instead
- */
- virtual bool SetActiveView(void) = 0;
-
/*!
* @brief Change the deck control mode, if this adapter is registered as playback device.
* @param mode The new control mode.
*/
virtual cec_logical_addresses GetActiveDevices(void) = 0;
+ /*!
+ * @brief Tell libCEC to poll for active devices on the bus.
+ */
+ virtual void RescanActiveDevices(void) = 0;
+
/*!
* @brief Check whether a device is active on the bus.
* @param iAddress The address to check.
*/
virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0;
+ /*!
+ * @return The list of addresses that libCEC is controlling
+ */
+ virtual cec_logical_addresses GetLogicalAddresses(void) = 0;
+
+ /*!
+ * @brief Get libCEC's current configuration.
+ * @param configuration The configuration.
+ * @return True when the configuration was updated, false otherwise.
+ */
+ virtual bool GetCurrentConfiguration(libcec_configuration *configuration) = 0;
+
+ /*!
+ * @brief Change libCEC's configuration.
+ * @param configuration The new configuration.
+ * @return True when the configuration was changed successfully, false otherwise.
+ */
+ virtual bool SetConfiguration(const libcec_configuration *configuration) = 0;
+
+ /*!
+ * @return True when this device can persist the user configuration, false otherwise.
+ */
+ virtual bool CanPersistConfiguration(void) = 0;
+
+ /*!
+ * @brief Persist the given configuration in adapter (if supported)
+ * @brief The configuration to store.
+ * @return True when the configuration was persisted, false otherwise.
+ */
+ virtual bool PersistConfiguration(libcec_configuration *configuration) = 0;
+
virtual const char *ToString(const cec_menu_state state) = 0;
virtual const char *ToString(const cec_version version) = 0;
virtual const char *ToString(const cec_power_status status) = 0;
virtual const char *ToString(const cec_system_audio_status mode) = 0;
virtual const char *ToString(const cec_audio_status status) = 0;
virtual const char *ToString(const cec_vendor_id vendor) = 0;
+ virtual const char *ToString(const cec_client_version version) = 0;
+ virtual const char *ToString(const cec_server_version version) = 0;
+
+ ////// deprecated methods, may be removed in a future version //////
+
+ /*!
+ * @deprecated Use libcec_configuration instead.
+ * @brief Enable physical address detection (if the connected adapter supports this).
+ * @return True when physical address detection was enabled, false otherwise.
+ */
+ virtual bool EnablePhysicalAddressDetection(void) = 0;
+
+ /*!
+ * @deprecated Use SetActiveSource() instead
+ */
+ virtual bool SetActiveView(void) = 0;
+
+ /*!
+ * @deprecated Use libcec_configuration instead
+ * @return Get the minimal version of libcec that this version of libcec can interface with.
+ */
+ virtual int8_t GetMinLibVersion(void) const = 0;
+
+ /*!
+ * @deprecated Use libcec_configuration instead
+ * @return Get the major version of libcec.
+ */
+ virtual int8_t GetLibVersionMajor(void) const = 0;
+
+ /*!
+ * @deprecated Use libcec_configuration instead
+ * @return Get the minor version of libcec.
+ */
+ virtual int8_t GetLibVersionMinor(void) const = 0;
+
+ /*!
+ * @deprecated Use callback methods instead
+ * @brief Get the next log message in the queue, if there is one.
+ * @param message The next message.
+ * @return True if a message was passed, false otherwise.
+ */
+ virtual bool GetNextLogMessage(cec_log_message *message) = 0;
+
+ /*!
+ * @deprecated Use callback methods instead
+ * @brief Get the next keypress in the queue, if there is one.
+ * @param key The next keypress.
+ * @return True if a key was passed, false otherwise.
+ */
+ virtual bool GetNextKeypress(cec_keypress *key) = 0;
+
+ /*!
+ * @deprecated Use callback methods instead
+ * @brief Get the next CEC command that was received by the adapter.
+ * @param action The next command.
+ * @return True when a command was passed, false otherwise.
+ */
+ virtual bool GetNextCommand(cec_command *command) = 0;
+
};
};
* @brief Load the CEC adapter library.
* @param strDeviceName How to present this device to other devices.
* @param deviceTypes The device types to use on the CEC bus.
+ * @param iPhysicalAddress The physical address to assume on the bus. If set to 0, libCEC will try to autodetect the address, with the data provided via SetHDMIPort()
* @return An instance of ICECAdapter or NULL on error.
*/
-extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list devicesTypes);
+extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_type_list deviceTypes, uint16_t iPhysicalAddress = 0);
/*!
- * @deprecated Please use CECInit() instead
* @brief Load the CEC adapter library.
- * @param strDeviceName How to present this device to other devices.
- * @param iLogicalAddress The logical of this device. PLAYBACKDEVICE1 by default.
- * @param iPhysicalAddress The physical address of this device. 0x1000 by default.
+ * @param configuration The configuration to pass to libCEC
* @return An instance of ICECAdapter or NULL on error.
*/
-extern "C" DECLSPEC void * CECCreate(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+extern "C" DECLSPEC void * CECInitialise(CEC::libcec_configuration *configuration);
/*!
* @brief Unload the CEC adapter library.