Error message

User warning: The following module is missing from the file system: fast_404. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1143 of /mnt/www/html/ooyala/docroot/includes/bootstrap.inc).

Funciones de API del reproductor

La funciones JavaScript del reproductor se pueden utilizar para personalizar el comportamiento y el aspecto del reproductor.

Funciones del reproductor

La siguiente tabla describe las principales funciones JavaScript del reproductor.

Función Descripción
destroy() Destruir elemento. Cuando se llama, el reproductor se elimina, se detiene toda la actividad y se descarga cualquier vídeo.
pause() Pausa la reproducción del vídeo actual.
play() Reproduce el vídeo actual.
seek() Buscar el parámetro especificado en segundos.

Tipo: Número

Valor válido: tiempo en segundos

Funciones GET

La siguiente tabla describe todas las funciones GET JavaScript del reproductor.

Función Descripción
getBitrateQualitiesAvailable() Devuelve un conjunto de cadenas. El tamaño del conjunto es dependiente del número de codificaciones disponible:
  • Cuando solo esté disponible una codificación, la función devuelve [‘auto’]

  • Cuando estén disponibles dos codificaciones, la función devuelve [‘auto’,’low’,’high’]

  • Cuando estén disponibles tres o más codificaciones, la función devuelve [‘auto’,’low’, ‘medium’, ’high’]

  • Cuando la información de la calidad de la tasa de transmisión de bits está disponible, la función devuelve [‘auto’]

Tipo: Conjunto

getBitratesAvailable()

Devuelve un conjunto con el número total de la tasa de transmisión de bits, en kbps o un conjunto vacío cuando el número de codificaciones no está disponible.

Nota: Con un reproductor Flash, puede obtener la tasa de transmisión de bits objetivo, si obtiene el valor inicial. Sin embargo, esto no es cierto para Quicktime. No hay ningún control sobre la capacidad de Quicktime para recoger la tasa de transmisión de bits y la opción por defecto en este caso es utilizar el tiempo sugerido sobre la base del mejor esfuerzo.

Ejemplo: [250, 500, 1000] indica que hay tres tasas de transmisión disponibles: 250 kbps, 500 kbps y 1000 kbps. Para un reproductor Ooyala basado en Flash, un editor puede utilizar esta API para obtener una lista de las tasas de transmisión de bits disponibles que se utilizan para la API setTargetBitrate().

getBufferLength() Devuelve el tamaño actual del búfer en segundos, cuando la longitud del búfer es admitida, o 0 en caso contrario.
Nota: Actualmente, los vídeos de Youtube y los vídeos remotos no admiten la longitud de búfer.

Tipo: Número


Valores devueltos: tiempo en segundos | 0   
getCurrentItemClosedCaptionsLanguages()

Obtiene una lista de los idiomas admitidos de los subtítulos para el elemento que está reproduciéndose actualmente. Esta lista se extrae del archivo XML (DFXP) de los subtítulos para este contenido, cargado mediante Backlot. Para más información sobre este archivo, consulte Carga de un archivo de subtítulos. Si no existe ningún archivo DFXP, este método devuelve una lista vacía. En el modo de streaming en vivo, los idiomas de los subtítulos se extraen del propio stream.

Tipo: Lista

Valores devueltos: Una lista en forma de "código de idioma":"displayName".

Ejemplo: { "en": "English" (inglés),... }.

Nota: Este método devolverá una excepción si el archivo de subtítulos ha sido cargado para el código embebido actual.

getDescription() Obtiene la descripción del vídeo actual desde Backlot. Esta API recupera la descripción introducida que se estableció en la pestaña Manage > Details de Backlot o una configuración manual equivalente.

Tipo: Cadena    

Valores devueltos: descripción alfanumérica del vídeo:

Ejemplo: Season 22 Opening Game

getDuration() Obtiene la duración total del vídeo en segundos.

Tipo: Número

Valor devuelto: duración en segundos

getEmbedCode() Obtiene el embedCode del reproductor actual.

Tipo: Cadena   

Valor devuelto: NodXQ5NTq0Y8Nw4GvIWBHlf-irMiKy7P

getError() Devuelve el código de error actual, si el código existe y el estado actual es error.

Tipo: Cadena  

Valor devuelto: Devuelve un mensaje de error que localiza el error.

getErrorText() Devuelve una cadena con un mensaje de error.

Tipo: Cadena

Valor devuelto: Mensaje de error que localiza el error.

Ejemplo: "Este vídeo no está autorizado para este dominio. Póngase en contacto con el administrador."

getItem() Obtiene un objeto que describe el vídeo actual.

Tipo: Objeto

Valor devuelto: Objeto, con los siguientes atributos:
  • embedCode
  • title
  • description
  • time (duración de la reproducción en segundos)
  • lineup
  • promo
  • hostedAtURL
getLiveTime() Devuelve la hora de una señal en vivo, esencialmente, lo mismo que getPlayheadTime(), pero incluye el desplazamiento del reloj si se ha proporcionado.

