Manual del desarrollador de lua.pdf

´ Y F ORMACI ON ´ EN L ABORATORIO DE I NVESTIGACI ON ´ I NFORM ATICA AVANZADA

Manual del desarrollador de lua

´ 1.0.0-4393-g34cf8b3 Version 1.0.0-4393-g34cf8b3

17 de septiembre de 2013

´ Indice general

1

APII ex AP expor portad tada a a lua

1.1

2

´ de modulos ´ Docume Doc umenta ntaci ción . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2

´ Refere Ref erenci ncia a del modulo channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2

1.1. 1. 1.1. 1.1 1

´ detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Desc De scrip ripci ción

2

1.1.1. 1.1 .1.2 2

´ de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . Docume Doc umenta ntaci ción

2

´ Refere Ref erenci ncia a del modulo channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4

1.1. 1. 1.2. 2.1 1


5

1.1.2. 1.1 .2.2 2


5

´ Refere Ref erenci ncia a del modulo control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8

1.1. 1. 1.3. 3.1 1


9

1.1.3. 1.1 .3.2 2


9

´ Refere Ref erenci ncia a del modulo display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10

1.1. 1. 1.4. 4.1 1


10

1.1.4. 1.1 .4.2 2


10

´ Refere Ref erenci ncia a del modulo dtvlua . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dtvlua

12

1.1. 1. 1.5. 5.1 1


13

1.1.5. 1.1 .5.2 2


13

´ Refere Ref erenci ncia a del modulo mainWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

1.1. 1. 1.6. 6.1 1


13

1.1.6. 1.1 .6.2 2


13

´ Refere Ref erenci ncia a del modulo middleware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15

1.1. 1. 1.7. 7.1 1


15

1.1.7. 1.1 .7.2 2


15

´ Refere Ref erenci ncia a del modulo mountservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mountservice

16

1.1. 1. 1.8. 8.1 1


16

1.1.8. 1.1 .8.2 2


16

´ Refere Ref erenci ncia a del modulo player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . player

17

1.1. 1. 1.9. 9.1 1


17

1.1.9. 1.1 .9.2 2


18

´ 1.1.10 1.1.1 0 Ref Referenc erencia ia del del m módulo storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19

´ detallada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.10.1 1.1.1 0.1 Descri Descripci pción

20

1.1.1 1.1 .1

1.1.2 1.1 .2

1.1.3 1.1 .3

1.1.4 1.1 .4

1.1.5 1.1 .5

1.1.6 1.1 .6

1.1.7 1.1 .7

1.1.8 1.1 .8

1.1.9 1.1 .9

1

´ de las funciones . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.10.2 1.1.1 0.2 Docum Documentaci entación

20

´ 1.1.11 1.1.1 1 Ref Referenc erencia ia del del m módulo tuner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20


21


21

´ 1.1.12 1.1.1 2 Ref Referenc erencia ia del del m módulo update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21


21


22

2

1

API API expo exporta rtada da a lua lua

