Referencia de objetos de Media API

Product
Video Cloud
Aplicable a roles
Desarrollador
Versión
Brightcove 5
Módulos
Media API
Edición
Todas
Creado por Chris Howell.

Este tema ofrece una referencia de los objetos Video, Playlist, Image, Rendition, CuePoint y LogoOverlay devueltos por los métodos de lectura de Media API:

Tenga en cuenta que estos objetos de Media API son parecidos a los objetos que se utilizan en Player API solo para Flash, aunque no idénticos. La Referencia de Media API también contiene información sobre estos objetos relacionados:

Objeto Video

El objeto Video es una agregación de información de activos y metadatos asociados a un vídeo. Video tiene las propiedades siguientes:

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
name Cadena no El título de este objeto Video con una limitación de 255 caracteres. Cuando se crea un vídeo, name es una propiedad obligatoria.
id long yes Un número asignado por Video Cloud al crear este objeto Video, que lo identifica de forma única.
referenceId Cadena no Id. especificado por el usuario y con limitación de 150 caracteres que identifica el objeto Video de forma única. Un referenceId se puede utilizar como clave externa para identificar este vídeo en otro sistema. Tenga en cuenta que el método find_videos_by_reference_ids no puede tratar elementos referenceId que contengan comas, por lo que conviene evitar el uso de comas en los valores de referenceId.
accountId long yes Un número asignado por Video Cloud que identifica de forma única la cuenta a la que pertenece el objeto Video.
shortDescription Cadena no Una descripción abreviada del objeto Video con limitación de 250 caracteres. Cuando se crea un vídeo, shortDescription es una propiedad obligatoria.
longDescription Cadena no Una descripción detallada de este objeto Video con limitación de 5.000 caracteres.
FLVURL Cadena yes La dirección URL del archivo de vídeo del objeto Video. Tenga en cuenta que únicamente se puede acceder a esta propiedad mediante Media API con un token de lectura o escritura especial. Esta propiedad se aplica independientemente de la codificación del vídeo, ya sea FLV (VP6) o MP4 (H.264). Consulte Acceso al contenido de vídeo con Media API.
renditions Matriz no Una matriz de objetos Rendition que representan las variantes de representación de una secuencia con múltiples tasas de bits disponibles para este objeto Video. Un objeto Video no debería tener más de 10 objetos Rendition. Tenga en cuenta que únicamente se puede acceder a esta propiedad mediante Media API con un token de lectura o escritura especial. Consulte Acceso al contenido de vídeo con Media API.
videoFullLength Rendition no Un único objeto Rendition que representa el archivo de vídeo correspondiente al objeto Video. Tenga en cuenta que únicamente se puede acceder a esta propiedad mediante Media API con un token de lectura o escritura especial. Consulte Acceso al contenido de vídeo con Media API.
creationDate Fecha yes Fecha de creación de este objeto Video, representada como el número de milisegundos desde el tiempo UNIX.
publishedDate Fecha yes Fecha de última activación de este objeto Video, representada como el número de milisegundos desde el tiempo UNIX.
lastModifiedDate Fecha yes Fecha de última modificación de este objeto Video, representada como el número de milisegundos desde el tiempo UNIX.
itemState Enumeración no Un ItemStateEnum. Una de las propiedades: ACTIVE, INACTIVE o DELETED. Esta propiedad solo puede establecerse en ACTIVE o INACTIVE; no se puede eliminar un vídeo definiendo su itemState en DELETED.
startDate Fecha no Primera fecha de disponibilidad de este objeto Video para su reproducción, representada como el número de milisegundos desde el tiempo UNIX.
endDate Fecha no Última fecha de disponibilidad de este objeto Video para su reproducción, representada como el número de milisegundos desde el tiempo UNIX.
linkURL Cadena no Una dirección URL opcional de un elemento relacionado con limitación de 255 caracteres.
linkText Cadena no El texto que se muestra para linkURL con limitación de 255 caracteres.
tags List no Una lista de cadenas que representan las etiquetas asignadas a este objeto Video. Cada etiqueta puede contener un máximo de 128 caracteres, y cada vídeo un máximo de 1.200 etiquetas.
videoStillURL Cadena yes La dirección URL de la imagen de captura de vídeo asociada a este objeto Video. Las capturas de vídeo son de 480 x 360 píxeles.
thumbnailURL Cadena yes La dirección URL de la imagen en miniatura asociada a este objeto Video. Las imágenes en miniatura son de 120 x 92 píxeles.
length long yes La longitud de este vídeo en milisegundos.
customFields Objeto no Una correlación de nombres y valores de los campos personalizados configurados para los vídeos de su cuenta. Más información y ejemplos.
economics Enumeración no Un EconomicsEnum. FREE o AD_SUPPORTED. AD_SUPPORTED significa que este objeto de vídeo tiene habilitadas las solicitudes de anuncios.
adKeys Cadena no Una cadena que representa los pares clave/valor del anuncio asignados al vídeo. Los pares clave/valor tienen el formato key=value y están separados por ampersands (&). Por ejemplo:
"adKeys":"category=sports&live=true"
geoRestricted Booleano no True indica que el vídeo tiene restricciones geográficas.
geoFilteredCountries List no Una lista de los códigos de dos letras de ISO-3166 de los países a los que se imponen las reglas de restricciones geográficas. Utilice minúsculas para los códigos de países.
geoFilterExclude Booleano no Si el valor es verdadero ("true"), el vídeo puede visualizarse en todos los países, salvo en aquellos que se indican en geoFilteredCountries; si está definido como falso, únicamente puede visualizarse en los países enumerados en geoFilteredCountries.
cuePoints List no Una lista de los objetos CuePoint asignados a este objeto Video.
playsTotal Entero yes Número de reproducciones del objeto Video desde su creación.
playsTrailingWeek Entero yes Número de reproducciones del objeto Video durante los últimos siete días sin incluir el día de hoy.

