Referencia de campos de video de la API de CMS

Esta es una referencia a los campos de video devueltos por la API de CMS.

Campos de video

Campos de video
Campo Tipo Descripción
account_id Cadena La identificación de la cuenta de Video Cloud
ad_keys Cadena Cadena que representa los pares clave / valor del anuncio asignados al video. Los pares clave / valor tienen el formato clave = valor y están separados por símbolos de unión. Por ejemplo: "adKeys": "category=sports&live=true"
clip_source_video_id Cadena El ID del video de origen que se recortó para producir este video o null si este video no es un clip de otro video.
complete booleano Si el procesamiento está completo - Nota: cuando crea un nuevo video, la propiedad completa se establece automáticamente en false. Tan pronto como exista una interpretación para el video, la propiedad completa se establecerá automáticamente en true
created_at Número, milisegundos de la época Cuándo se creó el video en el sistema Video Cloud
creado por Objeto Información sobre quién creó el video, si está disponible
cue_points Matriz de mapas matriz de mapas de puntos de referencia
custom_fields Mapa de pares de campo-valor (cadenas) Valores de campo personalizados establecidos para el video: tenga en cuenta que los campos personalizados que lo hacen no tienen un valor para este video no están incluidos en este mapa; Los valores de campo personalizados tienen una longitud máxima de 1024 caracteres de un solo byte.
dash_manifest_id Cadena Identificación del sistema para un manifiesto DASH
delivery_type Cadena Tipo de entrega del video:
  • dynamic_origin- entrega dinámica
  • live_origin- transmisión en vivo desde Brightcove Live
  • remote- activo
  • static_origin- sistema de ingesta heredado
  • unknown- no se pudo determinar (puede significar que el video no tiene versiones reproducibles)
description Cuerda; ocupa el lugar de la vieja descripción corta Breve descripción del video (longitud máxima: 248 caracteres de un solo byte)
digital_master_id Cadena La identificación del sistema para el maestro digital
drm_disabled booleano Para las cuentas habilitadas para DRM, establecer esto en verdadero evitará que el video sea empaquetado con DRM. Este campo no aparecerá si la cuenta no está habilitada para DRM.
duration Número, milisegundos Duración del video en milisegundos
economics Cadena, debe ser uno de los valores de enumeración válidos "AD_SUPPORTED" (predeterminado) o "GRATIS"
folder_id Cadena ID de la carpeta a la que pertenece el video
forensic_watermarking Cadena ACTIVE indica que el video tiene marcas de agua forenses. UNAVAILBLE significa que no se agregó marca de agua forense. null indica que la cuenta no está habilitada para marcas de agua forenses.
geo [1-3] Mapa de pares propiedad-valor Propiedades de restricción geográfica para el video
has_digital_master booleano Si el video tiene un archivo maestro archivado que se puede usar para retranscodificar. Tenga en cuenta que si está utilizando este campo para probar si un video se puede volver a codificar, no es confiable para videos compartidos. Si los videos se comparten con la cuenta, debe probar ambos has_digital_master = true y sharing.by_external_acct = false
id Cadena La identificación del video
imagenes Mapa de pares propiedad-valor Mapa de información sobre el póster e imágenes en miniatura
enlace Mapa de pares propiedad-valor Mapa de propiedades de enlaces relacionados
long_description Cadena Descripción larga (hasta 5000 caracteres)
name Cadena El nombre del video (longitud máxima: 248 caracteres de un solo byte)
offline_enabled booleano Si el video está habilitado para reproducción sin conexión
original_filename Cadena Nombre del archivo de video que se ingirió: será nulo para videos de activos remotos
playback_rights_id Cadena El identificador único para las restricciones de reproducción definidas en el API de derechos de reproducción.
projection Cadena La proyección de mapeo para videos de 360 °, por ejemplo, "equirectangular"
published_at Cadena Cadena de fecha y hora ISO-8601 que indica cuándo se publicó el video; tenga en cuenta que este campo se puede escribir; de forma predeterminada, se establece en la fecha en que se activó por primera vez el video.
reference_id Cadena Identificador especificado por el usuario que identifica de forma exclusiva el vídeo, limitado a 150 caracteres. Se puede usar un referenceId como clave externa para identificar este video en otro sistema.
calendario [1-1] Mapa de pares propiedad-valor Mapa de fecha y hora de inicio y finalización para la disponibilidad del video
sharing Mapa de pares propiedad-valor Mapa de las propiedades para compartir del video
smooth_client_manifest_id Cadena Identificación del sistema para un manifiesto suave
smooth_server_manifest_id Cadena Identificación del sistema para el servidor de manifiesto Smooth
state [1-4] Cadena ACTIVO, INACTIVO, PENDIENTE, ELIMINADO
tags [1-5] Matriz de etiquetas (cadenas) Matriz de etiquetas asignadas al video
text_tracks Matriz de pistas de texto estilo HTML5 Matriz de pistas de texto (archivos WebVTT) asignadas al video
transcripciones Matriz de transcripciones de texto sin formato Matriz de transcripciones (archivos de texto sin formato) asignadas al video
updated_at Cadena de fecha y hora Fecha y hora en que se modificó por última vez el video [1-2]
Actualizado por Objeto Información sobre quién actualizó el video por última vez, si está disponible
variantes Gama de variant objetos de metadatos Variantes de metadatos para diferentes idiomas
ingestion_profile_id Cadena El ID del perfil de ingesta utilizado para transcodificar este video. Solo lectura.

