X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=include%2Fcecc.h;h=466714667e37bcbd26652eaffa6686ed2d39a248;hb=ff50391c4f0724c10c7bb19b927e29b92dc40cd3;hp=bfbe0ccba60b60838d5c0214f6010152fb07fe6d;hpb=02ee2c6832291a768a1bf749baf68ec8756db528;p=deb_libcec.git diff --git a/include/cecc.h b/include/cecc.h index bfbe0cc..4667146 100644 --- a/include/cecc.h +++ b/include/cecc.h @@ -53,6 +53,19 @@ extern DECLSPEC int cec_init(const char *strDeviceName, CEC::cec_logical_address 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 +extern DECLSPEC int cec_init_typed(const char *strDeviceName, cec_device_type_list devicesTypes); +#endif + + /*! * @brief Unload the CEC adapter library. */ @@ -98,12 +111,17 @@ 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_version(void); +extern DECLSPEC int8_t cec_get_min_lib_version(void); /*! - * @return Get the version of libcec. + * @return Get the major version of libcec. */ -extern DECLSPEC int8_t cec_get_lib_version(void); +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. @@ -175,26 +193,108 @@ extern DECLSPEC int cec_get_next_command(cec_command *command); /*! * @brief Transmit a frame on the CEC line. * @param data The frame to send. - * @param bWaitForAck Wait for an ACK message for 1 second after this frame has been sent. * @return True when the data was sent and acked, false otherwise. */ #ifdef __cplusplus -extern DECLSPEC int cec_transmit(const CEC::cec_command &data, int bWaitForAck = 1); +extern DECLSPEC int cec_transmit(const CEC::cec_command &data); #else -extern DECLSPEC int cec_transmit(const cec_command &data, int bWaitForAck = 1); +extern DECLSPEC int cec_transmit(const cec_command &data); #endif /*! - * @brief Set the logical address of the CEC adapter. - * @param iLogicalAddress The cec adapter's logical address. - * @return True when the logical address was set succesfully, false otherwise. + * @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); +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 +extern DECLSPEC int cec_poll_device(cec_logical_address iLogicalAddress); +#endif + #ifdef __cplusplus }; #endif