Parámetros para el plugin
Los parámetros para el plugin pueden ser configurados de manera global en el área de administración y ésta configuración afectara a todos los videos. Sin embargo, el plugin también permite cambiar los valores por defecto para cada video indicando los nuevos valores dentro de cada etiqueta. Cuando se sobre escriben los parámetros por defecto, los nuevos valores se añaden en la primera parte de la etiqueta separados por espacios. Por ejemplo, si desea cambiar los valores de alto, ancho, e inicio de reproducción automática la etiqueta se vería como: {flv width="180" height="150" autostart="true"}fiesta{/flv}. Note que cuando se definen los parámetros en la etiqueta el nombre del atributo debe ser escrito en minúsculas seguido por un signo de igualdad y finalizando con el valor del atributo encerrado en comillas dobles.
La siguiente tabla muestra los nombres de los parámetros soportados, el nombre a usar en las etiquetas cuando se desea sobre escribir el valor por defecto y los valores posibles. Como se describió en la tabla de formatos soportados existen diferentes reproductores para reproducir los distintos formatos; El único reproductor que soporta todos los parámetros en éste listado es JW Media Player. Los reproductores restantes usualmente solo soportan ancho (width), alto (height) e inicio automático (autoplay). El reproductor de YouTube es una excepción, pues soporta algunos atributos especiales los cuales son descritos al final de la tabla. Nota: Algunos de los parámetros no se pueden configurar en el área de administración pero pueden ser configurados en la etiqueta. Estos parámetros son explicados al final en la sección de comentarios.
| Sección | Nombre del parámetro | Nombre del atributo | Valores |
|---|---|---|---|
| Parámetros del Plugin | Clase Contenedora | avcss | Cualquier nombre de clase |
| Parámetros del Plugin | Ancho del video | width | Valor en pixeles |
| Parámetros del Plugin | Alto del video | height | Valor en pixeles |
| Parámetros del Plugin | Ancho para videos de iFilm | iwidth | Valor en pixeles |
| Parámetros del Plugin | Alto para videos de iFilm | iheight | Valor en pixeles |
| Parámetros del Plugin | Ancho para videos de Metacafe | mwidth | Valor en pixeles |
| Parámetros del Plugin | Alto para videos de Metacafe | mheight | Valor en pixeles |
| Parámetros del Plugin | Modo de despliegue de Flash | wmode | ventana, transparente or opaco |
| Parámetros del Plugin | Color de fondo para flash | bgcolor | Valor indicando un color 1) |
| Parámetros del Plugin | Ancho para el audio | awidth | Valor en pixeles |
| Parámetros del Plugin | Ancho para el audio | aheight | Valor en pixeles |
| Parámetros Avanzados | Colores para los controles | pbgcolor | Valor indicando un color 1) |
| Parámetros Avanzados | Colores para el texto de los controles | pfgcolor | Valor indicando un color 1) |
| Parámetros Avanzados | Colores para resaltar los controles | phicolor | Valor indicando un color 1) |
| Parámetros Avanzados | Fondo del video | psccolor | Valor indicando un color 1) |
| Parámetros Avanzados | Inicio automático | autostart | true or false |
| Parámetros Avanzados | Mostrar barra de control | shownav | true or false |
| Parámetros Avanzados | Mostrar dígitos | showdigits | true or false |
| Parámetros Avanzados | Mostrar iconos | showicons | true or false |
| Parámetros Avanzados | Mostrar stop | showstop | true or false |
| Parámetros Avanzados | Mostrar descargar | showdownload | true or false 7) |
| Parámetros Avanzados | Mostrar botón de pantalla completa | usefullscreen | true or false |
| Parámetros Avanzados | Scriptable | enablejs | true or false 5) |
| Parámetros Avanzados | Logo | logo | URL/Ruta relativa 2) |
| Parámetros Avanzados | Modo de video | screenmode | Identificador de modo 3) |
| Parámetros Avanzados | Tamñ de la lista de reproducción | plsize | Valor en pixeles 3) |
| Parámetros Avanzados | Ajustar contenido | stretch | 0, 1, 2 or 3 4) |
| Parámetros Avanzados | Mínima versión de Flash | flashver | Tres números separados por puntos10) |
| Parámetros Avanzados | Mostrar Ecualizador | showeq | true or false |
| Parámetros Avanzados | Mostrar barra de búsqueda | searchbar | true or false |
| Parámetros Avanzados | Proveedor de búsqueda | searchlink | URL 12) |
| Parámetros Avanzados | Contenido alternativo | alt | Cualquier contenido HTML válido 13) |
| - | - | cfg | URL 6) |
| - | - | displaywidth | Valor en pixeles 3) |
| - | - | displayheight | Valor en pixeles 3) |
| - | - | divid | Valor de un ID de CSS 5) |
| - | - | link | URL 7) |
| - | - | linkfromdisplay | true or false 7) |
| - | - | linktarget | a window name (e.g. _blank) 7) |
| - | - | plthumbs | true o false 8) |
| - | - | type | Un tipo de archivo 9) |
| - | - | repeat | false, true or list 8) |
| - | - | shuffle | true o false 8) |
| - | - | autoscroll | true o false 8) |
| - | - | recurl | URL 11) |
| - | - | img | URL 14) |
| - | - | volume | int 15) |
| - | - | menu | true o false 16) |
| - | - | popup | true o false 17) |
Comentarios:
1. Los valores para los colores pueden ser expresados en cualquiera de los siguientes formatos los cuales serán convertidos al formato correcto de forma automática
- Valor hexadecimal de 6 dígitos precedido por # (e.g.: #223344 Igual que la sintaxis de HTML)
- Valor hexadecimal de 3 dígitos precedido por # (e.g.: #234 similar a la sintaxis corta usada en hojas de estilo)
- 3 valores decimales entre paréntesis seguidos de la palabra rgb (e.g.: rgb(99,140,235) - Igual a la sintaxis rgb usada en hojas de estilo)
- Un valor hexadecimal de 1 a 6 dígitos precedido por 0x (e.g.: 0x2345 como se usa en JavaScript)
- Uno de los 16 nombre de colores especificados en HTML 2.0.1 (e.g.: red)
2. Las imágenes para el logo puede ser especificada usando la URL (e.g.: http://miservidor.com/logo.png) o si la imagen se encuentra en el mismo servidor, usando la ruta local a la imagen (e.g.: /images/stories/logo2.png). Se recomienda el uso de imágenes en formato gif o png (preferido) ya que estos formatos tienen soporte para transparencia. La posición del logo es estática: Esquina superior derecha de la pantalla de video; sin embargo, si usted desea una posición diferente lo que puede hacer es crear una imagen más grande donde la mayor parte de la imagen es transparente.
3. El parámetro modo de video es especial ya que este no es un parámetro real para el reproductor JW Media Player sino un forma sencilla de indicarle al plugin como calcular los valores para los parámetros displaywidth and displayheight (Estos dos parámetros controlan el tamaño de la pantalla de video del reproductor. Usted puede usar uno de los siguientes valores:
| Modo | Descripción | |
|---|---|---|
| default | Este modo de despliega por defecto donde la barra de controles del reproductor se ubica debajo de la pantalla de video. La barra de control tiene un alto de 20 pixels luego el tamaño disponible para la pantalla de video es ancho x alto - 20. | |
| coverlay | En este modo, éste modo, displaywidth and displayheight se les asignará el mismo valor de ancho y alto respectivamente. Esto produce que la barra de control se muestre en forma transparente dentro del área de la pantalla de video. Adicionalmente, la barra de control aparecerá y desaparecerá cuando el ratón entra o sale del área de la pantalla de video. El tamaño disponible para la pantalla de video es ancho x alto. | |
| plbottom | Este modo pretende mostrar la lista de reproducción en la parte inferior debajo de la barra de controles. El alto de esta ventana desplegable es tomado del parámetro plsize. El tamaño disponible para la pantalla de video es ancho x alto - 20 - plsize. | |
| plright | Es similar a plbottom, pero la lista de reproducción se desplegará a la derecha de la pantalla de video. El ancho de esta ventana desplegable es tomado del parámetro plsize. El tamaño disponible para la pantalla de video es ancho - plsize x alto - 20. | |
| floatcplright | Este modo es una combinación de coverlay and plright. El tamaño disponible para la pantalla de video es ancho - plsize x alto. |
Nota: Cuando se dan valores para displaywidth or displayheight dentro de la etiqueta los cálculos descritos en la tabla anterior se deshabilitan.
4. Ajustar contenido define la forma de modificar el video para que este se ajuste al tamaño de la pantalla. 1 ajustará el video de forma proporcional para llenar la pantalla completa.0 cambiará las dimensiones hasta que el video encaje.2 ajustará el video de forma desproporcional para encajar tanto el alto como el ancho. 3 mostrará todos los ítems con sus dimensiones originales.
5. Cuando la opción de scripting está habilitada el reproductor puede ser controlado vía Javascript. Para poder controlar el reproductor de ésta forma, y en caso de múltiples reproductores en la página distinguir cada uno de ellos, el reproductor debe ser identificado por su ID. Para facilitar el scripting el valor de este ID puede ser asignado usando el atributo divid. Si no asigna valor usando el atributo el plugin asignará un valor de forma automática. El ID asignado al objeto Flash que será manipulado usando Javascript es p_ seguido del valor especificado.
6. Si necesita especificar varios parámetros, usted puede terminar con etiquetas bastante largas. Para evitar este inconveniente el atributo cfg almacena la URL que referencia un archivo de configuración (en formato XML) con los parámetros. Los nombres de las variables en dicho archivo pueden diferir de los nombres definidos en la tabla. Para mayor información acerca del nombre de los parámetros revise la documentación del reproductor JW Media Player. Pueden encontrar un ejemplo del archivo aquí.
7. La URL especificada en el atributo link es utilizada para proveer un medio de descarga de los videos/audio y/o información relacionada. La URL es utilizada cuando el botón de descargas es activado. Adicionalmente, si el valor del atributo linkfromdisplay es true un clic en la pantalla del reproductor cargará la URL en lugar de detener/reproducir el video. El atributo linktarget (Valoe por defecto: _blank) indica en que ventaba se debe cargar la URL.
8. Si plthumbs es true y se mostrarán las imágenes en miniatura que se hayan definido en la lista de reproducción. Si autoscroll es true la lista de reproducción rotará con el movimiento del ratón en lugar de usar la barra de desplazamiento. El atributo repeat determina la forma como el reproductor se comporta cuando termina la reproducción de un video y/o audio. Los posibles valores son: false lo que le indica al reproductor que no debe reproducir nada más, true significa reproduzca de nuevo desde el principio y list que indica que inicie la reproducción del siguiente ítem en la lista de reproducción. Cuando se está reproduciendo la lista la forma como el reproductor define cual es el siguiente ítem depende del parámetro shuffle (valor por defecto: true). Si el valor es false los ítems en la lista son reproducidos de forma secuencial. Cómo utilizar listas de reproducción se explica en la siguiente sección.
9. Cuando se usa la variante remote en la etiqueta usted puede referenciar cualquier archivo de video/audio con cualquier extensión o eventualmente sin ninguna. Cuando esto sucede, JW Media Player podría no reconocer el tipo de archivo de forma correcta. Este atributo permite forzar el tipo de medio a uno de los tipos soportados.
10. Este atributo le permite definir la versión mínima de Flash requerida para el funcionamiento del reproductor. El reproductor requiere al menos la versión 7 de Flash, sin embargo cuando el reproductor se ejecuta con esa versión varias características no funcionaran. Algunas de ellas son: scripting, despliegue de imagenes gif/png, los dígitos en la barra de control. Adicionalmente, si se desea la funcionalidad de pantalla completa se requiere como mínimo la versión 9.0.28 de Flash y para reproducir videos codificados como H264 la versión debe ser mínimo la 9.0.98. Se recomienda el uso como mínimo de la versión 9.0.28 si se desea modo de pantalla completo ó la 8 sin el modo de pantalla completa.
11. Este atributo permite proveer una URL a un archivo XML de recomendaciones. El archivo de recomendaciones contiene títulos, imágenes en miniatura y URLs a ítems relacionados como el video que se esta reproduciendo. El contenido se muestra una vez se termina la reproducción del video (similar a la forma como lo hace YouTube). Para mayor información acerca del archivo de recomendaciones vaya aquí.
12. La URL indicada acá provee un proveedor de búsquedas alternativo que será utilizado cuando el usuario utiliza la función de búsquedas en la barra de búsqueda. El texto que el usuario entre será añadido al final de esta URL. Por ejemplo, si la URL es: http://youtube.com/results?search_query= y el usuario está buscando: salsa la consulta resultado será: http://youtube.com/results?search_query=salsa.
13. Por defecto, el plugin provee dos advertencias cuando el contenido no puede ser reproducido. La primera advertencia se presenta cuando Javascript está deshabilitado. Otra advertencia se presenta cuando Javascript esta habilitado pero Flash no está disponible o la versión actual es menor a la especificada en el parámetro flashver. Utilizando este parámetro, la segunda advertencia puede ser reemplazada por un contenido personalizado. Si éste es el caso, la primera advertencia será deshabilitada por completo. El contenido personalizado no debe contener comillas sencillas (') ni el símbolo de llave (}). Si se desea colocar estos símbolos en el contenido estos deben ser escritos utilizando las entidades HTML correspondientes. Las advertencias son:
La advertencia de Javascript se ve como (generalmente el texto depende de la configuración de idioma del navegador):
To display this content, you need a JavaScript capable browser.
La advertencia de Flash se ve como (generalmente el texto depende de la configuración de idioma del navegador):
14. Este atributo permite especificar una imagen para ser pre visualizada (en forma de miniatura) cada vez que el reproductor es detenido. Usted puede especificar una ruta absoluta (por ejemplo, el valor comienza con http:// o https://) o una ruta relativa. Si la ruta es relativa, a este valor se le añadirá como prefijo el directorio que contiene las imágenes por defecto (images/stories).
15. The initial volume. Unit is percent, which implies a valid range of 0 .. 100.
16. This attribute can be used to manipulate the context menu of the player. For flash based players, setting this to false restricts the menu to the basic entries. For the DivX player, this disables the menu completely.
17. When this attribute is set to true, then the resulting player will be invisible and prepared to be displayed in a popup window or lightbox by using the avrpopup special tag.
Parámetros especiales para el reproductor de YouTube
El reproductor de YouTube soporta algunos atributos adicionales que usted puede configurar cuando utiliza la etiqueta {youtube}. La siguiente tabla describe estos atributos (Todos los atributos con valor boolean tienen como valor por defecto false):
| Sección Global | Nombre global del parámetro | Nombre del Atributo | Nombre en el API YouTube | Valores |
|---|---|---|---|---|
| Parámetros Avanzados | Inicio Automático | autostart | autoplay | true or false |
| Parámetros Avanzados | Color de Controles | pbgcolor | color1 | Valor de un color |
| Parámetros Avanzados | Color de resaltado de controles | phicolor | color2 | Valor de un color |
| - | - | ytborder | border | true o false |
| - | - | ytegm | egm | true o false |
| - | - | ytloop | loop | true o false |
| - | - | ytrel | rel | true o false |
Más información acerca de estos atributos se encuentra en la especificación del API de YouTube.