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

Class for Raw UDP stream requests. More...

Inheritance diagram for dvblinkremote::RawUdpStreamRequest:
dvblinkremote::StreamRequest dvblinkremote::Request

Public Member Functions

 RawUdpStreamRequest (const std::string &serverAddress, const long dvbLinkChannelId, const std::string &clientId, const std::string &clientAddress, const unsigned short int streamingPort)
 Initializes a new instance of the dvblinkremote::RawUdpStreamRequest class.
 ~RawUdpStreamRequest ()
 Destructor for cleaning up allocated memory.
std::string & GetClientAddress ()
 Gets the client address of the stream request.
long GetStreamingPort ()
 Gets the streaming port of the stream request.
- Public Member Functions inherited from dvblinkremote::StreamRequest
 StreamRequest (const std::string &serverAddress, const long dvbLinkChannelId, const std::string &clientId, const std::string &streamType)
 Initializes a new instance of the dvblinkremote::StreamRequest class.
virtual ~StreamRequest ()=0
 Pure virtual destructor for cleaning up allocated memory.
std::string & GetServerAddress ()
 Gets the server address for the stream request.
long GetDVBLinkChannelID ()
 Gets the DVBLink channel identifier for the stream request.
std::string & GetClientID ()
 Gets the unique identification string of the client for the stream request.
std::string & GetStreamType ()
 Gets the stream type for the stream request.

Additional Inherited Members

- Public Attributes inherited from dvblinkremote::StreamRequest
long Duration
 The timeout until channel playback is stopped by a server (indefinite if not specified).

Detailed Description

Class for Raw UDP stream requests.

This is used as input parameter for the IDVBLinkRemoteConnection::PlayChannel method.

See Also
IDVBLinkRemoteConnection::PlayChannel()

Constructor & Destructor Documentation

dvblinkremote::RawUdpStreamRequest::RawUdpStreamRequest ( const std::string &  serverAddress,
const long  dvbLinkChannelId,
const std::string &  clientId,
const std::string &  clientAddress,
const unsigned short int  streamingPort 
)

Initializes a new instance of the dvblinkremote::RawUdpStreamRequest class.

Parameters
serverAddressa constant string reference representing the DVBLink server address.
dvbLinkChannelIda constant long representing the DVBLink channel identifier.
clientIda constant string reference representing the unique identification string of the client.
clientAddressa constant string reference representing the client address.
streamingPorta constant unsigned short representing the streaming port.
Remarks
serverAddress is the IP address/server network name of the DVBLink server.
clientId should be the same across all DVBLink Client API calls from a given client. It can be a uuid for example or id/mac of the client device.
dvblinkremote::RawUdpStreamRequest::~RawUdpStreamRequest ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::RawUdpStreamRequest::GetClientAddress ( )

Gets the client address of the stream request.

Returns
The client address for the stream request.
long dvblinkremote::RawUdpStreamRequest::GetStreamingPort ( )

Gets the streaming port of the stream request.

Returns
The streaming port for the stream request.