Tipo: Número

getPlayheadTime() Devuelve la posición del encabezado del reproductor en segundos con una precisión de milisegundos.

Tipo: Número

Valor devuelto: duración en segundos

getState() Obtiene el estado actual del reproductor.

Tipo: Cadena

Valores devueltos: Uno de entre: LOADING : ‘loading’READY : ‘ready’PLAYING : ‘playing’PAUSED : ‘paused’BUFFERING : ‘buffering’ERROR : ‘error’DESTROYED : ‘destroyed’

getTargetBitrate() Obtiene la tasa de transmisión de bits objetivo, en kbps, si la tasa de transmisión de bits se ha establecido previamente, o es -1 en caso contrario.
getTargetBitrateQuality() Devuelve la calidad de la tasa de transmisión de bits objetivo: Uno entre auto, low, medium o high.

Solo funciona con el reproductor Flash.

Tipo: Cadena

getTitle() Obtiene el título del vídeo.

Tipo: Cadena

Valor devuelto: Título del vídeo

Ejemplo: Mi Canal de Snowboarding

getVolume()

Devuelve el volumen actual, en la medida de lo posible, en función de las limitaciones del dispositivo.

Tipo: Número

Valor devuelto: Un número entre 0 y 1 inclusive.

isFullscreen() Devuelve true si se encuentra en el modo pantalla completa, false en caso contrario. La implementación de pantalla completa se realiza, en la medida de lo posible, sobre la base de las limitaciones de los dispositivos.

Tipo: Booleano

Valores válidos: true | false

Funciones set

La siguiente tabla describe todas las funciones set JavaScript del reproductor V3.

Función Descripción
setClosedCaptionsLanguage(language)

Establece el idioma de los subtítulos que se mostrarán en el reproductor. Si no carga el archivo de subtítulos, el contenido se reproduce sin subtítulos. En el modo de streaming en vivo, los idiomas de los subtítulos se extraen del propio stream. Tenga en cuenta que, debido a la forma en que se admiten los subtítulos en iOS, no podemos agregar datos de subtítulos para IOS Web en vídeos remotos.

Parámetro: idioma

Valores válidos: Especifique el código de idioma ISO 639-1 | ninguno. En el caso del chino, utilice "zh-hans" para Chino Simplificado y "zn-hant" para Chino Tradicional. Para no mostrar subtítulos, establezca el idioma en "none" (ninguno).

Ejemplos: en, de, ja.

setEmbedCode(embedcode, options)

Establece el embedCode del reproductor actual. La función setEmbedCode también tiene una opción que le permite asignar dinámicamente un conjunto de ads a un código embebido.

Tipo: Cadena   

Parámetros: Toma un código embebido y un parámetro de opciones. El parámetro de opciones debe ser un objeto, que es una pareja de clave-valor que representa el código único del ad.

Ejemplo: el código del conjunto de ads debe pertenecer al mismo proveedor que el código embebido.

player.setEmbedCode(embedCode, {    adSetCode: 'foo'});
Nota: Esta función requiere que asocie un conjunto de ads a una película en Backlot. Para obtener más información, consulte el tema, “Asignar conjuntos de ads dinámicamente” en la Guía del desarrollador del reproductor V3.
setPlayheadTime(value)

Mueve el cabezal de reproducción a la ubicación especificada por el parámetro expresado en segundos.

Tipo: Número

Valores válidos: duración en segundos

setTargetBitrate(bitrate) Establece la tasa de transmisión de bits objetivo, en kbps. La información de entrada debe ser una tasa de transmisión de bits disponible. Las tasas de transmisión de bits disponibles pueden estar determinadas por una ejecución de getBitratesAvailable().    

La tasa de transmisión de bits no se mantiene de un vídeo a otroEsta configuración no se mantiene de un vídeo a otro. Por ejemplo, considere un canal con dos vídeos, el primero con la tasa de transmisión de bits más alta de 1000 kbps y el segundo con una tasa de transmisión de bits media de 1000 kbps y una tasa de transmisión más alta de 2000 kbps. Si establece la tasa de transmisión de bits a 1000 kbps, convertiremos este número a una calidad de la tasa de transmisión de bits, que en este caso es mayor. Como la calidad de la tasa de transmisión de bits se mantiene, el primer vídeo se reproducirá a 1000 kbps y el segundo vídeo se reproducirá a 2000 kbps, que es la tasa de transmisión de bits más alta.

Restricción de HDS al configurar la tasa de transmisión de bits

Si utiliza HDS, debe saber que HDS no se expone a nuestras API, lo cual es necesario para afectar a la tasa de transmisión de bits. Por lo tanto, aunque establezca una tasa de transmisión de bits objetivo, no cambiará.
setVolume(value) Establece el volumen actual, en la medida de lo posible, en función de las limitaciones del dispositivo.

Valores válidos: un número entre 0 y 1 inclusive