Documentación referente a los parámetros de configuración desde JS.

Transcripción

1 Documentació. SimpleVideoPlayer 2.x Autor: Joan Ribas ( jribas.t@tv3.cat ) Versión del documento: 2.02 Fecha de revisión: 17/01/2008 Documentación referente a los parámetros de configuración desde JS. 1.- Contexto. Para el proceso de incorporación del objecto SWF en las paginas HTML se escogió la solución SWFobject 1.5 ( ). SWFobject es un sistema fácil de implementar que nos proporciona 2 ventajas: - Evita el problema de ActiveX en Internet Explorer. - Facilita la configuración de atributos de flashplayer y parámetros flashvar. Para intermediar con SWFobject, hemos preparado un documento javascript llamado svp.js donde se ha simplificado el proceso en la función insertasvp(). En el caso de esta función se hospeda en la url: Insertar SVP en una página HTML. La función insertasvp() pinta SVP en una página HTML. function insertasvp( ContainerReference, ConfigData, FlashParams ) { } Usa 3 parámetros, todos son requeridos: ContainerReference: ConfigData: FlashParams: String Nombre del atributo id del tag <div> donde va pintarse la instancia de SVP. Si dicho <div> tuviera contenido, esté será sustituido. Object Objeto que contiene los parámetros referentes a la configuración de SVP2. Object Objeto que contiene los los parámetros comunes de flashplayer. La función no retorna ningún valor. Usar esta función implica construir previamente los objetos ConfigData y FlashParams que deben enviarse como parámetros. A continuación se redactan instrucciones y se detallan los parámetros que admite cada objeto. Listado de parámetros que admite el objeto ConfigData. VIDEO_ID: Number Identificador númerico del item

2 video. Es usado en caso de ser un video dinámico, gestionado por el servidor. Por ejemplo, en el portal Este numero se concatenará en la llamada a FLV_bbd_dadesItem.jsp. PLAYLIST_URL: VIDEO_URL: WIDTH: HEIGHT: AUTOPLAY: String Url de un documento XML que describe una PlayList de videos a reproducir. Usar este parámetro provoca que SVP2 omita el parámetro VIDEO_ID y cambia el sistema de obtención de los datos del video. Las funciones de Login, Subscripción, sessión y calidades no serán operativas. El botón de preferencias de calidad no aparerá en la consola. Este parámetro es útil en webs de programas, o inclusiones desde otro Flash. String Url de un video FLV. Usar este parámetro provoca que SVP2 omita los parámetros VIDEO_ID y PLAYLIST_URL. Anula el sistema de obtención de los datos del video. Las funciones de Playlist, Login, Subscripción, sessión no serán operativas. El botón de preferencias de calidad no aparerá en la consola. Este parámetro es útil en ocasiones puntuales en las que tan solo se necesita un reproductor de video sencillo. Number Ancho del video. SVP2 predominará los valores de tamaño por encima de originales del video. Por tanto este parámetro también puede usarse para forzar tamaños. No confundir este parametro con tamaños de flashplayer. Number Alto del video. SVP2 predominará los valores de tamaño por encima de originales del video. Por tanto este parámetro también puede usarse para forzar tamaños. No confundir este parametro con tamaños de flashplayer. String Indica si el video debe reproducirse sin esperar a que el usuario

3 interactue. STREAM_BUFFER_MSEC: POSTER_URL: PREVIDEO_URL: USE_CONSOLE: USE_QUALITY: USE_FULLSCREEN: Number En videos con descarga en Stream, este parámetro fuerza los Milisegundos de buffer que debe respetar antes de iniciar la reprodución cuando esta ha sido interrumpida. Por defecto se usan 5 segundos. Este parametro es inocuo cuando el player muestra videos en decarga progresiva. (! ) Nota Importante: Este parametro no modificará la primera reproducción inicial. Ya que esta siempre impuesta a 0.1 segundos. String Url de la imagen que muestra el Poster. Se ha testeado con JPG. Teoricamente debe funcionar con imagenes PNG, GIF y SWF. Pero no se ha testeado. El valor por defecto es "media/svp2_poster.jpg". Hay una logica que puede sobre-escribir este dato en runtime. Si la petición a dades video devuelve un nodo poster con una url, ese dato se usará por encima del parametro POSTER_URL. String Url de la imagen que muestra el aviso previo al video. El valor por defecto es " media/svp2_prevideo.swf". String Indica si debe usarse la interficie inferior que muestra los botones (llamada consola). Si USE_CONSOLE es false, el menu contextual del botón derecho también se deshabilitará. String Permite esconder el boton de preferencias de calidad. String Permite esconder el boton que

