X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcec.h;h=4a6ad989e7ef84042c2d47928cffda86e1b77124;hb=41e3372ac4ad2de0d20e19e9dc9c8776220451b1;hp=97e75a46f8e778b7d05471c9ea1e3f58afa81c97;hpb=f42d3e0fb1f63456b87232019d9cce731acad640;p=deb_libcec.git diff --git a/include/cec.h b/include/cec.h index 97e75a4..4a6ad98 100644 --- a/include/cec.h +++ b/include/cec.h @@ -34,7 +34,7 @@ #ifndef CECEXPORTS_H_ #define CECEXPORTS_H_ -#include +#include "cectypes.h" namespace CEC { @@ -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. */ @@ -364,6 +371,11 @@ namespace CEC */ virtual bool SetStreamPath(uint16_t iPhysicalAddress) = 0; + /*! + * @return The list of addresses that libCEC is controlling + */ + 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; @@ -374,6 +386,44 @@ 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; + 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. + * @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; + + /*! + * @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; }; }; @@ -381,19 +431,17 @@ namespace CEC * @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.