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

Lista de resumen de API JavaScript

Enumera y describe todas las API JavaScript del reproductor agrupadas por funciones/métodos, propiedades y eventos.

Las tablas siguientes proporcionan una lista resumen de todas las API JavaScript organizadas por los parámetros propiedades, funciones, eventos y pases de cadenas de consulta. Las propiedades individuales están vinculadas a temas que proporcionan más detalles. Juntos, los temas conforman una referencia de clase a las diversas funciones de la API JavaScript, sus métodos, propiedades, eventos y paso de cadena de consulta mediante parámetros disponibles a través de la interfaz JavaScript. Un código de ejemplo de listas de tema junto con el enlace a un ejemplo en vivo que muestra las capacidades de la API JavaScript. Para habilitar la API JavaScript, necesita proporcionar varios parámetros al script embebido de JavaScript:
  • callback—Nombre de la función JavaScript que recibe los callbacks de notificación de eventos. Esta función debe ser declarada con tres parámetros:
  • playerId (String)- ID del reproductor que invoca el callback
  • eventName (String)—Nombre de la notificación
  • parameters (Object) – Parámetros de notificación adicionales
Por ejemplo:
<script
 src="player.ooyala.com/player.js?callback=receiveOoyalaEvent&playerId=player&width=480&
height=360&embedCode=llMDQ6rMWxVWbvdxs2yduVEtSrNCJUk1"></script>

<script>
 

function receiveOoyalaEvent(playerId, eventName, eventParams) {
...
}
</script>           

Propiedades de JavaScript

Propiedades Descripción
getActivePanel Devuelve información, canales, embebido o sindicación si se muestra el panel respectivo, existe una cadena vacía o no se muestra ningún panel.
getCanRateCurrentItem Devuelve true cuando al usuario se le permite asignar una valoración al elemento actual.
getCurrentItem Obtiene un objeto que describe el vídeo actual.
getCurrentItemAverageRating

Obtiene la valoración media dada al elemento.

getCurrentItemClosedCaptionsLanguages Obtiene una lista de los idiomas admitidos de los subtítulos para el elemento que está reproduciéndose actualmente.
getCurrentItemDescription Obtiene la descripción del vídeo actual.
getCurrentItemEmbedCode/ setCurrentItemEmbedCode Obtiene/establece el embedCode del vídeo actual de un canal.
getCurrentItemRatings Obtiene la distribución de puntuación del elemento actual.
getCurrentItemTitle Obtiene el título del vídeo actual.
getDescription Obtiene la descripción de la fuente del reproductor.
getEmbedCode/setEmbedCode Obtiene/establece el embedCode del reproductor actual.
getErrorCode Obtiene el código de error actual, si es que existe.
getErrorText Obtiene el texto actual del error, si existe.
getFullscreen Devuelve true si se encuentra en el modo pantalla completa, false en caso contrario.
getItem Obtiene un objeto que describe el elemento embebido.
getLineup Obtiene un conjunto de objetos que describen el canal actual.
getPlayheadTime/setPlayheadTime Localiza el encabezado de reproducción o lo mueve a una nueva ubicación en segundos con una precisión de milisegundos.
getState Obtiene el estado actual del reproductor. Uno de reproduciéndose, en pausa, almacenado en búfer, canal o error.
getTitle Obtiene el título del vídeo o canal actual si no hay canal.
getTotalTime Obtiene la longitud del vídeo activo (en segundos con una precisión de milisegundos).
getVolume/setVolume

Obtiene/establece el volumen actual representado (un número entre 0 y 1 inclusive).

setModuleParams Cuando el reproductor carga módulos, establece los parámetros de la cadena de consulta del código embebido utilizando una función callback. Utilice esta función con el parámetro de cadena de consulta hasModuleParams.
setQueryStringParameters Establece los parámetros de cadena de consulta del reproductor actual.
setClosedCaptionsLanguage

Establece el idioma de los subtítulos que se mostrarán en el reproductor.

Funciones de JavaScript

Funciones Descripción
changeCurrentItem(embedCode) Establece el vídeo actual en un canal si el vídeo está presente. Devuelve true si se acepta, false en caso contrario.
fetchMetadata(embedCode) Comienza obteniendo los metadatos personalizables del embedCode dado. Esta API se encuentra disponible para cuentas Empresa y Profesionales.
fetchRelatedMedia(embedCode, options) Comienza obteniendo los medios relacionados con el embedCode dado.
getTimedText(startTime, endTime) Devuelve el texto cronometrado (subtítulos y su formato) que aparece entre los parámetros startTime y endTime (especificado en segundos).
getPromoFor(embedCode, width, height)

Devuelve una URL de una imagen de promoción del código embebido en un canal que será al menos de las dimensiones especificadas, o null si el código embebido no está presente en el canal.

