Index
All Classes and Interfaces|All Packages|Serialized Form
C
- createDefault() - Static method in class io.github.thoroldvix.internal.TranscriptApiFactory
-
Creates a new instance of
YoutubeTranscriptApi
using the default YouTube client. - createWithClient(YoutubeClient) - Static method in class io.github.thoroldvix.internal.TranscriptApiFactory
-
Creates a new instance of
YoutubeTranscriptApi
using the specifiedYoutubeClient
.
F
- fetch() - Method in interface io.github.thoroldvix.api.Transcript
-
Retrieves the content of the transcript.
- findGeneratedTranscript(String...) - Method in interface io.github.thoroldvix.api.TranscriptList
-
Searches for an automatically generated transcript using the provided language codes.
- findManualTranscript(String...) - Method in interface io.github.thoroldvix.api.TranscriptList
-
Searches for a manually created transcript using the provided language codes.
- findTranscript(String...) - Method in interface io.github.thoroldvix.api.TranscriptList
-
Searches for a transcript using the provided language codes.
- forEach(Consumer<? super Transcript>) - Method in interface io.github.thoroldvix.api.TranscriptList
- format(TranscriptContent) - Method in interface io.github.thoroldvix.api.TranscriptFormatter
-
Formats the transcript content.
G
- get(String, Map<String, String>) - Method in interface io.github.thoroldvix.api.YoutubeClient
-
Sends a GET request to the specified URL and returns the response body.
- getApiUrl() - Method in interface io.github.thoroldvix.api.Transcript
-
Returns API URL which needs to be called to fetch transcript content.
- getContent() - Method in interface io.github.thoroldvix.api.TranscriptContent
-
Retrieves a list of
TranscriptContent.Fragment
objects that represent the content of the transcript. - getDur() - Method in interface io.github.thoroldvix.api.TranscriptContent.Fragment
-
Retrieves the duration of the fragment in seconds.
- getLanguage() - Method in interface io.github.thoroldvix.api.Transcript
-
Gets the language of the transcript.
- getLanguageCode() - Method in interface io.github.thoroldvix.api.Transcript
-
Gets the language code of the transcript.
- getStart() - Method in interface io.github.thoroldvix.api.TranscriptContent.Fragment
-
Retrieves the start time of the fragment in seconds.
- getText() - Method in interface io.github.thoroldvix.api.TranscriptContent.Fragment
-
Retrieves the text of the fragment.
- getTranscript(String, String...) - Method in interface io.github.thoroldvix.api.YoutubeTranscriptApi
-
Retrieves transcript content for a single video.
- getTranscriptWithCookies(String, String, String...) - Method in interface io.github.thoroldvix.api.YoutubeTranscriptApi
-
Retrieves transcript content for a given video using cookies from a specified file path.
- getTranslationLanguages() - Method in interface io.github.thoroldvix.api.Transcript
-
Lists all available translation languages for the transcript.
- getVideoId() - Method in interface io.github.thoroldvix.api.Transcript
-
Gets the video id of the transcript.
I
- io.github.thoroldvix.api - package io.github.thoroldvix.api
- io.github.thoroldvix.internal - package io.github.thoroldvix.internal
- isGenerated() - Method in interface io.github.thoroldvix.api.Transcript
-
Determines if the transcript was automatically generated by YouTube.
- isTranslatable() - Method in interface io.github.thoroldvix.api.Transcript
-
Indicates whether the transcript can be translated.
J
- jsonFormatter() - Static method in class io.github.thoroldvix.api.TranscriptFormatters
-
Creates a
TranscriptFormatter
that formats transcript content as JSON.
L
- listTranscripts(String) - Method in interface io.github.thoroldvix.api.YoutubeTranscriptApi
-
Retrieves a list of available transcripts for a given video.
- listTranscriptsWithCookies(String, String) - Method in interface io.github.thoroldvix.api.YoutubeTranscriptApi
-
Retrieves a list of available transcripts for a given video using cookies from a specified file path.
P
- prettyJsonFormatter() - Static method in class io.github.thoroldvix.api.TranscriptFormatters
-
Creates a
TranscriptFormatter
that formats transcript content as pretty-printed JSON.
S
- srtFormatter() - Static method in class io.github.thoroldvix.api.TranscriptFormatters
-
Creates a
TranscriptFormatter
that formats transcript content as SRT (SubRip) subtitles.
T
- textFormatter() - Static method in class io.github.thoroldvix.api.TranscriptFormatters
-
Creates a
TranscriptFormatter
that formats transcript content as plain text without timestamps. - Transcript - Interface in io.github.thoroldvix.api
-
Represents a single transcript for a YouTube video, including its metadata.
- TranscriptApiFactory - Class in io.github.thoroldvix.internal
-
Class for creating instances of
YoutubeTranscriptApi
. - TranscriptContent - Interface in io.github.thoroldvix.api
-
Represents the content of a transcript for a single video.
- TranscriptContent.Fragment - Interface in io.github.thoroldvix.api
-
Represents a single fragment of the transcript content.
- TranscriptFormatter - Interface in io.github.thoroldvix.api
-
Represents a formatter for transcript content.
- TranscriptFormatters - Class in io.github.thoroldvix.api
-
Responsible for creating
TranscriptFormatter
instances. - TranscriptList - Interface in io.github.thoroldvix.api
-
Represents a list of all available transcripts for a YouTube video.
- TranscriptRetrievalException - Exception Class in io.github.thoroldvix.api
-
Exception thrown when a transcript cannot be retrieved for a specified video.
- TranscriptRetrievalException(String, String) - Constructor for exception class io.github.thoroldvix.api.TranscriptRetrievalException
-
Constructs a new exception with the specified detail message.
- TranscriptRetrievalException(String, String, Throwable) - Constructor for exception class io.github.thoroldvix.api.TranscriptRetrievalException
-
Constructs a new exception with the specified detail message and cause.
- translate(String) - Method in interface io.github.thoroldvix.api.Transcript
-
Translates the transcript into the specified language.
W
- webVTTFormatter() - Static method in class io.github.thoroldvix.api.TranscriptFormatters
-
Creates a
TranscriptFormatter
that formats transcript content as WebVTT format.
Y
- YoutubeClient - Interface in io.github.thoroldvix.api
-
Responsible for sending GET requests to YouTube.
- YoutubeTranscriptApi - Interface in io.github.thoroldvix.api
-
This is the main interface for the YouTube Transcript API.
All Classes and Interfaces|All Packages|Serialized Form