Gestion des transcriptions à l'aide de l'API CMS

Dans cette rubrique, vous apprendrez à utiliser l'API CMS pour mettre à jour les transcriptions de vos vidéos.

Introduction

Vous pouvez utiliser une PATCH demande pour mettre à jour les métadonnées associées aux transcriptions.

Remarques

Les méthodes expliquées dans ce document permettent de mettre à jour les fichiers de transcription ajoutés à vos vidéos. Actuellement, vous pouvez demander à Brightcove de générer un fichier de transcription (avec les sous-titres) lors de l'ingestion. L'intégration de vos propres fichiers de transcription sera prise en charge dans une prochaine version.

Autorisation

Les requêtes à l'API CMS nécessitent un en-tête d'autorisation qui contient vos jetons d'accès. Pour plus de détails sur la façon d'obtenir les informations d'identification client et de les utiliser pour récupérer des jetons d'accès, consultez le Présentation de Brightcove OAuth.

Les opérations dont vous aurez besoin pour mettre à jour les métadonnées de la vidéo sont video-cloud/video/update ou video-cloud/video/all.

Syntaxe

Nous vous recommandons de faire d'abord la demande suivante pour obtenir la baie complète :


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

Mise à jour des relevés de notes

Lors de la mise à jour des transcriptions, certains champs de la rubrique Transcriptions peuvent être traités différemment en fonction de leur type.

Champs de piste de texte
Champ	Type	Description
`id`	Chaîne	Valeur LECTURE SEULE. Identifiant généré par le système et nécessaire pour identifier le TT à mettre à jour.
`account_id`	Chaîne	Valeur LECTURE SEULE. Les mises à jour de ce champ seront ignorées.
`src`	Chaîne	À LIRE SEULEMENT. Emplacement du fichier de transcription.
`srclang`	Chaîne	Code de langue à 2 ou 4 lettres, tel que `es` ou `es-MX`
`label`	Chaîne	Étiquette lisible par l'homme. Limité à 255 caractères.
`status`	énumération	Valeurs valables (sensibles à la casse) : `published`- les transcriptions seront mises à la disposition des spectateurs `draft`- les transcriptions ne seront pas mises à la disposition des spectateurs
`sources`	baie	Valeur en lecture seule. `http` et `https` les URL de la transcription.
`default`	Booléen	`true` ou alors `false`. Vous ne pouvez pas en ajouter plusieurs `default=true` à des transcriptions avec des données différentes `srclang`. Les mises à jour de ce champ seront ignorées.

Requête

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

Exemple de corps de requête

Le corps de la requête sera un objet JSON contenant un tableau de transcriptions :

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