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

Class for Real-time Transport Protocol (RTP) stream requests. More...

Inheritance diagram for dvblinkremote::RealTimeTransportProtocolStreamRequest:
dvblinkremote::TranscodedVideoStreamRequest dvblinkremote::StreamRequest dvblinkremote::Request

Public Member Functions

 RealTimeTransportProtocolStreamRequest (const std::string &serverAddress, const long dvbLinkChannelId, const std::string &clientId, TranscodingOptions &transcodingOptions)
 Initializes a new instance of the dvblinkremote::RealTimeTransportProtocolStreamRequest class.
 ~RealTimeTransportProtocolStreamRequest ()
 Destructor for cleaning up allocated memory.
- Public Member Functions inherited from dvblinkremote::TranscodedVideoStreamRequest
 TranscodedVideoStreamRequest (const std::string &serverAddress, const long dvbLinkChannelId, const std::string &clientId, TranscodingOptions &transcodingOptions, const std::string &streamType)
 Initializes a new instance of the dvblinkremote::TranscodedVideoStreamRequest class.
virtual ~TranscodedVideoStreamRequest ()=0
 Destructor for cleaning up allocated memory.
TranscodingOptionsGetTranscodingOptions ()
 Gets the transcoding options 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 Real-time Transport Protocol (RTP) stream requests.

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

See Also
IDVBLinkRemoteConnection::PlayChannel()

Constructor & Destructor Documentation

dvblinkremote::RealTimeTransportProtocolStreamRequest::RealTimeTransportProtocolStreamRequest ( const std::string &  serverAddress,
const long  dvbLinkChannelId,
const std::string &  clientId,
TranscodingOptions transcodingOptions 
)

Initializes a new instance of the dvblinkremote::RealTimeTransportProtocolStreamRequest 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.
transcodingOptionsa dvblinkremote::TranscodingOptions instance reference representing the transcoding options of 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.
dvblinkremote::RealTimeTransportProtocolStreamRequest::~RealTimeTransportProtocolStreamRequest ( )

Destructor for cleaning up allocated memory.