DVBLink Remote API Library documentation
0.2.0-Master
|
Class used for connecting to a DVBLink Connect! server. More...
Static Public Member Functions | |
static IDVBLinkRemoteConnection * | Connect (dvblinkremotehttp::HttpClient &httpClient, const std::string &hostAddress, const long port) |
Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it. | |
static IDVBLinkRemoteConnection * | Connect (dvblinkremotehttp::HttpClient &httpClient, const std::string &hostAddress, const long port, const std::string &username, const std::string &password) |
Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it. | |
static void | GetCopyrightNotice (std::string ©right) |
Gets the copyright notice of the DVBLink Remote API library. | |
static void | GetVersion (std::string &version) |
Gets the version information of the DVBLink Remote API library. | |
static void | GetVersion (int &major, int &minor, int &patch) |
Gets the version numbers of the DVBLink Remote API library. |
Class used for connecting to a DVBLink Connect! server.
|
static |
Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it.
[in] | httpClient | A dvblinkremotehttp::HttpClient reference to be used for sending and recieving HTTP requests/responses to/from the DVBLink Connect! server. |
[in] | hostAddress | A constanst string reference representing the host address of the DVBLink Connect! server. |
[in] | port | A constanst long representing the base streaming port of the DVBLink Connect! server. |
|
static |
Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it.
[in] | httpClient | A dvblinkremotehttp::HttpClient reference to be used for sending and recieving HTTP requests/responses to/from the DVBLink Connect! server. |
[in] | hostAddress | A constanst string reference representing the host address of the DVBLink Connect! server. |
[in] | port | A constanst long representing the base streaming port of the DVBLink Connect! server. |
[in] | username | A constanst string reference representing the user name to be used for authentication towards the DVBLink Connect! server. |
[in] | password | A constanst string reference representing the password to be used for authentication towards the DVBLink Connect! server. |
|
static |
Gets the copyright notice of the DVBLink Remote API library.
[in,out] | copyright | A string reference representing the string where the copyright notice will be provided. |
|
static |
Gets the version information of the DVBLink Remote API library.
[in,out] | version | A string reference representing the string where the version information will be provided. |
|
static |
Gets the version numbers of the DVBLink Remote API library.
[in,out] | major | An integer reference representing the integer where the major version information will be provided. |
[in,out] | minor | An integer reference representing the integer where the minor version information will be provided. |
[in,out] | patch | An integer reference representing the integer where the patch version information will be provided. |