Verwalten von Textspuren mit der CMS-API

In diesem Thema erfahren Sie, wie Sie die CMS-API verwenden können, um die WebVTT-Textspuren Ihrer Videos zu aktualisieren.

Einleitung

Unabhängig davon, ob die Textspuren aufgenommen (statisch oder dynamisch) oder remote sind, können Sie a verwenden PATCH Anforderung zum Aktualisieren der mit den Textspuren verknüpften Metadaten.

Hinweise

  • Die in diesem Dokument erläuterten Methoden dienen zum Aktualisieren von WebVTT-Dateien, die Ihren Videos hinzugefügt wurden. Sie können WebVTT-Dateien in Video Cloud aufnehmen, indem Sie das Dynamische Aufnahme-API oder Remote-WebVTT-Dateien hinzufügen zu Ihren Videos mit der CMS-API.

Autorisierung

Anfragen an die CMS-API erfordern einen Autorisierungsheader, der Ihre Zugriffstoken enthält. Ausführliche Informationen zum Abrufen von Client-Anmeldeinformationen und deren Verwendung zum Abrufen von Zugriffstoken finden Sie im Übersicht über Brightcove OAuth.

Die Vorgänge, die Sie zum Aktualisieren von Video-Metadaten benötigen, sind video-cloud/video/update oder video-cloud/video/all.

Syntax

Wir empfehlen, zuerst die folgende Anfrage zu stellen, um das vollständige Array zu erhalten:


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

Aktualisieren von Textspuren

Beim Aktualisieren von Textspuren werden einige Felder in Felder für Textspuren kann je nach Art unterschiedlich behandelt werden.

Textspurfelder
Feld Typ Remote-Textspuren Statische aufgenommene Textspuren Dynamisch aufgenommene Textspuren
id Zeichenfolge SCHREIBGESCHÜTZTER Wert. Erforderlich, um den TT zu identifizieren, der aktualisiert werden muss.
account_id Zeichenfolge Aktualisierungen in diesem Feld werden ignoriert.
src Zeichenfolge Erforderlich und auf 255 Zeichen beschränkt. Aktualisierungen in diesem Feld werden ignoriert.
srclang Zeichenfolge Begrenzt auf 32 Zeichen.
label Zeichenfolge Begrenzt auf 255 Zeichen.
kind Aufzählung Gültige Werte sind:
  • subtitles
  • captions
  • descriptions
  • chapters
  • metadata
status Aufzähung Gültige Werte (Groß- und Kleinschreibung beachten):
  • published- Texttracks werden den Zuschauern zur Verfügung stehen
  • draft- Texttracks werden den Zuschauern nicht zur Verfügung stehen
  • null- (Standard-) Texttracks werden den Zuschauern zur Verfügung stehen
mime_type Zeichenfolge Begrenzt auf 32 Zeichen. Aktualisierungen in diesem Feld werden ignoriert.
asset_id Zeichenfolge SCHREIBGESCHÜTZTER Wert. Feld für diesen Typ nicht zutreffend. Aktualisierungen in diesem Feld werden ignoriert.
in_band_metadata_track_dispatch_type Zeichenfolge Feld für diesen Typ nicht zutreffend. Aktualisierungen in diesem Feld werden ignoriert.
sources Reihe SCHREIBGESCHÜTZTER Wert.
default Boolescher Wert true oder false. Das Feld default für aufgenommene Textspuren verhält sich für entfernte und eingefügte Textspuren dasselbe Verhalten. Sie können nicht mehrere hinzufügen default=true zu Textspuren mit verschiedenen srclang.  

Anfrage

Anwendbar für entfernte, statische und dynamische Textspuren.


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

Körperbeispiele anfordern

Remote-Textspuren

Der Anfragetext ist ein JSON-Objekt, das ein Array von Textspuren enthält:

        
          {
  "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"
    } 
  ] 
}
Statische Textspuren

Der Anfragetext ist ein JSON-Objekt, das ein Array von Textspuren enthält:

        
          {
  "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"
    } 
  ] 
}
Dynamische Textspuren

Der Anfragetext ist ein JSON-Objekt, das ein Array von Textspuren enthält:

        
          {
  "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" 
    } 
  ] 
}