You are on page 1of 24

L ABORATORIO DE I NVESTIGACI ON Y F ORMACI ON EN

I NFORM ATICA AVANZADA

Manual del desarrollador de lua

Version 1.0.0-4393-g34cf8b3

17 de septiembre de 2013
Indice general

1 API exportada a lua 2


1.1 Documentacion de modulos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.1 Referencia del modulo channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.1.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.1.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.2 Referencia del modulo channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1.2.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1.3 Referencia del modulo control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.3.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.3.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.4 Referencia del modulo display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.4.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.4.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.5 Referencia del modulo dtvlua . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.1.5.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.5.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.6 Referencia del modulo mainWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.6.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.6.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.7 Referencia del modulo middleware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1.7.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1.7.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1.8 Referencia del modulo mountservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.1.8.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.1.8.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.1.9 Referencia del modulo player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.1.9.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.1.9.2 Documentacion de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.1.10 Referencia del modulo storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.1.10.1 Descripcion detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

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

1.1. Documentacion de modulos

1.1.1. Referencia del modulo channel

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.1. Descripcion detallada

Provee funcionalidad para consultar informacion sobre canales y programacion.

1.1.1.2. Documentacion de las funciones

1.1.1.2.1. channel.blocked ( )

Indica si el canal actual esta bloqueado.

Devuelve

True si el canal actual esta bloqueado, False en caso contrario.

1.1.1.2.2. channel.change ( channelNumber )

Cambia el canal al indicado en channelNumber.


Parametros
number El numero del canal al que se quiere cambiar.
channelNumber

1.1.1.2.3. channel.current ( )

Devuelve

El numero del canal actual.

3
1.1.1.2.4. channel.getAspect ( )

Indica la relacion de aspecto del reproductor.

Devuelve

Un string indicando la relacion de aspecto del reproductor.

1.1.1.2.5. channel.getAudio ( )

Indica el tipo de audio del reproductor.

Devuelve

Un string indicando el tipo de audio del reproductor.

1.1.1.2.6. channel.getAudioInfo ( id )

Obtiene informacion de un stream de audio.


Parametros
number id El id del stream de audio.

Devuelve

Un string con la informacion del stream de audio indicado por id.

1.1.1.2.7. channel.getResolution ( )

Indica la resolucion del reproductor.

Devuelve

Un string indicando la resolucion del reproductor.

1.1.1.2.8. channel.haveSubtitle ( )

Indica si el video actual tiene subttulos.

Devuelve

El string CC si el video actual tiene subttulos, un string vaco en caso contrario.

1.1.1.2.9. channel.mute ( toggle )

Habilita/deshabilita el audio del canal actual.


Parametros
number toggle Indica si se debe habilitar o deshabilitar el audio del canal actual (1=habilitar, 0=deshabilitar).

1.1.1.2.10. channel.nextAudio ( )

Cambia al siguiente stream de audio.

Devuelve

El id del stream de audio que se esta reproduciendo actualmente.

4
1.1.1.2.11. channel.nextSubtitle ( )

Cambia al siguiente subttulo.

Devuelve

El id del subttulo usado actualmente.

1.1.1.2.12. channel.nextVideo ( )

Cambia al siguiente stream de video.

Devuelve

El id del stream de video que se esta reproduciendo actualmente.

1.1.1.2.13. channel.resize ( x, y, w, h )

Cambia el tamano/ubicacion del video del canal actual.


Parametros
number x Posicion horizontal de la esquina superior izquierda.
number y Posicion vertical de la esquina superior izquierda.
number w Ancho.
number h Alto.

1.1.1.2.14. channel.setFullScreen ( )

Pone el video del canal actual en pantalla completa (Relativo a la ventana principal).

1.1.1.2.15. channel.volume ( vol )

Cambia el volumen del audio del canal actual.


Parametros
number vol El nivel de volumen a setear.

1.1.2. Referencia del modulo channels

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.1. Descripcion detallada

Provee funcionalidad para consultar informacion sobre canales y programacion.

1.1.2.2. Documentacion de las funciones