´ de modulos ´ 1.1. 1. 1. Do Docu cume ment ntac aciion ´ 1.1.1. 1.1 .1. Ref Referen erencia cia del modulo channel Funciones blocked () blocked () current () current () change ( change ( channelNumber) setFullScreen () setFullScreen () resize ( resize ( x, y, w, h) mute ( mute ( toggle) volume ( volume ( vol) nextVideo () nextVideo () nextAudio () nextAudio () nextSubtitle () nextSubtitle () haveSubtitle () haveSubtitle () getResolution () getResolution () getAspect () getAspect () getAudio () getAudio () getAudioInfo ( getAudioInfo ( id)

´ detallada 1.1.1. 1.1 .1.1. 1. Des Descri cripci pci´ on ´ sobre canales y programaci´ ´ Provee funcionalidad para consultar informaci´ informacion programacion.

´ de las funciones 1.1.1.2. 1.1.1 .2. Docume Documentaci ntaci´ on 1.1.1. 1.1 .1.2.1 2.1..

channe cha nnel.b l.bloc locked ked ( )

Indica si el canal actual est´ esta´ bloqueado. Devuelve True si el canal actual est´ esta´ bloqueado, False en caso contrario.

1.1.1.2.2. 1.1.1 .2.2.

channel.ch channe l.change ange ( channelNumber )

Cambia el canal al indicado en channelNumber. ´ Par´ Par ametros number channelNumber

1.1.1. 1.1 .1.2.3 2.3..

El n umero ´ del canal al que se quiere cambiar.

channe cha nnel.c l.curr urrent ent ( )

Devuelve El número del canal actual.

3

1.1.1. 1.1 .1.2.4 2.4..

channe cha nnel.g l.getA etAspe spect ct ( )

´ de aspecto del reproductor. Indica la relaci´ relacion Devuelve ´ de aspecto del reproductor. Un string indicando la relaci´ relacion

1.1.1. 1.1 .1.2.5 2.5..

channe cha nnel.g l.getA etAudi udio o( )

Indica el tipo de audio del reproductor. Devuelve Un string indicando el tipo de audio del reproductor.

1.1.1.2.6. 1.1.1 .2.6.

channel.get channe l.getAudi AudioInf oInfo o ( id )

´ de un stream de audio. Obtiene informaci´ informacion ´ Par´ Par ametros number id

El id del stream stream de audio.

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

1.1.1. 1.1 .1.2.7 2.7..

channe cha nnel.g l.getR etReso esolut lution ion ( )

´ del reproductor. Indica la resoluci´ resolucion Devuelve ´ del reproductor. Un string indicando la resoluci´ resolucion

1.1.1. 1.1 .1.2.8 2.8..

channe cha nnel.h l.have aveSub Subtit title le ( )

Indica si el video actual tiene subt´ıtulos. ıtulos. Devuelve El string ”CC” si el video actual tiene subt´ıtulos, ıtulos, un string vac´ıo ıo en caso contrario.

1.1.1.2.9. 1.1.1 .2.9.

channel.m channe l.mute ute ( toggle )

Habilita/deshabilita el audio del canal actual. ´ Par´ Par ametros number toggle

1.1.1. 1.1 .1.2.1 2.10. 0.

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

channe cha nnel.n l.next extAud Audio io ( )

Cambia al siguiente stream de audio. Devuelve El id del stream de audio que se est a´ reproduciendo actualmente.

4

1.1.1. 1.1 .1.2.1 2.11. 1.

channe cha nnel.n l.next extSubt Subtitl itlee ( )

Cambia al siguiente subt´ subt´ıtulo. ıtulo. Devuelve El id del subt´ subt´ıtulo ıtulo usado actualmente.

1.1.1. 1.1 .1.2.1 2.12. 2.

channe cha nnel.n l.next extVid Video eo ( )

Cambia al siguiente stream de video. Devuelve El id del stream de video que se est´ esta´ reproduciendo actualmente.

x, y, w, h ) channel.re channe l.resize size ( x,

1.1.1.2.13 1.1.1 .2.13..

˜ ´ del video del canal actual. Cambia el tamano/ubicaci´ no/ubicaci on ´ Par´ Par ametros number x number y number w number h

1.1.1. 1.1 .1.2.1 2.14. 4.

´ horizontal de la esquina superior izquierda. Posicion ´ vertical de la esquina superior izquierda. Posicion Ancho. Alto.

channe cha nnel.s l.setF etFull ullScr Screen een ( )

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

channel.v channe l.volume olume ( vol )

Cambia el volumen del audio del canal actual. ´ Par´ Par ametros number vol

El nivel nivel de volumen a setear. setear.

´ 1.1.2. 1.1 .2. Ref Referen erencia cia del modulo channels Funciones zapperProgramFound ( ch) zapperProgramFound ( zapperChannelChanged ( zapperChannelChanged ( id) haveChannels () channelCount () channelCount () getAll () getAll () get ( get ( id) getInfo ( getInfo ( id) getShowsBetween ( getShowsBetween ( id, from, to) toggleOneSeg () toggleOneSeg () showOneSeg () showOneSeg () remove ( remove ( id) isProtected ( isProtected ( id) isBlocked ( isBlocked ( id) toggleBlocked ( toggleBlocked ( id) unblockAll () unblockAll () 5

toggleFavorite ( id) next ( next ( first, factor) nextFavorite ( nextFavorite ( first, factor) ´ detallada 1.1.2. 1.1 .2.1. 1. Des Descri cripci pci´ on ´ sobre canales y programaci´ ´ Provee funcionalidad para consultar informaci´ informacion programacion. ´ de las funciones 1.1.2.2. 1.1.2 .2. Docume Documentaci ntaci´ on 1.1.2. 1.1 .2.2.1 2.1..

channe cha nnels. ls.cha channe nnelCo lCount unt ( )

Devuelve La cantidad de canales disponibles. 1.1.2. 1.1 .2.2.2 2.2..

channe cha nnels. ls.get get ( id )

´ Par´ Par ametros number id

Identificador del canal a retornar. retornar.

Devuelve El canal identificado por id . ´ Ver tambi tambien getAll para getAll para ver la estructura de un canal. 1.1.2. 1.1 .2.2.3 2.3..

channe cha nnels. ls.get getAll All ( )

Obtiene la lista de canales donde cada canal esta representado por una tabla con los siguientes campos: channelID: el id del canal. channel: el número 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. 1.1.2 .2.4.

channels.ge channe ls.getInf tInfo o ( id )

´ extendida de un canal. A demas ´ de los campos indicados en l getAll a˜ ˜ Obtiene informaci´ informacion 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. ´ del programa actual. showDescription: La descripci´ descripcion

6


Identificador del canal a retornar. retornar.

Devuelve ´ extendida. El canal identificado por id con informaci´ informacion

1.1.2.2.5. 1.1.2 .2.5.

id, fr from om,, to ) channels.ge channe ls.getShow tShowsBetw sBetween een ( id,

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. ´ del programa. description: La descripci´ descripcion start: La fecha y hora de comienzo del programa. ´ del programa. duration: La duracion parentalAge: La edad de control parental. parentalContent: El contenido de control parental. ´ en minutos del programa. length: La duraci´ duracion startDate: • time: La hora hora de inicio del programa programa.. • date: La fecha fecha de inicio del programa. programa. stopDate: • time: La hora hora de fin del programa. programa. • date: La fecha fecha de fin del programa programa.. ´ Par´ Par ametros number id string from string to

El identificador del canal. Fecha/hora inicial. 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. 1.1 .2.2.6 2.6..

channe cha nnels. ls.hav haveCh eChann annels els ( )

Indica si existen canales. Devuelve 1 si hay canales disponibles, 0 en caso contrario.

1.1.2.2.7. 1.1.2 .2.7.

channels.i channe ls.isBloc sBlocked ked ( id )

7


El identificador del canal.

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

channels.i channe ls.isProt sProtected ected ( id )



Devuelve 1 si el canal identificado identificado por id se encuentra protegido mediante control parental, 0 en caso contrario. first, facto factor r ) channels.ne channe ls.next xt ( first,

1.1.2.2.9. 1.1.2 .2.9.

Cambia al canal siguiente del indicado en first, avanzando factor canales. ´ Par´ Par ametros number first number factor

Indica el canal a partir del cual cambiar. Indica la cantidad de canales a avanzar. avanzar.

Devuelve El identificador del canal actual. 1.1.2.2.10 1.1.2 .2.10..

first, fac factor tor ) channels.ne channe ls.nextFa xtFavori vorite te ( first,

Cambia al canal siguiente del indicado en first de la lista de favoritos, avanzando factor canales. ´ Par´ Par ametros number first number factor

Indica el canal a partir del cual cambiar. Indica la cantidad de canales a avanzar. avanzar.

Devuelve El identificador del canal actual. 1.1.2.2.11 1.1.2 .2.11..

channels.r channe ls.remove emove ( id )

Borra el canal identificado por id . ´ Par´ Par ametros number id

1.1.2. 1.1 .2.2.1 2.12. 2.


channe cha nnels. ls.sho showOn wOneSe eSeg g( )

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

channels.t channe ls.toggle oggleBlock Blocked ed ( id )

Bloquea/desbloquea el canala identificado por id .

8


1.1.2.2.14 1.1.2 .2.14..


channels.t channe ls.toggle oggleFav Favorite orite ( id )

˜ Anade/eliminal al canal identificado por id de la lista de favoritos. ´ Parametros Par´ number id

1.1.2. 1.1 .2.2.1 2.15. 5.

Identificador del canal.

channe cha nnels. ls.tog toggle gleOne OneSeg Seg ( )

Muestra/oculta los canales one-seg. Devuelve 1 si se muestran los canales one-seg, 0 en caso contrario.

1.1.2. 1.1 .2.2.1 2.16. 6.

channe cha nnels. ls.unb unbloc lockAl kAlll ( )

Desbloquea todos los canales. 1.1.2.2.17 1.1.2 .2.17..

channels.z channe ls.zapperC apperChannel hannelChanged Changed ( id )

´ se encuentra definida en lua, ser´ Evento que indica un cambio de canal. Si esta funci´ funcion sera´ llamada cuando ocurra un cambio de canal con el id del nuevo canal como parametro. ´ Par´ Par ametros number id

1.1.2.2.18 1.1.2 .2.18..

Identificador del del canal al cual se cambio. cambio.

channels.z channe ls.zapperP apperProgra rogramFoun mFound d ( ch )

´ se encuentra definida en lua, sera´ llamada Evento que indica que se encontr´ encontro´ un nuevo canal. Si esta funci´ funcion cuando se encuentre un nuevo canal con el canal encontrado como parametro. ´ Par´ Par ametros table ch

Tabla que representa representa al nuevo nuevo canal encontrado. encontrado.

´ Ver tambi tambien getAll para getAll para ver la estructura de un canal.

´ 1.1.3. 1.1 .3. Ref Referen erencia cia del modulo control Funciones setPIN ( str) setPIN ( resetPIN () resetPIN () checkPIN ( checkPIN ( str) isSet () isSet () isSessionOpened () isSessionOpened () getParentalAge () getParentalAge () setParentalAge ( setParentalAge ( age) getParentalContent () getParentalContent () setParentalContent ( setParentalContent ( byte)

9

´ detallada 1.1.3. 1.1 .3.1. 1. Des Descri cripci pci´ on Provee funcionalidad para el manejo de control parental.

´ de las funciones 1.1.3.2. 1.1.3 .2. Docume Documentaci ntaci´ on 1.1.3.2.1. 1.1.3 .2.1.

control.ch contr ol.checkPI eckPIN N ( str )

Valida el codigo de control parental indicado en str . ´ Par´ Par ametros string str

El codigo a validar. validar.

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

1.1.3. 1.1 .3.2.2 2.2..

contr con trol. ol.get getPar Parent entalA alAge ge ( )

Devuelve El valor de la edad de control parental.

1.1.3.2.3. 1.1.3 .2.3.

control.get contr ol.getParen ParentalCo talContent ntent ( )

Devuelve ´ utilizada de control parental. La configuraci´ configuracion

1.1.3. 1.1 .3.2.4 2.4..

contr con trol. ol.isS isSess ession ionOpe Opened ned ( )

´ se encuentra activa. Indica si se accedio accedio al control control parental y la sesi´ sesion Devuelve ´ esta activa, 0 en caso contrario. 1 si la sesi´ sesion

1.1.3. 1.1 .3.2.5 2.5..

contr con trol. ol.isS isSet et ( )

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

1.1.3. 1.1 .3.2.6 2.6..

contr con trol. ol.res resetP etPIN IN ( )

Borra la clave de control parental. 1.1.3.2.7. 1.1.3 .2.7.

control.se contr ol.setPar tParental entalAge Age ( age )

Setea la edad utilizada para el control parental.

10

´ Par´ Par ametros number age

1.1.3.2.8. 1.1.3 .2.8.

El valor de la edad de control parental a setear.

control.se contr ol.setPar tParental entalConten Contentt ( byte )

´ de control parental. Setea la configuraci´ configuracion ´ Par´ Par ametros number byte

1.1.3.2.9. 1.1.3 .2.9.

´ de control parental a utilizar. La configuraci´ configuracion

control.se contr ol.setPIN tPIN ( str )

Establece la clave de control parental. ´ Par´ Par ametros string str

La clave a establecer. establecer.

´ 1.1.4. 1.1 .4. Ref Referen erencia cia del modulo display Funciones getConnector () getConnector () getConnectors () getConnectors () getVideoMode ( getVideoMode ( idx) getVideoModes ( getVideoModes ( idx) getCurVideoMode () getCurVideoMode () getCurVideoModes () getCurVideoModes () setVideoMode ( setVideoMode ( conIdx, modIdx) setTransparency ( setTransparency ( value) getTransparency () getTransparency () getAspectMode () getAspectMode () getAspectModes () getAspectModes () setAspectMode ( setAspectMode ( idx) getModulator () getModulator () getModulators () getModulators () setModulator ( setModulator ( idx)

´ detallada 1.1.4. 1.1 .4.1. 1. Des Descri cripci pci´ on Provee funcionalidad relacionada con la pantalla.


displa dis playy.ge .getAs tAspec pectMo tMode de ( )

Devuelve ´ de aspecto que esta activa. [1] El ´ El ´ındice ındice de la relaci´ relacion ´ de aspecto que est´ [2] Un string que describe la relaci´ relacion esta´ activa.

11

1.1.4. 1.1 .4.2.2 2.2..

displa dis playy.ge .getAs tAspec pectMo tModes des ( )

Devuelve ´ [1] Una tabla con todas las relaciones de aspecto disponibles. ´ de aspecto activa. [2] El ´ındice ındice de la relacion

1.1.4. 1.1 .4.2.3 2.3..

displa dis playy.ge .getCo tConne nnecto ctorr ( )

Devuelve [1] El ´ındice ındice del connector que est´ esta´ activo. [2] Un string que describe al connector que est´ esta´ activo.

1.1.4. 1.1 .4.2.4 2.4..

displa dis playy.ge .getCo tConne nnecto ctors rs ( )

Devuelve [1] Una tabla con todos los conectores disponibles. [2] El ´ındice ındice del conector con ector activo. a ctivo.

1.1.4. 1.1 .4.2.5 2.5..

displa dis playy.ge .getCu tCurVi rVideo deoMod Modee ( )

Devuelve [1] El ´ındice ı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. 1.1.4 .2.6.

display displ ay.getC .getCurVide urVideoMode oModess ( )

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. 1.1 .4.2.7 2.7..

displa dis playy.ge .getMo tModul dulato atorr ( )

Devuelve [1] El ´ El ´ındice ındice del modulador de video activo. [2] Un string que describe el modulador de video activo.

1.1.4. 1.1 .4.2.8 2.8..

displa dis playy.ge .getMo tModul dulato ators rs ( )

Devuelve [1] Una tabla con todos los moduladores de video disponibles. [2] El ´ El ´ındice ındice del modulador de video activo.

1.1.4.2.9. 1.1.4 .2.9.

display displ ay.getT .getTranspa ransparency rency ( )

Devuelve El nivel de transparencia actual del menu.

1.1.4.2.10 1.1.4 .2.10..

display displ ay.getV .getVideoM ideoMode ode ( idx )

12

´ Par´ Par ametros number idx

El ´ El ´ındice ındice del conector.

Devuelve [1] El ´ El ´ındice ı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 1.1.4 .2.11..

display displ ay.getV .getVideoM ideoModes odes ( idx )

´ Par´ Par ametros number idx

El ´ındice ındice del conector.

Devuelve [1] Una tabla con todos los modos de video disponibles para el conector indicado por idx . [2] El ´ındice ındice del modo de video activo para el conector indicado por idx .

1.1.4.2.12 1.1.4 .2.12..

display displ ay.setA .setAspect spectMode Mode ( idx )

´ de aspecto actual. Cambia la relacion ´ Par´ Par ametros number idx

1.1.4.2.13 1.1.4 .2.13..

´ de aspecto a activar. El ´ El ´ındice ındice de la relaci´ relacion

display displ ay.setM .setModulat odulator or ( idx )

Activa el modulador de video indicado en idx . ´ Par´ Par ametros number idx

1.1.4.2.14 1.1.4 .2.14..

El ındice ıńdice del modulador de video a activar. activar.

display displ ay.setT .setTranspa ransparency rency ( value )

Cambia el nivel de transparencia del menu. ´ Par´ Par ametros number value

1.1.4.2.15 1.1.4 .2.15..

El nivel nivel de transparencia a setear. setear.

conIdx, mod modIdx Idx ) display displ ay.setV .setVideoM ideoMode ode ( conIdx,

Setea el modo de video indicado por modIdx para el conector indicado por conIdx. ´ Par´ Par ametros number conIdx number modIdx

El ´ El ´ındice ındice del conector. El ındice ıńdice del modo de video.

´ 1.1.5. 1.1 .5. Ref Referen erencia cia del modulo dtvlua Funciones log ( level, group, cat, str) log ( setLevel ( setLevel ( group, cat, level)

13

´ detallada 1.1.5. 1.1 .5.1. 1. Des Descri cripci pci´ on Provee funcionalidad de log


level, gr grou oup, p, ca cat, t, st str r ) dtvlua dtv lua.lo .log g ( level,

Muestra una linea de log. ´ Par´ Par ametros string level string group string cat string str

1.1.5.2.2. 1.1.5 .2.2.

Prioridad del log Grupo del log Categoria del log Texto del log

group,, cat cat,, lev level el ) dtvlua.set dtvlu a.setLevel Level ( group

Configura el nivel de log a mostrar ´ Par´ Par ametros string group string cat string level

Grupo del log Categoria del log Prioridad del log

´ 1.1.6. 1.1 .6. Ref Referen erencia cia del modulo mainWindow Funciones run () run () stop ( stop ( retCode) lockKeys ( lockKeys ( state) resetConfig () resetConfig () getTime ( getTime ( format) getDatePlus ( getDatePlus ( format, offset) cancelTimer ( cancelTimer ( id) registerTimer ( registerTimer ( id, ms) showBackground ( needShow) launchBrowser () launchBrowser () fullscreen ( fullscreen ( state) isFullscreen () isFullscreen () iconify ( iconify ( state)

´ detallada 1.1.6. 1.1 .6.1. 1. Des Descri cripci pci´ on Provee funcionalidad relacionada con el sistema y la ventana principal.


mainWindow mainW indow.canc .cancelTim elTimer er ( id )

´ de un timer. Cancela la ejecuci´ ejecucion

14


1.1.6.2.2. 1.1.6 .2.2.

El id del timer a cancelar. cancelar.

mainWindow mainW indow.ful .fullscre lscreen en ( state )

Cambia entre modo pantalla completa y ventana. ´ Par´ Par ametros number state

1.1.6.2.3. 1.1.6 .2.3.

Si es 0 cambia cambia a mod modo o venta ventana, na, cualqui cualquier er otro valor valor pon pone e la ventana ventana en mod modo o pan pantal talla la completa.

format, offse offset t ) mainWindow mainW indow.getDa .getDatePlu tePluss ( format,

´ Par´ Par ametros string format number offset

Indica el formato formato a usar (ej: ’Y-m-d’). ’Y-m-d’). Indica los d´ıas ıas a sumar a partir de hoy.

Devuelve String formateado segun format de la fecha actual mas los d´ıas ıas indicados por offset.

1.1.6.2.4. 1.1.6 .2.4.

mainWindow mainW indow.getT .getTime ime ( format )

´ sobre el tiempo actual (dias, horas) con el formato indicado en format. Informaci´ Informacion Par´ Par ametros ´ string format

Indica el formato formato a usar (ej: ’Y-m-d ’Y-m-d H:M’)

Devuelve String formateado segun format de el tiempo actual.

1.1.6.2.5. 1.1.6 .2.5.

mainWindow mainW indow.icon .iconify ify ( state )

Minimiza/restaura la ventana. ´ Par´ Par ametros number state

1.1.6. 1.1 .6.2.6 2.6..

Si es 0 restaura restaura la ventana, ventana, cualquier otro valor la minimiza minimiza a la bandeja del sistema.

mainWi mai nWindo ndow. w.isF isFull ullscr screen een ( )

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. 1.1.6 .2.7.

mainWindow mainW indow.laun .launchBr chBrowser owser ( )

Ejecuta un web browser si esta disponible. 1.1.6.2.8. 1.1.6 .2.8.

mainWindow mainW indow.loc .lockKey kKeyss ( state )

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

15

´ Par´ Par ametros number state

1.1.6.2.9. 1.1.6 .2.9.

Si es 1 los eventos eventos de teclado teclado llegar llegaran an a lua, si es 0 no. no.

id, ms ) mainWindow mainW indow.regi .registerTi sterTimer mer ( id,

´ indicada por ms . Una vez transcurridos milisegundos se llama a la funcion ´ de lua Registra un timer con la duracion OnTimerEvent con el id del timer. ´ Par´ Par ametros number id number ms

1.1.6. 1.1 .6.2.1 2.10. 0.

El identificador del timer. ´ del timer en milisegundos. La duraci´ duracion

mainWi mai nWindo ndow. w.res resetC etConfi onfig g( )

´ del sistema a sus valores por defecto. Resetea la configuraci´ configuracion 1.1.6. 1.1 .6.2.1 2.11. 1.

mainWi mai nWindo ndow. w.run run ( )

Ejecuta el loop principal de lua. 1.1.6.2.12 1.1.6 .2.12..

mainWindow mainW indow.show .showBackg Background round ( needShow )

Muestra/oculta el fondo de la ventana. ´ Parametros Par´ number needShow

1.1.6.2.13 1.1.6 .2.13..

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

mainWindow mainW indow.stop .stop ( retCode )

Finaliza el loop principal. ´ Par´ Par ametros number retCode

Codigo de error, 0 indica que no hubo errores. errores.

´ 1.1.7. 1.1 .7. Ref Referen erencia cia del modulo middleware Funciones isEnabled () isEnabled () enable ( enable ( state) getApplications () getApplications () haveApplications () haveApplications () runApplication ( runApplication ( id) lock ( lock ( needLock)

´ detallada 1.1.7. 1.1 .7.1. 1. Des Descri cripci pci´ on Provee funcionalidad relacionada con el middleware.


middlewar middl eware.enabl e.enablee ( state )

16

´ Par´ Par ametros number state

1.1.7.2.2. 1.1.7 .2.2.

Indica si se desea activar o desactivar el middleware middleware (1=activar, (1=activar, 0=desactivar). 0=desactivar).

middlewar middl eware.getAp e.getApplica plications tions ( )

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

1.1.7.2.3. 1.1.7 .2.3.

middlewar middl eware.have e.haveAppli Application cationss ( )

Devuelve ´ La cantidad de aplicaci´ aplicaciones disponibles.

1.1.7. 1.1 .7.2.4 2.4..

middle mid dlewar ware.i e.isEna sEnable bled d( )

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

1.1.7.2.5. 1.1.7 .2.5.

middlewar middl eware.loc e.lockk ( needLock )

´ de aplicaciones. Habilita/deshabilita la ejecuci´ ejecucion ´ Par´ Par ametros number needLock

1.1.7.2.6. 1.1.7 .2.6.

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

middlewar middl eware.runAp e.runApplica plication tion ( id )

´ Ejecuta una aplicacion. ´ Par´ Par ametros number id

´ a ejecutar. El id de de la aplicaci aplicación

´ 1.1.8. 1.1 .8. Ref Referen erencia cia del modulo mountservice Funciones registerExtension ( extension) registerExtension ( getFiles ( getFiles ( extension) reScan () reScan () addPath ( addPath ( path)

´ detallada 1.1.8. 1.1 .8.1. 1. Des Descri cripci pci´ on Provee funcionalidad para buscar archivos en el filesystem.


mountservic mount service.addP e.addPath ath ( path )

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

17

´ Par´ Par ametros path

1.1.8.2.2. 1.1.8 .2.2.

Un string con la nueva nueva ruta donde buscar. buscar.

mountservic mount service.getFi e.getFiles les ( extension )

´ especificada. Retorna un vector con los archivos que coinciden con la extensi´ extension ´ Parametros Par´ extension

Un string con la extension. extension.

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

1.1.8.2.3. 1.1.8 .2.3.

mountservic mount service.regi e.registerE sterExtens xtension ion ( extension )

´ para que luego se busquen archivos que coincidan. Registra una extensi´ extension Par´ Par ametros ´ key

1.1.8. 1.1 .8.2.4 2.4..

´ a agregar. Un string con la extensi´ extension

mounts mou ntserv ervice. ice.reS reScan can ( )

Vuelve Vuelve a escanear.

´ 1.1.9. 1.1 .9. Ref Referen erencia cia del modulo player Funciones audioFileEnd () audioFileEnd () toggleMute () toggleMute () isMuted () isMuted () setVolume ( setVolume ( vol) volumeUp () volumeUp () volumeDown () volumeDown () maxVolume () maxVolume () getVolume () getVolume () getAudioChannels () getAudioChannels () getAudioChannel () getAudioChannel () setAudioChannel (ch) setAudioChannel (ch) getImageFiles () getImageFiles () getAudioFiles () getAudioFiles () playAudioFile ( playAudioFile ( id) pauseAudioFile ( pauseAudioFile ( pause) stopAudioFile () stopAudioFile ()

´ detallada 1.1.9. 1.1 .9.1. 1. Des Descri cripci pci´ on Provee la funcionalidad relacionada con el reproductor de audio.

18


player pla yer.au .audio dioFil FileEn eEnd d( )

´ de la reproducci´ ´ de un audio. Se llamara´ a esta funci´ ´ de lua si la misma se Evento Evento que indica la finalizaci finalización reproduccion funcion encuentra definida. 1.1.9.2.2. 1.1.9 .2.2.

player. play er.getAu getAudioCha dioChannel nnel ( )

Devuelve [1] El número del canal de audio en uso actualmente. [2] El nombre del canal de audio en uso actualmente.

1.1.9.2.3. 1.1.9 .2.3.

player. play er.getAu getAudioCha dioChannels nnels ( )

Devuelve [1] Tabla con los nombres de los canales de audio soportados por el reproductor. [2] El número del canal de audio en uso actualmente.

1.1.9. 1.1 .9.2.4 2.4..

player pla yer.ge .getA tAudi udioFi oFiles les ( )

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. 1.1 .9.2.5 2.5..

player pla yer.ge .getIm tImage ageFil Files es ( )

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. 1.1 .9.2.6 2.6..

player pla yer.ge .getV tVolu olume me ( )

Devuelve El nivel de volumen actual del reproductor.

1.1.9. 1.1 .9.2.7 2.7..

player pla yer.i.isMu sMuted ted ( )

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

1.1.9. 1.1 .9.2.8 2.8..

player pla yer.ma .maxV xVolu olume me ( )

Devuelve ´ El maximo nivel de volumen del reproductor.

1.1.9.2.9. 1.1.9 .2.9.

player. play er.pauseA pauseAudioF udioFile ile ( pause )

´ del archivo de audio actual. Pausa/continua la reproducci´ reproduccion

19

´ Par´ Par ametros number pause

1.1.9.2.10 1.1.9 .2.10..

´ del archivo de audio actual (1=pausar, Indica Indica si se debe pausar o continua continuarr la reproducci reproducción 0=continuar).

player play er.pla .playAudi yAudioFile oFile ( id )

Reproduce el archivo de audio indicado por id . ´ Par´ Par ametros number id

1.1.9.2.11 1.1.9 .2.11..

El id del del archivo de audio a reproducir.

player play er.setA .setAudioCh udioChannel annel ( ch )

Cambia Cambia el canal de audio al indicado indicado en ch. ´ Par´ Par ametros number ch

1.1.9.2.12 1.1.9 .2.12..

El número umero del canal de audio a setear.

player play er.setV .setVolume olume ( vol )

Cambia el nivel de volumen del reproductor. ´ Par´ Par ametros number vol

1.1.9. 1.1 .9.2.1 2.13. 3.

El nivel nivel de volumen a setear. setear.

player pla yer.st .stopA opAudi udioFi oFile le ( )

´ del archivo de audio actual. Frena la reproduccion 1.1.9. 1.1 .9.2.1 2.14. 4.

player pla yer.to .toggl ggleMu eMute te ( )

Habilita/deshabilita el volumen del reproductor. Devuelve 0 si el volumen del reproductor se encuentra habilitado, 1 en caso contrario.

1.1.9. 1.1 .9.2.1 2.15. 5.

player pla yer.v .volu olumeD meDow own n( )

Decrementa el volumen del reproductor. 1.1.9. 1.1 .9.2.1 2.16. 6.

player pla yer.v .volu olumeU meUp p( )

Incrementa el volumen del reproductor.

1.1.10 1.1 .10..

´ Referen Ref erencia cia del modulo storage

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

20

´ detallada 1.1.10.1. 1.1.1 0.1. Descri Descripci pcion Provee funcionalidad para leer y guardar datos en el storage.

´ de las funciones 1.1.10.2. 1.1.1 0.2. Docume Documentaci ntaci´ on 1.1.10.2.1 1.1.1 0.2.1..

storage.loa stora ge.loadInt dInt ( key )

Lee un entero del storage. ´ Par´ Par ametros key

El nombre nombre del valor a leer. leer.

Devuelve El entero leido.

1.1.10.2.2 1.1.1 0.2.2..

storage.loa stora ge.loadStr dStr ( key )

Lee un string del storage. Par´ Par ametros ´ key

El nombre nombre del valor a leer. leer.

Devuelve El string leido.

1.1.10.2.3 1.1.1 0.2.3..

key, value ) storage.sav stora ge.saveInt eInt ( key,

Guarda un entero en el storage. ´ Par´ Par ametros key value

1.1.10.2.4 1.1.1 0.2.4..

El nombre del valor a guardar. guardar. El entero a guardar.

key, value ) storage.sav stora ge.saveStr eStr ( key,

Guarda un string en el storage. ´ Par´ Par ametros key value

1.1.11 1.1 .11..

El nombre del valor a guardar. guardar. El string a guardar. guardar.

´ Referen Ref erencia cia del modulo tuner

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

21

´ detallada 1.1.11.1. 1.1.1 1.1. Descri Descripci pcion Provee funcionalidad relacionada al uso del sintonizador de canales.

´ de las funciones 1.1.11.2. 1.1.1 1.2. Docume Documentaci ntaci´ on 1.1.11 1.1 .11.2. .2.1. 1.

tuner tun er.ge .getSi tSigna gnall ( )

Devuelve ˜ del sintonizador de canales. La intensidad de la se˜ senal

1.1.11 1.1 .11.2. .2.2. 2.

tuner tun er.st .start artScan Scan ( )

Lanza el escaneo de canales. 1.1.11 1.1 .11.2. .2.3. 3.

tuner tun er.st .stopS opScan can ( )

Detiene el escaneo de canales. 1.1.11.2.4 1.1.1 1.2.4..

tuner.zappe tuner .zapperBegin rBeginScan Scan ( count )

´ de lua si la misma se encuentra Evento que indica el comienzo del escaneo de canales. Se llamar´ llamara´ a esta funcion definida. ´ Par´ Par ametros number count

1.1.11 1.1 .11.2. .2.5. 5.

La cantidad cantidad de redes a escanear.

tuner tun er.za .zappe pperEn rEndSca dScan n( )

´ del escaneo de canales. Se llamar´ ´ de lua si la misma se encuentra Evento que indica la finalizacion llamara´ a esta funci´ funcion definida. 1.1.11.2.6 1.1.1 1.2.6..

tuner.zappe tuner .zapperScanNe rScanNetwor tworkk ( net )

´ de lua si la misma se Evento que indica el comienzo de escaneo de canales en una red. Se llamara´ a esta funci´ funcion encuentra definida. ´ Par´ Par ametros string net

1.1.12 1.1 .12..

La red que se comenzar´ comenzara´ a escanear.

´ Referen Ref erencia cia del modulo update

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

´ detallada 1.1.12.1. 1.1.1 2.1. Descri Descripci pcion Provee funcionalidad relacionada con las actualizaciones del zapper.

22

´ de las funciones 1.1.12.2. 1.1.1 2.2. Docume Documentaci ntaci´ on 1.1.12.2.1 1.1.1 2.2.1..

apply ly ) update.apply update. apply ( id, app

´ Par´ Par ametros number id number apply

1.1.12.2.2 1.1.1 2.2.2..

´ El id id de la actuali actualizaci zación. ´ (1=aplicar, 0=descartar). Indica si debe aplicar o descartar la actualizaci´ actualizacion

update.enabl update. enablee ( val )

Activa/desactiva las actualizaciones del zapper. ´ Par´ Par ametros number val

1.1.12 1.1 .12.2. .2.3. 3.

Indica si se deben activar o desactivar desactivar las actualizaciones actualizaciones del zapper (1=activar, (1=activar, 0=desactivar).

update. upd ate.isE isEnab nabled led ( )

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

1.1.12.2.4 1.1.1 2.2.4..

step, tot total al ) update.zapper update. zapperUpdate UpdateDownl DownloadPr oadProgress ogress ( step,

´ del zapper. Si esta funcion ´ se encuentra definida Evento que indica el progreso de descarga de una actualizaci´ actualizacion ´ del zapper. en lua, sera´ llamada cuando progrese la descarga de una actualizaci´ actualizacion ´ Par´ Par ametros number step number total

1.1.12.2.5 1.1.1 2.2.5..

Indica el progreso actual de descarga. Indica el total total de la descarga. descarga.

update.zapper update. zapperUpdate UpdateRecei Received ved ( id )

´ del zapper. Si la actualizaci´ ´ es obligatoria se aplicar´ Evento que indica la presencia de una actualizacion actualizacion aplicara´ la ´ se encuentra definida en lua, ser´ ´ como misma, de lo contrario si esta funci´ funcion sera´ llamada con el id de la actualizaci´ actualizacion parametro. ´ Par´ Par ametros number id

´ Identificador de la actualizaci´ actualizacion.

23

Manual del desarrollador de lua.pdf

Recommend Documents