cec: split up CEC processing and the public interface. removed obsolete methods from...

[deb_libcec.git] / include / CECExportsCpp.h

diff --git a/include/CECExportsCpp.h b/include/CECExportsCpp.h
index 635d5056bb8d7004188dc3e1e524f1e5cd05f9af..54dbcbfe3770e16eb027451f1b6970cf814fc066 100644 (file)
--- a/include/CECExportsCpp.h
+++ b/include/CECExportsCpp.h
@@ -33,9 +33,11 @@
 
 namespace CEC
 {
-  class ICECDevice
+  class ICECAdapter
   {
   public:
+    /*! @name Adapter methods */
+    //@{
     /*!
      * @see cec_open
      */
@@ -47,44 +49,30 @@ namespace CEC
     virtual void Close(void) = 0;
 
     /*!
-     * @see cec_find_devices
+     * @see cec_find_adapters
      */
-    virtual int  FindDevices(std::vector<cec_device> &deviceList, const char *strDevicePath = NULL) = 0;
+    virtual int FindAdapters(std::vector<cec_adapter> &deviceList, const char *strDevicePath = NULL) = 0;
 
     /*!
-     * @see cec_ping
+     * @see cec_ping_adapters
      */
-    virtual bool Ping(void) = 0;
+    virtual bool PingAdapter(void) = 0;
 
     /*!
      * @see cec_start_bootloader
      */
     virtual bool StartBootloader(void) = 0;
+    //@}
 
     /*!
-     * @depcrecated Use StandbyDevices() instead
-     */
-    virtual bool PowerOffDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
-
-    /*!
-     * @see cec_power_on_devices
-     */
-    virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
-
-    /*!
-     * @see cec_standby_devices
-     */
-    virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
-
-    /*!
-     * @see cec_set_active_view
+     * @see cec_get_min_version
      */
-    virtual bool SetActiveView(void) = 0;
+    virtual int GetMinVersion(void) = 0;
 
     /*!
-     * @see cec_set_inactive_view
+     * @see cec_get_lib_version
      */
-    virtual bool SetInactiveView(void) = 0;
+    virtual int GetLibVersion(void) = 0;
 
     /*!
      * @see cec_get_next_log_message
@@ -112,19 +100,25 @@ namespace CEC
     virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress) = 0;
 
     /*!
-     * @deprecated use SetLogicalAddress() instead
+     * @see cec_power_on_devices
      */
-    virtual bool SetAckMask(uint16_t iMask) = 0;
+    virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
 
     /*!
-     * @see cec_get_min_version
+     * @see cec_standby_devices
      */
-    virtual int GetMinVersion(void) = 0;
+    virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
 
     /*!
-     * @see cec_get_lib_version
+     * @see cec_set_active_view
      */
-    virtual int GetLibVersion(void) = 0;
+    virtual bool SetActiveView(void) = 0;
+
+    /*!
+     * @see cec_set_inactive_view
+     */
+    virtual bool SetInactiveView(void) = 0;
+
   };
 };
 
@@ -141,7 +135,7 @@ static int g_iLibCECInstanceCount = 0;
 /*!
  * @see cec_init
  */
-inline CEC::ICECDevice *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
+inline CEC::ICECAdapter *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 {
   typedef void* (__cdecl*_CreateLibCec)(const char *, uint8_t, uint8_t);
   _CreateLibCec CreateLibCec;
@@ -155,14 +149,14 @@ inline CEC::ICECDevice *LoadLibCec(const char *strName, CEC::cec_logical_address
   CreateLibCec = (_CreateLibCec) (GetProcAddress(g_libCEC, "CECCreate"));
   if (!CreateLibCec)
     return NULL;
-  return static_cast< CEC::ICECDevice* > (CreateLibCec(strName, iLogicalAddress, iPhysicalAddress));
+  return static_cast< CEC::ICECAdapter* > (CreateLibCec(strName, iLogicalAddress, iPhysicalAddress));
 }
 
 /*!
  * @brief Unload the given libcec instance.
  * @param device The instance to unload.
  */
-inline void UnloadLibCec(CEC::ICECDevice *device)
+inline void UnloadLibCec(CEC::ICECAdapter *device)
 {
   delete device;
 
@@ -178,16 +172,16 @@ inline void UnloadLibCec(CEC::ICECDevice *device)
 /*!
  * @see cec_init
  */
-inline CEC::ICECDevice *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
+inline CEC::ICECAdapter *LoadLibCec(const char *strName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, int iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS)
 {
-  return (CEC::ICECDevice*) CECCreate(strName, iLogicalAddress, iPhysicalAddress);
+  return (CEC::ICECAdapter*) CECCreate(strName, iLogicalAddress, iPhysicalAddress);
 };
 
 /*!
  * @brief Unload the given libcec instance.
  * @param device The instance to unload.
  */
-inline void UnloadLibCec(CEC::ICECDevice *device)
+inline void UnloadLibCec(CEC::ICECAdapter *device)
 {
   delete device;
 };