Objeto Playlist

El objeto Playlist es una colección de objetos Video. Playlist tiene las propiedades siguientes:

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
id long yes Un número que identifica al objeto Playlist de forma única. Este Id. se asigna automáticamente al crear el objeto Playlist.
referenceId Cadena no Id. especificado por el usuario y con limitación de 150 caracteres que identifica este objeto Playlist de forma única. Tenga en cuenta que el método find_playlists_by_reference_ids no puede tratar elementos referenceId que contengan comas, por lo que conviene evitar su uso en los valores de referenceId.
accountId long yes Un número asignado por Video Cloud que identifica de forma única la cuenta a la que pertenece este objeto Playlist.
name Cadena no El título de este objeto Playlist con una limitación de 100 caracteres. Cuando se crea una lista de reproducción, name es una propiedad obligatoria.
shortDescription Cadena no Una descripción abreviada del objeto Playlist con limitación de 250 caracteres.
videoIds List no Lista de los Id. de los objetos Video encapsulados en el objeto Playlist.
videos List no Una lista de los objetos Video encapsulados en el objeto Playlist.
playlistType Enumeración no

Para una lista de reproducción manual, ajuste el valor a EXPLICIT. Para una lista de reproducción inteligente, indique cómo ordenar la lista de reproducción asignando uno de los valores: OLDEST_TO_NEWEST (por fecha de activación)
NEWEST_TO_OLDEST (por fecha de activación)
START_DATE_OLDEST_TO_NEWEST
START_DATE_NEWEST_TO_OLDEST ALPHABETICAL (por nombre del vídeo)
PLAYS_TOTAL
PLAYS_TRAILING_WEEK

Cuando se crea una lista de reproducción playlistType es una propiedad obligatoria.
filterTags List no Una lista de las etiquetas aplicables a esta lista de reproducción inteligente. Por ejemplo:

"filterTags":["Sitka","ticks"]
tagInclusionRule Enumeración no Para una lista de reproducción inteligente, define si el vídeo debe contener todos o contener al menos uno de los valores contenidos en filterTags. Utilice AND para "contiene todos" u OR para "contiene al menos uno". No disponible en los métodos de lectura de la API.
thumbnailURL Cadena yes La dirección URL de la imagen en miniatura asociada a este objeto Playlist.

Objeto Image

Este objeto representa los metadatos de un archivo de imagen de su cuenta. Las imágenes se pueden asociar con los vídeos como imágenes en miniatura, capturas de vídeo o sobreimpresiones de logotipos. Una imagen puede tener formato JPEG, GIF o PNG. Tenga en cuenta que al crear un nuevo activo de imagen, la única propiedad obligatoria es type. Si no está cargando ningún archivo, también es obligatoria la propiedad remoteUrl. Para más información, consulte Agregar imágenes a vídeos con Media API y Inclusión de sobreimpresiones de logotipos en vídeos con la Media API.

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
id Largo yes Un número que identifica al objeto Image de forma única. Video Cloud asigna este Id. automáticamente al crear Image.
referenceId Cadena no Id. especificado por el usuario que identifica este objeto Image de forma única.
type ImageTypeEnum no THUMBNAIL, VIDEO_STILL o LOGO_OVERLAY. El objeto type es obligatorio, y se puede escribir en él al crear Image; posteriormente no se puede cambiar.
remoteUrl Cadena no La dirección URL de un archivo de imagen remoto. Esta propiedad es obligatoria si no carga ningún archivo para el activo de imagen.
displayName Cadena no El nombre del activo que se mostrará en el módulo multimedia.