4 abre el modo a pantalla completa. USE_VOLUMESLIDER: VOLUME_PERCENT: PREVIDEO_DURATION_SECONDS: SKIN_URL: SKIN_FORM_URL: CONDITIONALACCES_URL: LOGIN_URL: SMS_URL: VIDEOINFO_URL: String Conmuta la funcionalidad de sonido, entre mute y slider. Number Volumen inicial de sonido. El valor debe ser un intervalo de 0 a 100. Number Segundos de duración que se mantiene la imagen que muestra el aviso previo al video. String Url del swf de la skin básica que viste la aplicación. El valor por defecto es "themes/svp2_skintemplate.swf" String Url del swf de la skin de los formularios de login, sms y errores. Esta separado por que en integraciones sencillas no es necesario su uso. Así se ahorran peticiones, tiempo de espera y kb a trasferir. El valor por defecto es "themes/svp2_skinformtemplate.swf" peticiones a conditionalaccess. peticiones de login. peticiones para chequear SMS. peticiones a dadesitem.

5 USERINFO_URL: RELATEDINFO_URL: START_TEMPLATE: END_TEMPLATE: END_EXTERNALMC_URL: POSTER_CANLINK LINK_TVCINFOSMS_URL peticiones a sessionmanager. peticiones a items relacionats. Number Define el comportamiento inicial de SVP2. Es perceptible en la pantalla de poster. Posibles valores: 0 = poster with Button 1 = poster without Button 2 = poster with Veil Number Define el comportamiento final de SVP2. Es perceptible cuando concluye el último video. Posibles valores: 0 = loop (del último salta al primer video) 1 = poster (vuelve a pantalla de poster) 2 = loop to prevideo (salta a prevideo) 3 = Pantalla básica de related items 4 = External file (carga un SWF) Number Url de un archivo swf que se carga en la pantalla final, cuando se ha definido ese comportamiento en el parametro END_TEMPLATE (valor 4). El valor por defecto es media/svp2_relateditems.swf. String Indica si la imagen de poster tiene funcionalidad interactiva o solo decorativa. En valor false solo el boton central linkara. String Url a donde se linkará desde el formulario de SMS para acceder a la información adicional. El valor por defecto estan pendientes de definir. Actualmente es:

6 LINK_TVCSUBSCRIBE_URL USE_METALABEL: METALABEL_TEXT: METALABEL_BGCOLOR: METALABEL_TEXTCOLOR: USE_CRONO: CRONO_SHOWS_DURATION: SKIN_VOLUME_URL: LINK_RELATEDVIDEO_URL: String Url a donde se linkará desde el formulario de login para subscribirse a 3alacarta. El valor por defecto estan pendientes de definir. Actualmente es: String Activa o desactiva la label impresa sobre el video que muestra un texto con metainfo sobre el video. Por defecto este texto es Publicitat. String Texto que muestra la metalabel impresa sobre los videos. Es genérico, por tanto no permite asociar textos diferentes a cada video de la playlist. String Código hexadecimal para el color de fondo de la metalabel. La sintaxis del valor no usa el caracter # ; sino el sistema de Flash. Un ejemplo de valor es 0xFFFFFF. El valor por defecto es un Naranja. String Código hexadecimal para el color del texto de la metalabel. La sintaxis del valor no usa el caracter # ; sino el sistema de Flash. Un ejemplo de valor es 0xFFFFFF. El valor por defecto es un Blanco. String Activa o desactiva el temporizador en la botonera. Se usa como Boolean. Es decir admite 2 posibles valores las strings true y false. El valor no es case sensitive. String Muestra la duración del video en el Crono (junto al tiempo transcurrido). Se usa como Boolean. Es decir admite 2 String Url del swf de la skin que contiene el slider de volumen. Esta separado por dificultad técnica surgida a final de proyecto. El valor por defecto es "themes/svp2_skinvolumetemplate.swf" String Url base a donde linkaran los items relacionados de la pantalla final. Por defecto apuntan a "

7 SVP concatenará el parametro idint. USE_PREVIDEO: USE_LINK_TOCONTEXT: String Activa o desactiva el cartel de aviso de publicidad. Se usa como Boolean. Es decir admite 2 posibles valores las strings true y false. El valor no es case sensitive. Su valor por defecto es true. Esto significa que si la Playlist o el ConditAcc de un VIDEO_ID tienen el atributo publi del primer nodo en true se mostrará el cartel de Aviso. En los casos en que no se usen Playlist o VIDEO_ID, no se tiene encuenta ningun atributo; por tanto si el valor de USE_PREVIDEO es true se mostrará el cartel, en caso contrarío se esconderá. String Habilita la funcionalidad de linkar al contexto del video: Ficha o itemvideo. Permite esconder el boton que linka al item del video. Este boton es solo operativo cuando SVP conoce el VIDEO_ID. En los casos en que SVP usa VIDEO_URL o PLAYLIST_URL, este boton se desactiva automaticamente. Si VIDEO_LINKSTOCONTEXT es true, también el video linkará al contexto. VIDEO_LINKSTOCONTEXT: String Permite que el video también linke al contexto, ademas del boton de link. Este parámetro solo es operativo cuando el parametro USE_LINK_TOCONTEXT equivalga a true. USE_WATERMARK: String Indica si debe mostrarse la marca de TV (mosca). En los videos EMBED este valor siempre se sobreescribirá a true. Pero su valor por defecto es false.

