Table Of Contents

• Preface
• Requirements
• Configuration
• Channels
  • Groups
  • Images / Channel-Logos
• Events / EPG
  • Images
  • Search (EPGSEARCH)
• Info
• Osd
• Recordings
  • Cut
  • Marks
  • Play
• Remote
• Timers
  • Reading/Deleting Timers
  • Creating Timers
  • Updating Timers
• SearchTimers (EPGSEARCH)
  • Create
  • Delete
  • Show
  • Search
• ScraperImages
• Control the Wirbelscan plugin
  • Get the current state
  • Get the list of countries
  • Get the list of satellites
  • Get the current setup
  • Changes the current setup
  • Launches a command
• Webapp
• Femon

Preface

• Klaus Schmidinger: Of course because of the VDR itself. Thank you also for the nice and clean layout for the API-Documentation which I "borrowed" from your PLUGINS.html.
• Gerald Dachs: Thank you for the intial idea and the initial jsonapi-Plugin.
• Volker Richert: Thank you for fixing the UTF8-Support.
• Tommi Mäkitalo: Thank you for implementing the Regex-Support in cxxtools which allows RESTful web services.
• Holger Schvestka: Thank you for improving the package structure.
• All other yaVDR-Members who I haven't already mentioned, just because you are who you are and do your best to improve the VDR experience.
• The developers of the live and vnsisserver Plugins which helped me to learn a lot about the API of VDR.
• The developers of the live plugin where I borrowed parts of the epgsearch-implementation :-)
• Daniel Kuschny: Thank you for fixing my broken regular expressions. Will pay you a beer! :-)
• Keine_Ahnung@vdr-portal for the VDR 1.6 compatibility patch

Requirements

• VDR 1.7.18
• libcxxtools Rev. >= 1231, which is available as package for Ubuntu in the yavdr-PPA's

• XML or JSON Parser (Depends on which format you want to use! - You can also use the html-format, but that one is more a proof for the restful concept and does not show all information!)
• URL Decoder or JSON Serializer (to send data to the webservice, required f.e. to create timers, searchtimers usw...) e.g. POSTMan REST Client. There is a wide variety of REST clients available on the web.

Configuration

Channels

• <format> - The requested format: json, xml or html.
• <channelid> - Id of the requested channel.
• start, limit - These values are used to control the whole list. Start ist the first element you want to retrieve. Limit...

Groups

• <group> - returns the channels of the requested group

Images / Channel-Logos

Events / EPG

• <format> - The requested format: json, xml or html.
• <channelid> - (optional) id of the channel, if not set the plugin will return the whole epg sorted by your channel list
• <timespan> - the timespan from which you want to know the event-details, if set to 0 - all events in the future will be returned
• <from> - (optional) time in the future when the requested events should end/start (default-value: now)
• <eventid> - (optional) if you only want the details of a specific event
• <chevents> - (optional) the count of events for each channel
• <chfrom> - (optional) start number of the channel, from where events will be returned
• <chto> - (optional) end number of the channel, through events will be returned
• <only_count> - (optional) if you just want to know the amount of available epg items

Images

• <eventid> - Id of the event
• <imagenumber> - the number of the image, in the above mentioned examples it would be 0,1 or 2

Search

• query - (required)
• mode - (required) 0=phrase, 1=and, 2=or, 3=regex
• channelid - (optional) if id invalid, the plugin will search on every channel
• use_title - (optional, default) search in the title
• use_subtitle - (optional)
• use_description - (optional)

Info

Osd

Recordings

• <format> - The requested format: json, xml or html.
• <number> - The number of the recording which you want to delete. (The first recordings has the number 0.)
• <recordingnumber> - The number of the recording you want to retrieve.
• <source> - The full (url encoded) source path of the recording.
• <target> - The relative (url encoded) target path of the recording.
• marks=true - add the cutting marks by reading the marks file from the recording directory
• start, limit - These values are used to control the whole list. Start ist the first element you want to retrieve. Limit...

Cut

Marks

Play

• <number> - The number of the recording you want to play (GET).
• <number> - The number of the recording you want to rewind (POST).

Remote

Timers

Reading/Deleting Timers

• <format> - The requested format: json, xml or html.
• <timerid> - Id of the timer if you want to delete one.
• start, limit - These values are used to control the whole list. Start ist the first element you want to retrieve. Limit...

Creating Timers

• flags - set it to 1 for an active timer
• file - name of the recording (use an url-encoder for this text if you special characters)
• stop - the time when the recording should be start - in the 24 hour system, f.e. 2015 means quarter past ten in the evening
• start - the time when the recording sholud be stoped, f.e. 2230 (half past ten in the evening)
• day - YYYY-MM-DD, f.e. 2011-12-24 -> christmas :-)
• channel - ID of the channel
• weekdays - MTWTFSS, used for repeating timers -> just use '-' if you don't want the timer to run on the specific day
• minpre, minpost can be used together with a channel and eventid to create a timer without giving the other information to the api

Updating Timers

• timer_id - the id of the timer

SearchTimers

Create a SearchTimer