1.1.2.2.1. channels.channelCount ( )

Devuelve

La cantidad de canales disponibles.

1.1.2.2.2. channels.get ( id )

Parametros
number id Identificador del canal a retornar.

Devuelve

El canal identificado por id.

Ver tambien

getAll para ver la estructura de un canal.

1.1.2.2.3. channels.getAll ( )

Obtiene la lista de canales donde cada canal esta representado por una tabla con los siguientes campos:

channelID: el id del canal.

channel: el numero del canal.

name: el nombre del canal.

oneSeg: 1 si el canal es on-seg, 0 en caso contrario.

blocked: 1 si el canal esta bloqueado, 0 en caso contrario.

favorite: 1 si el canal esta marcado como favorito, 0 en caso contrario.

Devuelve

Una tabla con todos los canales.

1.1.2.2.4. channels.getInfo ( id )

Obtiene informacion extendida de un canal. A demas de los campos indicados en l getAll anade:

logo: La imagen del logo del canal.

parentalAge: La edad de control parental del programa actual.

parentalContent: El contenido de control parental del programa actual.

showName: El nombre del programa actual.

showDescription: La descripcion del programa actual.

6
Parametros
number id Identificador del canal a retornar.

Devuelve

El canal identificado por id con informacion extendida.

1.1.2.2.5. channels.getShowsBetween ( id, from, to )

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:

name: El nombre del programa.

description: La descripcion del programa.

start: La fecha y hora de comienzo del programa.

duration: La duracion del programa.

parentalAge: La edad de control parental.

parentalContent: El contenido de control parental.

length: La duracion en minutos del programa.

startDate:

time: La hora de inicio del programa.


date: La fecha de inicio del programa.

stopDate:

time: La hora de fin del programa.


date: La fecha de fin del programa.

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 ( )

Indica si existen canales.

Devuelve

1 si hay canales disponibles, 0 en caso contrario.

1.1.2.2.7. channels.isBlocked ( id )

7
Parametros
number id El identificador del canal.

Devuelve

1 si el canal identificado por id se encuentra bloqueado, 0 en caso contrario.

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.

1.1.2.2.9. channels.next ( first, factor )

Cambia al canal siguiente del indicado en first, avanzando factor canales.


Parametros
number first Indica el canal a partir del cual cambiar.
number factor Indica la cantidad de canales a avanzar.

Devuelve

El identificador del canal actual.

1.1.2.2.10. channels.nextFavorite ( first, factor )

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

El identificador del canal actual.

1.1.2.2.11. channels.remove ( id )

Borra el canal identificado por id.


Parametros
number id El identificador del canal.

1.1.2.2.12. channels.showOneSeg ( )

Devuelve

1 si actualmente se estan mostrando los canales one-seg, 0 en caso contrario.

1.1.2.2.13. channels.toggleBlocked ( id )

Bloquea/desbloquea el canala identificado por id.

8
Parametros
number id El identificador del canal.

1.1.2.2.14. channels.toggleFavorite ( id )

Anade/eliminal al canal identificado por id de la lista de favoritos.


Parametros
number id Identificador del canal.

1.1.2.2.15. channels.toggleOneSeg ( )

Muestra/oculta los canales one-seg.

Devuelve

1 si se muestran los canales one-seg, 0 en caso contrario.

1.1.2.2.16. channels.unblockAll ( )

Desbloquea todos los canales.

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

getAll para ver la estructura de un canal.

1.1.3. Referencia del modulo control

Funciones

setPIN ( str)
resetPIN ()
checkPIN ( str)
isSet ()
isSessionOpened ()
getParentalAge ()
setParentalAge ( age)
getParentalContent ()
setParentalContent ( byte)

9
1.1.3.1. Descripcion detallada

Provee funcionalidad para el manejo de control parental.

1.1.3.2. Documentacion de las funciones

1.1.3.2.1. control.checkPIN ( str )

Valida el codigo de control parental indicado en str.


Parametros
string str El codigo a validar.

Devuelve

True si el codigo es correcto, false en caso contrario.

1.1.3.2.2. control.getParentalAge ( )

