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

Class for stop stream requests. More...

Inheritance diagram for dvblinkremote::StopStreamRequest:
dvblinkremote::Request

Public Member Functions

 StopStreamRequest (long channelHandle)
 Initializes a new instance of the dvblinkremote::StopStreamRequest class.
 StopStreamRequest (const std::string &clientId)
 Initializes a new instance of the dvblinkremote::StopStreamRequest class.
 ~StopStreamRequest ()
 Destructor for cleaning up allocated memory.
long GetChannelHandle ()
 Gets the channel handle for the stop stream request.
std::string & GetClientID ()
 Gets the client identifier for the stop stream request.

Detailed Description

Class for stop stream requests.

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

See Also
IDVBLinkRemoteConnection::StopChannel()

Constructor & Destructor Documentation

dvblinkremote::StopStreamRequest::StopStreamRequest ( long  channelHandle)

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

Parameters
channelHandlea constant long representing the channel handle of an existing playing stream to stop.
See Also
dvblinkremote::StreamRequest() for information about the channel handle.
dvblinkremote::StopStreamRequest::StopStreamRequest ( const std::string &  clientId)

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

Parameters
clientIda constant string reference representing the unique identification string of the client for stopping all playing streams from that specific client.
dvblinkremote::StopStreamRequest::~StopStreamRequest ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

long dvblinkremote::StopStreamRequest::GetChannelHandle ( )

Gets the channel handle for the stop stream request.

Returns
Channel handle
std::string& dvblinkremote::StopStreamRequest::GetClientID ( )

Gets the client identifier for the stop stream request.

Returns
Client identifier