Notas

  • [1-1] Tenga en cuenta que un video programado es no inactivo fuera del período de disponibilidad programado
  • [1-2] La modificación puede haber sido realizada por un usuario o por el sistema Video Cloud.
  • [1-3] La restricción geográfica es un complemento de pago de Video Cloud; si desea comprar la capacidad de filtrado geográfico, comuníquese con su gerente de éxito del cliente
  • [1-4] state se puede configurar para ACTIVE o INACTIVE , pero no a PENDING o DELETED.

    La media de los estados es la siguiente:

    • ACTIVE- el video es reproducible
    • INACTIVE- el video se ha desactivado o no tiene los campos de metadatos obligatorios y, por lo tanto, no se puede reproducir
    • PENDING- esto está relacionado con el intercambio de medios; el video ha sido compartido desde otra cuenta, pero aún no ha sido aceptado por esta cuenta
    • DELETED- El vídeo ha sido borrado
  • [1-5] Tenga en cuenta las siguientes limitaciones para las etiquetas:
    • Las etiquetas pueden tener hasta 128 caracteres. Si alguna etiqueta tiene más de 128 caracteres, se mostrará un error cuando intente guardar los cambios
    • Las etiquetas no pueden contener comas; por ejemplo, una etiqueta de roof, attic + front yard no es apoyado
    • Un video no puede tener más de 1200 etiquetas en total.
    • Una etiqueta que solo difiere en mayúsculas y minúsculas se maneja como una etiqueta idéntica y las mayúsculas y minúsculas coincidirán automáticamente con las de la etiqueta original; los problemas con la distinción entre mayúsculas y minúsculas deben tratarse de forma externa a Video Cloud, por ejemplo, utilizando métodos JavaScript para modificar las cuerdas

Campos de fuente de video

Las tablas siguientes muestran campos para las fuentes (representaciones).

Fuentes de entrega dinámica

Campo Tipo Descripción
src Cadena URL de la fuente
type Cadena Tipo de video segmentado, generalmente application/x-mpegURL (para HLS) o application/dash+xml (para DASH)
ext_x_version Cadena Versión HLS: solo para fuentes HLS
profiles Cadena Perfiles: solo para fuentes DASH
codec Cadena Códec de video: solo para fuentes MP4
container Cadena Contenedor de video: solo para fuentes MP4
duration Entero Duración en milisegundos: solo para fuentes MP4
encoding_rate Entero Tasa de codificación en BPS: solo para fuentes MP4
height Entero Altura del fotograma en píxeles: solo para fuentes MP4
size entero Tamaño del archivo en bytes: solo para fuentes MP4
uploaded_at Cadena Fecha en que se cargó el video en formato de fecha ISO-8601
width Entero Ancho de fotograma en píxeles: solo para fuentes MP4