Objeto Rendition

El objeto ‘rendition’ representa una de las variantes de representación utilizadas para transmitir en secuencia un vídeo con múltiples tasas de bits desde un contenedor MP4 o FLV (para variantes de representación desde un contenedor M2TS, consulte el objeto iOSrendition). Un objeto Video no debería tener más de 10 objetos Rendition e iOSrendition. Para obtener más información, consulte Utilización de secuencias con múltiples tasas de bits y Creación de vídeos para secuencias con múltiples tasas de bits.

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
audioOnly Booleano no Si está ajustado a verdadero ("true"), esta variante de representación es sólo de audio y no tiene ningún contenido de vídeo. Las variantes de representación sólo de audio se pueden utilizar para difundir secuencias en dispositivos móviles a través de conexiones de bajo ancho de banda. Se recomienda que los vídeos en aplicaciones iOS deben incluir una variante de representación sólo de audio de 64 kbps.
controllerType Enumeración no Dependiendo de su CDN, uno de los siguientes valores:
  • AKAMAI_STREAMING
  • AKAMAI_SECURE_STREAMING
  • AKAMAI_LIVE
  • AKAMAI_HD
  • AKAMAI_HD_LIVE
  • LIMELIGHT_LIVE
  • LIMELIGHT_MEDIAVAULT
Consulte Ajuste de controllerType para obtener más información.
encodingRate Entero yes La tasa de codificación de la variante de representación en bits por segundo.
frameHeight Entero yes La altura en píxeles de la unidad de visualización de la variante de representación.
frameWidth Entero yes La anchura en píxeles de la unidad de visualización de la variante de representación.
id long no El identificador (ID) del vídeo.
referenceid Cadena no El identificador (ID) de referencia del vídeo.
remoteUrl Cadena no Obligatorio para los activos remotos. La ruta completa del archivo hospedado en el servidor remoto. Si el archivo se entrega mediante descarga progresiva, debe incluir el nombre de archivo y su extensión. También puede utilizar una dirección URL que redirija a otra que incluya el nombre de archivo y la extensión. Si el archivo se entrega utilizando secuencias de Flash, utilice el atributo remoteStreamName para proporcionar el nombre de la secuencia.
remoteStreamName Cadena no [Opcional, únicamente es obligatorio para los activos remotos de secuencias] Un nombre de secuencias para las secuencias de Flash incluido en el valor de la propiedad remoteUrl.
size long yes Obligatorio. El tamaño en bytes del archivo de la variante de representación.
uploadTimestampMillis long no La fecha y hora en las que el vídeo fue cargado en Video Cloud, en formato milisegundos Epoch.
url Cadena yes La dirección URL del archivo de la variante de representación.
videoCodec Enumeración no Obligatorio. Los valores válidos son SORENSON, ON2 y H264.
videoContainer Enumeración no El formato del wrapper que proporciona metadatos y describe cómo se almacenan el vídeo y el audio en el archivo. Los valores válidos son FLV y MP4 (para variantes de representación en M2TS, consulte el objeto iOSrendition). Para obtener más información, consulte Codecs y contenedores de vídeo compatibles.
videoDuration long no Obligatorio. La duración del activo de vídeo remoto en milisegundos.

Ajuste de controllerType

El valor del campos controllerType en el objeto Rendition puede depender de cómo usted entrega contenidos y qué CDN está utilizando. Valores admisibles para controllerType:

Valor de controllerType descripción
AKAMAI_STREAMING Akamai CDN, no en directo, sin TTL
AKAMAI_SECURE_STREAMING Akamai CDN, no en directo, con TTL
AKAMAI_LIVE Akamai CDN, en directo, sin DVR
AKAMAI_HD Akamai HD
AKAMAI_HD_LIVE en directo con DVR (tanto si la CDN principal de su cuenta es Akamai como si no)
LIMELIGHT_LIVE Limelight CDN, en directo
LIMELIGHT_MEDIAVAULT Limelight CDN, con el servicio opcional Media Vault de Limelight

Objeto iOSRendition

