X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcecc.h;h=d8fef4424d4e6426912071b4d989d8fc11c12fff;hb=d9106f0886dca327718b7f701287c6263462b2c1;hp=466714667e37bcbd26652eaffa6686ed2d39a248;hpb=ff50391c4f0724c10c7bb19b927e29b92dc40cd3;p=deb_libcec.git diff --git a/include/cecc.h b/include/cecc.h index 4667146..d8fef44 100644 --- a/include/cecc.h +++ b/include/cecc.h @@ -40,25 +40,12 @@ extern "C" { #endif -/*! - * @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. - * @return True when initialised, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_init(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); #else extern DECLSPEC int cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); #endif -/*! - * @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. - * @return True when initialised, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_init_typed(const char *strDeviceName, CEC::cec_device_type_list devicesTypes); #else @@ -66,229 +53,108 @@ extern DECLSPEC int cec_init_typed(const char *strDeviceName, cec_device_type_li #endif -/*! - * @brief Unload the CEC adapter library. - */ extern DECLSPEC void cec_destroy(void); -/*! - * @brief Open a connection to the CEC adapter. - * @param strPort The path to the port. - * @param iTimeout Connection timeout in ms. - * @return True when connected, false otherwise. - */ extern DECLSPEC int cec_open(const char *strPort, uint32_t iTimeout); -/*! - * @brief Close the connection to the CEC adapter. - */ extern DECLSPEC void cec_close(void); -/*! - * @brief Try to find all connected CEC adapters. Only implemented on Linux at the moment. - * @param deviceList The vector to store device descriptors in. - * @param strDevicePath Optional device path. Only adds device descriptors that match the given device path. - * @return The number of devices that were found, or -1 when an error occured. - */ #ifdef __cplusplus extern DECLSPEC int8_t cec_find_adapters(CEC::cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL); #else extern DECLSPEC int8_t cec_find_adapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL); #endif -/*! - * @brief Ping the CEC adapter. - * @return True when the ping was succesful, false otherwise. - */ extern DECLSPEC int cec_ping_adapters(void); -/*! - * @brief Start the bootloader of the CEC adapter. - * @return True when the command was sent succesfully, false otherwise. - */ extern DECLSPEC int cec_start_bootloader(void); -/*! - * @return Get the minimal version of libcec that this version of libcec can interface with. - */ extern DECLSPEC int8_t cec_get_min_lib_version(void); -/*! - * @return Get the major version of libcec. - */ extern DECLSPEC int8_t cec_get_lib_version_major(void); -/*! - * @return Get the minor version of libcec. - */ extern DECLSPEC int8_t cec_get_lib_version_minor(void); -/*! - * @brief Power on the connected CEC capable devices. - * @param address The logical address to power on. - * @return True when the command was sent succesfully, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_power_on_devices(CEC::cec_logical_address address = CEC::CECDEVICE_TV); #else extern DECLSPEC int cec_power_on_devices(cec_logical_address address = CECDEVICE_TV); #endif -/*! - * @brief Put connected CEC capable devices in standby mode. - * @brief address The logical address of the device to put in standby. - * @return True when the command was sent succesfully, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_standby_devices(CEC::cec_logical_address address = CEC::CECDEVICE_BROADCAST); #else extern DECLSPEC int cec_standby_devices(cec_logical_address address = CECDEVICE_BROADCAST); #endif -/*! - * @brief Broadcast a message that notifies connected CEC capable devices that this device is the active source. - * @return True when the command was sent succesfully, false otherwise. - */ extern DECLSPEC int cec_set_active_view(void); -/*! - * @brief Broadcast a message that notifies connected CEC capable devices that this device is no longer the active source. - * @return True when the command was sent succesfully, false otherwise. - */ extern DECLSPEC int cec_set_inactive_view(void); -/*! - * @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. - */ #ifdef __cplusplus extern DECLSPEC int cec_get_next_log_message(CEC::cec_log_message *message); #else extern DECLSPEC int cec_get_next_log_message(cec_log_message *message); #endif -/*! - * @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. - */ #ifdef __cplusplus extern DECLSPEC int cec_get_next_keypress(CEC::cec_keypress *key); #else extern DECLSPEC int cec_get_next_keypress(cec_keypress *key); #endif -/*! - * @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. - */ #ifdef __cplusplus extern DECLSPEC int cec_get_next_command(CEC::cec_command *command); #else extern DECLSPEC int cec_get_next_command(cec_command *command); #endif -/*! - * @brief Transmit a frame on the CEC line. - * @param data The frame to send. - * @return True when the data was sent and acked, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_transmit(const CEC::cec_command &data); #else extern DECLSPEC int cec_transmit(const cec_command &data); #endif -/*! - * @brief Change the logical address of the CEC adapter. - * @param iLogicalAddress The CEC adapter's new logical address. - * @return True when the logical address was set successfully, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_set_logical_address(CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1); #else extern DECLSPEC int cec_set_logical_address(cec_logical_address myAddress, cec_logical_address targetAddress); #endif -/*! - * @brief Change the physical address (HDMI port) of the CEC adapter. - * @param iPhysicalAddress The CEC adapter's new physical address. - * @brief True when the physical address was set successfully, false otherwise. - */ extern DECLSPEC int cec_set_physical_address(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS); -/*! - * @brief Display a message on the device with the given logical address. - * @param iLogicalAddres The device to display the message on. - * @param duration The duration of the message - * @param strMessage The message to display. - * @return True when the command was sent, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_set_osd_string(CEC::cec_logical_address iLogicalAddress, CEC::cec_display_control duration, const char *strMessage); #else extern DECLSPEC int cec_set_osd_string(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage); #endif -/*! - * @brief Enable or disable monitoring mode. - * @param bEnable True to enable, false to disable. - * @return True when switched successfully, false otherwise. - */ extern DECLSPEC int cec_switch_monitoring(int bEnable); -/*! - * @brief Get the CEC version of the device with the given logical address - * @param iLogicalAddress The device to get the CEC version for. - * @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched. - */ #ifdef __cplusplus extern DECLSPEC CEC::cec_version cec_get_device_cec_version(CEC::cec_logical_address iLogicalAddress); #else extern DECLSPEC cec_version cec_get_device_cec_version(cec_logical_address iLogicalAddress); #endif -/*! - * @brief Get the menu language of the device with the given logical address - * @param iLogicalAddress The device to get the menu language for. - * @param language The requested menu language. - * @return True when fetched succesfully, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_get_device_menu_language(CEC::cec_logical_address iLogicalAddress, CEC::cec_menu_language *language); #else extern DECLSPEC int cec_get_device_menu_language(cec_logical_address iLogicalAddress, cec_menu_language *language); #endif -/*! - * @brief Get the vendor ID of the device with the given logical address. - * @param iLogicalAddress The device to get the vendor id for. - * @return The vendor ID or 0 if it wasn't found. - */ #ifdef __cplusplus extern DECLSPEC uint64_t cec_get_device_vendor_id(CEC::cec_logical_address iLogicalAddress); #else extern DECLSPEC uint64_t cec_get_device_vendor_id(cec_logical_address iLogicalAddress); #endif -/*! - * @brief Get the power status of the device with the given logical address. - * @param iLogicalAddress The device to get the power status for. - * @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found. - */ #ifdef __cplusplus extern DECLSPEC CEC::cec_power_status cec_get_device_power_status(CEC::cec_logical_address iLogicalAddress); #else extern DECLSPEC cec_power_status cec_get_device_power_status(cec_logical_address iLogicalAddress); #endif -/*! - * @brief Sends a POLL message to a device. - * @param iAddress The device to send the message to. - * @return True if the POLL was acked, false otherwise. - */ #ifdef __cplusplus extern DECLSPEC int cec_poll_device(CEC::cec_logical_address iLogicalAddress); #else