Package io.github.thoroldvix.api

Class YoutubeTranscriptApi

java.lang.Object

io.github.thoroldvix.api.YoutubeTranscriptApi

public class YoutubeTranscriptApi
extends Object

This is the main interface for the YouTube Transcript API.

It provides functionality for retrieving all available transcripts or retrieving actual transcript content for a single video, playlist, or channel.

To instantiate this API, you should use TranscriptApiFactory.

Method Summary

Modifier and Type	Method	Description
TranscriptContent	getTranscript(String videoId, String... languageCodes)	Retrieves transcript content for a single video.
Map<String,TranscriptContent>	getTranscriptsForChannel(String channelName, BulkTranscriptRequest request, String... languageCodes)	Retrieves transcript content for all videos for the specified channel.
Map<String,TranscriptContent>	getTranscriptsForPlaylist(String playlistId, BulkTranscriptRequest request, String... languageCodes)	Retrieves transcript content for all videos in the specified playlist.
TranscriptList	listTranscripts(String videoId)	Retrieves a list of available transcripts for a given video.
Map<String,TranscriptList>	listTranscriptsForChannel(String channelName, BulkTranscriptRequest request)	Retrieves transcript lists for all videos for the specified channel.
Map<String,TranscriptList>	listTranscriptsForPlaylist(String playlistId, BulkTranscriptRequest request)	Retrieves transcript lists for all videos in the specified playlist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTranscript

public TranscriptContent getTranscript(String videoId,
 String... languageCodes)
                                throws TranscriptRetrievalException

Retrieves transcript content for a single video.

This is a shortcut for calling:

listTranscripts(videoId).findTranscript(languageCodes).fetch();

Parameters:

videoId - The ID of the video

languageCodes - A varargs list of language codes in descending priority.

For example:

If this is set to ("de", "en"), it will first attempt to fetch the German transcript ("de"), and then fetch the English transcript ("en") if the former fails. If no language code is provided, it uses English as the default language.

Returns:

TranscriptContent The transcript content

Throws:

TranscriptRetrievalException - If the retrieval of the transcript fails

IllegalArgumentException - If the video ID is invalid

listTranscripts

public TranscriptList listTranscripts(String videoId)
                               throws TranscriptRetrievalException

Retrieves a list of available transcripts for a given video.

Parameters:

videoId - The ID of the video

Returns:

TranscriptList A list of all available transcripts for the given video

Throws:

TranscriptRetrievalException - If the retrieval of the transcript list fails

IllegalArgumentException - If the video ID is invalid

listTranscriptsForPlaylist

public Map<String,TranscriptList> listTranscriptsForPlaylist(String playlistId,
 BulkTranscriptRequest request)
                                                      throws TranscriptRetrievalException

Retrieves transcript lists for all videos in the specified playlist.

Parameters:

playlistId - The ID of the playlist

request - BulkTranscriptRequest request object containing API key and stop on error flag

Returns:

A map of video IDs to TranscriptList objects

Throws:

TranscriptRetrievalException - If the retrieval of the transcript lists fails

getTranscriptsForPlaylist

public Map<String,TranscriptContent> getTranscriptsForPlaylist(String playlistId,
 BulkTranscriptRequest request,
 String... languageCodes)
                                                        throws TranscriptRetrievalException

Retrieves transcript content for all videos in the specified playlist.

Parameters:

playlistId - The ID of the playlist

request - BulkTranscriptRequest request object containing API key and stop on error flag

languageCodes - A varargs list of language codes in descending priority.

For example:

If this is set to ("de", "en"), it will first attempt to fetch the German transcript ("de"), and then fetch the English transcript ("en") if the former fails. If no language code is provided, it uses English as the default language.

Returns:

A map of video IDs to TranscriptContent objects

Throws:

TranscriptRetrievalException - If the retrieval of the transcript fails

listTranscriptsForChannel

public Map<String,TranscriptList> listTranscriptsForChannel(String channelName,
 BulkTranscriptRequest request)
                                                     throws TranscriptRetrievalException

Retrieves transcript lists for all videos for the specified channel.

Parameters:

channelName - The name of the channel

request - BulkTranscriptRequest request object containing API key and stop on error flag

Returns:

A map of video IDs to TranscriptList objects

Throws:

TranscriptRetrievalException - If the retrieval of the transcript lists fails

getTranscriptsForChannel

public Map<String,TranscriptContent> getTranscriptsForChannel(String channelName,
 BulkTranscriptRequest request,
 String... languageCodes)
                                                       throws TranscriptRetrievalException

Retrieves transcript content for all videos for the specified channel.

Parameters:

channelName - The name of the channel

request - BulkTranscriptRequest request object containing API key and stop on error flag

languageCodes - A varargs list of language codes in descending priority.

For example:

If this is set to ("de", "en"), it will first attempt to fetch the German transcript ("de"), and then fetch the English transcript ("en") if the former fails. If no language code is provided, it uses English as the default language.

Returns:

A map of video IDs to TranscriptContent objects

Throws:

TranscriptRetrievalException - If the retrieval of the transcript fails