Cette page a été traduite par l'API Cloud Translation.

Captions

Remarque:Le 5 août 2022, YouTube a annoncé qu'il avait modifié la façon dont les ID de sous-titres sont générés. Dans ce cadre, nous avons attribué de nouveaux ID de sous-titres à toutes les pistes de sous-titres. 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 accepte les méthodes suivantes pour les ressources captions:

list: Récupère une liste de pistes de sous-titres associées à une vidéo donné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. Essayer maintenant
insérer: Importez une piste de sous-titres.
mettre à jour: Modifiez une piste de sous-titres. Lorsque vous mettez à jour une piste de sous-titres, vous pouvez modifier son état de brouillon et/ou importer un nouveau fichier de sous-titres pour la piste.
supprimer: Supprimer une piste de sous-titres spécifiée Essayer
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 elle spécifie une valeur pour le paramètre tlang.

Représentation des ressources

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 ressource de l'API. La valeur sera `youtube#caption`.
`etag`	`etag` ETag de cette ressource.
`id`	`string` ID que YouTube utilise pour identifier la piste de sous-titres de manière unique.
`snippet`	`object` L'objet `snippet` contient des informations de base sur les sous-titres.
`snippet.videoId`	`string` ID utilisé par YouTube pour identifier de façon 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 la piste de sous-titres. Les valeurs valides pour cette propriété sont les suivantes : `ASR` : piste de sous-titres générée automatiquement grâce à la reconnaissance vocale. `forced` : piste de sous-titres qui est lue lorsqu'aucune autre piste n'est sélectionnée dans le lecteur. Par exemple, une vidéo montrant des extraterrestres parlant une langue étrangère peut comporter une piste de sous-titres forcés pour n'afficher que les sous-titres de 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 lors de la lecture.
`snippet.audioTrackType`	`string` Type de piste audio associée à 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 (un répertoire, par exemple). `descriptive` : la piste de sous-titres correspond à une piste audio alternative qui inclut une description audio supplémentaire. `primary` : la piste de sous-titres correspond à la piste audio principale de la vidéo, qui est normalement associée à la vidéo. `unknown` : il s'agit de la 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 en grand pour les malvoyants. La valeur par défaut est `false`.
`snippet.isEasyReader`	`boolean` Indique si la piste de sous-titres est formatée pour "simplicité de lecture", ce qui signifie qu'elle est de niveau 3 pour les élèves qui apprennent 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 sera `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 indiquer à YouTube de synchroniser la piste importée avec la vidéo. Si la valeur est `false`, YouTube utilise les codes temporels de la piste de sous-titres mise en ligne pour déterminer quand afficher les sous-titres.
`snippet.status`	`string` État de la piste de sous-titres. Les valeurs valides pour cette propriété sont les suivantes : `failed` `serving` `syncing`
`snippet.failureReason`	`string` La raison pour laquelle YouTube n'a pas réussi à traiter la piste de sous-titres. Cette propriété n'est présente que si la valeur de la propriété `state` est `failed`. Les valeurs valides pour cette propriété sont les suivantes : `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 accepté.