Gestión de transcripciones mediante la API de CMS

En este tema, aprenderá a usar la API de CMS para actualizar las transcripciones de sus videos.

Introducción

Puedes usar un PATCH solicitar la actualización de los metadatos asociados a las transcripciones.

Notas

  • Los métodos explicados en este documento son para actualizar los archivos de transcripción agregados a sus videos. Actualmente puede hacer que Brightcove genere un archivo de transcripción (junto con subtítulos) durante la ingesta. La ingesta de sus propios archivos de transcripción se admitirá en una versión futura.

Autorización

Las solicitudes a la API de CMS requieren un encabezado de autorización que contiene sus tokens de acceso. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Las operaciones que necesitará para actualizar los metadatos de video son video-cloud/video/update o video-cloud/video/all.

Sintaxis

Recomendamos realizar la siguiente solicitud primero para obtener la matriz completa:


GET
https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

Actualización de transcripciones

Al actualizar las transcripciones, algunos campos en los campos de transcripciones pueden tratarse de manera diferente según su tipo.

Campos de seguimiento de texto
Campo Tipo Descripción
id Cadena Valor de SÓLO LECTURA. Identificación generada por el sistema requerida para identificar el TT que necesita ser actualizado.
account_id Cadena Valor de SÓLO LECTURA. Se ignorarán las actualizaciones en este campo.
src Cadena SOLO LECTURA. Ubicación del archivo de transcripción.
srclang Cadena Código de idioma de 2 o 4 letras, como es o es-MX
label Cadena Etiqueta legible por humanos. Limitado a 255 caracteres.
status enumeración Valores válidos (distingue entre mayúsculas y minúsculas):
  • published- las transcripciones estarán disponibles para los espectadores
  • draft- las transcripciones no estarán disponibles para los espectadores
sources Gama valor de SOLO LECTURA. http y https URL para la transcripción.
default booleano true o false. No puede agregar varios default=true a transcripciones con diferentes srclang .

Se ignorarán las actualizaciones en este campo.

Solicitud

PATCH https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}

Ejemplo de cuerpo de solicitud

El cuerpo de la solicitud será un objeto JSON que contiene una serie de transcripciones:

"transcripts": [
  {
      "id": "d5967d03-1de1-a2de-47db-73486c7474c1",
      "account_id": "12345678910",
      "src": "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
      "srclang": "en-IE",
      "label": "Irish English",
      "status": "draft",
      "sources": [
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10"
      ],
      "default": false
  },
  {
      "id": "2d0cb632-8753-a68a-4143-aea0429eac7f",
      "account_id": "12345678910",
      "src": "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108",
      "srclang": "en-US",
      "label": "American English",
      "status": "draft",
      "sources": [
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108",
          "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/2d0cb632-a68a-4143-8753-aea0429eac7f/transcript.txt*~hmac=8ae7069ac9717559e9439f5112ee133d955ec18a09563e7a3e2a48a83637c108"
      ],
      "default": false
  }
]