dvblinkremote::IDVBLinkRemoteConnection Class Reference

Interface representing the available DVBLink Remote API methods. More...

Public Member Functions
virtual DVBLinkRemoteStatusCode	GetChannels (const GetChannelsRequest &request, ChannelList &response)=0
	Gets a list of all available channels.
virtual DVBLinkRemoteStatusCode	SearchEpg (const EpgSearchRequest &request, EpgSearchResult &response)=0
	Search the electronic program guide (EPG).
virtual DVBLinkRemoteStatusCode	PlayChannel (const StreamRequest &request, Stream &response)=0
	Start stream of a channel.
virtual DVBLinkRemoteStatusCode	StopChannel (const StopStreamRequest &request)=0
	Stop a streaming channel or channels.
virtual DVBLinkRemoteStatusCode	AddSchedule (const AddScheduleRequest &request)=0
	Add a schedule.
virtual DVBLinkRemoteStatusCode	GetSchedules (const GetSchedulesRequest &request, StoredSchedules &response)=0
	Gets a list of all schedules.
virtual DVBLinkRemoteStatusCode	UpdateSchedule (const UpdateScheduleRequest &request)=0
	Update a schedule.
virtual DVBLinkRemoteStatusCode	RemoveSchedule (const RemoveScheduleRequest &request)=0
	Remove a schedule.
virtual DVBLinkRemoteStatusCode	GetRecordings (const GetRecordingsRequest &request, RecordingList &response)=0
	Gets a list of all recordings.
virtual DVBLinkRemoteStatusCode	RemoveRecording (const RemoveRecordingRequest &request)=0
	Removes a recording.
virtual DVBLinkRemoteStatusCode	GetParentalStatus (const GetParentalStatusRequest &request, ParentalStatus &response)=0
	Get parental status.
virtual DVBLinkRemoteStatusCode	SetParentalLock (const SetParentalLockRequest &request, ParentalStatus &response)=0
	Sets the parental lock.
virtual DVBLinkRemoteStatusCode	GetM3uPlaylist (const GetM3uPlaylistRequest &request, M3uPlaylist &response)=0
	Gets a M3U playlist with direct HTTP links to all channels.
virtual DVBLinkRemoteStatusCode	GetPlaybackObject (const GetPlaybackObjectRequest &request, GetPlaybackObjectResponse &response)=0
	Gets a playback object.
virtual DVBLinkRemoteStatusCode	RemovePlaybackObject (const RemovePlaybackObjectRequest &request)=0
	Remove a playback object.
virtual DVBLinkRemoteStatusCode	StopRecording (const StopRecordingRequest &request)=0
	Stops a recording.
virtual DVBLinkRemoteStatusCode	GetStreamingCapabilities (const GetStreamingCapabilitiesRequest &request, StreamingCapabilities &response)=0
	Gets streams and protocols actually supported by a given instance of DVBLink server.
virtual DVBLinkRemoteStatusCode	GetRecordingSettings (const GetRecordingSettingsRequest &request, RecordingSettings &response)=0
	Gets recording settings.
virtual DVBLinkRemoteStatusCode	SetRecordingSettings (const SetRecordingSettingsRequest &request)=0
	Sets the recording settings.
virtual void	GetLastError (std::string &err)=0
	Gets a description of the last occured error.

Detailed Description

Interface representing the available DVBLink Remote API methods.

This is the interface for communicating with a DVBLink Connect! server. This class is abstract.

Member Function Documentation

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::AddSchedule ( const AddScheduleRequest &  request )

pure virtual

Add a schedule.

Parameters

[in]

request

A constant AddScheduleRequest reference representing the add schedule request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetChannels ( const GetChannelsRequest &  request, ChannelList &  response  )

pure virtual

Gets a list of all available channels.

Parameters

[in]	request	A constant GetChannelsRequest reference representing the get channel request criterias.
[in,out]	response	A ChannelList reference that will be populated with channels.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual void dvblinkremote::IDVBLinkRemoteConnection::GetLastError ( std::string &  err )

pure virtual

Gets a description of the last occured error.

Parameters

[in,out]

err

A string reference representing the string where the description of the last error will be provided.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetM3uPlaylist ( const GetM3uPlaylistRequest &  request, M3uPlaylist &  response  )

pure virtual

Gets a M3U playlist with direct HTTP links to all channels.

Parameters

[in]	request	A constant GetM3uPlaylistRequest reference representing the get M3U playlist request criterias.
[in,out]	response	A M3uPlaylist reference that will be populated with M3U playlist file content.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetParentalStatus ( const GetParentalStatusRequest &  request, ParentalStatus &  response  )

