DVBLink Remote API Library documentation
0.2.0-Master
|
Default namespace for DVBLink Remote API library. More...
Classes | |
class | IDVBLinkRemoteConnection |
Interface representing the available DVBLink Remote API methods. More... | |
class | DVBLinkRemote |
Class used for connecting to a DVBLink Connect! server. More... | |
class | Request |
Base class for DVBLink Client requests. More... | |
class | GetChannelsRequest |
Class for defining a get channels request. More... | |
class | ChannelIdentifierList |
Represent a strongly typed list of channel identifiers. More... | |
class | EpgSearchRequest |
Class for defining an electronic program guide (EPG) search request. More... | |
class | StreamRequest |
Abstract base class for stream requests. More... | |
class | TranscodingOptions |
Class for transcoded video stream options. More... | |
class | TranscodedVideoStreamRequest |
Abstract base class for transcoded video stream requests. More... | |
class | RealTimeTransportProtocolStreamRequest |
Class for Real-time Transport Protocol (RTP) stream requests. More... | |
class | HttpLiveStreamRequest |
Class for HTTP Live Stream (HLS) stream requests. More... | |
class | WindowsMediaStreamRequest |
Class for Windows Media Stream (ASF) stream requests. More... | |
class | RawHttpStreamRequest |
Class for Raw HTTP stream requests. More... | |
class | RawUdpStreamRequest |
Class for Raw UDP stream requests. More... | |
class | StopStreamRequest |
Class for stop stream requests. More... | |
class | AddScheduleRequest |
class | AddManualScheduleRequest |
Class for add manual schedule requests. More... | |
class | AddScheduleByEpgRequest |
Class for add schedule by electronic program guide (EPG) requests. More... | |
class | GetSchedulesRequest |
Class for get schedules requests. More... | |
class | UpdateScheduleRequest |
Class for update schedule requests. More... | |
class | RemoveScheduleRequest |
Class for remove schedule requests. More... | |
class | GetRecordingsRequest |
Class for get recordings requests. More... | |
class | RemoveRecordingRequest |
Class for remove recording requests. More... | |
class | GetParentalStatusRequest |
Class for get parental status requests. More... | |
class | SetParentalLockRequest |
Class for set parental lock requests. More... | |
class | GetM3uPlaylistRequest |
Class for get M3U playlist requests. More... | |
class | GetPlaybackObjectRequest |
Class for get playback object requests. More... | |
class | RemovePlaybackObjectRequest |
Class for remove playback object requests. More... | |
class | StopRecordingRequest |
Class for stop recording requests. More... | |
class | GetStreamingCapabilitiesRequest |
Class for get streaming capabilities requests. More... | |
class | GetRecordingSettingsRequest |
Class for get recording settings requests. More... | |
class | SetRecordingSettingsRequest |
Class for set recording settings requests. More... | |
class | Response |
Base class for DVBLink Client responses. More... | |
class | Channel |
Represent a DVBLink channel. More... | |
class | ChannelList |
Represent a strongly typed list of DVBLink channels which is used as output parameter for the IDVBLinkRemoteConnection::GetChannels method. More... | |
class | ItemMetadata |
Represent metadata for an item. More... | |
class | Program |
Represent a program in an electronic program guide (EPG). More... | |
class | EpgData |
Represent a strongly typed list of programs in an electronic program guide (EPG). More... | |
class | ChannelEpgData |
Represent electronic program guide (EPG) data for a channel. More... | |
class | EpgSearchResult |
Represent a strongly typed list of electronic program guide (EPG) data for channels which is used as output parameter for the IDVBLinkRemoteConnection::SearchEpg method. More... | |
class | Stream |
Represent a DVBLink playing channel which is used as output parameter for the IDVBLinkRemoteConnection::PlayChannel method. More... | |
class | Recording |
Represent a recording. More... | |
class | RecordingList |
Represent a strongly typed list of recordings which is used as output parameter for the IDVBLinkRemoteConnection::GetRecordings method. More... | |
class | StoredManualSchedule |
Class for stored manual schedules. More... | |
class | StoredManualScheduleList |
Represent a strongly typed list of stored manual schedules. More... | |
class | StoredEpgSchedule |
Class for stored EPG schedules. More... | |
class | StoredEpgScheduleList |
Represent a strongly typed list of stored EPG schedules. More... | |
class | StoredSchedules |
Represent stored schedules which is used as output paramater for the IDVBLinkRemoteConnection::GetSchedules method. More... | |
class | ParentalStatus |
Represent parental status which is used as output parameter for the IDVBLinkRemoteConnection::SetParentalLock and IDVBLinkRemoteConnection::GetParentalStatus methods. More... | |
class | M3uPlaylist |
Represent M3U playlist which is used as output parameter for the IDVBLinkRemoteConnection::GetM3uPlaylist method. More... | |
class | PlaybackObject |
Abstract base class for playback objects. More... | |
class | PlaybackContainer |
Class for playback container. More... | |
class | PlaybackContainerList |
Represent a strongly typed list of playback containers. More... | |
class | PlaybackItem |
Abstract base class for playback items. More... | |
class | RecordedTvItemMetadata |
Represent metadata for a recorded TV item. More... | |
class | RecordedTvItem |
Class for recorded TV items. More... | |
class | VideoItemMetadata |
Represent metadata for a video. More... | |
class | VideoItem |
Class for video items. More... | |
class | PlaybackItemList |
Represent a strongly typed list of playback items. More... | |
class | GetPlaybackObjectResponse |
Represent playback object response which is used as output parameter for the IDVBLinkRemoteConnection::GetPlaybackObject method. More... | |
class | StreamingCapabilities |
Represent streaming capabilities which is used as output parameter for the IDVBLinkRemoteConnection::GetStreamingCapabilities method. More... | |
class | RecordingSettings |
Represent recording settings which is used as output parameter for the IDVBLinkRemoteConnection::GetRecordingSettings method. More... | |
class | Schedule |
Abstract base class for schedules. More... | |
class | ManualSchedule |
Abstract base class for manual schedules. More... | |
class | EpgSchedule |
Abstract base class for electronic program guide (EPG) schedules. More... |
Enumerations | |
enum | DVBLinkRemoteStatusCode { DVBLINK_REMOTE_STATUS_OK = 0, DVBLINK_REMOTE_STATUS_ERROR = 1000, DVBLINK_REMOTE_STATUS_INVALID_DATA = 1001, DVBLINK_REMOTE_STATUS_INVALID_PARAM = 1002, DVBLINK_REMOTE_STATUS_NOT_IMPLEMENTED = 1003, DVBLINK_REMOTE_STATUS_MC_NOT_RUNNING = 1005, DVBLINK_REMOTE_STATUS_NO_DEFAULT_RECORDER = 1006, DVBLINK_REMOTE_STATUS_MCE_CONNECTION_ERROR = 1008, DVBLINK_REMOTE_STATUS_CONNECTION_ERROR = 2000, DVBLINK_REMOTE_STATUS_UNAUTHORISED = 2001 } |
An enum representing the different status codes that DVBLink Remote API request could return. More... |
Variables | |
const int | DVBLINK_REMOTE_DEFAULT_BUFFER_SIZE = 1024 |
A constant integer representing the default buffer size. | |
const char | DVBLINK_REMOTE_EOF = '\0' |
A constant char representing the EOF string. | |
const char | DVBLINK_REMOTE_NEWLINE = '\n' |
A constant char representing the newline string. | |
const std::string | DVBLINK_REMOTE_SERVER_URL_SCHEME = "http" |
A constant string for the scheme used to communicate with DVBLink server. | |
const std::string | DVBLINK_REMOTE_SERVER_URL_PATH = "cs/" |
A constant string for the path specifying how to find the resource where DVBLink Remote API requests should be sent to. | |
const std::string | DVBLINK_REMOTE_SERVER_URL_FORMAT = "%s://%s:%ld/%s" |
A constant string used to format a DVBLink server URL. | |
const std::string | DVBLINK_REMOTE_HTTP_METHOD = dvblinkremotehttp::DVBLINK_REMOTE_HTTP_POST_METHOD |
A constant string representing the HTTP method used to communicate with the DVBLink Remote API. | |
const std::string | DVBLINK_REMOTE_HTTP_CONTENT_TYPE = "application/x-www-form-urlencoded; charset=utf-8" |
A constant string representing the MIME type of the data sent via DVBLink Remote API requests. | |
const std::string | DVBLINK_REMOTE_HTTP_COMMAND_QUERYSTRING = "command" |
A constant string representing the name of the DVBLink command querystring used for data to be sent in a DVBLink Remote API request. | |
const std::string | DVBLINK_REMOTE_HTTP_XML_PARAM_QUERYSTRING = "xml_param" |
A constant string representing the name of the DVBLink xml data querystring used for data to be sent in a DVBLink Remote API request. | |
const std::string | DVBLINK_REMOTE_GET_CHANNELS_CMD = "get_channels" |
A constant string representing the DVBLink command for retrieving channels. | |
const std::string | DVBLINK_REMOTE_PLAY_CHANNEL_CMD = "play_channel" |
A constant string representing the DVBLink command for playing a channel. | |
const std::string | DVBLINK_REMOTE_STOP_CHANNEL_CMD = "stop_channel" |
A constant string representing the DVBLink command for stopping one or several playing channels. | |
const std::string | DVBLINK_REMOTE_SEARCH_EPG_CMD = "search_epg" |
A constant string representing the DVBLink command for searching the electronic program guide (EPG). | |
const std::string | DVBLINK_REMOTE_GET_RECORDINGS_CMD = "get_recordings" |
A constant string representing the DVBLink command for retrieving recordings. | |
const std::string | DVBLINK_REMOTE_ADD_SCHEDULE_CMD = "add_schedule" |
A constant string representing the DVBLink command for adding a recording schedule. | |
const std::string | DVBLINK_REMOTE_REMOVE_SCHEDULE_CMD = "remove_schedule" |
A constant string representing the DVBLink command for removing a recording schedule. | |
const std::string | DVBLINK_REMOTE_REMOVE_RECORDING_CMD = "remove_recording" |
A constant string representing the DVBLink command for removing a recording. | |
const std::string | DVBLINK_REMOTE_SET_PARENTAL_LOCK_CMD = "set_parental_lock" |
A constant string representing the DVBLink command for setting a parental lock. | |
const std::string | DVBLINK_REMOTE_GET_PARENTAL_STATUS_CMD = "get_parental_status" |
A constant string representing the DVBLink command for retrieving parental lock status. | |
const std::string | DVBLINK_REMOTE_GET_SCHEDULES_CMD = "get_schedules" |
A constant string representing the DVBLink command for retrieving schedules. | |
const std::string | DVBLINK_REMOTE_UPDATE_SCHEDULE_CMD = "update_schedule" |
A constant string representing the DVBLink command for updating a schedule. | |
const std::string | DVBLINK_REMOTE_GET_PLAYLIST_M3U_CMD = "get_playlist_m3u" |
A constant string representing the DVBLink command for retrieving a M3U playlist of channels. | |
const std::string | DVBLINK_REMOTE_GET_OBJECT_CMD = "get_object" |
A constant string representing the DVBLink command for retrieving a playlist object. | |
const std::string | DVBLINK_REMOTE_REMOVE_OBJECT_CMD = "remove_object" |
A constant string representing the DVBLink command for removing a playlist object. | |
const std::string | DVBLINK_REMOTE_STOP_RECORDING_CMD = "stop_recording" |
A constant string representing the DVBLink command for stopping an active recording. | |
const std::string | DVBLINK_REMOTE_GET_STREAMING_CAPABILITIES_CMD = "get_streaming_capabilities" |
A constant string representing the DVBLink command for retrieving streaming capabilities. | |
const std::string | DVBLINK_REMOTE_GET_RECORDING_SETTINGS_CMD = "get_recording_settings" |
A constant string representing the DVBLink command for retrieving recording settings. | |
const std::string | DVBLINK_REMOTE_SET_RECORDING_SETTING_CMD = "set_recording_settings" |
A constant string representing the DVBLink command for setting recording settings. | |
const std::string | DVBLINK_REMOTE_STREAM_TYPE_ANDROID = "rtp" |
A constant string representing a Real Time Transport Protocol stream type for Android devices. | |
const std::string | DVBLINK_REMOTE_STREAM_TYPE_IPHONE = "hls" |
A constant string representing a Http Live stream type for IOS devices. | |
const std::string | DVBLINK_REMOTE_STREAM_TYPE_WINPHONE = "asf" |
A constant string representing a Windows Media stream type for Windows phone devices. | |
const std::string | DVBLINK_REMOTE_STREAM_TYPE_RAW_HTTP = "raw_http" |
A constant string representing a Raw HTTP stream type. | |
const std::string | DVBLINK_REMOTE_STREAM_TYPE_RAW_UDP = "raw_udp" |
A constant string representing a Raw UDP stream type. | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_OK = "DVBLink Remote API command was successful" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_OK . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_ERROR = "An unspecified error occurred" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_ERROR . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_INVALID_DATA = "Invalid request data provided" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_INVALID_DATA . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_INVALID_PARAM = "Invalid request parameter provided" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_INVALID_PARAM . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_NOT_IMPLEMENTED = "An invalid command was provided to the DVBLink Remote API" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_NOT_IMPLEMENTED . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_MC_NOT_RUNNING = "Windows Media Center is not running" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_MC_NOT_RUNNING . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_NO_DEFAULT_RECORDER = "No default recorder is configured" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_NO_DEFAULT_RECORDER . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_MCE_CONNECTION_ERROR = "An error occurred when trying to establish a connection to Windows Media Center" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_MCE_CONNECTION_ERROR . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_CONNECTION_ERROR = "An error occurred when trying to establish a connection to the DVBLink Connect! Server" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_CONNECTION_ERROR . | |
const std::string | DVBLINK_REMOTE_STATUS_DESC_UNAUTHORIZED = "An authentication error occurred when trying to establish a connection to the DVBLink Connect! Server" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_UNAUTHORISED . |
Default namespace for DVBLink Remote API library.
An enum representing the different status codes that DVBLink Remote API request could return.
const std::string dvblinkremote::DVBLINK_REMOTE_ADD_SCHEDULE_CMD = "add_schedule" |
A constant string representing the DVBLink command for adding a recording schedule.
const int dvblinkremote::DVBLINK_REMOTE_DEFAULT_BUFFER_SIZE = 1024 |
A constant integer representing the default buffer size.
const char dvblinkremote::DVBLINK_REMOTE_EOF = '\0' |
A constant char representing the EOF string.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_CHANNELS_CMD = "get_channels" |
A constant string representing the DVBLink command for retrieving channels.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_OBJECT_CMD = "get_object" |
A constant string representing the DVBLink command for retrieving a playlist object.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_PARENTAL_STATUS_CMD = "get_parental_status" |
A constant string representing the DVBLink command for retrieving parental lock status.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_PLAYLIST_M3U_CMD = "get_playlist_m3u" |
A constant string representing the DVBLink command for retrieving a M3U playlist of channels.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_RECORDING_SETTINGS_CMD = "get_recording_settings" |
A constant string representing the DVBLink command for retrieving recording settings.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_RECORDINGS_CMD = "get_recordings" |
A constant string representing the DVBLink command for retrieving recordings.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_SCHEDULES_CMD = "get_schedules" |
A constant string representing the DVBLink command for retrieving schedules.
const std::string dvblinkremote::DVBLINK_REMOTE_GET_STREAMING_CAPABILITIES_CMD = "get_streaming_capabilities" |
A constant string representing the DVBLink command for retrieving streaming capabilities.
const std::string dvblinkremote::DVBLINK_REMOTE_HTTP_COMMAND_QUERYSTRING = "command" |
A constant string representing the name of the DVBLink command querystring used for data to be sent in a DVBLink Remote API request.
const std::string dvblinkremote::DVBLINK_REMOTE_HTTP_CONTENT_TYPE = "application/x-www-form-urlencoded; charset=utf-8" |
A constant string representing the MIME type of the data sent via DVBLink Remote API requests.
const std::string dvblinkremote::DVBLINK_REMOTE_HTTP_METHOD = dvblinkremotehttp::DVBLINK_REMOTE_HTTP_POST_METHOD |
A constant string representing the HTTP method used to communicate with the DVBLink Remote API.
const std::string dvblinkremote::DVBLINK_REMOTE_HTTP_XML_PARAM_QUERYSTRING = "xml_param" |
A constant string representing the name of the DVBLink xml data querystring used for data to be sent in a DVBLink Remote API request.
const char dvblinkremote::DVBLINK_REMOTE_NEWLINE = '\n' |
A constant char representing the newline string.
const std::string dvblinkremote::DVBLINK_REMOTE_PLAY_CHANNEL_CMD = "play_channel" |
A constant string representing the DVBLink command for playing a channel.
const std::string dvblinkremote::DVBLINK_REMOTE_REMOVE_OBJECT_CMD = "remove_object" |
A constant string representing the DVBLink command for removing a playlist object.
const std::string dvblinkremote::DVBLINK_REMOTE_REMOVE_RECORDING_CMD = "remove_recording" |
A constant string representing the DVBLink command for removing a recording.
const std::string dvblinkremote::DVBLINK_REMOTE_REMOVE_SCHEDULE_CMD = "remove_schedule" |
A constant string representing the DVBLink command for removing a recording schedule.
const std::string dvblinkremote::DVBLINK_REMOTE_SEARCH_EPG_CMD = "search_epg" |
A constant string representing the DVBLink command for searching the electronic program guide (EPG).
const std::string dvblinkremote::DVBLINK_REMOTE_SERVER_URL_FORMAT = "%s://%s:%ld/%s" |
A constant string used to format a DVBLink server URL.
The default format is <scheme>://<domain>:<port>/<path>.
DVBLINK_REMOTE_SERVER_URL_SCHEME
.DVBLINK_REMOTE_SERVER_URL_PATH
. const std::string dvblinkremote::DVBLINK_REMOTE_SERVER_URL_PATH = "cs/" |
A constant string for the path specifying how to find the resource where DVBLink Remote API requests should be sent to.
const std::string dvblinkremote::DVBLINK_REMOTE_SERVER_URL_SCHEME = "http" |
A constant string for the scheme used to communicate with DVBLink server.
const std::string dvblinkremote::DVBLINK_REMOTE_SET_PARENTAL_LOCK_CMD = "set_parental_lock" |
A constant string representing the DVBLink command for setting a parental lock.
const std::string dvblinkremote::DVBLINK_REMOTE_SET_RECORDING_SETTING_CMD = "set_recording_settings" |
A constant string representing the DVBLink command for setting recording settings.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_CONNECTION_ERROR = "An error occurred when trying to establish a connection to the DVBLink Connect! Server" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_CONNECTION_ERROR
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_ERROR = "An unspecified error occurred" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_ERROR
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_INVALID_DATA = "Invalid request data provided" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_INVALID_DATA
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_INVALID_PARAM = "Invalid request parameter provided" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_INVALID_PARAM
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_MC_NOT_RUNNING = "Windows Media Center is not running" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_MC_NOT_RUNNING
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_MCE_CONNECTION_ERROR = "An error occurred when trying to establish a connection to Windows Media Center" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_MCE_CONNECTION_ERROR
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_NO_DEFAULT_RECORDER = "No default recorder is configured" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_NO_DEFAULT_RECORDER
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_NOT_IMPLEMENTED = "An invalid command was provided to the DVBLink Remote API" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_NOT_IMPLEMENTED
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_OK = "DVBLink Remote API command was successful" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_OK
.
const std::string dvblinkremote::DVBLINK_REMOTE_STATUS_DESC_UNAUTHORIZED = "An authentication error occurred when trying to establish a connection to the DVBLink Connect! Server" |
A constant string representing a description of the DVBLink Remote API status code DVBLINK_REMOTE_STATUS_UNAUTHORISED
.
const std::string dvblinkremote::DVBLINK_REMOTE_STOP_CHANNEL_CMD = "stop_channel" |
A constant string representing the DVBLink command for stopping one or several playing channels.
const std::string dvblinkremote::DVBLINK_REMOTE_STOP_RECORDING_CMD = "stop_recording" |
A constant string representing the DVBLink command for stopping an active recording.
const std::string dvblinkremote::DVBLINK_REMOTE_STREAM_TYPE_ANDROID = "rtp" |
A constant string representing a Real Time Transport Protocol stream type for Android devices.
const std::string dvblinkremote::DVBLINK_REMOTE_STREAM_TYPE_IPHONE = "hls" |
A constant string representing a Http Live stream type for IOS devices.
const std::string dvblinkremote::DVBLINK_REMOTE_STREAM_TYPE_RAW_HTTP = "raw_http" |
A constant string representing a Raw HTTP stream type.
const std::string dvblinkremote::DVBLINK_REMOTE_STREAM_TYPE_RAW_UDP = "raw_udp" |
A constant string representing a Raw UDP stream type.
const std::string dvblinkremote::DVBLINK_REMOTE_STREAM_TYPE_WINPHONE = "asf" |
A constant string representing a Windows Media stream type for Windows phone devices.
const std::string dvblinkremote::DVBLINK_REMOTE_UPDATE_SCHEDULE_CMD = "update_schedule" |
A constant string representing the DVBLink command for updating a schedule.