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

API de JavaScript en el reproductor

Las API JavaScript de la UI del reproductor/del reproductor pueden utilizarse para manejar aspectos del reproductor como son el modo pantalla completa, el estado del reproductor, el volumen, el encabezado del reproductor, el volumen del reproductor, etc.

Propiedades de la UI del reproductor y del reproductor

La siguiente tabla describe todas las propiedades JavaScript que están asociadas a un reproductor.

Función Descripción
getState

Obtiene el estado actual del reproductor.

Formato: De sólo lectura

Tipo: Cadena

Valores válidos: Uno de reproduciéndose, en pausa, almacenado en búfer, canal o error.

getActivePanel

Devuelve información, canales, embebido o sindicación si el panel respectivo está vacío o existe una cadena vacía y no se muestra.

Formato: de solo lectura

Tipo: Cadena

getDescription

Obtiene la descripción de la fuente del reproductor. Normalmente, esta es la descripción introducida para un archivo de sonido o vídeo en Backlot. Esta API le permite recuperar la descripción introducida que se estableció en la pestaña Manage > Details de Backlot o una configuración manual equivalente. Formato: de solo lectura

Tipo: Cadena

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

Ejemplo: "Season 22 Opening Game"

getFullscreen

Devuelve true si se encuentra en el modo pantalla completa, false en caso contrario.

Formato: De sólo lectura

Tipo: Booleano

Valores válidos: true | false

getPlayheadTime/setPlayheadTime

Localiza el encabezado de reproducción o lo mueve a una nueva ubicación en segundos con una precisión de milisegundos.

Tipo: Número

Valores válidos: duración en segundos

getVolume

Obtiene el volumen actual.

Tipo: Número

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

setModuleParams

Cuando el reproductor carga módulos, pasa datos al módulo o módulos usando la función callback. Utilice esta función con el parámetro de cadena de consulta hasModuleParams. El parámetro hasModuleParams=1 indica al reproductor que debería esperar a que los datos personalizables se envíen mediante la función setModuleParams.

Tipo: Objeto

Valores válidos: una pareja de clave-valor

Uso: La función setModuleParams se utiliza con hasModuleParams como método más eficaz de pasar parámetros al player.js en lugar de hacerlo mediante thruParams. Recomendamos el uso de setModuleParams con hasModuleParams en lugar del uso de thruParams. La función setModuleParams toma un objeto de parejas clave-valor.

Ejemplo: Si desea agregar parámetros a su script embebido, utilice hasModuleParams y un callback en la cadena embebida, tal como se muestra en el siguiente ejemplo:

<script src="http://player.ooyala.com/player.js? ... hasModuleParams=1&callback=playerAPICallback"></script>

En el siguiente ejemplo, se establece hasModuleParams en 1, mientras que el callback puede ser cualquier función. También debe añadir la función callback en JavaScript en cualquier lugar de su página. En el callback, espere el evento playerEmbedded y ejecute setModuleParams. El ejemplo siguiente proporciona la función callback de hasModuleParams:

// callback function
function playerAPICallback(playerId, eventName, parameters) {
  // the callback gets called when events are fired (here, wait for the playerEmbedded event)
  if (eventName == "playerEmbedded") {
    document.getElementById(playerId).setModuleParams({
      // include any module parameters as an object of key-value pairs, example below
      "doubleclick" : {
        "tagUrl" : "http://ad.doubleclick.net/pfadx/N270.132652.1516607168321/B3442378.3;dcadv=1379578;sz=0x0;ord=79879;dcmt=text/xml"
      }
    });
  }
}
setQueryStringParameters Establece los parámetros de cadena de consulta del reproductor actual. Consulte el tema "Parámetros cruzados y cadena de consulta" en este documento.
setVolume Establece el volumen actual. Tipo: Número Valores válidos: un número entre 0 y 1 inclusive

Manejo de eventos de la UI del reproductor/del reproductor

La siguiente tabla describe todos los eventos JavaScript que están asociados a un reproductor.

Evento Parámetros del tercer argumento para callback Descripción
activePanelChanged

activePanel

Tipo: Objeto

El panel de canal, compartir, embebido o información ha sido expuesto o escondido.
playheadTimeChanged( )

playheadTime

Tipo: Hash

El encabezado del reproductor se ha movido.
apiReady( ) Tipo: Objeto El reproductor está listo para recibir consultas de la API como playMovie(), getItem(), etc. Espere a que este evento sea ejecutado antes de enviar consultas a la API. Este evento se ejecuta siempre que el embedCode del reproductor cambia. El código embebido puede cambiarse mediante setEmbedCode() o setQueryStringParameters().

Nota: Versión 2 y superior.

fullscreenChanged( )

Cancelable

Tipo: Cadena

Parámetros: (formato, fuente, tipo)

Ejemplo: (video, doubleClick, adStarted)

El estado Full-screen se ha cambiado.
loadComplete( ) Tipo: Objeto El reproductor se ha inicializado. Esto se encuentra obsoleto; use el evento apiReady en su lugar.
metadataReady( )

metadatos

Tipo: Cadena

Valores válidos: Cada pareja de nombre/valor tiene dos propiedades: nombre y valor

Ejemplo: { name: "actor", value: "Johnny Depp"}

Los metadatos solicitados por la orden fetchMetadata() ya están preparados. La propiedad de metadatos es un conjunto de parejas de valores/nombres.

playComplete( ) Tipo: Nulo

El vídeo o canal se ha completado.

playerEmbedded Tipo: Objeto Un player.js embebido en una página web lanza este evento y desencadena un callback. Por ejemplo,
{
  // the callback gets called when events are fired (here, wait for the playerEmbedded event)
  if (eventName == "playerEmbedded") {
  ... 
Este evento se utiliza con el parámetro de cadena de consulta hasModuleParams, la función setModuleParams y el parámetro de cadena de consulta callback.
ratingsApiReady( )   La API de valoraciones se ha cargado y ya está preparada para su uso. El evento se ha enviado después de ejecutar loadRatingsApi().
relatedMediaReady( ) relatedMedia. La propiedad relatedMedia es un conjunto de elementos multimedia.

Cada elemento tiene un título, duración, publicidad y un embedCode.

Los medios relacionados solicitados por la orden fetchRelatedMedia() ya están preparados.

seeked( )

newPlayheadTime, oldPlayheadTime

Tipo: Hash

Se ha producido un evento de búsqueda en el reproductor. Este evento puede desencadenarse de dos maneras:
  • un usuario mueve la scrubber bar
  • Se realiza la consulta API setPlayheadTime

Nota: El evento se registra cuando el usuario libera la scrubber bar.

stateChanged( )

state, errorCode, errorText

Tipo: Objeto

Valores válidos: reproduciéndose | en pausa | almacenando en búfer | error

El estado ha cambiado entre reproduciéndose, en pausa, almacenando en búfer o error.
totalTimeChanged( )

totalTime

Tipo: Hash

La duración total del elemento ha cambiado.
volumeChanged( )

volume

Tipo: Hash

El volumen ha cambiado.

Información relacionada

La siguiente lista proporciona enlaces a documentación de Backlot que ofrece algunos datos generales sobre reproductores.