source: titan/doc/htmlapi.txt

Last change on this file was 34859, checked in by obi, 4 years ago

webif add system/telnet page

File size: 13.1 KB
Line 
1/*****************************************************/
2/* this file is part of the tiTan / tiTanNIT Project */
3/* and allowed only for use with this.               */
4/*                                                   */
5/* copyright by NIT                                  */
6/*****************************************************/
7
8use query?param&param&... for html output
9use queryraw?param&param&... for raw-struct output
10
11query:  sendrc
12raw:                    nothing
13desc:                   send rc code
14param:          rc code
15example:        query?sendrc&rcmute
16
17query:  getrectimer
18raw:                    begin#end#justplay#repeate#name#serviceid#transpoderid#status#errstr#timestamp#channelname#afterevent (or "no data", if no timer in list)
19desc:                   get active record timer list
20param:          no
21example:        queryraw?getrectimer
22
23query:  getrectimerarchive
24raw:                    begin#end#justplay#repeate#name#serviceid#transpoderid#status#errstr#timestamp#channelname#afterevent (or "no data", if no timer in list)
25desc:                   get old record timer list
26param:          no
27example:        queryraw?getrectimer
28
29query:  addrectimer (not used for queryraw)
30raw:                    ???
31desc:                   add a record timer
32param:          ???
33
34query:  editrectimer (not used for queryraw)
35raw:                    ???
36desc:                   edit a record timer
37param:          ???
38
39query:  delrectimer
40raw:                    begin#end#justplay#repeate#name#serviceid#transpoderid#status#errstr#timestamp#channelname#afterevent
41desc:                   delete a record timer and give active record timer list back
42param:          timestamp       (from getrectimer/getrectimerarchive entry)
43example:        queryraw?delrectimer&1362672485239282
44
45query:  rectimersend
46raw:                    ok -> TimerID
47desc:                   set a record timer
48param:          node=                           (0 for new timer, else timestamp from getrectimer/getrectimerarchive entry)
49param:          name=                           (timer name)
50param:          type=                           ("record" for record, else switch timer)
51param:          begin=                  (start time, format "HH:MM dd-mm-YYYY" example "10:26 11-03-2013")
52param:          end=                            (end time, format "HH:MM dd-mm-YYYY" example "11:26 11-03-2013")
53param:          sid=                            (ServiceID from channel)
54param:          tid=                            (TransponderID from channel)
55param:          repeat=                 (0 no repeate, else Bitmuster, 1 Mo, 2 Di, 4 Mi, 8 Do, 16 Fr, 32 Sa, 64 So)
56param:          afterevent=     (0 auto,1 nothing, 2 standby, 3 shutdown)
57param:          ext=1                           (if ext=x exist, then we give the current created timer entry back, else the active record timer list)
58param:          send=Send               (must exist)
59param:          channel=                (channel name --> use it only, if you don't use sid+tid. Channelname must be unique in your channellist)
60example:        queryraw?rectimersend&node=%s&name=%s&type=%s&begin=%s&end=%s&sid=%s&tid=%s&repeat=%s&afterevent=%s&ext=1&send=Send';
61example:        queryraw?rectimersend&node=%s&name=%s&type=%s&begin=%s&end=%s&channel=%s&repeat=%s&afterevent=%s&send=Send
62
63query:  getbouquet
64raw:                    bouquetname#type
65desc:                   get a list of all bouquets
66param:          no
67example:        queryraw?getbouquet
68
69query:  getsat
70raw:                    satname#orbitalpos
71desc:                   get a list of all sat
72param:          no
73example:        queryraw?getsat
74
75query:  getprovider
76raw:                    providername#number
77desc:                   get a list of all provoder
78param:          no
79example:        queryraw?getprovider
80
81query:  getaz
82raw:                    returns A-Z
83desc:                   get chars A-Z
84param:          no
85example:        queryraw?getaz
86
87query:  getchannelpage
88raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
89desc:                   get a channel page
90param:          at type 0 = 0, 1 = orbitalpos, 2 = providername, 3 = A-Z
91param:          type (0 = all, 1 = sat, 2 = provider, 3 = A-Z)
92param:          page nr
93example:        queryraw?getchannelpage&0&0&1
94
95query:  getallchannel
96raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
97desc:                   get channel page 1 from "getchannelpage" with type 0(all)
98param:          no
99example:        queryraw?getallchannel
100
101query:  getbouquetchannel
102raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
103desc:                   get all channel from a bouquet
104param:          bouquetname
105example:        queryraw?getbouquetchannel&Musik
106
107query:  getsatchannel
108raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
109desc:                   get channel page 1 from "getchannelpage" with type 1(Sat)
110param:          orbitalposition
111example:        queryraw?getsatchannel&192
112
113query:  getproviderchannel
114raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
115desc:                   get all channel from a provider
116param:          providerID (List number in "getprovider")
117example:        queryraw?getproviderchannel&31
118
119query:  getazchannel
120raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
121desc:                   get all channel from first char
122param:          char (A-Z in ASCII Dec)
123example:        queryraw?getazchannel&81
124
125query:  switch
126raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
127desc:                   change channel
128param:          channelid
129param:          transponderid
130param:          bouquetName (BOUQUET)-xxx     / is an optional param, it set the right bouquet in channellist.
131example:        queryraw?switch&66553&20625&(BOUQUET)-Musik
132
133query:  getaktservice
134raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
135desc:                   get akt service data from TV channel
136param:          no
137example:        queryraw?getaktservice
138
139query:  getservice
140raw:                    channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort#nexteventid#lockstatus
141desc:                   get service data
142param:          channelid
143param:          transponderid
144example:        queryraw?getservice&66553&20625
145
146query:  getsysteminfo
147raw:                    titan#NIT#ReleaseRev#ImageName#BoxType#BoxTime
148desc:                   get system data
149param:          no
150example:        queryraw?getsysteminfo
151
152query:  getconfig
153raw:                    ParamName#ParamValue
154desc:                   get titan config data
155param:          no
156example:        queryraw?getconfig
157
158query:  getchannellock
159raw:                    channelname#serviceid#transponderid#channellock
160param:          channelid
161param:          transponderid
162example:        queryraw?getchannellock&66553&20625
163
164query:  getbouquetepg
165raw:                    BeginNewChannel(fixtext)#channelname#serviceid#transponderid#servicetype
166                                        epgshort#begin#end#subtitle#epglong#eventid
167                                        epgshort#begin#end#subtitle#epglong#eventid
168                                        BeginNewChannel(fixtext)#channelname#serviceid#transponderid#servicetype
169                                        epgshort#begin#end#subtitle#epglong#eventid
170                                        epgshort#begin#end#subtitle#epglong#eventid
171                                        ....
172desc:                   get EPG data from all channel from a bouquet
173param:          bouquetname
174param:          longepgtext 0/1
175param:          startzeit (unix time format)
176param:          endzeit         (unix time format)
177example:        queryraw?getbouquetepg&Musik&0&1381707900&1381729500
178
179query:  getepg
180raw:                    epgshort#begin#end#subtitle#epglong
181desc:                   get epg data from epg event id
182param:          channelid
183param:          transponderid
184param:          epg event id
185example:        queryraw?getepg&61302&66553&20625
186
187query:  getmovieepg
188raw:                    returns text from movie .epg file
189desc:                   get the epg to a recorded movie
190param:          movie name (full path)
191example:        queryraw?getmovieepg&/media/hdd/movie/movie.ts
192
193query:  getsingleepg
194raw:                    epgshort#begin#end#subtitle#epglong#eventid
195desc:                   get all epg data from a channel
196param:          channelid
197param:          transponderid
198example:        queryraw?getsingleepg&61301&66553&0
199
200query:  getgmultiepg (for queryraw use "getbouquetepg")
201raw:                    ???
202desc:                   get all epg from all channel in a bouquet
203param:          bouquetname
204param:          page nr
205
206query:  getepgsearch
207raw:                    BeginNewChannel(fixtext)#channelname#serviceid#transponderid#servicetype
208                                        epgshort#begin#end#subtitle#epglong#eventid
209                                        epgshort#begin#end#subtitle#epglong#eventid
210                                        BeginNewChannel(fixtext)#channelname#serviceid#transponderid#servicetype
211                                        epgshort#begin#end#subtitle#epglong#eventid
212                                        epgshort#begin#end#subtitle#epglong#eventid
213                                        ....
214desc:                   search epg entry
215param:          Search String
216param:          Pagecount       (optional)      -1=all
217param:          withlongepg (optional)  0/1
218example:        queryraw?getepgsearch&Tagesschau&-1&0
219
220query:  getsignal
221raw:                    ber#unc#signal#snr
222desc:                   get tuner signal value from active TV tuner
223param:          no
224example:        queryraw?getsignal
225
226query:  getmoviefilelist
227raw:                    filename#type (dir = 0, file = 1)
228desc:                   get a list of movies
229param:          empty or path
230param:          page nr (not used for queryraw)
231example:        queryraw?getmoviefilelist
232
233query:  delmoviefile
234raw:                    give "getmoviefilelist" back
235desc:                   delete a movie file
236param:          path
237param:          1
238param:          FileName
239example:        queryraw?delmoviefile&/media/hdd/movie&1&Movie.ts)
240
241query:  getm3u
242raw:                    m3u format
243desc:                   get m3u file from a movie
244param:          moviename
245
246query:  getvideo
247raw:                    http url string for video
248desc:                   get html inline code for playing movie
249param:          moviename
250
251query:  getshoot
252raw:                    fixtext "shoot.html"
253desc:                   get a screenshot
254param:          type (0=gui+tv+freez, 1=gui+tv, 2=tv, 3=gui)
255example:        queryraw?getshoot&1
256
257query:  poweroff
258raw:                    nothing
259desc:                   poweroff the box
260param:          no
261example:        queryraw?poweroff
262
263query:  restart
264raw:                    nothing
265desc:                   restart the box
266param:          no
267example:        queryraw?restart
268
269query:  guirestart
270raw:                    nothing
271desc:                   gui restart the box
272param:          no
273example:        queryraw?guirestart
274
275query:  standby
276raw:                    nothing
277desc:                   set box in standby
278param:          no
279example:        queryraw?standby
280
281query:  boxstatus
282raw:                    running or standby
283desc:                   get boxstatus (running or standby)
284param:          no
285example:        queryraw?boxstatus
286
287query:  message
288raw:                    fixtext "Message send"
289desc:                   shows the message on tv
290param:          message=
291example:        queryraw?message=Hallo Message
292
293query:  xmessage
294raw:                    fixtext "OK"
295desc:                   shows the Xmessage on tv
296param:          caption=
297param:          body=
298param:          timeout=        (in secound, 0 for static message)
299example:        cgi-bin/xmessage?caption=Hallo&body=Text&timeout=30
300
301query:  getvol
302raw:                    vol (0-100)
303desc:                   get the current volume value
304param:          no
305example:        queryraw?getvol
306
307query:  setvol
308raw:                    returns the active vol (0-100)
309desc:                   set the volume
310param:          0-100
311example:        queryraw?setvol&50
312
313query:  getmute
314raw:                    mute (0/1)
315descr:          get the current mute state
316param:          no
317example:        queryraw?getmute
318
319query:  setmute
320raw:                    returns the aktive mute (0/1)
321descr:          set mute
322param:          0/1
323example:        queryraw?setmute&1
324
325query:  getrccodes
326raw:                    rcName#code
327descr:          gets all rccodes
328param:          no
329example:        queryraw?getrccodes
330
331query:  getdrawcount
332raw:                    count
333descr:          returns the OSD counter value
334param:          no
335example:        queryraw?getdrawcount
336
337query:  gethelpchoices
338raw:            ??
339descr:          returns help text list
340param:          no
341example:        queryraw?gethelpchoices
342
343query:  gethelp
344raw:            ??
345descr:          returns help text
346param:          yes
347example:        queryraw?gethelp&adjust
348
349query:  getcommand
350raw:            ??
351descr:          returns command output
352param:          yes
353example:        queryraw?getcommand&cmd=free
354example:        queryraw?getcommand&cmd=df%02-h
355
356query:  webgethelp
357raw:            ??
358descr:          displayed your local test page
359param:          yes
360example:        queryraw?gettestpage&/tmp/test.html
361
362query:  getrecfreesize
363raw:                    recPath#fullSize#freeSize#percent(x %)#
364desc:                   getrecfreesize
365param:          no
366example:        queryraw?getrecfreesize
367
368query:  videoplay
369raw:                    play: play (on error "can not start playback")
370raw:                    stop: stop (on error "not in play mode")
371raw                             pause: pause (on error "not in play mode")
372raw                             ff: ff (on error "not in play mode")
373raw                             fr: fr (on error "not in play mode")
374raw                             getlen: len in sek (on error "not in play mode")
375raw                             getpos: pos in sek (on error "not in play mode")
376raw                             getisplaying: 0/1 (on error "not in play mode")
377raw                             getplayercan: playercan bits (on error "not in play mode")
378descr:          play a stream on TV
379param:          play url/local/hoster file(full path)
380param:          stop url/local file(full path)
381param:          pause url/local file(full path)
382param:          ff url/local file(full path)
383param:          fr url/local file(full path)
384param:          getlen url/local file(full path)
385param:          getpos url/local file(full path)
386param:          getisplaying url/local file(full path)
387param:          getplayercan url/local file(full path)
388example:        queryraw?videoplay&play&/media/hdd/movie/movie.ts
389example:        queryraw?videoplay&play&url=http://film.de/file.avi
390example:        queryraw?videoplay&play&hosterurl=http://www.youtube.com/watch?v=zrHiUAKMcaw
391example:        queryraw?videoplay&play&hosterurl=http://www.myvideo.de/watch/9727247/Staffel_9_Folge_17_Geschichten_vom_Loslassen_How_I_Met_Your_Mother
392example:        queryraw?videoplay&play&hosterurl=http://streamcloud.eu/20ge1pw013j6/Rambo.I.1982.REMASTERED.German.AC3.HDRip.x264-FuN.mp4.html
393
394***************************************
395
396playercan bits:
3970 policy
3981 auditraklist
3992 subtitle
4003 videomode
4014 powerofftimer
4025 videosettings
4036 stop
4047 ff
4058 fr
4069 pause
40710 play
40811 jump/seek reverse
40912 jump/seek forward
41013 changecodec
41114 infobar
Note: See TracBrowser for help on using the repository browser.