Se usó la API de Cloud Translation para traducir esta página.

Captions

Nota: El 13 de marzo de 2024, YouTube anunció que dará de baja el parámetro sync para los extremos de las APIs de captions.insert y captions.update. La sincronización automática de subtítulos sigue disponible en YouTube Creator Studio. Consulta el historial de revisión de la API para obtener más detalles.

Un recurso caption representa una pista de subtítulos de YouTube. Una pista de subtítulos se asocia con un solo video de YouTube.

Métodos

La API admite los siguientes métodos para los recursos captions:

list: Recupera una lista de pistas de subtítulos asociadas con un video específico. Ten en cuenta que la respuesta de la API no contiene los subtítulos reales y que el método captions.download proporciona la capacidad de recuperar una pista de subtítulos. Pruébalo ahora.
insertar: Sube una pista de subtítulos.
actualizar: Actualiza una pista de subtítulos. Cuando actualizas una pista de subtítulos, puedes cambiar el estado de borrador de la pista, subir un archivo de subtítulos nuevo o realizar ambas acciones.
borrar: Borra una pista de subtítulos especificada. Pruébala ahora.
descargar: Descarga una pista de subtítulos. La pista de subtítulos se devuelve en su formato original, a menos que la solicitud especifique un valor para el parámetro tfmt y en su idioma original, a menos que la solicitud especifique un valor para el parámetro tlang.

Representación de recursos

En la siguiente estructura JSON, se muestra el formato de un recurso 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
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
`kind`	`string` Identifica el tipo de recurso de la API. El valor será `youtube#caption`.
`etag`	`etag` La Etag de este recurso.
`id`	`string` ID que YouTube utiliza para identificar de forma exclusiva la pista de subtítulos.
`snippet`	`object` El objeto `snippet` contiene detalles básicos sobre la leyenda.
`snippet.videoId`	`string` ID que YouTube utiliza para identificar de forma exclusiva el video asociado con la pista de subtítulos.
`snippet.lastUpdated`	`datetime` Fecha y hora de la última actualización de la pista de subtítulos. El valor se especifica en el formato ISO 8601.
`snippet.trackKind`	`string` Tipo de pista de subtítulos. Los valores válidos para esta propiedad son los siguientes: `ASR`: es una pista de subtítulos generada mediante el reconocimiento de voz automático. `forced`: es una pista de subtítulos que se reproduce cuando no se selecciona otra pista en el reproductor. Por ejemplo, un video en el que se muestran alienígenas hablando en un idioma extranjero puede tener una pista de subtítulos forzada para mostrar solo subtítulos en ese idioma. `standard`: Es una pista de subtítulos normal. Este es el valor predeterminado.
`snippet.language`	`string` El idioma de la pista de subtítulos. El valor de la propiedad es una etiqueta de idioma BCP-47.
`snippet.name`	`string` Nombre de la pista de subtítulos. El nombre está pensado para que el usuario lo vea como opción durante la reproducción. La longitud máxima permitida del nombre es de 150 caracteres.
`snippet.audioTrackType`	`string` Corresponde al tipo de pista de audio asociada con la pista de subtítulos. Los valores válidos para esta propiedad son los siguientes: `commentary`: la pista de subtítulos corresponde a una pista de audio alternativa que incluye comentarios, como los del directorio. `descriptive`: la pista de subtítulos corresponde a una pista de audio alternativa que incluye audio descriptivo adicional. `primary`: la pista de subtítulos corresponde a la pista de audio principal del video, que es la pista de audio que normalmente se asocia al video. `unknown`: este es el valor predeterminado.
`snippet.isCC`	`boolean` Indica si la pista contiene subtítulos para personas sordas o con hipoacusia. El valor predeterminado es `false`.
`snippet.isLarge`	`boolean` Indica si la pista de subtítulos utiliza texto grande para las personas con discapacidad visual. El valor predeterminado es `false`.
`snippet.isEasyReader`	`boolean` Indica si la pista de subtítulos tiene un formato de "lector fácil", lo que significa que está en el nivel de tercer grado para los estudiantes de idiomas. El valor predeterminado es `false`.
`snippet.isDraft`	`boolean` Indica si la pista de subtítulos es un borrador. Si el valor es `true`, el recorrido no es públicamente visible. El valor predeterminado es `false`.
`snippet.isAutoSynced`	`boolean` Indica si YouTube sincronizó la pista de subtítulos con la pista de audio del video. El valor será `true` si se solicitó una sincronización de manera explícita cuando se subió la pista de subtítulos. Por ejemplo, cuando llamas a los métodos `captions.insert` o `captions.update`, puedes establecer el parámetro `sync` en `true` para indicarle a YouTube que sincronice con el video la pista que se subió. Si el valor es `false`, YouTube usa los códigos de tiempo de la pista de subtítulos que se subió para determinar cuándo mostrar los subtítulos.
`snippet.status`	`string` Estado de la pista de subtítulos. Los valores válidos para esta propiedad son los siguientes: `failed` `serving` `syncing`
`snippet.failureReason`	`string` El motivo por el que YouTube no pudo procesar la pista de subtítulos. Esta propiedad solo está presente si el valor de la propiedad `state` es `failed`. Los valores válidos para esta propiedad son los siguientes: `processingFailed`: YouTube no pudo procesar la pista de subtítulos que se subió. `unknownFormat`: no se reconoció el formato de la pista de subtítulos. `unsupportedFormat`: no se admite el formato de la pista de subtítulos.