cec: moved method decriptions from cecc.h to cec.h
[deb_libcec.git] / include / cecc.h
index 1d4c26c0c2b408110445bfcd39d8cc4497c9e199..d8fef4424d4e6426912071b4d989d8fc11c12fff 100644 (file)
 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 bool cec_init(const char *strDeviceName, CEC::cec_logical_address iLogicalAddress = CEC::CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+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 bool cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+extern DECLSPEC int cec_init(const char *strDeviceName, cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1, uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
 #endif
 
-/*!
- * @brief Unload the CEC adapter library.
- */
+#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
+
+
 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 bool cec_open(const char *strPort, uint32_t iTimeout);
+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 bool cec_ping_adapters(void);
+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 bool cec_start_bootloader(void);
+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.
- */
-extern DECLSPEC int8_t cec_get_lib_version(void);
+extern DECLSPEC int8_t cec_get_lib_version_major(void);
+
+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 bool cec_power_on_devices(CEC::cec_logical_address address = CEC::CECDEVICE_TV);
+extern DECLSPEC int cec_power_on_devices(CEC::cec_logical_address address = CEC::CECDEVICE_TV);
 #else
-extern DECLSPEC bool cec_power_on_devices(cec_logical_address address = CECDEVICE_TV);
+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 bool cec_standby_devices(CEC::cec_logical_address address = CEC::CECDEVICE_BROADCAST);
+extern DECLSPEC int cec_standby_devices(CEC::cec_logical_address address = CEC::CECDEVICE_BROADCAST);
 #else
-extern DECLSPEC bool cec_standby_devices(cec_logical_address address = CECDEVICE_BROADCAST);
+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 bool cec_set_active_view(void);
+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 bool cec_set_inactive_view(void);
+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 bool cec_get_next_log_message(CEC::cec_log_message *message);
+extern DECLSPEC int cec_get_next_log_message(CEC::cec_log_message *message);
 #else
-extern DECLSPEC bool cec_get_next_log_message(cec_log_message *message);
+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 bool cec_get_next_keypress(CEC::cec_keypress *key);
+extern DECLSPEC int cec_get_next_keypress(CEC::cec_keypress *key);
 #else
-extern DECLSPEC bool cec_get_next_keypress(cec_keypress *key);
+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 bool cec_get_next_command(CEC::cec_command *command);
+extern DECLSPEC int cec_get_next_command(CEC::cec_command *command);
 #else
-extern DECLSPEC bool cec_get_next_command(cec_command *command);
+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.
- * @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 bool cec_transmit(const CEC::cec_command &data, bool bWaitForAck = true);
+extern DECLSPEC int cec_transmit(const CEC::cec_command &data);
 #else
-extern DECLSPEC bool cec_transmit(const cec_command &data, bool bWaitForAck = true);
+extern DECLSPEC int cec_transmit(const cec_command &data);
+#endif
+
+#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
+
+extern DECLSPEC int cec_set_physical_address(uint16_t iPhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS);
+
+#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
+
+extern DECLSPEC int cec_switch_monitoring(int bEnable);
+
+#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
+
+#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
+
+#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
+
+#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 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.
- */
 #ifdef __cplusplus
-extern DECLSPEC bool cec_set_logical_address(CEC::cec_logical_address iLogicalAddress);
+extern DECLSPEC int cec_poll_device(CEC::cec_logical_address iLogicalAddress);
 #else
-extern DECLSPEC bool cec_set_logical_address(cec_logical_address myAddress, cec_logical_address targetAddress);
+extern DECLSPEC int cec_poll_device(cec_logical_address iLogicalAddress);
 #endif
 
 #ifdef __cplusplus