Devuelve

El valor de la edad de control parental.

1.1.3.2.3. control.getParentalContent ( )

Devuelve

La configuracion utilizada de control parental.

1.1.3.2.4. control.isSessionOpened ( )

Indica si se accedio al control parental y la sesion se encuentra activa.

Devuelve

1 si la sesion esta activa, 0 en caso contrario.

1.1.3.2.5. control.isSet ( )

Checkea si el control parental esta habilitado.

Devuelve

1 si el control parental esta habilitado, 0 en caso contrario.

1.1.3.2.6. control.resetPIN ( )

Borra la clave de control parental.

1.1.3.2.7. control.setParentalAge ( age )

Setea la edad utilizada para el control parental.

10
Parametros
number age El valor de la edad de control parental a setear.

1.1.3.2.8. control.setParentalContent ( byte )

Setea la configuracion de control parental.


Parametros
number byte La configuracion de control parental a utilizar.

1.1.3.2.9. control.setPIN ( str )

Establece la clave de control parental.


Parametros
string str La clave a establecer.

1.1.4. Referencia del modulo display

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.1. Descripcion detallada

Provee funcionalidad relacionada con la pantalla.

1.1.4.2. Documentacion de las funciones

1.1.4.2.1. display.getAspectMode ( )

Devuelve

[1] El ndice de la relacion de aspecto que esta activa.


[2] Un string que describe la relacion de aspecto que esta activa.

11
1.1.4.2.2. display.getAspectModes ( )

Devuelve

[1] Una tabla con todas las relaciones de aspecto disponibles.


[2] El ndice de la relacion de aspecto activa.

1.1.4.2.3. display.getConnector ( )

Devuelve

[1] El ndice del connector que esta activo.


[2] Un string que describe al connector que esta activo.

1.1.4.2.4. display.getConnectors ( )

Devuelve

[1] Una tabla con todos los conectores disponibles.


[2] El ndice del conector activo.

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] El ndice del modulador de video activo.


[2] Un string que describe el modulador de video activo.

1.1.4.2.8. display.getModulators ( )

Devuelve

[1] Una tabla con todos los moduladores de video disponibles.


[2] El ndice del modulador de video activo.

1.1.4.2.9. display.getTransparency ( )

Devuelve

El nivel de transparencia actual del menu.

1.1.4.2.10. display.getVideoMode ( idx )

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.

