Professional Documents
Culture Documents
Version 1.0.0-4393-g34cf8b3
17 de septiembre de 2013
Indice general
1
1.1.10.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.1.11 Referencia del modulo tuner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.1.11.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.11.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.12 Referencia del modulo update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.12.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.12.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 22
2
1 API exportada a lua
Funciones
blocked ()
current ()
change ( channelNumber)
setFullScreen ()
resize ( x, y, w, h)
mute ( toggle)
volume ( vol)
nextVideo ()
nextAudio ()
nextSubtitle ()
haveSubtitle ()
getResolution ()
getAspect ()
getAudio ()
getAudioInfo ( id)
1.1.1.2.1. channel.blocked ( )
Devuelve
1.1.1.2.3. channel.current ( )
Devuelve
3
1.1.1.2.4. channel.getAspect ( )
Devuelve
1.1.1.2.5. channel.getAudio ( )
Devuelve
1.1.1.2.6. channel.getAudioInfo ( id )
Devuelve
1.1.1.2.7. channel.getResolution ( )
Devuelve
1.1.1.2.8. channel.haveSubtitle ( )
Devuelve
1.1.1.2.10. channel.nextAudio ( )
Devuelve
4
1.1.1.2.11. channel.nextSubtitle ( )
Devuelve
1.1.1.2.12. channel.nextVideo ( )
Devuelve
1.1.1.2.13. channel.resize ( x, y, w, h )
1.1.1.2.14. channel.setFullScreen ( )
Pone el video del canal actual en pantalla completa (Relativo a la ventana principal).
Funciones
zapperProgramFound ( ch)
zapperChannelChanged ( id)
haveChannels ()
channelCount ()
getAll ()
get ( id)
getInfo ( id)
getShowsBetween ( id, from, to)
toggleOneSeg ()
showOneSeg ()
remove ( id)
isProtected ( id)
isBlocked ( id)
toggleBlocked ( id)
unblockAll ()
5
toggleFavorite ( id)
next ( first, factor)
nextFavorite ( first, factor)
1.1.2.2.1. channels.channelCount ( )
Devuelve
1.1.2.2.2. channels.get ( id )
Parametros
number id Identificador del canal a retornar.
Devuelve
Ver tambien
1.1.2.2.3. channels.getAll ( )
Obtiene la lista de canales donde cada canal esta representado por una tabla con los siguientes campos:
Devuelve
1.1.2.2.4. channels.getInfo ( id )
Obtiene informacion extendida de un canal. A demas de los campos indicados en l getAll anade:
6
Parametros
number id Identificador del canal a retornar.
Devuelve
Obtiene una lista de programas correspondientes al canal identificado por id, que se muestran entre las fechas
from y to. Cada programa esta representado por una tabla con los siguientes campos:
startDate:
stopDate:
Parametros
number id El identificador del canal.
string from Fecha/hora inicial.
string to Fecha/hora final.
Devuelve
Una tabla con los programas del canal identificado por id que se muestran entre las fechas especificadas en
from y to.
1.1.2.2.6. channels.haveChannels ( )
Devuelve
1.1.2.2.7. channels.isBlocked ( id )
7
Parametros
number id El identificador del canal.
Devuelve
1.1.2.2.8. channels.isProtected ( id )
Parametros
number id El identificador del canal.
Devuelve
1 si el canal identificado por id se encuentra protegido mediante control parental, 0 en caso contrario.
Devuelve
Cambia al canal siguiente del indicado en first de la lista de favoritos, avanzando factor canales.
Parametros
number first Indica el canal a partir del cual cambiar.
number factor Indica la cantidad de canales a avanzar.
Devuelve
1.1.2.2.11. channels.remove ( id )
1.1.2.2.12. channels.showOneSeg ( )
Devuelve
1.1.2.2.13. channels.toggleBlocked ( id )
8
Parametros
number id El identificador del canal.
1.1.2.2.14. channels.toggleFavorite ( id )
1.1.2.2.15. channels.toggleOneSeg ( )
Devuelve
1.1.2.2.16. channels.unblockAll ( )
1.1.2.2.17. channels.zapperChannelChanged ( id )
Evento que indica un cambio de canal. Si esta funcion se encuentra definida en lua, sera llamada cuando ocurra
un cambio de canal con el id del nuevo canal como parametro.
Parametros
number id Identificador del canal al cual se cambio.
1.1.2.2.18. channels.zapperProgramFound ( ch )
Evento que indica que se encontro un nuevo canal. Si esta funcion se encuentra definida en lua, sera llamada
cuando se encuentre un nuevo canal con el canal encontrado como parametro.
Parametros
table ch Tabla que representa al nuevo canal encontrado.
Ver tambien
Funciones
setPIN ( str)
resetPIN ()
checkPIN ( str)
isSet ()
isSessionOpened ()
getParentalAge ()
setParentalAge ( age)
getParentalContent ()
setParentalContent ( byte)
9
1.1.3.1. Descripcion detallada
Devuelve
1.1.3.2.2. control.getParentalAge ( )
Devuelve
1.1.3.2.3. control.getParentalContent ( )
Devuelve
1.1.3.2.4. control.isSessionOpened ( )
Devuelve
1.1.3.2.5. control.isSet ( )
Devuelve
1.1.3.2.6. control.resetPIN ( )
10
Parametros
number age El valor de la edad de control parental a setear.
Funciones
getConnector ()
getConnectors ()
getVideoMode ( idx)
getVideoModes ( idx)
getCurVideoMode ()
getCurVideoModes ()
setVideoMode ( conIdx, modIdx)
setTransparency ( value)
getTransparency ()
getAspectMode ()
getAspectModes ()
setAspectMode ( idx)
getModulator ()
getModulators ()
setModulator ( idx)
1.1.4.2.1. display.getAspectMode ( )
Devuelve
11
1.1.4.2.2. display.getAspectModes ( )
Devuelve
1.1.4.2.3. display.getConnector ( )
Devuelve
1.1.4.2.4. display.getConnectors ( )
Devuelve
1.1.4.2.5. display.getCurVideoMode ( )
Devuelve
[1] El ndice del modo de video que esta activo para el conector actual.
[2] Un string que describe al modo de video que esta activo para el conector actual.
1.1.4.2.6. display.getCurVideoModes ( )
Devuelve
[1] Una tabla con todos los modos de video disponibles para el conector actual.
[2] El ndice del modo de video activo para el conector actual.
1.1.4.2.7. display.getModulator ( )
Devuelve
1.1.4.2.8. display.getModulators ( )
Devuelve
1.1.4.2.9. display.getTransparency ( )
Devuelve
12
Parametros
number idx El ndice del conector.
Devuelve
[1] El ndice del modo de video que esta activo para el conector indicado por idx.
[2] Un string que describe al modo de video que esta activo para el conector indicado por idx.
Parametros
number idx El ndice del conector.
Devuelve
[1] Una tabla con todos los modos de video disponibles para el conector indicado por idx.
[2] El ndice del modo de video activo para el conector indicado por idx.
Setea el modo de video indicado por modIdx para el conector indicado por conIdx.
Parametros
number conIdx El ndice del conector.
number modIdx El ndice del modo de video.
Funciones
13
1.1.5.1. Descripcion detallada
Funciones
run ()
stop ( retCode)
lockKeys ( state)
resetConfig ()
getTime ( format)
getDatePlus ( format, offset)
cancelTimer ( id)
registerTimer ( id, ms)
showBackground ( needShow)
launchBrowser ()
fullscreen ( state)
isFullscreen ()
iconify ( state)
1.1.6.2.1. mainWindow.cancelTimer ( id )
14
Parametros
number id El id del timer a cancelar.
Parametros
string format Indica el formato a usar (ej: Y-m-d).
number offset Indica los das a sumar a partir de hoy.
Devuelve
String formateado segun format de la fecha actual mas los das indicados por offset.
Informacion sobre el tiempo actual (dias, horas) con el formato indicado en format.
Parametros
string format Indica el formato a usar (ej: Y-m-d H:M)
Devuelve
Minimiza/restaura la ventana.
Parametros
number state Si es 0 restaura la ventana, cualquier otro valor la minimiza a la bandeja del sistema.
1.1.6.2.6. mainWindow.isFullscreen ( )
Devuelve
1.1.6.2.7. mainWindow.launchBrowser ( )
15
Parametros
number state Si es 1 los eventos de teclado llegaran a lua, si es 0 no.
Registra un timer con la duracion indicada por ms. Una vez transcurridos milisegundos se llama a la funcion de lua
OnTimerEvent con el id del timer.
Parametros
number id El identificador del timer.
number ms La duracion del timer en milisegundos.
1.1.6.2.10. mainWindow.resetConfig ( )
1.1.6.2.11. mainWindow.run ( )
Funciones
isEnabled ()
enable ( state)
getApplications ()
haveApplications ()
runApplication ( id)
lock ( needLock)
16
Parametros
number state Indica si se desea activar o desactivar el middleware (1=activar, 0=desactivar).
1.1.7.2.2. middleware.getApplications ( )
Devuelve
1.1.7.2.3. middleware.haveApplications ( )
Devuelve
1.1.7.2.4. middleware.isEnabled ( )
Devuelve
1.1.7.2.6. middleware.runApplication ( id )
Funciones
registerExtension ( extension)
getFiles ( extension)
reScan ()
addPath ( path)
17
Parametros
path Un string con la nueva ruta donde buscar.
Retorna un vector con los archivos que coinciden con la extension especificada.
Parametros
extension Un string con la extension.
Devuelve
Registra una extension para que luego se busquen archivos que coincidan.
Parametros
key Un string con la extension a agregar.
1.1.8.2.4. mountservice.reScan ( )
Vuelve a escanear.
Funciones
audioFileEnd ()
toggleMute ()
isMuted ()
setVolume ( vol)
volumeUp ()
volumeDown ()
maxVolume ()
getVolume ()
getAudioChannels ()
getAudioChannel ()
setAudioChannel (ch)
getImageFiles ()
getAudioFiles ()
playAudioFile ( id)
pauseAudioFile ( pause)
stopAudioFile ()
18
1.1.9.2. Documentacion de las funciones
1.1.9.2.1. player.audioFileEnd ( )
Evento que indica la finalizacion de la reproduccion de un audio. Se llamara a esta funcion de lua si la misma se
encuentra definida.
1.1.9.2.2. player.getAudioChannel ( )
Devuelve
1.1.9.2.3. player.getAudioChannels ( )
Devuelve
[1] Tabla con los nombres de los canales de audio soportados por el reproductor.
[2] El numero del canal de audio en uso actualmente.
1.1.9.2.4. player.getAudioFiles ( )
Devuelve
Una tabla con los archivos de audio (mp3) encontrados en el dispositivo usb. De cada archivo se retorna el id
y el nombre del mismo.
1.1.9.2.5. player.getImageFiles ( )
Devuelve
Una tabla con las imagenes (jpg y png) encontradas en el dispositivo usb. De cada imagen se retorna el id, el
nombre del archivo, y la ruta completa a la misma.
1.1.9.2.6. player.getVolume ( )
Devuelve
1.1.9.2.7. player.isMuted ( )
Devuelve
1.1.9.2.8. player.maxVolume ( )
Devuelve
19
Parametros
number pause Indica si se debe pausar o continuar la reproduccion del archivo de audio actual (1=pausar,
0=continuar).
1.1.9.2.10. player.playAudioFile ( id )
1.1.9.2.11. player.setAudioChannel ( ch )
1.1.9.2.13. player.stopAudioFile ( )
1.1.9.2.14. player.toggleMute ( )
Devuelve
1.1.9.2.15. player.volumeDown ( )
1.1.9.2.16. player.volumeUp ( )
Funciones
20
1.1.10.1. Descripcion detallada
Devuelve
El entero leido.
Devuelve
El string leido.
Funciones
zapperBeginScan ( count)
zapperScanNetwork ( net)
zapperEndScan ()
startScan ()
stopScan ()
getSignal ()
21
1.1.11.1. Descripcion detallada
1.1.11.2.1. tuner.getSignal ( )
Devuelve
1.1.11.2.2. tuner.startScan ( )
1.1.11.2.3. tuner.stopScan ( )
Evento que indica el comienzo del escaneo de canales. Se llamara a esta funcion de lua si la misma se encuentra
definida.
Parametros
number count La cantidad de redes a escanear.
1.1.11.2.5. tuner.zapperEndScan ( )
Evento que indica la finalizacion del escaneo de canales. Se llamara a esta funcion de lua si la misma se encuentra
definida.
Evento que indica el comienzo de escaneo de canales en una red. Se llamara a esta funcion de lua si la misma se
encuentra definida.
Parametros
string net La red que se comenzara a escanear.
Funciones
zapperUpdateReceived ( id)
zapperUpdateDownloadProgress ( step, total)
isEnabled ()
enable ( val)
apply ( id, apply)
22
1.1.12.2. Documentacion de las funciones
Parametros
number id El id de la actualizacion.
number apply Indica si debe aplicar o descartar la actualizacion (1=aplicar, 0=descartar).
1.1.12.2.3. update.isEnabled ( )
Devuelve
Evento que indica el progreso de descarga de una actualizacion del zapper. Si esta funcion se encuentra definida
en lua, sera llamada cuando progrese la descarga de una actualizacion del zapper.
Parametros
number step Indica el progreso actual de descarga.
number total Indica el total de la descarga.
1.1.12.2.5. update.zapperUpdateReceived ( id )
Evento que indica la presencia de una actualizacion del zapper. Si la actualizacion es obligatoria se aplicara la
misma, de lo contrario si esta funcion se encuentra definida en lua, sera llamada con el id de la actualizacion como
parametro.
Parametros
number id Identificador de la actualizacion.
23