dvblinkremote::StreamRequest Class Reference

Abstract base class for stream requests. More...

Inheritance diagram for dvblinkremote::StreamRequest:

Public Member Functions
	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.

Public Attributes
long	Duration
	The timeout until channel playback is stopped by a server (indefinite if not specified).

Detailed Description

Abstract base class for stream requests.

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

See Also

IDVBLinkRemoteConnection::PlayChannel()

Constructor & Destructor Documentation

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.

Parameters

serverAddress	a constant string reference representing the DVBLink server address.
dvbLinkChannelId	a constant long representing the DVBLink channel identifier.
clientId	a constant string reference representing the unique identification string of the client.
streamType	a constant string reference representing the stream type for the stream request.

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.

virtual dvblinkremote::StreamRequest::~StreamRequest ( )

pure virtual

Pure virtual destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::StreamRequest::GetClientID

(

)

Gets the unique identification string of the client for the stream request.

Returns

Stream request client identifier

long dvblinkremote::StreamRequest::GetDVBLinkChannelID

(

)

Gets the DVBLink channel identifier for the stream request.

Returns

Stream request channel identifier

std::string& dvblinkremote::StreamRequest::GetServerAddress

(

)

Gets the server address for the stream request.

Returns

Stream request server address

Remarks

Ip address/server network name of the DVBLink server.

std::string& dvblinkremote::StreamRequest::GetStreamType

(

)

Gets the stream type for the stream request.

Returns

Stream request stream type

Member Data Documentation

long dvblinkremote::StreamRequest::Duration

The timeout until channel playback is stopped by a server (indefinite if not specified).