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

Las API ActionScript 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
getCurrentItemEmbedCode

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

Tipo: Cadena

Valor devuelto: devuelve la información del código embebido.

getEmbedCode Obtiene el embedCode del reproductor actual.

Tipo: Cadena

Valor devuelto: devuelve la información del código embebido.

Ejemplo: "Q3bDhiMToizUftO"

getItem Obtiene un objeto que describe el elemento embebido. 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).

Tipo: Objeto

Valor devuelto: Descripción del elemento

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

Tipo: Cadena

setEmbedCode Establece el embedCode del reproductor actual

Tipo: Cadena

Funciones del EmbedCode

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

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

Tipo: Booleano

Valor devuelto: 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

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

Valores devueltos: parejas de nombre/valor

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. El parámetro options es un parámetro de objeto opcional. Puede disponer de los siguientes campos:

  • orderBy:
  • uploadedAt,DESC
  • uploadedAt,ASC

Ejemplo: Para lograr los medios relacionados con el EmbedCode del vídeo más reciente primero:

 fetchRelatedMedia("theEmbedCode", { orderBy: "uploadedAt,DESC" })
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 devueltos: URL | null

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.