Captions

Remarque:Le 13 mars 2024, YouTube a annoncé l'abandon du paramètre sync pour les points de terminaison d'API captions.insert et captions.update. La synchronisation automatique des sous-titres est toujours disponible dans YouTube Creator Studio. Pour en savoir plus, consultez l'historique des révisions de l'API.

Une ressource caption représente une piste de sous-titres YouTube. Une piste de sous-titres est associée à une seule vidéo YouTube.

Méthodes

L'API prend en charge les méthodes suivantes pour les ressources captions:

liste
Récupère la liste des pistes de sous-titres associées à une vidéo spécifiée. Notez que la réponse de l'API ne contient pas les sous-titres réels et que la méthode captions.download permet de récupérer une piste de sous-titres. Essayez maintenant.
insérer
Importez une piste de sous-titres. Essayer
update
Mettre à jour une piste de sous-titres. Lorsque vous mettez à jour une piste de sous-titres, vous pouvez modifier son état de brouillon, importer un nouveau fichier de sous-titres pour la piste ou les deux. Essayez maintenant.
télécharger
Téléchargez une piste de sous-titres. La piste de sous-titres est renvoyée dans son format d'origine, sauf si la requête spécifie une valeur pour le paramètre tfmt et dans sa langue d'origine, sauf si la requête spécifie une valeur pour le paramètre tlang. Essayez maintenant.
supprimer
Supprime une piste de sous-titres spécifiée. Essayer

Représentation de la ressource

La structure JSON suivante montre le format d'une ressource captions:

{
  "kind": "youtube#caption",
  "etag": etag,
  "id": string,
  "snippet": {
    "videoId": string,
    "lastUpdated": datetime,
    "trackKind": string,
    "language": string,
    "name": string,
    "audioTrackType": string,
    "isCC": boolean,
    "isLarge": boolean,
    "isEasyReader": boolean,
    "isDraft": boolean,
    "isAutoSynced": boolean,
    "status": string,
    "failureReason": string
  }
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind string
Identifie le type de la ressource API. La valeur sera youtube#caption.
etag etag
Etag de cette ressource.
id string
ID utilisé par YouTube pour identifier de manière unique la piste de sous-titres.
snippet object
L'objet snippet contient des informations de base sur le sous-titre.
snippet.videoId string
ID utilisé par YouTube pour identifier de manière unique la vidéo associée à la piste de sous-titres.
snippet.lastUpdated datetime
Date et heure de la dernière mise à jour de la piste de sous-titres. La valeur est spécifiée au format ISO 8601.
snippet.trackKind string
Type de piste de sous-titres.

Les valeurs valides pour cette propriété sont les suivantes :
  • ASR : piste de sous-titres générée à l'aide de la reconnaissance vocale automatique.
  • forced : piste de sous-titres lue lorsqu'aucune autre piste n'est sélectionnée dans le lecteur. Par exemple, une vidéo montrant des extraterrestres parlant dans une langue extraterrestre peut comporter une piste de sous-titres forcée pour n'afficher que des sous-titres dans cette langue.
  • standard : piste de sous-titres standard. Il s'agit de la valeur par défaut.
snippet.language string
Langue de la piste de sous-titres. La valeur de la propriété est un tag de langue BCP-47.
snippet.name string
Nom de la piste de sous-titres. Le nom doit être visible par l'utilisateur en tant qu'option pendant la lecture. La longueur maximale du nom est de 150 caractères.
snippet.audioTrackType string
Type de piste audio associé à la piste de sous-titres.

Les valeurs valides pour cette propriété sont les suivantes :
  • commentary : la piste de sous-titres correspond à une piste audio alternative qui inclut des commentaires, comme des commentaires de guide.
  • descriptive : la piste de sous-titres correspond à une piste audio alternative qui inclut des éléments audio descriptifs supplémentaires.
  • primary : la piste de sous-titres correspond à la piste audio principale de la vidéo, qui est la piste audio normalement associée à la vidéo.
  • unknown : valeur par défaut.
snippet.isCC boolean
Indique si la piste contient des sous-titres pour les sourds et les malentendants. La valeur par défaut est false.
snippet.isLarge boolean
Indique si la piste de sous-titres utilise du texte de grande taille pour les personnes ayant une déficience visuelle. La valeur par défaut est false.
snippet.isEasyReader boolean
Indique si la piste de sous-titres est formatée pour un "lecteur facile", c'est-à-dire qu'elle est au niveau de la troisième année pour les apprenants de la langue. La valeur par défaut est false.
snippet.isDraft boolean
Indique si la piste de sous-titres est un brouillon. Si la valeur est true, le titre n'est pas visible publiquement. La valeur par défaut est false.
snippet.isAutoSynced boolean
Indique si YouTube a synchronisé la piste de sous-titres avec la piste audio de la vidéo. La valeur est true si une synchronisation a été explicitement demandée lors de l'importation de la piste de sous-titres. Par exemple, lorsque vous appelez les méthodes captions.insert ou captions.update, vous pouvez définir le paramètre sync sur true pour demander à YouTube de synchroniser le titre mis en ligne avec la vidéo. Si la valeur est false, YouTube utilise les codes temporels de la piste de sous-titres importée pour déterminer quand afficher les sous-titres.
snippet.status string
État de la piste de sous-titres.

Valeurs valides pour cette propriété :
  • failed
  • serving
  • syncing
snippet.failureReason string
Raison pour laquelle YouTube n'a pas pu traiter la piste de sous-titres. Cette propriété n'est présente que si la valeur de la propriété state est failed.

Valeurs valides pour cette propriété :
  • processingFailed : YouTube n'a pas réussi à traiter la piste de sous-titres mise en ligne.
  • unknownFormat : le format de la piste de sous-titres n'a pas été reconnu.
  • unsupportedFormat : le format de la piste de sous-titres n'est pas compatible.