Captions

Uwaga: 5 sierpnia 2022 r. ogłosiliśmy, że zmieniliśmy sposób generowania identyfikatorów napisów i w ramach tej zmiany przypisujemy nowe identyfikatory napisów do wszystkich ścieżek napisów. Więcej informacji znajdziesz w historii wersji interfejsu API.

Zasób caption reprezentuje ścieżkę napisów YouTube. Ścieżka napisów jest powiązana dokładnie z jednym filmem w YouTube.

Metody

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

list
Pobierz listę ścieżek napisów 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 teraz
wstaw
Prześlij ścieżkę z napisami.
zaktualizuj
Zaktualizuj ścieżkę z napisami. Aktualizując ścieżkę napisów, możesz zmienić jej wersję, przesłać nowy plik napisów lub obie te opcje.
usuń
Usuń 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 jego oryginalnym języku, chyba że żądanie określa wartość parametru tlang.

Reprezentowanie zasobów

Poniższa struktura JSON pokazuje 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
  }
}

Usługi

Poniższa tabela określa właściwości, które pojawiają się w tym zasobie:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#caption.
etag etag
Otagowanie tego zasobu.
id string
Identyfikator używany przez YouTube do jednoznacznego identyfikowania ścieżki z napisami.
snippet object
Obiekt snippet zawiera podstawowe informacje o napisie.
snippet.videoId string
Identyfikator, który YouTube wykorzystuje do jednoznacznego identyfikowania filmu powiązanego ze ścieżką napisów.
snippet.lastUpdated datetime
Data i godzina ostatniej aktualizacji ścieżki z napisami. Wartość ma format ISO 8601.
snippet.trackKind string
Typ ścieżki z napisami.

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 napisów, która jest odtwarzana, gdy w odtwarzaczu nie wybrano żadnej innej ścieżki. Na przykład w filmie, w którym kosmici mówiący w języku obcego posługują się językiem obcym, możemy wymusić stosowanie napisów w języku obcym.
  • standard – standardowa ś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 napisów. Będzie ona widoczna dla użytkownika jako opcja podczas odtwarzania.
snippet.audioTrackType string
Typ ścieżki audio powiązany z napisami.

Prawidłowe wartości tej właściwości to:
  • commentary – ścieżka napisów odpowiada alternatywnej ścieżce audio, która zawiera komentarz, taki jak komentarz do katalogu.
  • descriptive – ścieżka z podpisem odpowiada alternatywnej ścieżce audio, która zawiera dodatkowe informacje.
  • primary – ścieżka napisów odpowiada głównej ścieżce dźwiękowej filmu, która jest zwykle powiązana z tym filmem.
  • unknown – wartość domyślna.
snippet.isCC boolean
Wskazuje, czy utwór zawiera napisy dla osób niesłyszących i niedosłyszących. Wartością domyślną jest false.
snippet.isLarge boolean
Wskazuje, czy ścieżka z napisami jest przeznaczona dla osób z wadą wzroku. Wartością domyślną jest false.
snippet.isEasyReader boolean
Wskazuje, czy ścieżka napisów jest sformatowana dla „czytelnego czytelnika”, co oznacza, że jest to trzecia klasa dla osób uczących się języków. 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 napisów w filmie została zsynchronizowana przez YouTube ze ścieżką dźwiękową filmu. Wartość będzie wynosić true, jeśli podczas przesyłania ścieżki z podpisem wyraźnie przesłano prośbę o synchronizację. Na przykład wywołując metody captions.insert lub captions.update, możesz ustawić wartość sync na true, dzięki której YouTube zsynchronizuje przesłany utwór z filmem. Jeśli wartość to false, YouTube używa sygnatur czasowych z przesłanej ścieżki napisów, aby określić, kiedy należy wyświetlić napisy.
snippet.status string
Stan ścieżki napisów.

Prawidłowe wartości tej właściwości to:
  • failed
  • serving
  • syncing
snippet.failureReason string
Przyczyna, dla której nie udało się przetworzyć ścieżki z napisami. Ta właściwość jest dostępna tylko wtedy, gdy wartość właściwości state to failed.

Prawidłowe wartości tej właściwości to:
  • processingFailed – nie udało się 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.