Fuentes de ingesta heredadas (representaciones)

Campo Tipo
src URL de cadena, solo para activos web de PD y activos HLS
app_name Cuerda, solo para la transmisión de activos web
stream_name Cuerda, solo para la transmisión de activos web
codec Cadena
container Cadena
duration ¿Largo?
encoding_rate ¿Largo?
height Entero
id Cadena
size Largo
uploaded_at Cadena en formato de fecha ISO-8601
width Entero

Manifiesto de HLS de ingesta heredada

Campo Tipo
src URL de cadena
type Cadena (aplicación / x-mpegURL)
codec Cadena
container Cadena

Manifiesto HDS de ingesta heredada

Campo Tipo
asset_id Cadena
src URL de cadena
type Cadena (aplicación/f4m)

Manifiesto de Dash de ingesta heredada

Campo Tipo
asset_id Cadena
src URL de cadena
type Cadena (aplicación / guión + xml)

Manifiestos suaves de ingesta heredada (servidor y cliente)

Campo Tipo
asset_id Cadena
src URL de cadena
type Cadena (aplicación / vnd.ms-sstr + xml)

Campos de cuepoint

La siguiente tabla muestra campos para puntos de referencia.

Campos de punto de referencia
Campo Tipo Descripción
id Cadena Identificación del sistema para el punto de referencia
force_stop booleano Si el video debe detenerse en el punto de referencia
metadata Cuerda; solo punto de código Una cadena de metadatos asociada con el punto de referencia.
name Cadena El nombre del punto de referencia
time Flotador Tiempo del punto de referencia en segundos medido desde el inicio del video
type Cadena El tipo de punto de referencia ( AD o DATA)

Campos geográficos

La siguiente tabla muestra los campos de objetos geográficos.