1.1.4.2.11. display.getVideoModes ( 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.

1.1.4.2.12. display.setAspectMode ( idx )

Cambia la relacion de aspecto actual.


Parametros
number idx El ndice de la relacion de aspecto a activar.

1.1.4.2.13. display.setModulator ( idx )

Activa el modulador de video indicado en idx.


Parametros
number idx El ndice del modulador de video a activar.

1.1.4.2.14. display.setTransparency ( value )

Cambia el nivel de transparencia del menu.


Parametros
number value El nivel de transparencia a setear.

1.1.4.2.15. display.setVideoMode ( conIdx, modIdx )

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.

1.1.5. Referencia del modulo dtvlua

Funciones

log ( level, group, cat, str)


setLevel ( group, cat, level)

13
1.1.5.1. Descripcion detallada

Provee funcionalidad de log

1.1.5.2. Documentacion de las funciones

1.1.5.2.1. dtvlua.log ( level, group, cat, str )

Muestra una linea de log.


Parametros
string level Prioridad del log
string group Grupo del log
string cat Categoria del log
string str Texto del log

1.1.5.2.2. dtvlua.setLevel ( group, cat, level )

Configura el nivel de log a mostrar


Parametros
string group Grupo del log
string cat Categoria del log
string level Prioridad del log

1.1.6. Referencia del modulo mainWindow

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.1. Descripcion detallada

Provee funcionalidad relacionada con el sistema y la ventana principal.

1.1.6.2. Documentacion de las funciones

1.1.6.2.1. mainWindow.cancelTimer ( id )

Cancela la ejecucion de un timer.

14
Parametros
number id El id del timer a cancelar.

1.1.6.2.2. mainWindow.fullscreen ( state )

Cambia entre modo pantalla completa y ventana.


Parametros
number state Si es 0 cambia a modo ventana, cualquier otro valor pone la ventana en modo pantalla
completa.

1.1.6.2.3. mainWindow.getDatePlus ( format, offset )

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.

1.1.6.2.4. mainWindow.getTime ( format )

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

String formateado segun format de el tiempo actual.

1.1.6.2.5. mainWindow.iconify ( state )

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 ( )

Indica el modo en que se encuentra la ventana.

Devuelve

True si se esta en moodo pantalla completa, False en caso contrario.

1.1.6.2.7. mainWindow.launchBrowser ( )

Ejecuta un web browser si esta disponible.

1.1.6.2.8. mainWindow.lockKeys ( state )

Indica si lua debe escuchar los eventos de teclado/control.

15
Parametros
number state Si es 1 los eventos de teclado llegaran a lua, si es 0 no.

1.1.6.2.9. mainWindow.registerTimer ( id, ms )

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 ( )

Resetea la configuracion del sistema a sus valores por defecto.

1.1.6.2.11. mainWindow.run ( )

Ejecuta el loop principal de lua.

1.1.6.2.12. mainWindow.showBackground ( needShow )

Muestra/oculta el fondo de la ventana.


Parametros
number Indica si se debe ocultar o mostrar el fondo de la ventana (1=mostrar, 0=ocultar).
needShow

1.1.6.2.13. mainWindow.stop ( retCode )

Finaliza el loop principal.


Parametros
number retCode Codigo de error, 0 indica que no hubo errores.

1.1.7. Referencia del modulo middleware

Funciones

isEnabled ()
enable ( state)
getApplications ()
haveApplications ()
runApplication ( id)
lock ( needLock)

1.1.7.1. Descripcion detallada

Provee funcionalidad relacionada con el middleware.

1.1.7.2. Documentacion de las funciones

1.1.7.2.1. middleware.enable ( state )

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

Una tabla con las aplicaciones disponibles [id, name].

1.1.7.2.3. middleware.haveApplications ( )

Devuelve

La cantidad de aplicaciones disponibles.

1.1.7.2.4. middleware.isEnabled ( )

Devuelve

1 si el middleware esta habilitado, 0 en caso contrario.

1.1.7.2.5. middleware.lock ( needLock )

Habilita/deshabilita la ejecucion de aplicaciones.


Parametros
number Indica si se desea habilitar o deshabilitar las aplicaciones (1=habilitar, 0=deshabilitar).
needLock

1.1.7.2.6. middleware.runApplication ( id )

Ejecuta una aplicacion.


Parametros
number id El id de la aplicacion a ejecutar.

1.1.8. Referencia del modulo mountservice

Funciones

registerExtension ( extension)
getFiles ( extension)
reScan ()
addPath ( path)

1.1.8.1. Descripcion detallada

Provee funcionalidad para buscar archivos en el filesystem.

1.1.8.2. Documentacion de las funciones

1.1.8.2.1. mountservice.addPath ( path )

Agrega una ruta a la lista en donde se buscaran los archivos.

17
Parametros
path Un string con la nueva ruta donde buscar.

1.1.8.2.2. mountservice.getFiles ( extension )

Retorna un vector con los archivos que coinciden con la extension especificada.
Parametros
extension Un string con la extension.

Devuelve

Un vector de strings con las ubicaciones de los archivos que coinciden.

1.1.8.2.3. mountservice.registerExtension ( extension )

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.

1.1.9. Referencia del modulo player

Funciones

audioFileEnd ()
toggleMute ()
isMuted ()
setVolume ( vol)
volumeUp ()
volumeDown ()
maxVolume ()
getVolume ()
getAudioChannels ()
getAudioChannel ()
setAudioChannel (ch)
getImageFiles ()
getAudioFiles ()
playAudioFile ( id)
pauseAudioFile ( pause)
stopAudioFile ()

1.1.9.1. Descripcion detallada

Provee la funcionalidad relacionada con el reproductor de audio.

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] El numero del canal de audio en uso actualmente.