8 WATERMARK_URL: String Url del swf que contiene la marca del author, como por ejemplo la Mosca de TV. El valor por defecto es "themes/watermark.swf" USE_RIGHTCLICKMENU: String Indica si se mostrará el menu contextual del botón derecho de Mouse. Si USE_CONSOLE es false, el menu contextual también se deshabilitará. STATS_HITINTERVALSECONDS: Number Indica los segundos del intervalo de espera entre cada HIT al server de auditoria de trafico. Influye en los hits que se realizan mientras se esta reproduciendo el video. Este parámetro no afecta a los hits de inicio y final del video. STATS_CONTENTGROUP_REF: STATS_VIDEOTITLE_REF: String Parametro que se envia a sitecensus en el campo CG (content group) concatenado junto al dominio. Este valor solo se usa si VIDEO_ID no esta definido. En los videos con VIDEO_ID se usa el valor que llega en dadesitem. String Parametro que se envia a sitecensus en el campo TL (title). Este valor solo se usa si VIDEO_ID no esta definido. En los videos con VIDEO_ID se usa el valor que llega en dadesitem. Nota: Los indicadores de las variables son case sensitive. Debe respetarse las mayúsculas y minúsculas. Listado de parámetros que admite el objeto FlashParams. src: bgcolor: width: String Url de un archivo swf de SVP. (! ) No debe usarse. Entra en conflicto con ExpressInstall de FlashPlayer. SWFObject ya define este parametro. String Código hexadecimal del color de fondo. Por ejemplo: "#ffffff" Number Ancho del objeto flash.

9 No confundir con el tamaño del video. height: quality: swliveconnect: menu: scale: align: salign: Number Alto del objeto flash. No confundir con el tamaño del video. Es importante entender esta diferencia. Ya que si se esta usando la consola debe sumarse su tamaño al tamaño del video. Y si no se va a usar, el tamaño del video y flash coincidirá en la mayoria de los casos. String Tipo de render que debe usar flashplayer. Los valores más comunes son low, medium y high. String Habilita/mejora la comunicación runtime entre javascript y flash. String Permite al usuario acceder al control del flash desde el menu derecho. String Política de escala. SVP2 usa el valor "noscale". String Alineación horizontal de los elementos internos del flash. SVP2 usa el valor "l" que equivale a left. String Alineación horizontal y vertical de los elementos internos del flash. SVP2 usa el valor "tl" que equivale a top-left. allowfullscreen: wmode: String Clausula de seguridad que habilita la posibilidad de reproducir a ventana completa. Debe usarse en concordancia con el parámetro USE_FULLSCREEN del objeto ConfigData (descrito anteriormente). String Modo de ventana. No usar nunca. Nota: Los indicadores de las variables son case sensitive. Debe respetarse las mayúsculas y minúsculas.

10 3.- Directorios en servidor. Como norma general; en servidor se habilitará un directorio exclusivo para SVP2. En dicho directorio encontraremos los archivos SWF i JS repartidos en subdirectorios. - El subdirectorio themes contendrá todas los archivos de las diferentes skins de cada portal o web de programa. Tanto de interfaz como de formulario. - El subdirectorio media contendrá los archivos que se consideran contenido. Por ejemplo; la imagen/animación de prevideo, imágenes forzadas como poster, pantallas forzadas de relateditems - El subdirectorio js contendrá los archivos Javascript comentados anteriormente. - La raiz del directorio, es decir la carpeta SVP2, contendrá el arxhivo motor de la aplicación y archivos de debug como FlashInspector. En el caso de TV3, la url sería Sistema para embedar un SVP2 fuera del dominio de tv3.cat. A continuación se muestra un ejemplo del codigo que se publicaría para permitir que un usuario pueda distribuir un video desde su propia pagina web o blog. <script src=" language="javascript"></script> <script type="text/javascript">embedsvp(68019)</script> Debe copiarse y pegarse en el body de la pagina html. 5.- Tabla de versiones. Versión Fecha de Release Notas febrero 08 Estreno tv3.cat, videos en descarga progresiva Pendiente Se añade soporte a videos en stream Pendiente Mejora en buffering de videos en stream.