Administrar pistas de texto con la API de CMS

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

Introducción

Ya sea que las pistas de texto sean ingeridas (estáticas o dinámicas) o remotas, puede usar un PATCH solicitud para actualizar los metadatos asociados con las pistas de texto.

Notas

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 pistas de texto

Al actualizar pistas de texto, algunos campos en Campos de pistas de texto puede tratarse de manera diferente según su tipo.

Campos de seguimiento de texto
Campo Tipo Pistas de texto remotas Pistas de texto ingerido estático Pistas dinámicas de texto ingerido
id Cadena Valor de SÓLO LECTURA. Requerido para identificar el TT que necesita actualizarse.
account_id Cadena Se ignorarán las actualizaciones en este campo.
src Cadena Obligatorio y limitado a 255 caracteres. Se ignorarán las actualizaciones en este campo.
srclang Cadena Limitado a 32 caracteres.
label Cadena Limitado a 255 caracteres.
kind Enum Los valores válidos son:
  • subtitles
  • captions
  • descriptions
  • chapters
  • metadata
status enumeración Valores válidos (distingue entre mayúsculas y minúsculas):
  • published- las pistas de texto estarán disponibles para los espectadores
  • draft- las pistas de texto no estarán disponibles para los espectadores
  • null- Las pistas de texto (predeterminado) estarán disponibles para los espectadores
mime_type Cadena Limitado a 32 caracteres. Se ignorarán las actualizaciones en este campo.
asset_id Cadena Valor de SÓLO LECTURA. Campo no aplicable para este tipo. Se ignorarán las actualizaciones en este campo.
in_band_metadata_track_dispatch_type Cadena Campo no aplicable para este tipo. Se ignorarán las actualizaciones en este campo.
sources Gama Valor de SÓLO LECTURA.
default booleano true o false. El campo default para las pistas de texto ingeridas tendrá el mismo comportamiento para las pistas de texto remotas e ingeridas. No puede agregar varios default=true a pistas de texto con diferentes srclang.  

Solicitud

Aplicable a pistas de texto dinámicas, estáticas y remotas.


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

Solicitar ejemplos de cuerpo

Pistas de texto remotas

El cuerpo de la solicitud será un objeto JSON que contiene una matriz de pistas de texto:

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "src" :     "https://some.site.com/captions/bc_smart_ja.vtt",
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published"
    }, 
    { 
      "id" : "5678-5678-5678"
      "src" : "https://some.site.com/captions/bc_smart_es.vtt",  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published"
    } 
  ] 
}
Pistas de texto estático

El cuerpo de la solicitud será un objeto JSON que contiene una matriz de pistas de texto:

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published"
    }, 
    { 
      "id" : "5678-5678-5678"  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published"
    } 
  ] 
}
Pistas de texto dinámicas

El cuerpo de la solicitud será un objeto JSON que contiene una matriz de pistas de texto:

        
          {
  "text_tracks" : 
  [ 
    { 
      "id" : "1234-1234-1234"
      "srclang" : "ja", 
      "label" : "日本人", 
      "kind" : "captions", 
      "mime_type" : null, 
      "default" : true,
      "status": "published" 
    }, 
    { 
      "id" : "5678-5678-5678"  
      "srclang" : "es", 
      "label" : "español", 
      "kind" : "descriptions",
      "mime_type" : null,
      "default" : false,
      "status": "published" 
    } 
  ] 
}