incrementCurrentItemRating(rating) Incrementa la puntuación del elemento actual.
loadRatingsApi() Carga la API de valoraciones.
pauseMovie() Pausa el vídeo actual.
playMovie() Reproduce el vídeo actual.
skipAd() Salta el ad actual.

Eventos de JavaScript

Notificaciones de eventos entregadas con la función callback. Tenga en cuenta que los posibles problemas de compatibilidad entre navegadores impiden el uso de eventos DHTML estándar.
Evento Parámetros del tercer argumento a callback Descripción
activePanelChanged activePanel. El panel de canal, compartir, embebido o información ha sido expuesto o escondido.
adCompleted( ) formato, fuente, tipo. Acaba de terminar de reproducirse un ad.
adClicked( ) formato, fuente, tipo. Se ha hecho clic en un ad.
apiReady( )   El reproductor está preparado para recibir solicitudes de la API como playMovie(), getItem(), etc.
companionAdsReady( ) tipo, companionAds. Uno o más ads auxiliares están listos para ser mostrados. Solo se aplica a los ads compatibles con VAST.
currentItemEmbedCodeChanged( ) descripción, embedCode, hostedAtURL, alineación, publicidad, duración (en segundos), título. El elemento actual ha cambiado.
embedCodeChanged( ) descripción, embedCode, hostedAtURL, alineación, publicidad. El elemento del reproductor de nivel más alto ha cambiado.
fullscreenChanged( ) formato, fuente, tipo. El estado Full-screen se ha cambiado.
loadComplete( )   El reproductor se ha inicializado.
metadataReady( ) metadatos.

Acaba de comenzar a reproducirse un ad.

playComplete( )   El vídeo o canal se ha completado.
playheadTimeChanged( ) playheadTime. El encabezado del reproductor se ha movido.
playerEmbedded   Un reproductor se ha embebido en una página web. Puede usar este evento para desencadenar un callback.
ratingsApiReady( )  

La API de valoraciones se ha cargado y ya está preparada para su uso.

relatedMediaReady( ) relatedMedia. Los medios relacionados solicitados por la orden fetchRelatedMedia() ya están preparados.
seeked( ) newPlayheadTime, oldPlayheadTime. Se ha producido un evento de búsqueda en el reproductor.
stateChanged( ) relatedMedia. El estado ha cambiado.
totalTimeChanged( ) totalTime La duración total del elemento ha cambiado.
volumeChanged( ) volume. El volumen ha cambiado.

API de selección de tasa de transmisión de bits JavaScript

Para seleccionar una tasa de transmisión de bits, puede utilizar cualquiera de las siguientes opciones:
  • seleccione una tasa de transmisión de bits basada en su calidad (auto, baja, media o alta). Por ejemplo, si establece la tasa de transmisión de bits en alta, el reproductor decidirá cuál es la codificación más alta disponible.
  • seleccione una tasa de transmisión de bits basada en el número de kbps (suma de las codificaciones de vídeo y sonido). Por ejemplo, considere un vídeo con la tasa de transmisión siguiente disponible: [600 kbps, 1000 kbps, 3000 kbps, 4000 kbps]. Puede establecer que la calidad de la tasa de transmisión de bits sea cualquiera de esos valores.

Funciones de selección de la tasa de transmisión de bits JavaScript

La tabla siguiente describe todos los métodos JavaScript (una función invocada mediante un objeto) que están asociados a las tasas de transmisión de bits y a los búferes.

Función Descripción
getBitrateQualitiesAvailable()

Devuelve un conjunto de cadenas.

getTargetBitrateQuality() Obtiene la calidad de la tasa de transmisión de bits objetivo. Uno de entre auto, low, medium o high.
setTargetBitrate(bitrate) Establece la tasa de transmisión de bits objetivo, en kbps.
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.
getTargetBitrate() Obtiene la tasa de transmisión de bits objetivo, si la tasa de transmisión de bits se ha establecido previamente, o es -1 en caso contrario.
getBufferLength() Devuelve el tamaño actual del búfer en segundos, cuando la longitud del búfer es admitida, o 0 en caso contrario.
setTargetBitrateQuality(quality) Establece la calidad de la tasa de transmisión de bits objetivo.

Eventos de selección de la tasa de transmisión de bits JavaScript

La siguiente tabla describe todos los eventos JavaScript asociados a las tasas de transmisión de bits.
Función Descripción
changeCurrentItem(embedCode)

La calidad de la tasa de transmisión de bits del objetivo ha cambiado.

targetBitrateQualityChanged La calidad de la tasa de transmisión de bits del objetivo ha cambiado.

Ejemplos de JavaScript

Las listas siguientes enumeran los ejemplos de parámetro cruzado de cadena de consulta. Haga clic en el enlace para ver el ejemplo.