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 JavaScript del código embebido

Las API JavaScript del código embebido pueden utilizarse para gestionar la obtención y el establecimiento del embedCode de los vídeos, la obtención de descripciones de vídeos, imágenes y metadatos de los vídeos.

Propiedades del EmbedCode

La siguiente tabla describe todas las propiedades JavaScript asociadas al código embebido.

Función Descripción
SetEmbedCode

Establece el embedCode del reproductor actual.

Tipo: Cadena

getCurrentItemEmbedCode

Obtiene/establece el embedCode del vídeo actual de un canal.

Tipo: Cadena

getEmbedCode

Obtiene el embedCode del reproductor actual.

Tipo: Cadena

getItem

Obtiene un objeto que describe el elemento embebido.

Tipo: Objeto

Valor devuelto: Objeto. El objeto incluye el código embebido, el título, la descripción, la duración (duración de la reproducción en segundos), alineación, publicidad y hostedAtURL (alojamiento en URL).

setCurrentItemEmbedCode Establece el embedCode del vídeo actual de un canal. Tipo: Cadena

Funciones del EmbedCode

La siguiente tabla describe todos los métodos JavaScript asociados al código embebido.

Evento Descripción
fetchMetadata(embedCode)

Comienza obteniendo los metadatos personalizables del embedCode dado. Cuando se han obtenido los metadatos, se ejecutará el evento metadataReady, que contiene todas las parejas de valor/nombre del vídeo. Esta API se encuentra disponible para cuentas Empresa y Profesionales.

Tipo: Cadena

Valor válido: Especifique una cadena de código embebido.

Valores devueltos: parejas de nombre/valor

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.

Tipo: Cadena

Valores válidos: Especifica un embedCode, además de un ancho y un alto.

Valor devuelto: URL | null

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.

Tipo: Booleano

Valores válidos: true | false

currentItemEmbedCodeChanged( )

descripción, embedCode, hostedAtURL, alineación, publicidad, duración (en segundos), título.

Tipo: Hash

embedCodeChanged( )

descripción, embedCode, hostedAtURL, alineación, publicidad

Tipo: Hash

fetchRelatedMedia(embedCode, options) Comienza obteniendo los medios relacionados con el embedCode dado. Cuando se han obtenido los medios relacionados, se ejecuta el evento relatedMediaReady, que contiene los medios relacionados con el vídeo. Los medios relacionados se especifican en Backlot, en la pestaña Publish->Player Branding->End Screen.

Option es un parámetro Objeto opcional que puede disponer de los siguientes campos:

  • orderBy:
  • uploadedAt,DESC
  • uploadedAt,ASC

Ejemplo

El ejemplo siguiente hará que aparezcan los medios relacionados con el EmbedCode del vídeo más reciente primero.
fetchRelatedMedia("theEmbedCode", { orderBy: "uploadedAt,DESC" })

Información relacionada

La siguiente lista proporciona enlaces a la documentación de Backlot que ofrece algunos datos generales sobre los códigos embebidos y los scripts de código.