cec: added SetStreamPath()/cec_set_stream_path_logical()/cec_set_stream_path_physical...

[deb_libcec.git] / include / cec.h

diff --git a/include/cec.h b/include/cec.h
index 98adaf9309b7bc9119122b9eaf2419230deeb95a..97e75a46f8e778b7d05471c9ea1e3f58afa81c97 100644 (file)
--- a/include/cec.h
+++ b/include/cec.h
@@ -2,7 +2,7 @@
 /*
  * This file is part of the libCEC(R) library.
  *
- * libCEC(R) is Copyright (C) 2011 Pulse-Eight Limited.  All rights reserved.
+ * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
  * libCEC(R) is an original work, containing original code.
  *
  * libCEC(R) is a trademark of Pulse-Eight Limited.
@@ -59,7 +59,15 @@ namespace CEC
     virtual void Close(void) = 0;
 
     /*!
-     * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment.
+     * @brief Set and enable the callback methods. If this method is not called, the GetNext...() methods will have to be used.
+     * @param cbParam Parameter to pass to callback methods.
+     * @param callbacks The callbacks to set.
+     * @return True when enabled, false otherwise.
+     */
+    virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 0;
+
+    /*!
+     * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment.
      * @param deviceList The vector to store device descriptors in.
      * @param iBufSize The size of the deviceList buffer.
      * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
@@ -286,24 +294,24 @@ namespace CEC
 
     /*!
      * @brief Sends a volume up keypress to an audiosystem if it's present.
-     * @param bWait Wait for the response of the audiosystem when true.
+     * @param bSendRelease Send a key release after the keypress.
      * @return The new audio status.
      */
-    virtual uint8_t VolumeUp(bool bWait = true) = 0;
+    virtual uint8_t VolumeUp(bool bSendRelease = true) = 0;
 
     /*!
      * @brief Sends a volume down keypress to an audiosystem if it's present.
-     * @param bWait Wait for the response of the audiosystem when true.
+     * @param bSendRelease Send a key release after the keypress.
      * @return The new audio status.
      */
-    virtual uint8_t VolumeDown(bool bWait = true) = 0;
+    virtual uint8_t VolumeDown(bool bSendRelease = true) = 0;
 
     /*!
      * @brief Sends a mute keypress to an audiosystem if it's present.
-     * @param bWait Wait for the response of the audiosystem when true.
+     * @param bSendRelease Send a key release after the keypress.
      * @return The new audio status.
      */
-    virtual uint8_t MuteAudio(bool bWait = true) = 0;
+    virtual uint8_t MuteAudio(bool bSendRelease = true) = 0;
 
     /*!
      * @brief Send a keypress to a device on the CEC bus.
@@ -327,7 +335,7 @@ namespace CEC
      * @param iAddress The device to get the OSD name for.
      * @return The OSD name.
      */
-    virtual cec_osd_name GetOSDName(cec_logical_address iAddress) = 0;
+    virtual cec_osd_name GetDeviceOSDName(cec_logical_address iAddress) = 0;
 
     /*!
      * @brief Get the logical address of the device that is currently the active source on the CEC bus.
@@ -342,6 +350,20 @@ namespace CEC
      */
     virtual bool IsActiveSource(cec_logical_address iAddress) = 0;
 
+    /*!
+     * @brief Sets the stream path to the device on the given logical address.
+     * @param iAddress The address to activate.
+     * @return True when the command was sent, false otherwise.
+     */
+    virtual bool SetStreamPath(cec_logical_address iAddress) = 0;
+
+    /*!
+     * @brief Sets the stream path to the device on the given logical address.
+     * @param iPhysicalAddress The address to activate.
+     * @return True when the command was sent, false otherwise.
+     */
+    virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 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;
@@ -352,7 +374,6 @@ namespace CEC
     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;
-
   };
 };