Package io.github.thoroldvix.api

Class Transcript

java.lang.Object
io.github.thoroldvix.api.Transcript
public class Transcript extends Object
Represents a single transcript for a YouTube video, including its metadata.

This interface provides methods to access the transcript content and to perform translations into different languages. Individual transcripts can be obtained through the TranscriptList class.

  • Method Details

    • fetch

      public TranscriptContent fetch() throws TranscriptRetrievalException
      Retrieves the content of the transcript.
      Returns:
      The content of the transcript as a TranscriptContent object.
      Throws:
      TranscriptRetrievalException - If the transcript content cannot be retrieved.

    • translate

      public Transcript translate(String languageCode) throws TranscriptRetrievalException
      Translates the transcript into the specified language.
      Parameters:
      languageCode - The language code to which the transcript should be translated.
      Returns:
      A Transcript representing the translated transcript.
      Throws:
      TranscriptRetrievalException - If the transcript cannot be translated.

    • getVideoId

      public String getVideoId()
      Gets the video id of the transcript.
      Returns:
      The video id as a String.

    • getLanguage

      public String getLanguage()
      Gets the language of the transcript.
      Returns:
      The language as a String.

    • getApiUrl

      public String getApiUrl()
      Returns API URL which needs to be called to fetch transcript content.
      Returns:
      String API URL to fetch transcript content

    • getLanguageCode

      public String getLanguageCode()
      Gets the language code of the transcript.
      Returns:
      The language code as a String.

    • isGenerated

      public boolean isGenerated()
      Determines if the transcript was automatically generated by YouTube.
      Returns:
      true if the transcript was automatically generated; false otherwise.

    • getTranslationLanguages

      public Set<String> getTranslationLanguages()
      Lists all available translation languages for the transcript.
      Returns:
      A set of language codes representing available translation languages.

    • isTranslatable

      public boolean isTranslatable()
      Indicates whether the transcript can be translated.
      Returns:
      true if the transcript is translatable; false otherwise.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object