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

Reproductores

Cuando crea un reproductor y le asigna uno o más vídeos en su cuenta, define las opciones de reproducción y la apariencia de su contenido.

Crear un reproductor

[POST] /v2/players 
{
     properties
} 
   

Enumerar reproductores

[GET] /v2/players
   

Visualizar la información del reproductor

[GET] /v2/players/player_id
   

Eliminar un reproductor

[DELETE] /v2/players/player_id
   

Atributos de ruta

En la tabla siguiente se describen todos los atributos que se pueden expresar por medio de la ruta.

Atributo de ruta Descripción
player_id

El ID del reproductor. Para obtener una lista de reproductores, realice una consulta GET contra la ruta /players.

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: /players/b4f1a93b779145b4a9c8ef15f8502345

Propiedades

En la siguiente tabla se describen todas las propiedades que se pueden asociar a un reproductor.

Propiedad Descripción ¿Obligatorio?
accent_color

Especifica el tono cromático del formato de color de la web.

Tipo: Cadena

Por defecto: ffbb00

Ejemplo: "66FF33"

Origen: ooyala_branding

No
alpha

Especifica la transparencia de la marca de agua.

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: 1,0

Valores válidos: de 0.0 a 1.0

Origen: marca de agua

No
always_show

Muestra la scrubber bar durante la reproducción del vídeo.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "false"

Origen: scrubber

No
buffer_on_pause

Hace que el vídeo se cargue en la memoria buffer mientras esté pausado. Esto es útil para usuarios con conexiones de red lentas.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "false"

Origen: playback

No
click_behavior

Especifica cómo se abre el vídeo relacionado si se hace clic en la vista previa.

Tipo: Cadena

Valores válidos: same_player | same_page | new_page

Por defecto: same_player

Condiciones: Obligatorio si se especifica related_videos.

Ejemplo: "same_player"

Origen: related_videos

Condicional
click_url

La URL a la que se dirige un usuario cuando se hace clic en la marca de agua.

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: "www.mywebsite.com"

Origen: marca de agua

No
default_closed_caption_language

Especifica el idioma por defecto de los subtítulos.

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: "true"

No
digg_sharing

Permite la interacción en Digg. Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
email_sharing

Les permite a los usuarios compartir el vídeo mediante correo electrónico. Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
enable_error_screen

Muestra la pantalla de error de Ooyala si hay un error de reproducción.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
facebook_sharing

Permite la interacción en Facebook . Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
image_url

Solo lectura. La URL a la vista previa provisional que se muestra mientras realiza un scrub por un vídeo. Para cargar una nueva imagen, ver [Scrubber](/v2/docs/players_scrubber).

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: "http://ak.c.ooyala.com/ZnMmM6AO3C-iBubra3R2Xd6pXHgK/shelf123467931"

Origen: scrubber

No
image_url

Solo lectura. La marca de agua mostrada durante un vídeo. Aceptamos marcas de agua .PNG, .JPG, .GIF y .SWF, y recomendamos utilizar archivos .PNF con fondos transparentes. Para cargar una nueva imagen, ver [Watermark](/v2/docs/players_watermark).

Tipo: Cadena

Por defecto: Ninguno

Ejemplo: "http://ak.c.ooyala.com/ZnMmM6AO3C-iBubra3R2Xd6pXHgK/watermark123467943"

Origen: marca de agua

No
is_default

Establece este reproductor como plantilla de reproductor que se utilizará por defecto al crear nuevos reproductores.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

No
labels

Especifica una etiqueta para utilizar con vídeos compartidos.

Tipo: Cadena

Por defecto: Ninguno

Condiciones: Obligatorio si se especifica source.

Ejemplo: "videos_of_kittens"

Origen: related_videos

Condicional
name

Nombre del reproductor.

Tipo: Cadena

Ejemplo: "Mi Reproductor con Marca de agua"

ooyala_branding

Especifica las opciones de marca. Tipo: Contenedor

No
order

Especifica si los vídeos relacionados aparecen en orden ascendente o descendente.

Tipo: Cadena

Valores válidos: "asc" | "desc"

Por defecto: "desc"

Ejemplo: "desc"

Origen: related_videos

No
playback

Especifica las opciones de reproducción. Tipo: Contenedor

No
provider_homepage_url

La URL a la página de inicio de su sitio web.

Tipo: Cadena

Por defecto: Ninguno

Condiciones: Obligatorio si show_info_screen_homepage_link se establece en "true".

Ejemplo: "http://myhomepage.com"

Condicional
related_videos

Especifica la configuración de vídeos relacionados. Tipo: Contenedor

No
scrubber

Especifica las opciones de scrubber. Tipo: Contenedor

No
show_ad_countdown

Muestra un cronómetro decreciente durante el anuncio, que le permite al usuario saber cuándo empezará el vídeo.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
show_bitrate_button

Muestra un botón que permite a los usuarios elegir entre las tasas de transmisión de bits disponibles.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
show_channel_button

Muestra el botón Canal, en el que los usuarios pueden hacer clic para visualizar otro contenido del canal.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
show_embed_button

Muestra un botón embebido que contiene un fragmento de código para el vídeo, que los usuarios pueden embeber en sus sitios web.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
show_end_screen_replay_button

Cuando el vídeo termina, permite al usuario hacer clic en un botón para volver a reproducir el vídeo.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
show_info_button

Activa el botón Info que el usuario puede utilizar para visualizar información sobre el vídeo.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
show_info_screen_description

Muestra la descripción del vídeo cuando el usuario hace clic en el botón Info. Si está activado, show_info_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
show_info_screen_homepage_link

