cec: added a command to the interface to start the bootloader directly, without going...

[deb_libcec.git] / include / cec.h

diff --git a/include/cec.h b/include/cec.h
index 1d36eb98ded34a299c3b48df92df97e3d17bdb82..0332088906e72a0a5c254ec42b023251aa02e00e 100644 (file)
--- a/include/cec.h
+++ b/include/cec.h
@@ -89,21 +89,25 @@ namespace CEC
     //@}
 
     /*!
+     * @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.
@@ -111,6 +115,7 @@ namespace CEC
     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.
@@ -118,6 +123,7 @@ namespace CEC
     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.
@@ -146,6 +152,7 @@ namespace CEC
     virtual bool SetPhysicalAddress(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS) = 0;
 
     /*!
+     * @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.
      */
@@ -369,6 +376,19 @@ namespace CEC
      */
     virtual cec_logical_addresses GetLogicalAddresses(void) = 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_logical_address address) = 0;
+    virtual const char *ToString(const cec_deck_control_mode mode) = 0;
+    virtual const char *ToString(const cec_deck_info status) = 0;
+    virtual const char *ToString(const cec_opcode opcode) = 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;
+
     /*!
      * @brief Get libCEC's current configuration.
      * @param configuration The configuration.
@@ -395,17 +415,15 @@ namespace CEC
      */
     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_logical_address address) = 0;
-    virtual const char *ToString(const cec_deck_control_mode mode) = 0;
-    virtual const char *ToString(const cec_deck_info status) = 0;
-    virtual const char *ToString(const cec_opcode opcode) = 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;
+    /*!
+     * @brief Tell libCEC to poll for active devices on the bus.
+     */
+    virtual void RescanActiveDevices(void) = 0;
+
+    /*!
+     * @return true when libCEC is the active source on the bus, false otherwise.
+     */
+    virtual bool IsLibCECActiveSource(void) = 0;
   };
 };
 
@@ -423,7 +441,13 @@ extern "C" DECLSPEC void * CECInit(const char *strDeviceName, CEC::cec_device_ty
  * @param configuration The configuration to pass to libCEC
  * @return An instance of ICECAdapter or NULL on error.
  */
-extern "C" DECLSPEC void * CECInitialise(const CEC::libcec_configuration *configuration);
+extern "C" DECLSPEC void * CECInitialise(CEC::libcec_configuration *configuration);
+
+/*!
+ * @brief Try to connect to the adapter and send the "start bootloader" command, without initialising libCEC and going through all checks
+ * @return True when the command was send, false otherwise.
+ */
+extern "C" DECLSPEC bool CECStartBootloader(void);
 
 /*!
  * @brief Unload the CEC adapter library.