DVBLink Remote API Library documentation  0.2.0-Master
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
dvblinkremote::DVBLinkRemote Class Reference

Class used for connecting to a DVBLink Connect! server. More...

Static Public Member Functions

static IDVBLinkRemoteConnectionConnect (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 IDVBLinkRemoteConnectionConnect (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 &copyright)
 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.

Detailed Description

Class used for connecting to a DVBLink Connect! server.

Member Function Documentation

static IDVBLinkRemoteConnection* dvblinkremote::DVBLinkRemote::Connect ( dvblinkremotehttp::HttpClient httpClient,
const std::string &  hostAddress,
const long  port 
)
static

Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it.

Parameters
[in]httpClientA dvblinkremotehttp::HttpClient reference to be used for sending and recieving HTTP requests/responses to/from the DVBLink Connect! server.
[in]hostAddressA constanst string reference representing the host address of the DVBLink Connect! server.
[in]portA constanst long representing the base streaming port of the DVBLink Connect! server.
static IDVBLinkRemoteConnection* dvblinkremote::DVBLinkRemote::Connect ( dvblinkremotehttp::HttpClient httpClient,
const std::string &  hostAddress,
const long  port,
const std::string &  username,
const std::string &  password 
)
static

Connect to a DVBLink Connect! server and recieve a IDVBLinkRemoteConnection instance for executing DVBLink Remote API methods against it.

Parameters
[in]httpClientA dvblinkremotehttp::HttpClient reference to be used for sending and recieving HTTP requests/responses to/from the DVBLink Connect! server.
[in]hostAddressA constanst string reference representing the host address of the DVBLink Connect! server.
[in]portA constanst long representing the base streaming port of the DVBLink Connect! server.
[in]usernameA constanst string reference representing the user name to be used for authentication towards the DVBLink Connect! server.
[in]passwordA constanst string reference representing the password to be used for authentication towards the DVBLink Connect! server.
static void dvblinkremote::DVBLinkRemote::GetCopyrightNotice ( std::string &  copyright)
static

Gets the copyright notice of the DVBLink Remote API library.

Parameters
[in,out]copyrightA string reference representing the string where the copyright notice will be provided.
static void dvblinkremote::DVBLinkRemote::GetVersion ( std::string &  version)
static

Gets the version information of the DVBLink Remote API library.

Parameters
[in,out]versionA string reference representing the string where the version information will be provided.
static void dvblinkremote::DVBLinkRemote::GetVersion ( int &  major,
int &  minor,
int &  patch 
)
static

Gets the version numbers of the DVBLink Remote API library.

Parameters
[in,out]majorAn integer reference representing the integer where the major version information will be provided.
[in,out]minorAn integer reference representing the integer where the minor version information will be provided.
[in,out]patchAn integer reference representing the integer where the patch version information will be provided.