Struct TranscriptList

pub struct TranscriptList {
    pub video_id: String,
    pub manually_created_transcripts: HashMap<String, Transcript>,
    pub generated_transcripts: HashMap<String, Transcript>,
    pub translation_languages: Vec<TranslationLanguage>,
}

TranscriptList

A collection of available transcripts for a YouTube video.

This struct provides access to all transcripts available for a video, including:

• Manually created transcripts (by the video owner or contributors)
• Automatically generated transcripts (created by YouTube’s speech recognition)
• Available translation languages for translatable transcripts

The TranscriptList differentiates between manually created and automatically generated transcripts, as the manually created ones tend to be more accurate. This allows you to prioritize manually created transcripts over automatically generated ones.

Usage Example

let api = YouTubeTranscriptApi::new(None, None, None)?;

// Get a list of all available transcripts for a video
let transcript_list = api.list_transcripts("dQw4w9WgXcQ").await?;

// Print all available transcripts
println!("Available transcripts: {}", transcript_list);

// Find a transcript in a specific language (prioritizing English)
let transcript = transcript_list.find_transcript(&["en", "en-US"])?;

// Or specifically find a manually created transcript
let manual_transcript = transcript_list.find_manually_created_transcript(&["en"])?;

// Or retrieve an automatically generated transcript
let auto_transcript = transcript_list.find_generated_transcript(&["en"])?;

Fields

video_id: String

The YouTube video ID this transcript list belongs to

manually_created_transcripts: HashMap<String, Transcript>

Map of language codes to manually created transcripts

generated_transcripts: HashMap<String, Transcript>

Map of language codes to automatically generated transcripts

translation_languages: Vec<TranslationLanguage>

List of languages available for translation

Implementations

impl TranscriptList

pub fn new( video_id: String, manually_created_transcripts: HashMap<String, Transcript>, generated_transcripts: HashMap<String, Transcript>, translation_languages: Vec<TranslationLanguage>, ) -> Self

Creates a new TranscriptList with the provided components.

Parameters

• video_id - The YouTube video ID this transcript list belongs to
• manually_created_transcripts - Map of language codes to manually created transcripts
• generated_transcripts - Map of language codes to automatically generated transcripts
• translation_languages - List of languages available for translation

Returns

A new TranscriptList instance

pub fn build( video_id: String, video_page_html: &Value, ) -> Result<Self, CouldNotRetrieveTranscript>

Creates a TranscriptList from YouTube’s caption JSON data.

This method parses YouTube’s internal caption data structure to extract:

• Available transcripts (both manual and automatic)
• Their respective language codes and names
• Information about available translation languages

Parameters

• video_id - The YouTube video ID
• video_page_html - JSON data extracted from YouTube’s page containing caption information

Returns

• Result<Self, CouldNotRetrieveTranscript> - A transcript list or an error

Errors

Returns an error if the caption data cannot be properly parsed.

pub fn build_without_client( video_id: String, video_page_html: &Value, ) -> Result<Self, CouldNotRetrieveTranscript>

Creates a TranscriptList from YouTube’s caption JSON data without requiring a client.

This method is similar to build but doesn’t take a client parameter, making it suitable for use in serialization/deserialization contexts.

Parameters

• video_id - The YouTube video ID
• video_page_html - JSON data extracted from YouTube’s page containing caption information

Returns

• Result<Self, CouldNotRetrieveTranscript> - A transcript list or an error

Errors

Returns an error if the caption data cannot be properly parsed.

pub fn find_transcript( &self, language_codes: &[&str], ) -> Result<Transcript, CouldNotRetrieveTranscript>

Finds a transcript matching one of the specified language codes.

This method searches for transcripts in the order of priority:

1. Manually created transcripts with the specified language codes (in order)
2. Automatically generated transcripts with the specified language codes (in order)

Parameters

• language_codes - Array of language codes to search for, in order of preference

Returns

• Result<Transcript, CouldNotRetrieveTranscript> - Matching transcript or an error

Errors

Returns an error if no transcript is found for any of the specified language codes.

Example

let api = YouTubeTranscriptApi::new(None, None, None)?;
let transcript_list = api.list_transcripts("dQw4w9WgXcQ").await?;

// Try to find English, fall back to Spanish, then auto-generated English
let transcript = transcript_list.find_transcript(&["en", "es", "en-US"])?;

pub fn find_manually_created_transcript( &self, language_codes: &[&str], ) -> Result<Transcript, CouldNotRetrieveTranscript>

Finds a manually created transcript matching one of the specified language codes.

This method only searches the manually created transcripts, skipping any automatically generated ones. This is useful when you want to ensure you’re getting a human-created transcript for better accuracy.

Parameters

• language_codes - Array of language codes to search for, in order of preference

Returns

• Result<Transcript, CouldNotRetrieveTranscript> - Matching transcript or an error

Errors

Returns an error if no manually created transcript is found for any of the specified language codes.

Example

let api = YouTubeTranscriptApi::new(None, None, None)?;
let transcript_list = api.list_transcripts("dQw4w9WgXcQ").await?;

// Only look for manually created transcripts
match transcript_list.find_manually_created_transcript(&["en"]) {
    Ok(transcript) => {
        println!("Found manual transcript!");
    },
    Err(_) => {
        println!("No manual transcript available, falling back to auto-generated");
        let auto_transcript = transcript_list.find_generated_transcript(&["en"])?;
    }
}

pub fn find_generated_transcript( &self, language_codes: &[&str], ) -> Result<Transcript, CouldNotRetrieveTranscript>

Finds an automatically generated transcript matching one of the specified language codes.

This method only searches the automatically generated transcripts, skipping any manually created ones. This might be useful in rare cases where you specifically want the auto-generated version.

Parameters

• language_codes - Array of language codes to search for, in order of preference

Returns

• Result<Transcript, CouldNotRetrieveTranscript> - Matching transcript or an error

Errors

Returns an error if no automatically generated transcript is found for any of the specified language codes.

pub fn transcripts(&self) -> impl Iterator<Item = &Transcript>

Returns a reference to all available transcripts.

This method provides access to both manually created and automatically generated transcripts as an iterator.

Returns

An iterator over references to all available transcripts.

Example

let api = YouTubeTranscriptApi::new(None, None, None)?;
let transcript_list = api.list_transcripts("dQw4w9WgXcQ").await?;

// Print info about all available transcripts
for transcript in transcript_list.transcripts() {
    println!("Language: {} ({}), Auto-generated: {}",
        transcript.language(),
        transcript.language_code(),
        transcript.is_generated());
}

Trait Implementations

impl Clone for TranscriptList

fn clone(&self) -> TranscriptList

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TranscriptList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TranscriptList

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TranscriptList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a TranscriptList

type Item = &'a Transcript

The type of the elements being iterated over.

type IntoIter = Chain<Map<Values<'a, String, Transcript>, fn(&'a Transcript) -> &'a Transcript>, Map<Values<'a, String, Transcript>, fn(&'a Transcript) -> &'a Transcript>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for TranscriptList

type Item = Transcript

The type of the elements being iterated over.

type IntoIter = IntoIter<<TranscriptList as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for TranscriptList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.