• search - (required)
• mode - (required) 0=phrase, 1=all words, 2=at least one word, 3=match exactly, 4=regex, 5=fuzzy
• id - used to edit an existing timer
• tolerance - used in fuzzy mode
• match_case - 0=false, 1=true
• use_time
• start_time
• stop_time
• use_title
• use_subtitle
• use_channel - 0=no, 1=interval, 2=channel group, 3=only FTA
• channel_min - id of the minimal channel (channelid)
• channel_max - id of the maximum channel (channelid)
• channels - f.e. All
• use_as_searchtimer - 0=no, 1=yes, 2=user defined
• use_duration - 0=false, 1=true
• duration_min
• duration_max
• use_dayofweek - 0=false, 1=true
• dayofweek - 7bits to represent the seven weekdays
• use_in_favorites
• directory
• del_recs_after_days
• keep_recs
• pause_on_recs
• blacklist_mode - always 0, blacklist currently not supported
• switch_min_before
• avoid_repeats
• allowed_repeats
• repeats_within_days
• compare_title - 0=false, 1=true
• compare_subtitle
• compare_summary
• compare_categories

Delete a SearchTimer

Show one SearchTimer

Search Events of a SearchTimer

ScraperImage

Retrieve Images from additional media.

Control the Wirbelscan plugin

Get the state of the Wirbelscan plugin

{
  "status":2
}

{
  "status":1,
  "currentDevice":"CXD2837 DVB-C DVB-T/T2",
  "progress":1,"strength":0,
  "transponder":"DVB-C 113.000MHz M2 SR6900",
  "numChannels":552,"newChannels":0,"nextTransponder":0
}

• 0 = no status information available, try again later.
• 1 = scan in progress.
• 2 = no scan in progress (not started, finished or stopped).
• 3 = plugin is busy, try again later.

Retrieve the list of countries from the Wirbelscan plugin

{"countries":
  [
    {"id":0,"shortName":"AF","fullName":"AFGHANISTAN"},
    {"id":1,"shortName":"AX","fullName":"\ufffdLAND ISLANDS"},
    {"id":2,"shortName":"AL","fullName":"ALBANIA"},
    {"id":3,"shortName":"DZ","fullName":"ALGERIA"},
    ...
    {"id":246,"shortName":"ZM","fullName":"ZAMBIA"},
    {"id":247,"shortName":"ZW","fullName":"ZIMBABWE"}
  ],
  "count":0,
  "total":248
}

Retrieve the list of satellites from the Wirbelscan plugin

{"satellites":
  [
    {"id":0,"shortName":"S180E0","fullName":"180.0 east Intelsat 18"},
    {"id":1,"shortName":"S172E0","fullName":"172.0 east GE 23"},
    {"id":2,"shortName":"S169E0","fullName":"169.0 east Intelsat 5"},
    {"id":3,"shortName":"S166E0","fullName":"166.0 east Intelsat 8"},
    ...
    {"id":131,"shortName":"S139W0","fullName":"135.0 west AMC 8"},
    {"id":132,"shortName":"S177W0","fullName":"177.0 west NSS 9"}
  ],
  "count":0,
  "total":133
}

Retrieve the current setup of the Wirbelscan plugin

{
  "verbosity":5,
  "logFile":2,
  "DVB_Type":2,
  "DVBT_Inversion":0,
  "DVBC_Inversion":0,
  "DVBC_Symbolrate":0,
  "DVBC_QAM":0,
  "CountryId":82,
  "SatId":6,
  "scanflags":31,
  "ATSC_type":0
}

• verbosity - 0 (errors only) .. 5 (extended debug); default = 3 (messages)
• logFile - 0 = off, 1 = stdout, 2 = syslog
• DVB_Type - DVB-T = 0, DVB-C = 1, DVB-S/S2 = 2, PVRINPUT = 3, PVRINPUT(FM Radio) = 4, ATSC = 5, TRANSPONDER = 999
• DVBT_Inversion - AUTO/OFF = 0, AUTO/ON = 1
• DVBC_Inversion - AUTO/OFF = 0, AUTO/ON = 1
• DVBC_Symbolrate - careful here - may change. AUTO = 0, 6900 = 1, 6875 = 2 (...) 14 = 5483, 15 = ALL
• DVBC_QAM - AUTO = 0,QAM64 = 1, QAM128 = 2, QAM256 = 3, ALL = 4
• CountryId - the id according to country, found in country list, see wirbelscan_GetCountry
• SatId - the id according to satellite, found in list, see wirbelscan_GetSat
• scanflags - bitwise flag of wanted channels: TV = (1 << 0), RADIO = (1 << 1), FTA = (1 << 2), SCRAMBLED = (1 << 4), HDTV = (1 << 5)
• ATSC_type - VSB = 0, QAM = 1, both VSB+QAM = 2

Changes the current setup of the Wirbelscan plugin

{
    "verbosity": 3,
    "logFile": 1,
    "DVB_Type": 3,
    "DVBT_Inversion": 0,
    "DVBC_Inversion": 0,
    "DVBC_Symbolrate": 0,
    "DVBC_QAM": 0,
    "CountryId": 82,
    "SatId": 67,
    "scanflags": 31,
    "ATSC_type": 0
}

Launch a command with the Wirbelscan plugin

• command

• 0 = start scanning
• 1 = stop scanning
• 2 = store current setup

{
  "replycode":true
}

Webapp

Retrieve Webapp.

Femon

Retrieve Femon data