KeyArgo
/
youtube-transcript-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify language rules in README.md 

With the current documentation, it's unclear what one needs to do if their video is not in English.
This commit is contained in:
nbonato 2023-10-12 18:38:20 +02:00 committed by GitHub
parent 99ce79792f
commit cb277cab8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -31,6 +31,8 @@ from youtube_transcript_api import YouTubeTranscriptApi
YouTubeTranscriptApi.get_transcript(video_id) YouTubeTranscriptApi.get_transcript(video_id)
``` ```
> **Note:** By default, this will try to access the English transcript of the video. If your video has a different language, or you are interested in fetching a different language's transcript, please read the section below.
This will return a list of dictionaries looking somewhat like this: This will return a list of dictionaries looking somewhat like this:
```python ```python
@ -53,15 +55,22 @@ This will return a list of dictionaries looking somewhat like this:
You can add the `languages` param if you want to make sure the transcripts are retrieved in your desired language (it defaults to english). You can add the `languages` param if you want to make sure the transcripts are retrieved in your desired language (it defaults to english).
```python ```python
YouTubeTranscriptApi.get_transcripts(video_ids, languages=['de', 'en']) YouTubeTranscriptApi.get_transcript(video_ids, languages=['de', 'en'])
``` ```
It's a list of language codes in a descending priority. In this example it will first try to fetch the german transcript (`'de'`) and then fetch the english transcript (`'en'`) if it fails to do so. If you want to find out which languages are available first, [have a look at `list_transcripts()`](#list-available-transcripts) It's a list of language codes in a descending priority. In this example it will first try to fetch the german transcript (`'de'`) and then fetch the english transcript (`'en'`) if it fails to do so. If you want to find out which languages are available first, [have a look at `list_transcripts()`](#list-available-transcripts).
If you only want one language, you still need to format the languages argument as a list, i.e.,
```python
YouTubeTranscriptApi.get_transcript(video_ids, languages=['de'])
```
### Batch fetching of transcripts
To get transcripts for a list of video ids you can call: To get transcripts for a list of video ids you can call:
```python ```python
YouTubeTranscriptApi.get_transcripts(video_ids, languages=['de', 'en']) YouTubeTranscriptApi.get_transcripts(["video_id1", "video_id2"], languages=['de', 'en'])
``` ```
`languages` also is optional here. `languages` also is optional here.