Ta strona została przetłumaczona przez Cloud Translation API.

Captions

Uwaga: 13 marca 2024 r. ogłosiliśmy, że powoduje wycofanie parametru sync dla metody captions.insert i Punkty końcowe interfejsu API captions.update. Automatyczna synchronizacja napisów jest nadal dostępna w YouTube Studio. Zobacz Historia wersji interfejsu API dla .

Zasób caption reprezentuje ścieżkę z napisami w YouTube. Ścieżka z napisami jest powiązana tylko z jednym filmem w YouTube.

Metody

Interfejs API obsługuje następujące metody w przypadku zasobów captions:

list: Pobieranie listy ścieżek z napisami powiązanych z określonym filmem. Pamiętaj, że odpowiedź interfejsu API nie zawiera rzeczywistych napisów, a metoda captions.download umożliwia pobranie ścieżki napisów. Wypróbuj
wstaw: Prześlij ścieżkę z napisami.
zaktualizuj: Zaktualizuj ścieżkę z napisami. Podczas aktualizowania ścieżki z napisami możesz zmienić stan wersji roboczej ścieżki, przesłać nowy plik z napisami lub wykonać obie te czynności.
usuń: Usunąć określoną ścieżkę z napisami. Wypróbuj teraz
pobierz: Pobierz ścieżkę z napisami. Ścieżka z napisami jest zwracana w oryginalnym formacie, chyba że żądanie określa wartość parametru tfmt i w języku oryginału, chyba że żądanie określa wartość parametru tlang.

Reprezentowanie zasobu

Poniższa struktura JSON przedstawia format zasobu 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
  }
}

Właściwości

Właściwości występujące w tym zasobie są opisane w tabeli poniżej:

Właściwości
`kind`	`string` Określa typ zasobu interfejsu API. Wartość wyniesie `youtube#caption`.
`etag`	`etag` Etag tego zasobu.
`id`	`string` Identyfikator, za pomocą którego YouTube jednoznacznie identyfikuje ścieżkę z napisami.
`snippet`	`object` Obiekt `snippet` zawiera podstawowe informacje na temat podpisu.
`snippet.videoId`	`string` Identyfikator, za pomocą którego YouTube jednoznacznie identyfikuje film powiązany ze ścieżką napisów.
`snippet.lastUpdated`	`datetime` Data i godzina ostatniej aktualizacji ścieżki z napisami. Wartość jest podana w formacie ISO 8601.
`snippet.trackKind`	`string` Typ ścieżki napisów. Prawidłowe wartości tej właściwości to: `ASR` – ścieżka z napisami wygenerowana przy użyciu automatycznego rozpoznawania mowy. `forced` – ścieżka z napisami, która jest odtwarzana, gdy w odtwarzaczu nie jest wybrana żadna inna ścieżka. Na przykład film, w którym kosmici mówią w obcym języku, mogą mieć wymuszoną ścieżkę napisów, która będzie wyświetlać tylko napisy dla obcych. `standard` – zwykła ścieżka z napisami. jest to wartość domyślna
`snippet.language`	`string` Język ścieżki z napisami. Wartością właściwości jest tag języka BCP-47.
`snippet.name`	`string` Nazwa ścieżki z napisami. Nazwa jest widoczna dla użytkownika jako jedna z opcji odtwarzania podczas odtwarzania. Maksymalna obsługiwana długość nazwy to 150 znaków.
`snippet.audioTrackType`	`string` Typ ścieżki audio powiązanej ze ścieżką z napisami. Prawidłowe wartości tej właściwości to: `commentary` – ścieżka z napisami odpowiada alternatywnej ścieżce audio, która zawiera komentarz, np. komentarz do katalogu. `descriptive` – ścieżka z napisami odpowiada alternatywnej ścieżce dźwiękowej, która zawiera dodatkową ścieżkę dźwiękową. `primary` – ścieżka z napisami odpowiada głównej ścieżce dźwiękowej filmu, czyli ścieżce audio zazwyczaj kojarzonej z filmem. `unknown` – to wartość domyślna.
`snippet.isCC`	`boolean` Wskazuje, czy ścieżka audio zawiera napisy dla osób niesłyszących i niedosłyszących. Wartością domyślną jest `false`.
`snippet.isLarge`	`boolean` Wskazuje, czy w ścieżce z napisami używany jest duży tekst dla osób z wadami wzroku. Wartością domyślną jest `false`.
`snippet.isEasyReader`	`boolean` Wskazuje, czy ścieżka z napisami jest sformatowana pod kątem prostego czytnika, co oznacza, że są one przeznaczone dla osób uczących się języka 3 klasy. Wartością domyślną jest `false`.
`snippet.isDraft`	`boolean` Wskazuje, czy ścieżka z napisami jest wersją roboczą. Jeśli wartość to `true`, utwór nie jest widoczny publicznie. Wartością domyślną jest `false`.
`snippet.isAutoSynced`	`boolean` Wskazuje, czy ścieżka z napisami została zsynchronizowana przez YouTube ze ścieżką dźwiękową w filmie. Jeśli podczas przesyłania ścieżki napisów zostało wyraźnie zażądane zsynchronizowanie, wartość będzie wynosić `true`. Na przykład przy wywoływaniu metod `captions.insert` lub `captions.update` możesz ustawić parametr `sync` na `true`, aby polecić YouTube zsynchronizowanie przesłanej ścieżki audio z filmem. Jeśli wartością jest `false`, YouTube ustala, kiedy wyświetlić napisy na podstawie kodów czasu z przesłanej ścieżki napisów.
`snippet.status`	`string` Stan ścieżki napisów. Prawidłowe wartości tej właściwości to: `failed` `serving` `syncing`
`snippet.failureReason`	`string` Powód, dla którego nie udało się przetworzyć ścieżki z napisami w YouTube. Ta właściwość jest obecna tylko wtedy, gdy wartość właściwości `state` to `failed`. Dozwolone wartości tej właściwości to: `processingFailed` – YouTube nie może przetworzyć przesłanej ścieżki z napisami. `unknownFormat` – format ścieżki z napisami nie został rozpoznany. `unsupportedFormat` – format ścieżki z napisami nie jest obsługiwany.