@playzone/youtube-transcript
Version:
A JavaScript API which allows you to get the transcripts/subtitles for a given YouTube video. It also works for automatically generated subtitles and it does not require a headless browser.
43 lines • 1.29 kB
TypeScript
import { AxiosInstance } from 'axios';
import { TranscriptList, FetchedTranscript } from '../transcripts/models';
import { ProxyConfig } from '../proxies';
/**
* Main YouTube Transcript API class
*/
export declare class YouTubeTranscriptApi {
private readonly fetcher;
constructor(proxyConfig?: ProxyConfig, httpClient?: AxiosInstance);
/**
* Create HTTP client with proper configuration
*/
private createHttpClient;
/**
* Extract proxy host from URL
*/
private extractProxyHost;
/**
* Extract proxy port from URL
*/
private extractProxyPort;
/**
* Extract proxy authentication from URL
*/
private extractProxyAuth;
/**
* Fetch transcript for a single video (shortcut method)
*/
fetch(videoId: string, languages?: string[], preserveFormatting?: boolean): Promise<FetchedTranscript>;
/**
* Get list of available transcripts for a video
*/
list(videoId: string): Promise<TranscriptList>;
}
/**
* Convenience function to create a new API instance
*/
export declare function createYouTubeTranscriptApi(proxyConfig?: ProxyConfig, httpClient?: AxiosInstance): YouTubeTranscriptApi;
/**
* Default export
*/
export default YouTubeTranscriptApi;
//# sourceMappingURL=index.d.ts.map