Definir puntos de referencia con Media API

Product
Video Cloud
Aplicable a roles
Desarrollador
Versión
Brightcove 5
Módulos
Media API
Edición
Pro, Enterprise

Puede utilizar la API Media Write de Video Cloud para añadir puntos de referencia a un vídeo. Un punto de referencia es un marcador en un instante concreto a lo largo de un vídeo. Puede utilizar puntos de referencia para desencadenar anuncios intermedios o para separar capítulos o escenas en un vídeo de largo formato.

Las APIs Media Write únicamente están disponibles para los clientes que utilizan Video Cloud Pro y Enterprise. Si desea ampliar su cuenta de Video Cloud, póngase en contacto con Brightcove para obtener más información.

También puede añadir puntos de referencia mediante el módulo de publicidad de Video Cloud o transferencia FTP por lotes, mediante el elemento XML <cuepoint> en su manifiesto de transferencia por lotes. Para más información sobre los distintos métodos para añadir puntos de referencia, consulte Añadir puntos de referencia y vídeos.

Creación de puntos de referencia

Los puntos de referencia se crean mediante el método create_video de Media API. El método create_video tiene la firma siguiente:

create_video(token:String, video:Video, filename:String, 
   maxsize:Long, file:InputStream, file_checksum:String, 
   create_multiple_renditions:Boolean, cuePoints:List):Long

Para utilizar el método create_video, pase:

  • su token de escritura de Media API;
  • el Id. o Id. de referencia del vídeo al que desea asignar un punto de referencia;
  • una lista de CuePoints, incluidas las siguientes propiedades de cada punto de referencia:

propiedades de los puntos de referencia

nombre ¿obligatorio? descripción
name Obligatorio Un nombre que permita hacer referencia al punto de referencia. La longitud máxima del nombre de un punto de referencia es de 128 caracteres.
time Obligatorio El momento del punto de referencia, calculado en milisegundos desde el comienzo del vídeo.
forceStop Opcional Si está establecido en true, el vídeo detiene la reproducción en el punto de referencia. Este valor únicamente es válido para los puntos de referencia tipo AD.
type Obligatorio Un código entero que corresponde al tipo de punto de referencia. 0 (AD) o 1 (CODE). Un punto de referencia AD se utiliza para desencadenar solicitudes de anuncios intermedios. Un punto de referencia CODE permite indicar una pausa de capítulo o de escena en el vídeo.
metadata Opcional Una cadena que se puede pasar junto con un punto de referencia CODE. La longitud máxima de los metadatos de un punto de referencia es de 512 caracteres.

Por ejemplo, para un vídeo con el Id. 123, para definir un punto de referencia CODE después de 1 segundo de vídeo, un punto de referencia CODE después de 48 segundos de vídeo y un punto de referencia AD después de 120 segundos de vídeo, podría publicar algo similar en http://api.brightcove.com/services/:

{"method": "create_video",
  "params": {
    "token": "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video": {
      "name": "Debe especificarse el nombre.",
      "shortDescription": "Así como la shortDescription",
      "cuePoints": [
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_2", "time": 48000, "type": 1, "metadata": "algunos datos"}, 
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}

Actualización de puntos de referencia

Puede actualizar o eliminar un punto de referencia existente mediante el método update_video de Media API. Cuando se utiliza el parámetro opcional cuePoints con el método update_video, se reescriben todos los puntos de referencia existentes del vídeo afectado. Los puntos de referencia que no incluya explícitamente en el parámetro cuePoints se eliminarán.

Por ejemplo, asumiendo que usted ya había definido puntos de referencia para el vídeo con el Id. 123, como en el ejemplo anterior, podría enviar algo similar a esto en http://api.brightcove.com/services/ para definir un punto de referencia CODE adicional después de 360 segundos de vídeo y eliminar el punto de referencia CODE después de 48 segundos de vídeo:

{"method": "update_video",
  "params": {
    "token" : "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video" : {
      "id": 123,
      "cuePoints":[
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_3", "time": 360000, "type": 1},
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}

 

Etiquetas
puntos de referencia, puntos de referencia