El objeto ‘iosrendition’ representa una de las variantes de representación utilizadas para transmitir en secuencia un vídeo desde un contenedor de tipo M2TS, en otras palabras, una secuencia HLS reproducible en dispositivos iOS. Un objeto Video no debería tener más de 10 objetos Rendition e iOSrendition. Para obtener más información, consulte Utilización de secuencias con múltiples tasas de bits y Creación de vídeos para secuencias con múltiples tasas de bits.

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
audioOnly Booleano no Si está ajustado a verdadero ("true"), esta variante de representación es sólo de audio y no tiene ningún contenido de vídeo. Las variantes de representación sólo de audio se pueden utilizar para difundir secuencias en dispositivos móviles a través de conexiones de bajo ancho de banda. Se recomienda que los vídeos en aplicaciones iOS deben incluir una variante de representación sólo de audio de 64 kbps.
controllerType Enumeración no DEFAULT
encodingRate Entero yes La tasa de codificación de la variante de representación en bits por segundo.
frameHeight Entero yes La altura en píxeles de la unidad de visualización de la variante de representación.
frameWidth Entero yes La anchura en píxeles de la unidad de visualización de la variante de representación.
id long no El identificador (ID) del vídeo.
referenceid Cadena no El identificador (ID) de referencia del vídeo.
remoteUrl Cadena no Obligatorio para los activos remotos. La ruta completa del archivo hospedado en el servidor remoto. Si el archivo se entrega mediante descarga progresiva, debe incluir el nombre de archivo y su extensión. También puede utilizar una dirección URL que redirija a otra que incluya el nombre de archivo y la extensión. Si el archivo se entrega utilizando secuencias de Flash, utilice el atributo remoteStreamName para proporcionar el nombre de la secuencia.
remoteStreamName Cadena no [Opcional, únicamente es obligatorio para los activos remotos de secuencias] Un nombre de secuencias para las secuencias de Flash incluido en el valor de la propiedad remoteUrl.
size long yes Obligatorio. El tamaño en bytes del archivo de la variante de representación.
uploadTimestampMillis long no La fecha y hora en las que el vídeo fue cargado en Video Cloud, en formato milisegundos Epoch.
url Cadena no La dirección URL de la secuencia m3u8.
videoCodec Enumeración no Obligatorio. El valor válido es H264.
videoContainer Enumeración no El formato del wrapper que proporciona metadatos y describe cómo se almacenan el vídeo y el audio en el archivo. El valor válido es M2TS. Para obtener más información, consulte Codecs y contenedores de vídeo compatibles.
videoDuration long no Obligatorio. La duración del activo de vídeo remoto en milisegundos.

CuePoint

El objeto CuePoint es un marcador que se establece en un punto en el tiempo concreto durante 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. Para obtener más información, consulte Agregar puntos de referencia y vídeos y Definir puntos de referencia con Media API.

Nombre de la propiedad Tipo ¿Sólo lectura? Descripción
name Cadena yes Obligatorio. Un nombre que permita hacer referencia al punto de referencia.
videoId Cadena yes Una lista separada por comas de los Id. de uno o varios vídeos a los que se aplica este punto de referencia.
time Largo yes Obligatorio. El momento del punto de referencia, calculado en milisegundos desde el comienzo del vídeo.
forceStop Booleano no 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 Enumeración yes Obligatorio. Un código entero que corresponde al tipo de punto de referencia. 0 (AD) o 1 (CODE). Un punto de referencia de anuncio 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 Cadena no Una cadena que se puede pasar junto con un punto de referencia CODE. No más de 512 caracteres.

 

LogoOverlay

El objeto LogoOverlay representa una sobreimpresión de logotipos asignada a un vídeo. La sobreimpresión del logotipo aparece sobre una parte de la pantalla durante toda la reproducción del vídeo. Para más información, consulte Creación de sobreimpresiones de logotipos e Inclusión de sobreimpresiones de logotipos en vídeos con la Media API. También puede definir una sobreimpresión de logotipo predeterminada para la cuenta. Si tiene una sobreimpresión de logotipo definida a nivel de cuenta y define también una sobreimpresión de logotipo para un vídeo, se mostrará la sobreimpresión de logotipo definida para el vídeo, y no la definida a nivel de cuenta.

Nombre de la propiedad Tipo Descripción
id Largo Un número que identifica este objeto inequívocamente al objeto LogoOverlay. Video Cloud asigna este Id. automáticamente al crear LogoOverlay.
image Image Un objeto Imagen, definido por su ID o referenceId, con type=LOGO_OVERLAY.
tooltip Cadena Opcional. Un texto que aparece cuando el espectador desplaza el ratón sobre la sobreimpresión del logotipo.
linkURL Cadena Opcional. Una dirección URL a la que el espectador accede al hacer clic en la sobreimpresión del logotipo.
alignment Enumeración Opcional. Un elemento LogoOverlayAlignmentEnum que representa la orientación de la sobreimpresión del logotipo con respecto a la pantalla de vídeo. Uno de los valores siguientes: TOP_LEFT, BOTTOM_LEFT, TOP_RIGHT, or BOTTOM_RIGHT. El ajuste predeterminado es BOTTOM_RIGHT.
Etiquetas
referencia