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

Class for set recording settings requests. More...

Inheritance diagram for dvblinkremote::SetRecordingSettingsRequest:
dvblinkremote::Request

Public Member Functions

 SetRecordingSettingsRequest (const int timeMarginBeforeScheduledRecordings, const int timeMarginAfterScheduledRecordings, const std::string &recordingPath)
 Initializes a new instance of the dvblinkremote::SetRecordingSettingsRequest class.
 ~SetRecordingSettingsRequest ()
 Destructor for cleaning up allocated memory.
int GetTimeMarginBeforeScheduledRecordings ()
 Gets the configured time margin before a schedule recording is started.
int GetTimeMarginAfterScheduledRecordings ()
 Gets the configured time margin after a schedule recording is stopped.
std::string & GetRecordingPath ()
 Gets the configured file system path where recordings will be stored.

Detailed Description

Class for set recording settings requests.

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

See Also
IDVBLinkRemoteConnection::SetRecordingSettings()

Constructor & Destructor Documentation

dvblinkremote::SetRecordingSettingsRequest::SetRecordingSettingsRequest ( const int  timeMarginBeforeScheduledRecordings,
const int  timeMarginAfterScheduledRecordings,
const std::string &  recordingPath 
)

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

dvblinkremote::SetRecordingSettingsRequest::~SetRecordingSettingsRequest ( )

Destructor for cleaning up allocated memory.

Member Function Documentation

std::string& dvblinkremote::SetRecordingSettingsRequest::GetRecordingPath ( )

Gets the configured file system path where recordings will be stored.

Returns
Configured file system path
int dvblinkremote::SetRecordingSettingsRequest::GetTimeMarginAfterScheduledRecordings ( )

Gets the configured time margin after a schedule recording is stopped.

Returns
Number of seconds after a schedule recording is stopped
int dvblinkremote::SetRecordingSettingsRequest::GetTimeMarginBeforeScheduledRecordings ( )

Gets the configured time margin before a schedule recording is started.

Returns
Number of seconds before a schedule recording is started