X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcec.h;h=cbc83463e6d327d2c953310e9cf54c3c7d1f1cca;hb=566a8c68bb4c34031b6f61b2afdcb05c9f1d755c;hp=0e463eb91fb4a88359f0a3b723dcc90681b81ac6;hpb=fa4798bd538f6114390884ad6f2f9c44c9f77e09;p=deb_libcec.git diff --git a/include/cec.h b/include/cec.h index 0e463eb..cbc8346 100644 --- 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. @@ -34,7 +34,7 @@ #ifndef CECEXPORTS_H_ #define CECEXPORTS_H_ -#include +#include "cectypes.h" namespace CEC { @@ -60,10 +60,11 @@ namespace CEC /*! * @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(ICECCallbacks *callbacks) = 0; + 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. @@ -145,6 +146,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. */ @@ -349,6 +351,51 @@ 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; + + /*! + * @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; @@ -359,6 +406,7 @@ 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; }; }; @@ -366,19 +414,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(const CEC::libcec_configuration *configuration); /*! * @brief Unload the CEC adapter library.