soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    CMS API Referencia de campos de video

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

    Campos de video

    Campos de video
    Campo Tipo Descripción
    account_id Cuerda La Video Cloud ID de la cuenta
    ad_keys Cuerda Cadena que representa los pares clave / valor publicitario asignados al video. Los pares de clave / valor se formatean como clave = valor y están separados por signos y. Por ejemplo: "adKeys": "category=sports&live=true"
    clip_source_video_id Cuerda La ID del video fuente que fue recortado para producir este video o null si este video no es un clip de otro video.
    complete Boolean Si el procesamiento está completo: Nota: cuando crea un video nuevo, la propiedad completa se configura automáticamente en false. Tan pronto como exista una versión para el video, la propiedad completa se configurará automáticamente en true
    created_at Número, milisegundos de época Cuando el video fue creado en el Video Cloud sistema
    created_by 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 valores de campo (cadenas) Valores de campo personalizados establecidos para el video: tenga en cuenta ese campo personalizado que hace no tener un valor para este video no está incluido en este mapa; los valores de campo personalizados tienen una longitud máxima de caracteres 1024 de un solo byte
    dash_manifest_id Cuerda Identificación del sistema para un manifiesto DASH
    delivery_type Cuerda Tipo de entrega para el video:
    • dynamic_origin - entrega dinámica
    • live_origin - transmisión en vivo desde Brightcove Live
    • remote - activo
    • static_origin - sistema de ingesta legado
    • unknown - no se pudo determinar (puede significar que el video no tiene reproducciones reproducibles)
    description Cuerda; toma el lugar del antiguo shortDescription Breve descripción del video (longitud máxima: caracteres 248 de un solo byte)
    digital_master_id Cuerda La identificación del sistema para el maestro digital
    drm_disabled Boolean 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 String, debe ser uno de los valores enum válidos ya sea "AD_SUPPORTED" (predeterminado) o "FREE"
    folder_id Cuerda ID de la carpeta a la que pertenece el video
    geo [1 3-] Mapa de pares propiedad-valor Propiedades de restricción geográfica para el video
    has_digital_master Boolean Si el video tiene un maestro archivado que se puede usar para la retranscodificación. Tenga en cuenta que si está utilizando este campo para probar si un video se puede retranscodificar, no es confiable para videos compartidos. Si los videos se comparten en la cuenta, debe probar ambos has_digital_master = true y sharing.by_external_acct = false
    id Cuerda El video id
    images Mapa de pares propiedad-valor Mapa de información sobre el póster y las imágenes en miniatura
    link Mapa de pares propiedad-valor Mapa de propiedades de enlaces relacionados
    long_description Cuerda Descripción larga (hasta caracteres 5000)
    name Cuerda El nombre del video (longitud máxima: caracteres 248 de un solo byte)
    offline_enabled Boolean Si el video está habilitado para reproducción sin conexión
    original_filename Cuerda Nombre del archivo de video que se ha ingerido: será nulo para los videos de activos remotos
    projection Cuerda La proyección de mapeo para videos 360 °, por ejemplo, "equirectangular"
    published_at Cuerda Cadena de fecha y hora de ISO-8601 que indica cuándo se publicó el video: tenga en cuenta que este campo puede escribirse; de forma predeterminada, se establece en la fecha en que se activó por primera vez el video.
    reference_id Cuerda Una identificación especificada por el usuario que identifica de manera única el video, limitado a caracteres 150. Un referenceId se puede utilizar como clave externa para identificar este video en otro sistema. La identificación de referencia no debe contener espacios, comas o caracteres especiales.
    schedule [1 1-] Mapa de pares propiedad-valor Mapa de fechas de inicio y final para la disponibilidad del video
    sharing Mapa de pares propiedad-valor Mapa de las propiedades para compartir del video
    smooth_client_manifest_id Cuerda Identificación del sistema para un manifiesto Smooth
    smooth_server_manifest_id Cuerda Identificación del sistema para el servidor de Smooth manifest
    state [1 4-] Cuerda ACTIVO, INACTIVO, PENDIENTE, BORRADO
    tags [1 5-] Matriz de etiquetas (cadenas) Matriz de etiquetas asignadas al video
    text_tracks Matriz de pistas de texto HTML5 Matriz de pistas de texto (archivos WebVTT) asignadas al video
    updated_at Cadena de fecha y hora Fecha en que se modificó por última vez el video [1 2-]
    updated_by Objeto Información sobre quién actualizó por última vez el video, si está disponible

    Notas

    • [1 1-] Tenga en cuenta que un video programado es no inactivo fuera del período de disponibilidad programada
    • [1 2-] La modificación puede haber sido realizada por un usuario o Video Cloud sistema
    • [1 3-] La restricción geográfica es un complemento pagado a Video Cloud; Si desea adquirir la capacidad de filtrado geográfico, póngase en contacto con su administrador de cuentas.
    • [1 4-] state se puede configurar para ACTIVE or INACTIVE, pero no a PENDING or DELETED.
    • [1 5-] Tenga en cuenta las siguientes limitaciones para las etiquetas:
      • Las etiquetas pueden ser hasta caracteres 128. Si alguna etiqueta tiene más de caracteres 128, 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 un total de etiquetas 1200
      • Una etiqueta que difiere solo en mayúsculas (minúsculas, mayúsculas) se maneja como una etiqueta idéntica y la caja coincidirá automáticamente con la etiqueta original. Los problemas con la sensibilidad de las mayúsculas y minúsculas deben manejarse externamente para Video Cloud, por ejemplo, usando métodos de JavaScript para modificar las cadenas

    Campos de fuente de video

    Las tablas a continuación muestran campos para las fuentes (rendiciones).

    Fuentes dinámicas de entrega

    Campo Tipo Descripción
    src Cuerda URL para la fuente
    type Cuerda Tipo de video segmentado, generalmente application/x-mpegURL (para HLS) o application/dash+xml (para DASH)
    ext_x_version Cuerda Versión HLS: solo para fuentes HLS
    profiles Cuerda Perfiles: solo para fuentes DASH
    codec Cuerda Códec de video: solo para fuentes MP4
    container Cuerda 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 de archivo en bytes: solo para fuentes MP4
    uploaded_at Cuerda Fecha en que el video fue cargado en formato de fecha ISO-8601
    width Entero Ancho de fotograma en píxeles: solo para fuentes MP4

    Legado de las fuentes de ingreso (Rendiciones)

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

    Legado ingesta de manifiesto de HLS

    Campo Tipo
    src String URL
    type String (application / x-mpegURL)
    codec Cuerda
    container Cuerda

    Legacy ingesta HDS manifiesto

    Campo Tipo
    asset_id Cuerda
    src String URL
    type String (aplicación / f4m)

    Legado ingerir Dash manifiesto

    Campo Tipo
    asset_id Cuerda
    src String URL
    type String (aplicación / dash + xml)

    Legacy ingese manifiestos Smooth (servidor y cliente)

    Campo Tipo
    asset_id Cuerda
    src String URL
    type String (application / vnd.ms-sstr + xml)

    Campos de cuepoint

    La tabla a continuación muestra los campos para cuepoints.

    Campos de puntos de referencia
    Campo Tipo Descripción
    id Cuerda Identificación del sistema para el punto de referencia
    force_stop Boolean 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 Cuerda El nombre del punto de referencia
    time Flotador Hora del punto de referencia en segundos medido desde el inicio del video
    type Cuerda El tipo de punto de referencia ( AD or DATA)

    Campos geo

    La tabla a continuación muestra los campos del objeto geo.

    Campos de geo-filtrado
    Campo Tipo Descripción
    countries Matriz de código de país Cadenas Arreglo de la lista ISO 3166 de códigos de letras 2 (https://www.iso.org/obp/ui/) para países en los que se permite o no se puede reproducir el video
    exclude_countries Boolean Si es cierto, la matriz de países se trata como una lista de países excluidos de la visualización
    restricted Boolean Si el geo-filtrado está habilitado para este video

    Campos de imagen

    La tabla a continuación muestra los campos del objeto de imagen

    Campos de carteles

    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 video)
    poster.asset_id Cuerda Identificación del sistema para el póster predeterminado
    poster.src String URL URL para el cartel predeterminado
    poster.sources Matriz de mapas Matriz de mapas para carteles
    poster.sources.asset_id Cuerda Identificación del sistema para el póster
    poster.sources.src String URL URL para el cartel
    poster.sources.height Número Altura del cartel en píxeles
    poster.sources.width Número Ancho del cartel en píxeles

    Campos de miniaturas

    Campo Tipo Descripción
    thumbnail Objeto Propiedades para la miniatura del video
    thumbnail.asset_id Cuerda Identificación del sistema para la imagen en miniatura predeterminada
    thumbnail.src String URL URL de origen para la miniatura predeterminada
    thumbnail.sources Matriz de mapas Matriz de mapas para imágenes en miniatura
    thumbnail.sources.asset_id Cuerda Identificación del sistema para la miniatura
    thumbnail.sources.src String URL URL para 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 tabla a continuación muestra los campos del objeto de enlace.

    Campos de enlace
    Campo Tipo Descripción
    url Cuerda Enlace relacionado URL
    text Cuerda Texto de enlace relacionado

    Programar campos

    La tabla a continuación muestra los campos para el objeto de calendario

    Programar campos
    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 ver
    starts_at Cadena en formato de fecha ISO-8601 Fecha y hora en que el video está disponible para ver

    Compartiendo campos

    La tabla a continuación muestra los campos de objetos compartidos

    Compartiendo campos
    Campo Tipo Descripción
    by_external_acct Boolean Es cierto si este video se compartió desde alguna otra cuenta.
    by_id Cuerda ID de cuenta que originó la acción
    source_id Cuerda Identificación de video del video original (copia del participante)
    to_external_acct Boolean Es cierto si este video se comparte con otra cuenta
    by_reference Boolean Es cierto que este video se comparte por referencia (siempre será true para videos compartidos a través de la CMS API)

    Text Track Fields

    La tabla a continuación muestra los campos de seguimiento de texto.

    Campo Tipo Descripción
    id Cuerda Identificación del sistema para el elemento de pistas de texto
    src Cuerda Dirección del archivo de seguimiento (URL)
    srclang Cuerda Lenguaje de la pista, por ejemplo, "en"
    label Cuerda Un título legible por el usuario para el conjunto de pistas de texto
    kind Cuerda Cómo se usa la pista: "subtítulos", "subtítulos", "descripciones", "capítulos", "metadatos"
    mime_type Cuerda tipo de mime de las pistas de texto, por ejemplo, "text / vtt"
    asset_id Cuerda Identificación del sistema para el archivo de seguimiento; null si el activo es remoto
    in_band_metadata_track_dispatch_type Cuerda Identificación del sistema para el archivo de seguimiento; null si el activo es remoto
    sources Formación sólo lectura
    src Cuerda Dirección del archivo de seguimiento (URL)
    default Boolean Indica que la pista debe estar habilitada de forma predeterminada. Solo debe ser cierto en una pista.

    Creado por campos

    La tabla a continuación muestra el created_by campos de objetos.

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

    Actualizado por campos

    La tabla a continuación muestra el updated_by campos de objetos.

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

    Página actualizada por última vez el 12 jun 2020