Implémentation: sous-titres

Les exemples suivants montrent comment utiliser l'API YouTube Data (v3) pour effectuer des fonctions liées aux sous-titres.

Récupérez une liste de pistes de sous-titres pour une vidéo.

Pour récupérer la liste des pistes de sous-titres disponibles pour une vidéo spécifique, appelez la méthode captions.list. Définissez la valeur du paramètre videoId sur l'ID vidéo YouTube qui identifie de manière unique la vidéo pour laquelle vous récupérez les sous-titres. Votre requête doit être autorisée à l'aide d'OAuth 2.0.

La requête ci-dessous récupère la liste des sous-titres d'une vidéo sur la chaîne YouTube Google Stories:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

Consultez la documentation de la méthode captions.list pour obtenir des exemples de code.

Créer une piste de sous-titres

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car cet outil ne permet pas d'importer des fichiers, ce qui est une exigence pour cette méthode.

Vous pouvez utiliser la méthode captions.insert de l'API pour importer un nouveau canal de sous-titres pour une vidéo. Lorsque vous importez un titre, vous devez spécifier une valeur pour les propriétés de ressource caption suivantes:

• snippet.videoId : identifie la vidéo à laquelle la piste de sous-titres est ajoutée.
• snippet.language : langue de la piste de sous-titres.
• snippet.name : nom de la piste de sous-titres.

Les options supplémentaires suivantes sont disponibles lorsque vous importez une piste de sous-titres:

• Si vous définissez le paramètre sync sur true, YouTube ignorera tous les codes temporels du fichier de sous-titres importé et générera de nouveaux codes temporels pour les sous-titres.

  Vous devez définir le paramètre sync sur true si vous importez une transcription sans codes temporels, ou si vous pensez que les codes temporels de votre fichier sont incorrects et que vous souhaitez que YouTube tente de les corriger.

• Si vous définissez la propriété snippet.isDraft de la ressource caption sur true, le canal ne sera pas visible publiquement.

Consultez la documentation de la méthode captions.insert pour obtenir des exemples de code.

Télécharger une piste de sous-titres

Cette requête ne peut pas être testée à l'aide d'APIs Explorer, car cet outil ne permet pas de télécharger des fichiers.

Pour télécharger une piste de sous-titres spécifique, appelez la méthode captions.download. Définissez la valeur du paramètre id sur l'ID de la piste de sous-titres YouTube qui identifie de manière unique la piste de sous-titres que vous téléchargez. Votre requête doit être autorisée à l'aide d'OAuth 2.0.

L'API v3 est compatible avec les options suivantes:

• Pour spécifier qu'une piste de sous-titres doit être renvoyée dans un format spécifique, définissez la valeur du paramètre tfmt pour identifier le format souhaité. La définition du paramètre liste les valeurs acceptées.

• Pour récupérer la traduction d'une piste de sous-titres, définissez la valeur du paramètre tlang sur un code de langue ISO 639-1 à deux lettres qui identifie la langue des sous-titres souhaitée. La traduction est générée à l'aide d'une traduction automatique, comme Google Traduction.

Consultez la documentation de la méthode captions.download pour obtenir des exemples de code.

Modifier une piste de sous-titres

L'API permet de modifier l'état d'une piste de sous-titres, d'importer une nouvelle piste de sous-titres pour un fichier, ou les deux.

Vous pouvez utiliser APIs Explorer pour tester la possibilité de modifier l'état brouillon d'un titre. Toutefois, vous ne pouvez pas utiliser l'explorateur d'API pour mettre à jour la piste de sous-titres réelle, car cet outil ne permet pas d'importer de fichiers.

La requête ci-dessous récupère la liste des sous-titres d'une vidéo sur la chaîne YouTube Google Stories:

La requête met à jour l'état "Brouillon" d'un canal de sous-titres sur true, ce qui signifie qu'il ne sera pas visible publiquement. Pour effectuer la requête dans l'explorateur d'API, vous devez définir la valeur de la propriété id pour identifier un canal de sous-titres.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

Consultez la documentation de la méthode captions.update pour obtenir des exemples de code.

Supprimer une piste de sous-titres

Cet exemple montre comment supprimer une piste de sous-titres. L'exemple se présente comme suit:

• Étape 1: Récupérez l'ID de la piste de sous-titres

  Suivez les étapes ci-dessus pour récupérer la liste des pistes de sous-titres d'une vidéo. La liste peut être utilisée pour afficher une liste de pistes de sous-titres, en utilisant l'ID de chaque piste comme clé.

• Étape 2: Supprimez le canal

  Appelez la méthode captions.delete pour supprimer une vidéo spécifique. Dans la requête, le paramètre id spécifie l'ID de la piste de sous-titres que vous supprimez. La requête doit être autorisée à l'aide d'OAuth 2.0. Si vous testez cette requête dans APIs Explorer, vous devrez remplacer la valeur du paramètre id par un ID de piste de sous-titres valide.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
  id=CAPTION_TRACK_ID