mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Doxygen comments added
This commit is contained in:
@@ -14,8 +14,8 @@
|
||||
// Hyperion includes
|
||||
#include <hyperion/Hyperion.h>
|
||||
|
||||
/// Check if XBMC is playing something. When it does not, this class will send all black data Hyperion to
|
||||
/// override (grabbed) data with a lower priority
|
||||
/// This class will check if XBMC is playing something. When it does not, this class will send all black data to Hyperion.
|
||||
/// This allows grabbed screen data to be overriden while in the XBMC menus.
|
||||
///
|
||||
/// Note: The json TCP server needs to be enabled manually in XBMC in System/Settings/Network/Services
|
||||
class XBMCVideoChecker : public QObject
|
||||
@@ -23,13 +23,22 @@ class XBMCVideoChecker : public QObject
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
/// @Constructor
|
||||
/// @param address Netwrok address of the XBMC instance
|
||||
/// @param port Port number to use (XBMC default = 9090)
|
||||
/// @param interval The interval at which XBMC is polled
|
||||
/// @param hyperion The Hyperion instance
|
||||
/// @param priority The priority at which to send the all black data
|
||||
XBMCVideoChecker(const std::string & address, uint16_t port, uint64_t interval, Hyperion * hyperion, int priority);
|
||||
|
||||
/// \brief Start polling XBMC
|
||||
void start();
|
||||
|
||||
private slots:
|
||||
/// \brief Send a request to XBMC
|
||||
void sendRequest();
|
||||
|
||||
/// @brief receive a reply from XBMC
|
||||
void receiveReply();
|
||||
|
||||
private:
|
||||
|
Reference in New Issue
Block a user