Muestra un enlace al proveedor del vídeo. Si está activado, deben especificarse show_info_screen_homepage_link y show_info_screen_homepage_name.

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

Condicional
show_info_screen_title

Muestra el título del vídeo cuando el usuario hace clic en el botón Info. Si está activado, show_info_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
show_share_button

Activa el botón compartir, que les permite a los usuarios compartir el contenido en redes sociales. Si activa este botón sin activar las demás opciones sociales (por ej., twitter_sharing), el botón aparecerá sin ninguna opción.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Condiciones: Obligatorio si se especifica una o más opciones de interacción.

Ejemplo: "true"

Origen: ooyala_branding

Condicional
show_volume_button

Muestra el botón de volumen.

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
sort

Especifica cómo se ordenan los vídeos relacionados.

Tipo: Cadena

Valores válidos: "upload_time"

Por defecto: "upload_time"

Ejemplo: "upload_time"

Origen: related_videos

No
source

Especifica qué tipos de vídeos se muestran como vídeos relacionados.

Tipo: Cadena

Valores válidos: shared_labels | specified_label

Por defecto: Ninguno

Condiciones: Obligatorio si se especifica related_videos.

Ejemplo: "same_player"

Origen: related_videos

Condicional
stumbleupon_sharing

Permite la interacción en StumbleUpon. Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
twitter_sharing

Permite la interacción en Twitter. Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: false

Ejemplo: "true"

Origen: ooyala_branding

No
url_sharing

Muestra un botón Copiar URL. Si está activado, show_share_button se debe establecer en "true".

Tipo: Booleano

Valores válidos: true | false

Por defecto: true

Ejemplo: "true"

Origen: ooyala_branding

No
watermark

Especifica las opciones de marca de agua. Tipo: Contenedor

No

Ejemplos

Este ejemplo crea un reproductor básico que utiliza toda la configuración por defecto:

 [POST] /v2/players
{
  "name": "Basic Player"
}
    

Backlot devuelve una respuesta similar a la siguiente:

{
  "ooyala_branding": {
    "show_share_button": true,
    "twitter_sharing": false,
    "show_info_screen_homepage_link": true,
    "show_ad_countdown": true,
    "show_info_screen_title": true,
    "facebook_sharing": false,
    "show_info_button": true,
    "url_sharing": false,
    "email_sharing": true,
    "digg_sharing": false,
    "show_embed_button": true,
    "show_info_screen_description": false,
    "show_bitrate_button": false,
    "show_channel_button": true,
    "enable_error_screen": true,
    "show_end_screen_replay_button": true,
    "accent_color": "#ffbb00",
    "show_volume_button": true
  },
  "name": "Basic Player",
  "provider_homepage_url": null,
  "related_videos": {
    "click_behavior": "new_page",
    "order": "desc",
    "sort": "upload_time",
    "labels": [

    ],
    "source": "shared_labels"
  },
  "is_default": false,
  "scrubber": {
    "image_url": null,
    "always_show": false
  },
  "playback": {
    "buffer_on_pause": false
  },
  "id": "83fc33534581448eab446935baa6b1f0",
  "default_closed_caption_language": "",
  "watermark": {
    "image_url": null,
    "click_url": null,
    "alpha": 1.0
  }
}
    

Ordenando Pruébelo

Note: Puede obtener esta información en cualquier momento generando una consulta GET contra el ID del reproductor (por ej., [GET] /v2/players/83fc33534581448eab446935baa6b1f0).

Este ejemplo activa la interacción con Twitter y Facebook y cambia el tono cromático a rosa:

[PATCH] /v2/players/83fc33534581448eab446935baa6b1f0
{
  "ooyala_branding": {
    "twitter_sharing": true,
    "facebook_sharing": true,
    "accent_color": "#FF1493"
  }
}
    

Backlot devuelve una respuesta similar a la siguiente:

{
  "ooyala_branding": {
    "show_share_button": true,
    "twitter_sharing": true,
    "show_info_screen_homepage_link": true,
    "show_ad_countdown": true,
    "show_info_screen_title": true,
    "facebook_sharing": true,
    "show_info_button": true,
    "url_sharing": false,
    "email_sharing": true,
    "digg_sharing": false,
    "show_embed_button": true,
    "show_info_screen_description": false,
    "show_bitrate_button": false,
    "show_channel_button": true,
    "enable_error_screen": true,
    "show_end_screen_replay_button": true,
    "accent_color": "#FF1493",
    "show_volume_button": true
  },
  "name": "Basic Player",
  "provider_homepage_url": null,
  "related_videos": {
    "click_behavior": "new_page",
    "order": "desc",
    "sort": "upload_time",
    "labels": [

    ],
    "source": "shared_labels"
  },
  "is_default": false,
  "scrubber": {
    "image_url": null,
    "always_show": false
  },
  "playback": {
    "buffer_on_pause": false
  },
  "id": "83fc33534581448eab446935baa6b1f0",
  "default_closed_caption_language": "",
  "watermark": {
    "image_url": null,
    "click_url": null,
    "alpha": 1.0
  }
}
    

Ordenando Pruébelo

Este ejemplo enumera todos los reproductores:

[GET] /v2/players
    

Backlot devuelve una lista de reproductores y sus ajustes de configuración.

Ordenando Pruébelo

Este ejemplo elimina un reproductor:

[DELETE] /v2/players/83fc33534581448eab446935baa6b1f0
    

Backlot devuelve una respuesta 200.

Ordenando Pruébelo