pure virtual

Get parental status.

Parameters

[in]	request	A constant GetParentalStatusRequest reference representing the get parental status request criterias.
[in,out]	response	A ParentalStatus reference that will be populated with parental status details.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetPlaybackObject ( const GetPlaybackObjectRequest &  request, GetPlaybackObjectResponse &  response  )

pure virtual

Gets a playback object.

Parameters

[in]	request	A constant GetPlaybackObjectRequest reference representing the get playback object request criterias.
[in,out]	response	A GetObjectResult reference that will be populated with playback object details.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetRecordings ( const GetRecordingsRequest &  request, RecordingList &  response  )

pure virtual

Gets a list of all recordings.

Parameters

[in]	request	A constant GetRecordingsRequest reference representing the get recordings request criterias.
[in,out]	response	A RecordingList reference that will be populated with Recording objects.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetRecordingSettings ( const GetRecordingSettingsRequest &  request, RecordingSettings &  response  )

pure virtual

Gets recording settings.

Parameters

[in]	request	A constant GetRecordingSettingsRequest reference representing the get recording settings request criterias.
[in,out]	response	A RecordingSettings reference that will be populated with recording settings details.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetSchedules ( const GetSchedulesRequest &  request, StoredSchedules &  response  )

pure virtual

Gets a list of all schedules.

Parameters

[in]	request	A constant GetSchedulesRequest reference representing the get schedules request criterias.
[in,out]	response	A ScheduleList reference that will be populated with Schedule objects.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::GetStreamingCapabilities ( const GetStreamingCapabilitiesRequest &  request, StreamingCapabilities &  response  )

pure virtual

Gets streams and protocols actually supported by a given instance of DVBLink server.

Parameters

[in]	request	A constant GetStreamingCapabilitiesRequest reference representing the get streaming capabilities request criterias.
[in,out]	response	A StreamingCapabilities reference that will be populated with streaming capability details.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::PlayChannel ( const StreamRequest &  request, Stream &  response  )

pure virtual

Start stream of a channel.

Parameters

[in]	request	A constant StreamRequest reference representing the stream request criterias.
[in,out]	response	A Stream reference that will be populated with details of a playing stream.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::RemovePlaybackObject ( const RemovePlaybackObjectRequest &  request )

pure virtual

Remove a playback object.

Parameters

[in]

request

A constant RemovePlaybackObjectRequest reference representing the remove playback object request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::RemoveRecording ( const RemoveRecordingRequest &  request )

pure virtual

Removes a recording.

Parameters

[in]

request

A constant RemoveRecordingRequest reference representing the remove recording request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::RemoveSchedule ( const RemoveScheduleRequest &  request )

pure virtual

Remove a schedule.

Parameters

[in]

request

A constant RemoveScheduleRequest reference representing the remove schedule request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::SearchEpg ( const EpgSearchRequest &  request, EpgSearchResult &  response  )

pure virtual

Search the electronic program guide (EPG).

Parameters

[in]	request	A constant GetChannelsRequest reference representing the EPG search request criterias.
[in,out]	response	A EpgSearchResult reference that will be populated with ChannelEPGData objects.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::SetParentalLock ( const SetParentalLockRequest &  request, ParentalStatus &  response  )

pure virtual

Sets the parental lock.

Parameters

[in]	request	A constant SetParentalLockRequest reference representing the set parental lock request criterias.
[in,out]	response	A ParentalStatus reference that will be populated with parental status details.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::SetRecordingSettings ( const SetRecordingSettingsRequest &  request )

pure virtual

Sets the recording settings.

Parameters

[in]

request

A constant SetRecordingSettingsRequest reference representing the set recording settings request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::StopChannel ( const StopStreamRequest &  request )

pure virtual

Stop a streaming channel or channels.

Parameters

[in]

request

A constant StopStreamRequest reference representing the stop stream request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::StopRecording ( const StopRecordingRequest &  request )

pure virtual

Stops a recording.

Parameters

[in]

request

A constant StopRecordingRequest reference representing the stop recording request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.

virtual DVBLinkRemoteStatusCode dvblinkremote::IDVBLinkRemoteConnection::UpdateSchedule ( const UpdateScheduleRequest &  request )

pure virtual

Update a schedule.

Parameters

[in]

request

A constant UpdateScheduleReqest reference representing the update schedule request criterias.

Returns

A DVBLinkRemoteStatusCode representing the status of the executed method.