soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Referencia de campos de vídeo de API de CMS

    Esta es una referencia a campos de vídeo devueltos por la API de CMS.

    Campos de vídeo

    Campos del vídeo
    Campo Tipo Descripción
    account_id Cadena El ID de cuenta de Video Cloud
    ad_keys Cadena Cadena que representa los pares clave/valor de anuncio asignados al vídeo. Los pares clave/valor se formatean como clave=valor y están separados por símbolos. Por ejemplo: "adKeys": "category=sports&live=true"
    clip_source_video_id Cadena El ID del vídeo de origen que se recortó para producir este vídeo o si este no es un clip de otro vídeo.null
    complete Booleano Si se ha completado el procesamiento: Nota: al crear un nuevo vídeo, la propiedad complete se establece automáticamente en.false Tan pronto como exista una copia para el vídeo, la propiedad completa se establecerá automáticamente en true
    created_at Número, milisegundos de la época Cuando se creó el vídeo en el sistema de Video Cloud
    created_by Objeto Información sobre quién creó el vídeo, si está disponible
    puntos_cua_ Matriz de mapas matriz de mapas de puntos de referencia
    custom_fields Mapa de pares de valores de campo (Cadenas) Valores de campo personalizados establecidos para el vídeo: tenga en cuenta que el campo personalizado que no tiene un valor para este vídeo no se incluye en este mapa; los valores de campo personalizados tienen una longitud máxima de 1024 caracteres de un solo byte
    dash_manifest_id Cadena ID del sistema para un manifiesto DASH
    delivery_type Cadena Tipo de entrega para el vídeo:
    • dynamic_origin - Entrega dinámica
    • live_origin - transmisión en directo desde Brightcove Live
    • remote - activo
    • static_origin - sistema de ingesta heredado
    • unknown - no se pudo determinar (puede significar que el vídeo no tiene representaciones reproducibles)
    description String; ocupa el lugar de la antigua ShortDescription Breve descripción del vídeo (longitud máxima: 248 caracteres de un byte)
    digital_master_id Cadena El identificador del sistema para el maestro digital
    drm_disabled Booleano Para las cuentas habilitadas para DRM, si se establece esto en true, se evitará que el vídeo se empaque DRM. Este campo no aparecerá si la cuenta no está habilitada para DRM.
    duration Número, milisegundos Duración del vídeo en milisegundos
    economics Cadena, debe ser uno de los valores enum válidos ya sea «AD_SUPPORTED» (predeterminado) o «FREE»
    folder_id Cadena ID de la carpeta a la que pertenece el vídeo
    geo [1-3] Mapa de pares de propiedades y valor Propiedades de restricción geográfica para el vídeo
    has_digital_master Booleano Si el vídeo tiene un maestro archivado que se puede utilizar para retranscodificación. Tenga en cuenta que si está utilizando este campo para comprobar si un vídeo se puede retranscodificar, no es fiable para los vídeos compartidos. Si los vídeos se comparten con la cuenta, debe probar has_digital_master = true tanto para sharing.by_external_acct = false
    id Cadena El ID de vídeo
    imágenes Mapa de pares de propiedades y valor Mapa de información sobre el póster y las imágenes en miniatura
    vínculo Mapa de pares de propiedades y valor Mapa de propiedades relacionadas con enlaces
    long_description Cadena Descripción larga (hasta 5000 caracteres)
    name Cadena El nombre del vídeo (longitud máxima: 248 caracteres de un byte)
    offline_enabled Booleano Si el vídeo está habilitado para la reproducción sin conexión
    original_filename Cadena Nombre del archivo de vídeo que se ingirió: será nulo para los vídeos de activos remotos
    projection Cadena La proyección cartográfica para vídeos de 360°, por ejemplo, «equirectangular»
    published_at Cadena Cadena de fecha y hora ISO-8601 que indica cuándo se publicó el vídeo: tenga en cuenta que este campo se puede escribir; de forma predeterminada, se establece en la fecha en la que el vídeo se activó por primera vez.
    reference_id Cadena Identificador especificado por el usuario que identifica de forma única el vídeo, limitado a 150 caracteres. Un ReferenceID se puede utilizar como clave externa para identificar este vídeo en otro sistema. El identificador de referencia no debe contener espacios, comas o caracteres especiales.
    calendario [1-1] Mapa de pares de propiedades y valor Mapa de las fechas de inicio y finalización de la disponibilidad del vídeo
    sharing Mapa de pares de propiedades y valor Mapa de las propiedades de uso compartido del vídeo
    smooth_client_manifest_id Cadena Identificador del sistema para un manifiesto suave
    smooth_server_manifest_id Cadena Identificador del sistema para el servidor de manifiesto suave
    state [ 1-4] Cadena ACTIVO, INACTIVO, PENDIENTE, ELIMINADO
    tags [ 1-5] Matriz de etiquetas (Cadenas) Matriz de etiquetas asignadas al vídeo
    text_tracks Matriz de pistas de texto de estilo HTML5 Matriz de pistas de texto (archivos WebVTT) asignadas al vídeo
    updated_at Cadena de fecha y hora Fecha y hora en que se modificó el vídeo por última vez [1-2]
    actualizado_por Objeto Información sobre quién actualizó el vídeo por última vez, si está disponible

    Notas

    • [ 1-1] Tenga en cuenta que un vídeo programado no está inactivo fuera del período de disponibilidad programada
    • [ 1-2] La modificación puede haber sido realizada por un usuario o el sistema de Video Cloud
    • [ 1-3] La restricción geográfica es un complemento de pago para Video Cloud; si desea adquirir la capacidad de geo-filtrado, póngase en contacto con su administrador de cuentas
    • [ 1-4] se state puede establecer en ACTIVE o INACTIVE , pero no en PENDING o DELETED.
    • [ 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, no se admite una etiqueta deroof, attic + front yard
      • Un vídeo no puede tener más de 1.200 etiquetas en total.
      • Una etiqueta que difiere solo en mayúsculas (minúsculas, mayúsculas) se maneja como una etiqueta idéntica y el caso coincidirá automáticamente con los de la etiqueta original; los problemas con la sensibilidad de mayúsculas y minúsculas deben tratarse externamente a Video Cloud, por ejemplo, utilizando métodos JavaScript para modificar las cadenas

    Campos de origen de vídeo

    Las tablas siguientes muestran campos para los orígenes (copias).

    Orígenes de entrega dinámica

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

    Orígenes de ingesta heredados (copias)

    Campo Tipo
    src URL de cadena, sólo para activos web PD y activos HLS
    app_name Cadena, sólo para transmisión de activos web
    stream_name Cadena, sólo para 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

    Manifesto HLS de ingesta heredada

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

    Manifiesto HDS de ingesta heredado

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

    Manifiesto Dash de ingesta heredada

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

    Ingesta heredada Manifiestos suaves (servidor y cliente)

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

    Campos de punto de referencia

    La siguiente tabla muestra los campos de puntos de referencia.

    Campos de punto de referencia
    Campo Tipo Descripción
    id Cadena Identificador del sistema para el punto de referencia
    force_stop Booleano Si el vídeo debe detenerse en el punto de referencia
    metadata Cadena; sólo punto de código Una cadena de metadatos asociada al 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 vídeo
    type Cadena El tipo de punto de referencia (o)ADDATA

    Campos geográfico

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

    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 el vídeo está permitido o no permitido reproducir
    exclude_countries Booleano Si es true, 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 vídeo

    Campos de imagen

    La siguiente tabla muestra 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 para el póster de vídeo (también conocido como video todavía)
       poster.asset_id Cadena Identificador 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 Identificador del sistema para el póster
         poster.sources.src URL de cadena URL del póster
         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 miniatura

    Campo Tipo Descripción
    thumbnail Objeto Propiedades de la miniatura del vídeo
       thumbnail.asset_id Cadena ID del sistema para la imagen en miniatura predeterminada
       thumbnail.src URL de cadena Dirección URL de origen para la miniatura predeterminada
       thumbnail.sources Matriz de mapas Matriz de mapas para imágenes en miniatura
         thumbnail.sources.asset_id Cadena Identificador 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 Anchura de imagen en píxeles

    En la siguiente tabla se muestran los campos del objeto de vínculo.

    Campos de enlace
    Campo Tipo Descripción
    url Cadena URL de vínculo relacionado
    text Cadena Texto de enlace relacionado

    Campos de planificación

    La siguiente tabla muestra los campos del objeto de planificación

    Campos de planificación
    Campo Tipo Descripción
    ends_at Cadena en formato de fecha ISO-8601 Fecha-hora cuando el vídeo deja de estar disponible para su visualización
    starts_at Cadena en formato de fecha ISO-8601 Fecha-hora cuando el vídeo está disponible para su visualización

    Compartir campos

    La siguiente tabla muestra los campos de objetos compartidos

    Compartir campos
    Campo Tipo Descripción
    by_external_acct Booleano True si este vídeo se compartió desde otra cuenta.
    by_id Cadena ID de cuenta que originó el recurso compartido
    source_id Cadena ID de vídeo del vídeo original (copia del compartidor)
    to_external_acct Booleano True si este vídeo se comparte con otra cuenta
    by_reference Booleano Es cierto que este vídeo se comparte por referencia (siempre será para vídeos compartidos a través de la API de CMS)true

    Campos de pista de texto

    La siguiente tabla muestra los campos de seguimiento de texto.

    Campo Tipo Descripción
    id Cadena Identificador 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 utiliza la pista: «subtítulos», «subtítulos», «descripciones», «capítulos», «metadatos»
    mime_type Cadena tipo mime de las pistas de texto, por ejemplo, «text/vtt»
    asset_id Cadena ID del sistema para el archivo de seguimiento; nulo si el activo es remoto
    in_band_metadata_track_dispatch_type Cadena ID del sistema para el archivo de seguimiento; nulo si el activo es remoto
    sources Array sólo lectura
       src Cadena Dirección del archivo de seguimiento (URL)
    default Booleano Indica que la pista debe estar habilitada de forma predeterminada. Sólo debería ser cierto en una pista.

    Creado por campos

    En la siguiente tabla se muestran los campos de objeto.created_by

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

    Actualizado por campos

    En la siguiente tabla se muestran los campos de objeto.updated_by

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

    Última actualización de la página el 29-09-2020