-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add methods for fetching transcript content directly
- Loading branch information
1 parent
28078d7
commit 88075ba
Showing
5 changed files
with
321 additions
and
152 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
lib/src/main/java/io/github/thoroldvix/api/TranscriptRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package io.github.thoroldvix.api; | ||
|
|
||
| /** | ||
| * Request object for retrieving transcripts from {@link PlaylistsTranscriptApi}. | ||
| * <p> | ||
| * Contains API key required for the YouTube V3 API, | ||
| * and optionally a file path to the text file containing the authentication cookies. If cookies are not provided, the API will not be able to access age restricted videos. | ||
| * Also contains a flag to stop on error, or continue on error. Defaults to false if not provided. | ||
| * </p> | ||
| * </p> | ||
| */ | ||
| public class TranscriptRequest { | ||
| private final String apiKey; | ||
| private final String cookiesPath; | ||
| private final boolean stopOnError; | ||
|
|
||
| /** | ||
| * Creates a new instance of {@link TranscriptRequest} | ||
| * | ||
| * @param apiKey API key for the YouTube V3 API (see <a href="https://developers.google.com/youtube/v3/getting-started">Getting started</a>) | ||
| * @param cookiesPath The file path to the text file containing the authentication cookies. Used in the case if some videos are age restricted see {<a href="https://github.com/Thoroldvix/youtube-transcript-api#cookies">Cookies</a>} | ||
| * @param stopOnError Whether to stop if transcript retrieval fails for a video. If false, all transcripts that could not be retrieved will be skipped, | ||
| * * otherwise an exception will be thrown on first error. | ||
| */ | ||
| public TranscriptRequest(String apiKey, String cookiesPath, boolean stopOnError) { | ||
| if (apiKey == null || apiKey.isBlank()) { | ||
| throw new IllegalArgumentException("API key cannot be null or blank"); | ||
| } | ||
| this.apiKey = apiKey; | ||
| this.cookiesPath = cookiesPath; | ||
| this.stopOnError = stopOnError; | ||
| } | ||
|
|
||
| public TranscriptRequest(String apiKey, String cookiesPath) { | ||
| this(apiKey, cookiesPath, true); | ||
| } | ||
|
|
||
| public TranscriptRequest(String apiKey) { | ||
| this(apiKey, null, true); | ||
| } | ||
|
|
||
| public TranscriptRequest(String apiKey, boolean stopOnError) { | ||
| this(apiKey, null, stopOnError); | ||
| } | ||
|
|
||
| /** | ||
| * @return API key for the YouTube V3 API (see <a href="https://developers.google.com/youtube/v3/getting-started">Getting started</a>) | ||
| */ | ||
| public String getApiKey() { | ||
| return apiKey; | ||
| } | ||
|
|
||
| /** | ||
| * @return The file path to the text file containing the authentication cookies. Used in the case if some videos are age restricted see {<a href="https://github.com/Thoroldvix/youtube-transcript-api#cookies">Cookies</a>} | ||
| */ | ||
| public String getCookiesPath() { | ||
| return cookiesPath; | ||
| } | ||
|
|
||
| /** | ||
| * @return Whether to stop if transcript retrieval fails for a video. If false, all transcripts that could not be retrieved will be skipped, | ||
| * * otherwise an exception will be thrown on first error. | ||
| */ | ||
| public boolean isStopOnError() { | ||
| return stopOnError; | ||
| } | ||
| } |
Oops, something went wrong.