#endif
/*!
- * @brief Try to find all connected CEC adapters. Only implemented on Linux and Windows at the moment.
+ * @brief Try to find all connected CEC adapters.
* @param deviceList The vector to store device descriptors in.
* @param iBufSize The size of the deviceList buffer.
* @param strDevicePath Optional device path. Only adds device descriptors that match the given device path.
virtual int8_t FindAdapters(cec_adapter *deviceList, uint8_t iBufSize, const char *strDevicePath = NULL) = 0;
/*!
- * @brief Ping the CEC adapter.
+ * @brief Sends a ping command to the adapter, to check if it's responding.
* @return True when the ping was succesful, false otherwise.
*/
virtual bool PingAdapter(void) = 0;
/*!
- * @brief Start the bootloader of the CEC adapter.
- * @return True when the command was sent succesfully, false otherwise.
+ * @brief Start the bootloader of the CEC adapter. Closes the connection when successful.
+ * @return True when the command was sent successfully, false otherwise.
*/
virtual bool StartBootloader(void) = 0;
//@}
/*!
* @deprecated Use libcec_configuration instead
- * @return Get the minimal version of libcec that this version of libcec can interface with.
+ * @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.
+ * @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.
+ * @return Get the minor version of libCEC.
*/
virtual int8_t GetLibVersionMinor(void) const = 0;
virtual bool GetNextCommand(cec_command *command) = 0;
/*!
- * @brief Transmit a command over the CEC line.
+ * @brief Transmit a raw CEC command over the CEC line.
* @param data The command to send.
* @return True when the data was sent and acked, false otherwise.
*/
virtual bool Transmit(const cec_command &data) = 0;
/*!
- * @brief Change the logical address of the CEC adapter.
+ * @brief Change the logical address on the CEC bus of the CEC adapter. libCEC automatically assigns a logical address, and this method is only available for debugging purposes.
* @param iLogicalAddress The CEC adapter's new logical address.
* @return True when the logical address was set successfully, false otherwise.
*/
virtual bool SetLogicalAddress(cec_logical_address iLogicalAddress = CECDEVICE_PLAYBACKDEVICE1) = 0;
/*!
- * @brief Change the physical address (HDMI port) of the CEC adapter.
+ * @brief Change the physical address (HDMI port) of the CEC adapter. libCEC will try to autodetect the physical address when connecting. If it did, it's set in libcec_configuration.
* @param iPhysicalAddress The CEC adapter's new physical address.
* @brief True when the physical address was set successfully, false otherwise.
*/
/*!
* @brief Changes the active HDMI port.
- * @param iBaseDevice The device to which this libcec is connected.
+ * @param iBaseDevice The device to which this libCEC is connected.
* @param iPort The new port number.
* @return True when changed, false otherwise.
*/
#endif
/*!
- * @brief Power on the connected CEC capable devices.
+ * @brief Power on the given CEC capable devices. If CECDEVICE_BROADCAST is used, then wakeDevice in libcec_configuration will be used.
* @param address The logical address to power on.
* @return True when the command was sent succesfully, false otherwise.
*/
virtual bool PowerOnDevices(cec_logical_address address = CECDEVICE_TV) = 0;
/*!
- * @brief Put connected CEC capable devices in standby mode.
+ * @brief Put the given CEC capable devices in standby mode. If CECDEVICE_BROADCAST is used, then standbyDevices in libcec_configuration will be used.
* @brief address The logical address of the device to put in standby.
* @return True when the command was sent succesfully, false otherwise.
*/
virtual bool StandbyDevices(cec_logical_address address = CECDEVICE_BROADCAST) = 0;
/*!
- * @brief Change the active source.
+ * @brief Change the active source to a device type handled by libCEC. Use CEC_DEVICE_TYPE_RESERVED to make the default type used by libCEC active.
* @param type The new active source. Leave empty to use the primary type
* @return True when the command was sent succesfully, false otherwise.
*/
virtual bool SetActiveView(void) = 0;
/*!
- * @brief Change the deck control mode, if this adapter is registered as playback device.
+ * @brief Change the deck control mode, if this adapter is registered as playback or recording device.
* @param mode The new control mode.
- * @param bSendUpdate True to send the status over the CEC line.
+ * @param bSendUpdate True to send the new status over the CEC line.
* @return True if set, false otherwise.
*/
virtual bool SetDeckControlMode(cec_deck_control_mode mode, bool bSendUpdate = true) = 0;
/*!
- * @brief Change the deck info, if this adapter is a playback device.
+ * @brief Change the deck info, if this adapter is a playback or recording device.
* @param info The new deck info.
- * @param bSendUpdate True to send the status over the CEC line.
+ * @param bSendUpdate True to send the new status over the CEC line.
* @return True if set, false otherwise.
*/
virtual bool SetDeckInfo(cec_deck_info info, bool bSendUpdate = true) = 0;
virtual bool SetInactiveView(void) = 0;
/*!
- * @brief Change the menu state.
- * @param state The new true.
- * @param bSendUpdate True to send the status over the CEC line.
+ * @brief Change the menu state. This value is already changed by libCEC automatically if a device is (de)activated.
+ * @param state The new state.
+ * @param bSendUpdate True to send the new status over the CEC line.
* @return True if set, false otherwise.
*/
virtual bool SetMenuState(cec_menu_state state, bool bSendUpdate = true) = 0;
/*!
- * @brief Display a message on the device with the given logical address.
- * @param iLogicalAddress The device to display the message on.
+ * @brief Display a message on the device with the given logical address. Not supported by most TVs.
+ * @param iLogicalAddress The logical address of 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.
virtual bool SetOSDString(cec_logical_address iLogicalAddress, cec_display_control duration, const char *strMessage) = 0;
/*!
- * @brief Enable or disable monitoring mode.
+ * @brief Enable or disable monitoring mode, for debugging purposes. If monitoring mode is enabled, libCEC won't respond to any command, but only log incoming data.
* @param bEnable True to enable, false to disable.
* @return True when switched successfully, false otherwise.
*/
/*!
* @brief Get the CEC version of the device with the given logical address
- * @param iLogicalAddress The device to get the CEC version for.
+ * @param iLogicalAddress The logical address of the device to get the CEC version for.
* @return The version or CEC_VERSION_UNKNOWN when the version couldn't be fetched.
*/
virtual cec_version GetDeviceCecVersion(cec_logical_address iLogicalAddress) = 0;
/*!
* @brief Get the menu language of the device with the given logical address
- * @param iLogicalAddress The device to get the menu language for.
+ * @param iLogicalAddress The logical address of the device to get the menu language for.
* @param language The requested menu language.
* @return True when fetched succesfully, false otherwise.
*/
/*!
* @brief Get the vendor ID of the device with the given logical address.
- * @param iLogicalAddress The device to get the vendor id for.
+ * @param iLogicalAddress The logical address of the device to get the vendor ID for.
* @return The vendor ID or 0 if it wasn't found.
*/
virtual uint64_t GetDeviceVendorId(cec_logical_address iLogicalAddress) = 0;
/*!
* @brief Get the power status of the device with the given logical address.
- * @param iLogicalAddress The device to get the power status for.
+ * @param iLogicalAddress The logical address of the device to get the power status for.
* @return The power status or CEC_POWER_STATUS_UNKNOWN if it wasn't found.
*/
virtual cec_power_status GetDevicePowerStatus(cec_logical_address iLogicalAddress) = 0;
#endif
/*!
- * @brief Sends a POLL message to a device.
+ * @brief Sends a POLL message to a device, to check if it's present and responding.
* @param iLogicalAddress The device to send the message to.
* @return True if the POLL was acked, false otherwise.
*/
virtual bool PollDevice(cec_logical_address iLogicalAddress) = 0;
/*!
- * @return The devices that are active on the bus and not handled by libcec.
+ * @return The logical addresses of the devices that are active on the bus, including those handled by libCEC.
*/
virtual cec_logical_addresses GetActiveDevices(void) = 0;
/*!
* @brief Send a keypress to a device on the CEC bus.
- * @param iDestination The address to send the message to.
+ * @param iDestination The logical address of the device to send the message to.
* @param key The key to send.
* @param bWait True to wait for a response, false otherwise.
* @return True when the keypress was acked, false otherwise.
/*!
* @brief Send a key release to a device on the CEC bus.
- * @param iDestination The address to send the message to.
+ * @param iDestination The logical address of the device to send the message to.
* @param bWait True to wait for a response, false otherwise.
- * @return True when the keypress was acked, false otherwise.
+ * @return True when the key release was acked, false otherwise.
*/
virtual bool SendKeyRelease(cec_logical_address iDestination, bool bWait = false) = 0;
/*!
* @brief Check whether a device is currently the active source on the CEC bus.
- * @param iLogicalAddress The address to check.
+ * @param iLogicalAddress The logical address of the device to check.
* @return True when it is the active source, false otherwise.
*/
virtual bool IsActiveSource(cec_logical_address iLogicalAddress) = 0;
virtual bool SetStreamPath(cec_logical_address iLogicalAddress) = 0;
/*!
- * @brief Sets the stream path to the device on the given logical address.
+ * @brief Sets the stream path to the device on the given physical 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
+ * @return The list of logical addresses that libCEC is controlling
*/
virtual cec_logical_addresses GetLogicalAddresses(void) = 0;
virtual bool SetConfiguration(const libcec_configuration *configuration) = 0;
/*!
- * @return True when this device can persist the user configuration, false otherwise.
+ * @return True when this CEC adapter 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.
+ * @brief configuration The configuration to store.
* @return True when the configuration was persisted, false otherwise.
*/
virtual bool PersistConfiguration(libcec_configuration *configuration) = 0;
virtual bool IsLibCECActiveSource(void) = 0;
/*!
- * @brief Get information about the given device
+ * @brief Get information about the given CEC adapter.
* @param strPort The port to which the device is connected
* @param config The device configuration
* @param iTimeoutMs The timeout in milliseconds
*/
virtual bool EnableCallbacks(void *cbParam, ICECCallbacks *callbacks) = 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.
/*!
* @brief Changes the active HDMI port.
- * @param iBaseDevice The device to which this libcec is connected.
+ * @param iBaseDevice The device to which this libCEC is connected.
* @param iPort The new port number.
* @return True when changed, false otherwise.
*/
/*!
* @brief Get the physical address of the device with the given logical address.
- * @param iLogicalAddress The device to get the vendor id for.
+ * @param iLogicalAddress The logical address of the device to get the physical address for.
* @return The physical address or 0 if it wasn't found.
*/
virtual uint16_t GetDevicePhysicalAddress(cec_logical_address iLogicalAddress) = 0;
repositories / deb_libcec.git / commitdiff
