Changeset 24291 for titan/doc


Ignore:
Timestamp:
Oct 14, 2013, 2:26:33 AM (7 years ago)
Author:
wonderdoc
Message:

update htmlApi Doku

File:
1 edited

Legend:

Unmodified
Added
Removed
  • titan/doc/htmlapi.txt

    r17972 r24291  
    99use queryraw?param&param&... for raw-struct output
    1010
    11 query: sendrc
    12 raw: nothing
    13 desc: send rc code
    14 param: rc code
    15 
    16 query: getrectimer
    17 raw: begin#end#justplay#repeate#name#serviceid#transpoderid#status#errstr#timestamp#channelname#afterevent
    18 desc: get aktive record timer
    19 param: no
    20 
    21 query: addrectimer
    22 raw: ?
    23 desc: add a record timer
    24 param: ?
    25 
    26 query: delrectimer
    27 raw: ?
    28 desc: delete a record timer
    29 param: ?
    30 
    31 query: editrectimer
    32 raw: ?
    33 desc: edit a record timer
    34 param: ?
    35 
    36 query: rectimersend
    37 raw: ?
    38 desc: ?
    39 param: ?
    40 
    41 query: getrectimerarchive
    42 raw: begin#end#justplay#repeate#name#serviceid#transpoderid#status#errstr#timestamp#channelname#afterevent
    43 desc: get old record timer
    44 param: no
    45 
    46 query: setvol
    47 raw: returns the aktive vol (0-100)
    48 desc: set the volume
    49 param: 0-100
    50 
    51 query: setmute
    52 raw: returns the aktive mute (0/1)
    53 descr: set mute
    54 param: 0/1
    55 
    56 query: getbouquet
    57 raw: bouquetname#type
    58 desc: get a list of all bouquets
    59 param: no
    60 
    61 query: getsat
    62 raw: satname#orbitalpos
    63 desc: get a list of all sat
    64 param: no
    65 
    66 query: getprovider
    67 raw: providername#number
    68 desc: get a list of all provoder
    69 param: no
    70 
    71 query: getaz
    72 raw: returns A-Z
    73 desc: get chars A-Z
    74 param: no
    75 
    76 query: getchannelpage
    77 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    78 desc: get a channel page
    79 param: 0 = 0, 1 = orbitalpos, 2 = providername, 3 = A-Z
    80 param: type (0 = all, 1 = sat, 2 = provider, 3 = A-Z)
    81 param: page nr
    82 
    83 query: getallchannel
    84 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    85 desc: get all channel
    86 param: no
    87 
    88 query: getbouquetchannel
    89 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    90 desc: get all channel from a bouquet
    91 param: bouquetname
    92 
    93 query: getsatchannel
    94 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    95 desc: get all channel from a sat
    96 param: orbitalposition
    97 
    98 query: getproviderchannel
    99 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    100 desc: get all channel from a provider
    101 param: providername
    102 
    103 query: getazchannel
    104 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    105 desc: get all channel from first char
    106 param: char (A-Z)
    107 
    108 query: switch
    109 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    110 desc: change channel
    111 param: channelid
    112 param: transponderid
    113 
    114 query: getaktservice
    115 raw: channelname#proz#serviceid#transponderid#channellist#servicetype#eventid#actstarttime#actepgshort#nextstartime#nextstoptime#nextepgshort
    116 desc: get akt service
    117 param: no
    118 
    119 query: getepg
    120 raw: epgshort#begin#end#subtitle#epglong
    121 desc: get epg from a channel
    122 param: channelid
    123 param: transponderid
    124 param: epg event id
    125 
    126 query: getmovieepg
    127 raw: returns .epg
    128 desc: gets the epg to a recordet movie
    129 param: movie name (full path)
    130 
    131 query: getsingleepg
    132 raw: epgshort#begin#end#subtitle#epglong#eventid
    133 desc: get all epg to a channel
    134 param: channelid
    135 param: transponderid
    136 
    137 query: getgmultiepg
    138 raw: ?
    139 desc: get all epg from all channel in a bouquet
    140 param: bouquetname
    141 param: page nr
    142 
    143 query: getepgsearch
    144 raw: ?
    145 desc: search epg entry
    146 param: ?
    147 
    148 query: getsignal
    149 raw: ber#unc#signal#snr
    150 desc: get tuner signals
    151 param: no
    152 
    153 query: getmoviefilelist
    154 raw: name#type (dir = 0, file = 1)
    155 desc: get a list of movies
    156 param: empty or path
    157 param: page nr
    158 
    159 query: delmoviefile
    160 raw: ?
    161 desc: delete a file
    162 param: ?
    163 
    164 query: getm3u
    165 raw: m3u format
    166 desc: get m3u file from a movie
    167 param: moviename
    168 
    169 query: getvideo
    170 raw: http url string for video
    171 desc: get html inline code for playing movie
    172 param: moviename
    173 
    174 query: getshoot
    175 raw: fixtext shoot.html
    176 desc: get a screenshot
    177 param: type (gui, tv, gui + tv)
    178 
    179 query: poweroff
    180 raw: nothing
    181 desc: poweroff the box
    182 param: no
    183 
    184 query: restart
    185 raw: nothing
    186 desc: restart the box
    187 param: no
    188 
    189 query: guirestart
    190 raw: nothing
    191 desc: gui restart the box
    192 param: no
    193 
    194 query: standby
    195 raw: nothing
    196 desc: set box in standby
    197 param: no
    198 
    199 query: boxstatus
    200 raw: running or standby
    201 desc: get boxstatus (running or standby)
    202 param: no
    203 
    204 query: message
    205 raw: fixtext Message send
    206 desc: shows the message on tv
    207 param; message
    208 
    209 query: getvol
    210 raw: returns the aktive vol (0-100)
    211 desc: get the volume
    212 param: 0-100
    213 
    214 query: getmute
    215 raw: returns the aktive mute (0/1)
    216 descr: get mute
    217 param: no
    218 
    219 query: setvol
    220 raw: returns the aktive vol (0-100)
    221 desc: set the volume
    222 param: no
    223 
    224 query: getrccodes
    225 raw: name#code
    226 descr: gets all rccodes
    227 param: no
    228 
    229 query: videoplay
    230 raw play: play (on error "can not start playback")
    231 raw stop: stop (on error "not in play mode")
    232 raw pause: pause (on error "not in play mode")
    233 raw ff: ff (on error "not in play mode")
    234 raw fr: fr (on error "not in play mode")
    235 raw getlen: len in sek (on error "not in play mode")
    236 raw getpos: pos in sek (on error "not in play mode")
    237 raw getisplaying: 0/1 (on error "not in play mode")
    238 raw getplayercan: playercan bits (on error "not in play mode")
    239 descr: play a stream
    240 param: play url
    241 param: stop url
    242 param: pause url
    243 param: ff url
    244 param: fr url
    245 param: getlen url
    246 param: getpos url
    247 param: getisplaying url
    248 param: getplayercan url
     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 (1=gui, 2=tv, 3=gui + tv)
     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:  videoplay
     332raw:                    play: play (on error "can not start playback")
     333raw:                    stop: stop (on error "not in play mode")
     334raw                             pause: pause (on error "not in play mode")
     335raw                             ff: ff (on error "not in play mode")
     336raw                             fr: fr (on error "not in play mode")
     337raw                             getlen: len in sek (on error "not in play mode")
     338raw                             getpos: pos in sek (on error "not in play mode")
     339raw                             getisplaying: 0/1 (on error "not in play mode")
     340raw                             getplayercan: playercan bits (on error "not in play mode")
     341descr:          play a stream on TV
     342param:          play url/local file(full path)
     343param:          stop url/local file(full path)
     344param:          pause url/local file(full path)
     345param:          ff url/local file(full path)
     346param:          fr url/local file(full path)
     347param:          getlen url/local file(full path)
     348param:          getpos url/local file(full path)
     349param:          getisplaying url/local file(full path)
     350param:          getplayercan url/local file(full path)
     351example:        queryraw?videoplay&play&/media/hdd/movie/movie.ts
    249352
    250353***************************************
Note: See TracChangeset for help on using the changeset viewer.