Campos de filtrado geográfico
Campo Tipo Descripción
countries Matriz de cadenas de códigos de país Matriz de la lista ISO 3166 de códigos de 2 letras (https://www.iso.org/obp/ui/) para los países en los que se permite o no se permite la reproducción del video
exclude_countries booleano Si es verdadero, la matriz de países se trata como una lista de países excluidos de la visualización.
restricted booleano Si el filtrado geográfico está habilitado para este video

Campos de imagen

La siguiente tabla muestra los campos de objetos de imagen

Campos de póster

Campo Tipo Descripción
   images.thumbnail Mapa Asignar las propiedades de la imagen en miniatura
poster Objeto Propiedades del póster de video (también conocido como imagen fija de video)
   poster.asset_id Cadena Identificación del sistema para el póster predeterminado
   poster.src URL de cadena URL del póster predeterminado
   poster.sources Matriz de mapas Matriz de mapas para carteles
     poster.sources.asset_id Cadena Identificación del sistema para el póster
     poster.sources.src URL de cadena URL del cartel
     poster.sources.height Número Altura del póster en píxeles
     poster.sources.width Número Ancho del póster en píxeles

Campos de miniaturas

Campo Tipo Descripción
thumbnail Objeto Propiedades de la miniatura del video
   thumbnail.asset_id Cadena Identificación del sistema para la imagen en miniatura predeterminada
   thumbnail.src URL de cadena URL de origen de la miniatura predeterminada
   thumbnail.sources Matriz de mapas Matriz de mapas para imágenes en miniatura
     thumbnail.sources.asset_id Cadena ID del sistema para la miniatura
     thumbnail.sources.src URL de cadena URL de la miniatura
     thumbnail.sources.height Número Altura de la imagen en píxeles
     thumbnail.sources.width Número Ancho de imagen en píxeles

La siguiente tabla muestra los campos del objeto de vínculo.

Campos de enlace
Campo Tipo Descripción
url Cadena URL del enlace relacionado
text Cadena Texto del enlace relacionado

Campos de programación

La siguiente tabla muestra los campos para el objeto de programación.

Campos de programación
Campo Tipo Descripción
ends_at Cadena en formato de fecha ISO-8601 Fecha y hora en que el video deja de estar disponible para su visualización
starts_at Cadena en formato de fecha ISO-8601 Fecha y hora en que el video estará disponible para su visualización

Compartiendo campos

La siguiente tabla muestra los campos del objeto para compartir

Compartir campos
Campo Tipo Descripción
by_external_acct booleano Verdadero si este video se compartió desde otra cuenta.
by_id Cadena ID de cuenta que originó el recurso compartido
source_id Cadena ID de video del video original (copia del participante)
to_external_acct booleano Verdadero si este video se comparte con otra cuenta
by_reference booleano Es cierto que este video se comparte por referencia (siempre se true para videos compartidos a través de la API de CMS)

Campos de seguimiento de texto

La siguiente tabla muestra los campos de seguimiento de texto.

Campo Tipo Descripción
id Cadena ID del sistema para el elemento de seguimiento de texto
src Cadena Dirección del archivo de seguimiento (URL)
srclang Cadena Idioma de la pista, por ejemplo, "en"
label Cadena Un título legible por el usuario para el conjunto de pistas de texto.
kind Cadena Cómo se supone que debe usarse la pista: subtitles , captions , descriptions , chapters , metadata
mime_type Cadena tipo de mímica de las pistas de texto, por ejemplo, "texto / vtt"
asset_id Cadena Identificación del sistema para el archivo de seguimiento; nulo si el activo es remoto
in_band_metadata_track_dispatch_type Cadena Identificación del sistema para el archivo de seguimiento; nulo si el activo es remoto
status Cadena Estado de las pistas: published , draft , o null
sources Gama solo lectura
   src Cadena Dirección del archivo de seguimiento (URL)
default booleano Indica que la pista debe estar habilitada por defecto. Solo debería ser cierto en una pista.

Campos de transcripción

La siguiente tabla muestra los campos de transcripción.

Campo Tipo Descripción
id Cadena ID del sistema para el elemento de seguimiento de texto
account_id Cadena La identificación de la cuenta del sistema
src Cadena Dirección del archivo de seguimiento (URL)
srclang Cadena Idioma de la pista, por ejemplo, "en" o "ex-MX": este campo se puede actualizar
label Cadena Un título legible por el usuario para el conjunto de pistas de texto: este campo se puede actualizar
status Cadena El estado de la transcripción, ya sea published o draft - este campo se puede actualizar
sources Gama solo lectura: matriz de URL donde un cliente puede recuperar la transcripción; habrá un http y https URL para cada transcripción
default booleano Indica que la pista debe estar habilitada por defecto. Solo debería ser cierto en una pista.

Creado por campos

La siguiente tabla muestra el created_by campos de objeto.

Creado por Fields
Campo Tipo Descripción
type Cadena El tipo de actualizador, ya sea:
  • user- un usuario en Studio
  • api-key- un usuario a través de una API
id Cadena La identificación de usuario en el sistema Video Cloud
email Cadena La dirección de correo electrónico del usuario en el sistema Video Cloud

Actualizado por campos

La siguiente tabla muestra el updated_by campos de objeto.

Actualizado por campos
Campo Tipo Descripción
type Cadena El tipo de actualizador, ya sea:
  • user- un usuario en Studio
  • api-key- un usuario a través de una API
id Cadena La identificación de usuario en el sistema Video Cloud
email Cadena La dirección de correo electrónico del usuario en el sistema Video Cloud

Campos variantes

La siguiente tabla muestra el variant campos de objeto.

Actualizado por campos
Campo Tipo Descripción
language Cadena El idioma de esta variante en el formato de código de país de idioma (ejemplos: en-US, es-ES). Tenga en cuenta que language solo se incluye cuando crea una variante; NO debe incluirlo al actualizar la variante
name Cadena El título del video en este idioma
description Cadena El título del video en este idioma
long_description Cadena El título del video en este idioma
custom_fields Objeto mapa de fieldname: value pares, donde los valores son para este idioma; los valores tienen una longitud máxima de 1024 caracteres de un solo byte. Nota: asegúrese de utilizar el interno nombre del campo, no el nombre para mostrar / td>