[2] El nombre del canal de audio en uso actualmente.

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

El nivel de volumen actual del reproductor.

1.1.9.2.7. player.isMuted ( )

Devuelve

0 si el volumen del reproductor se encuentra habilitado, 1 en caso contrario.

1.1.9.2.8. player.maxVolume ( )

Devuelve

El maximo nivel de volumen del reproductor.

1.1.9.2.9. player.pauseAudioFile ( pause )

Pausa/continua la reproduccion del archivo de audio actual.

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 )

Reproduce el archivo de audio indicado por id.


Parametros
number id El id del archivo de audio a reproducir.

1.1.9.2.11. player.setAudioChannel ( ch )

Cambia el canal de audio al indicado en ch.


Parametros
number ch El numero del canal de audio a setear.

1.1.9.2.12. player.setVolume ( vol )

Cambia el nivel de volumen del reproductor.


Parametros
number vol El nivel de volumen a setear.

1.1.9.2.13. player.stopAudioFile ( )

Frena la reproduccion del archivo de audio actual.

1.1.9.2.14. player.toggleMute ( )

Habilita/deshabilita el volumen del reproductor.

Devuelve

0 si el volumen del reproductor se encuentra habilitado, 1 en caso contrario.

1.1.9.2.15. player.volumeDown ( )

Decrementa el volumen del reproductor.

1.1.9.2.16. player.volumeUp ( )

Incrementa el volumen del reproductor.

1.1.10. Referencia del modulo storage

Funciones

saveStr ( key, value)


loadStr ( key)
saveInt ( key, value)
loadInt ( key)

20
1.1.10.1. Descripcion detallada

Provee funcionalidad para leer y guardar datos en el storage.

1.1.10.2. Documentacion de las funciones

1.1.10.2.1. storage.loadInt ( key )

Lee un entero del storage.


Parametros
key El nombre del valor a leer.

Devuelve

El entero leido.

1.1.10.2.2. storage.loadStr ( key )

Lee un string del storage.


Parametros
key El nombre del valor a leer.

Devuelve

El string leido.

1.1.10.2.3. storage.saveInt ( key, value )

Guarda un entero en el storage.


Parametros
key El nombre del valor a guardar.
value El entero a guardar.

1.1.10.2.4. storage.saveStr ( key, value )

Guarda un string en el storage.


Parametros
key El nombre del valor a guardar.
value El string a guardar.

1.1.11. Referencia del modulo tuner

Funciones

zapperBeginScan ( count)
zapperScanNetwork ( net)
zapperEndScan ()
startScan ()
stopScan ()
getSignal ()

21
1.1.11.1. Descripcion detallada

Provee funcionalidad relacionada al uso del sintonizador de canales.

1.1.11.2. Documentacion de las funciones

1.1.11.2.1. tuner.getSignal ( )

Devuelve

La intensidad de la senal del sintonizador de canales.

1.1.11.2.2. tuner.startScan ( )

Lanza el escaneo de canales.

1.1.11.2.3. tuner.stopScan ( )

Detiene el escaneo de canales.

1.1.11.2.4. tuner.zapperBeginScan ( count )

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.

1.1.11.2.6. tuner.zapperScanNetwork ( net )

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.

1.1.12. Referencia del modulo update

Funciones

zapperUpdateReceived ( id)
zapperUpdateDownloadProgress ( step, total)
isEnabled ()
enable ( val)
apply ( id, apply)

1.1.12.1. Descripcion detallada

Provee funcionalidad relacionada con las actualizaciones del zapper.

22
1.1.12.2. Documentacion de las funciones

1.1.12.2.1. update.apply ( id, apply )

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.2. update.enable ( val )

Activa/desactiva las actualizaciones del zapper.


Parametros
number val Indica si se deben activar o desactivar las actualizaciones del zapper (1=activar, 0=desacti-
var).

1.1.12.2.3. update.isEnabled ( )

Devuelve

1 si las actualizaciones del zapper se encuentran activadas, 0 en caso contrario.

1.1.12.2.4. update.zapperUpdateDownloadProgress ( step, total )

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

You might also like